MenuToggleItemCog

TOCK by NullSave\UI Cog\Scripts\Menu\MenuToggleItemCog.cs

Inherits: MenuItemCog

Description

Menu item used to toggle between two states.

Inherited properties and methods can be found here.

Properties

Checked True if toggle is in "On" state.
Auto Wrap If true allows toggle between states in same input direction.
Hide Unsel Value If true whichever state is not active will have its elements hidden.
Save to Location Determines where to save the users selected value.
On Text Text element for displaying "on" value.
On Background Image background for "on" value.
Off Text Text element for displaying "off" value.
Off Background Image background for "off" value.
Toggle Text (Normal) Color to apply to "on" and "off" text elements when item is enabled but not selected.
Toggle Background (Normal) Color to apply to "on" and "off" image elements when item is enabled but not selected.
Toggle Text (Selected) Color to apply to "on" and "off" text elements when item is selected.
Toggle Background (Selected) Color to apply to "on" and "off" image elements when item is selected.
Toggle Text (Disabled) Color to apply to "on" and "off" text elements when item is disabled.
Toggle Background (Disabled) Color to apply to "on" and "off" image elements when item is disabled.
onUnchecked Raised when the value is set to "off" state.