Simple toggle functionality. More...

Inheritance diagram for UIToggle:

Static Public Member Functions
static UIToggle	GetActiveToggle (int group)
	Return the first active toggle within the specified group. More...

Public Attributes
int	group = 0
	If set to anything other than '0', all active toggles in this group will behave as radio buttons. More...

UIWidget	activeSprite
	Sprite that's visible when the 'isActive' status is 'true'. More...

Animation	activeAnimation
	Animation to play on the active sprite, if any. More...

bool	startsActive = false
	Whether the toggle starts checked. More...

bool	instantTween = false
	If checked, tween-based transition will be instant instead. More...

bool	optionCanBeNone = false
	Can the radio button option be 'none'? More...

List< EventDelegate >	onChange = new List<EventDelegate>()
	Callbacks triggered when the toggle's state changes. More...

Static Public Attributes
static BetterList< UIToggle >	list = new BetterList<UIToggle>()
	List of all the active toggles currently in the scene. More...

static UIToggle	current
	Current toggle that sent a state change notification. More...

Properties
bool	value `[get, set]`
	Whether the toggle is checked. More...

bool	isChecked `[get, set]`

Detailed Description

Simple toggle functionality.

Member Function Documentation

static UIToggle UIToggle.GetActiveToggle ( int group )

static

Return the first active toggle within the specified group.

Animation UIToggle.activeAnimation

Animation to play on the active sprite, if any.

UIWidget UIToggle.activeSprite

Sprite that's visible when the 'isActive' status is 'true'.

UIToggle UIToggle.current

static

Current toggle that sent a state change notification.

int UIToggle.group = 0

If set to anything other than '0', all active toggles in this group will behave as radio buttons.

bool UIToggle.instantTween = false

If checked, tween-based transition will be instant instead.

BetterList<UIToggle> UIToggle.list = new BetterList<UIToggle>()

static

List of all the active toggles currently in the scene.

List<EventDelegate> UIToggle.onChange = new List<EventDelegate>()

Callbacks triggered when the toggle's state changes.

bool UIToggle.optionCanBeNone = false

Can the radio button option be 'none'?

bool UIToggle.startsActive = false

Whether the toggle starts checked.

bool UIToggle.isChecked

getset

bool UIToggle.value

getset

Whether the toggle is checked.

The documentation for this class was generated from the following file: