SmashHammer.UI.ISlider Interface Reference

Provides access to a UI slider's properties. More...

Inheritance diagram for SmashHammer.UI.ISlider:

Properties
float	Value [get, set]
	The slider value.
float	MaxValue [get, set]
	The maximum value.
float	MinValue [get, set]
	The minimum value.
bool	WholeNumbers [get, set]
	Is the slider restricted to whole numbers?
string	ValueDisplayFormat [get, set]
	The value display format string.

Events
ValueChangedHandler	OnChanged
	Event that is raised when the slider value is changed.

Detailed Description

Provides access to a UI slider's properties.

Property Documentation

Value

float SmashHammer.UI.ISlider.Value

getset

The slider value.

The current value of this slider.

Implemented in SmashHammer.UI.LabelledSlider, and SmashHammer.UI.Slider.

MaxValue

float SmashHammer.UI.ISlider.MaxValue

getset

The maximum value.

The maximum value that this slider can have.

Implemented in SmashHammer.UI.Slider.

MinValue

float SmashHammer.UI.ISlider.MinValue

getset

The minimum value.

The minimum value that this slider can have.

Implemented in SmashHammer.UI.Slider.

WholeNumbers

bool SmashHammer.UI.ISlider.WholeNumbers

getset

Is the slider restricted to whole numbers?

true if this slider should snap to integer values; otherwise, false.

Implemented in SmashHammer.UI.Slider.

ValueDisplayFormat

string SmashHammer.UI.ISlider.ValueDisplayFormat

getset

The value display format string.

The format string used by this slider for showing its current value as text.

Implemented in SmashHammer.UI.Slider.