SmashHammer.UI.INumberField Interface Reference

Provides access to a UI number field's properties. More...

Inheritance diagram for SmashHammer.UI.INumberField:

Properties
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?

Events
ValueChangedHandler	OnEndEdit
	Event that is raised when editing the number field has ended.

Detailed Description

Provides access to a UI number field's properties.

Property Documentation

Value

float SmashHammer.UI.INumberField.Value

getset

The number field value.

The current value of this number field.

Implemented in SmashHammer.UI.NumberField.

MaxNumDecimalPlaces

int SmashHammer.UI.INumberField.MaxNumDecimalPlaces

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!

Implemented in SmashHammer.UI.NumberField.

WholeNumbers

bool SmashHammer.UI.INumberField.WholeNumbers

getset

Is the number field restricted to whole numbers?

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

Implemented in SmashHammer.UI.NumberField.