SmashHammer.UI.Slider Class Reference

A slider UI element. More...

Inheritance diagram for SmashHammer.UI.Slider:

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.
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.ISlider
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.

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.ISlider
ValueChangedHandler	OnChanged
	Event that is raised when the slider value is changed.

Detailed Description

A slider UI element.

Property Documentation

Value

float SmashHammer.UI.Slider.Value

getset

The slider value.

The current value of this slider.

Implements SmashHammer.UI.ISlider.

MaxValue

float SmashHammer.UI.Slider.MaxValue

getset

The maximum value.

The maximum value that this slider can have.

Implements SmashHammer.UI.ISlider.

MinValue

float SmashHammer.UI.Slider.MinValue

getset

The minimum value.

The minimum value that this slider can have.

Implements SmashHammer.UI.ISlider.

WholeNumbers

bool SmashHammer.UI.Slider.WholeNumbers

getset

Is the slider restricted to whole numbers?

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

Implements SmashHammer.UI.ISlider.

ValueDisplayFormat

string SmashHammer.UI.Slider.ValueDisplayFormat

getset

The value display format string.

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

Implements SmashHammer.UI.ISlider.