MoreMountains.Tools.MMDebugMenuItemCheckbox Class Reference

A class used to bind a checkbox to a MMDebugMenu More...

Inheritance diagram for MoreMountains.Tools.MMDebugMenuItemCheckbox:

Public Member Functions
virtual void	TriggerCheckboxEvent ()
	Triggers an event when the checkbox gets pressed More...
virtual void	TriggerCheckboxEventTrue ()
	Triggers an event when the checkbox gets checked and becomes true More...
virtual void	TriggerCheckboxEventFalse ()
	Triggers an event when the checkbox gets unchecked and becomes false More...
virtual void	OnEnable ()
	Starts listening for events More...
virtual void	OnDestroy ()
	Stops listening for events More...

Public Attributes
MMDebugMenuSwitch	Switch
	the switch used to display the checkbox More...
Text	SwitchText
	the text used to display the checkbox's text More...
string	CheckboxEventName = "Checkbox"
	the name of the checkbox event More...

Protected Member Functions
virtual void	OnMMDebugMenuCheckboxEvent (string checkboxEventName, bool value, MMDebugMenuCheckboxEvent.EventModes eventMode)

Protected Attributes
bool	_valueSetThisFrame = false
bool	_listening = false

Detailed Description

A class used to bind a checkbox to a MMDebugMenu

Member Function Documentation

OnDestroy()

virtual void MoreMountains.Tools.MMDebugMenuItemCheckbox.OnDestroy ( )

virtual

Stops listening for events

OnEnable()

virtual void MoreMountains.Tools.MMDebugMenuItemCheckbox.OnEnable ( )

virtual

Starts listening for events

OnMMDebugMenuCheckboxEvent()

virtual void MoreMountains.Tools.MMDebugMenuItemCheckbox.OnMMDebugMenuCheckboxEvent ( string  checkboxEventName, bool  value, MMDebugMenuCheckboxEvent.EventModes  eventMode  )

protectedvirtual

TriggerCheckboxEvent()

virtual void MoreMountains.Tools.MMDebugMenuItemCheckbox.TriggerCheckboxEvent ( )

virtual

Triggers an event when the checkbox gets pressed

TriggerCheckboxEventFalse()

virtual void MoreMountains.Tools.MMDebugMenuItemCheckbox.TriggerCheckboxEventFalse ( )

virtual

Triggers an event when the checkbox gets unchecked and becomes false

TriggerCheckboxEventTrue()

virtual void MoreMountains.Tools.MMDebugMenuItemCheckbox.TriggerCheckboxEventTrue ( )

virtual

Triggers an event when the checkbox gets checked and becomes true

Member Data Documentation

_listening

bool MoreMountains.Tools.MMDebugMenuItemCheckbox._listening = false

protected

_valueSetThisFrame

bool MoreMountains.Tools.MMDebugMenuItemCheckbox._valueSetThisFrame = false

protected

CheckboxEventName

string MoreMountains.Tools.MMDebugMenuItemCheckbox.CheckboxEventName = "Checkbox"

the name of the checkbox event

Switch

MMDebugMenuSwitch MoreMountains.Tools.MMDebugMenuItemCheckbox.Switch

the switch used to display the checkbox

SwitchText

Text MoreMountains.Tools.MMDebugMenuItemCheckbox.SwitchText

the text used to display the checkbox's text

---

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

• E:/Github/Store/HighroadEngine/Assets/HighroadEngine/MMTools/Tools/MMDebugMenu/Scripts/MMDebugMenuItems/MMDebugMenuItemCheckbox.cs