A number field UI element. More...

Inheritance diagram for SmashHammer.UI.NumberField:

Properties
float	Value `[get, set]`
	The number field value.

int	MaxNumDecimalPlaces = 0 `[get, set]`
	The maximum number of decimal places allowed.

bool	WholeNumbers `[get, set]`
	Is the number field restricted to whole numbers?

Properties inherited from SmashHammer.UI.Element
virtual bool	IsVisible `[get, set]`
	Is the element visible?

Properties inherited from SmashHammer.UI.IElement
bool	IsVisible `[get, set]`
	Is the element visible?

bool	IsInteractable `[get, set]`
	Is the element interactable?

bool	IsTargetable `[get, set]`
	Is the element targetable?

Properties inherited from SmashHammer.UI.INumberField
float	Value `[get, set]`
	The number field value.

int	MaxNumDecimalPlaces `[get, set]`
	The maximum number of decimal places allowed.

bool	WholeNumbers `[get, set]`
	Is the number field restricted to whole numbers?

Additional Inherited Members
Public Types inherited from SmashHammer.UI.ISizeable
enum	Align : byte { LeftEdge , RightEdge , TopEdge , BottomEdge , HorizEdges , VertEdges , HorizCentre , VertCentre }
	UI element alignment mode. More...

void	SetAlignment (Align align, float paramA, float paramB)
	Set the element's alignment.

void	SetRotation (float angle)
	Set the element's rotation.

Events inherited from SmashHammer.UI.IFocusable
ValueChangedHandler	OnGainFocus
	Event that is raised when the element gains focus.

ValueChangedHandler	OnLoseFocus
	Event that is raised when the element loses focus.

Events inherited from SmashHammer.UI.INumberField
ValueChangedHandler	OnEndEdit
	Event that is raised when editing the number field has ended.

Detailed Description

A number field UI element.

Property Documentation

float SmashHammer.UI.NumberField.Value

getset

The number field value.

The current value of this number field.

int SmashHammer.UI.NumberField.MaxNumDecimalPlaces = 0

getset

The maximum number of decimal places allowed.

The maximum number of decimal places that this number field will be restricted to. Set to non-positive value to disable the restriction.

Only applicable when WholeNumbers is not enabled!

bool SmashHammer.UI.NumberField.WholeNumbers

getset

Is the number field restricted to whole numbers?

true if this number field should only allow integer values; otherwise, false.