Tanoda
UnityEngine.UI.ExtensionsToggle Class Reference

Simple toggle – something that has an 'on' and 'off' states: checkbox, toggle button, radio button, etc. More...

Inheritance diagram for UnityEngine.UI.ExtensionsToggle:

Classes

class  ToggleEvent
 
class  ToggleEventObject
 

Public Types

enum  ToggleTransition { None , Fade }
 

Public Member Functions

virtual void Rebuild (CanvasUpdate executing)
 
virtual void LayoutComplete ()
 
virtual void GraphicUpdateComplete ()
 
virtual void OnPointerClick (PointerEventData eventData)
 React to clicks. More...
 
virtual void OnSubmit (BaseEventData eventData)
 

Public Attributes

string UniqueID
 Variable to identify this script, change the datatype if needed to fit your use case More...
 
ToggleTransition toggleTransition = ToggleTransition.Fade
 Transition type. More...
 
Graphic graphic
 Graphic the toggle should be working with. More...
 
ToggleEvent onValueChanged = new ToggleEvent()
 Allow for delegate-based subscriptions for faster events than 'eventReceiver', and allowing for multiple receivers. More...
 
ToggleEventObject onToggleChanged = new ToggleEventObject()
 Allow for delegate-based subscriptions for faster events than 'eventReceiver', and allowing for multiple receivers. More...
 

Protected Member Functions

 ExtensionsToggle ()
 
override void OnEnable ()
 
override void OnDisable ()
 
override void OnDidApplyAnimationProperties ()
 
override void Start ()
 Assume the correct visual state. More...
 

Properties

ExtensionsToggleGroup Group [get, set]
 
bool IsOn [get, set]
 Whether the toggle is currently active. More...
 

Detailed Description

Simple toggle – something that has an 'on' and 'off' states: checkbox, toggle button, radio button, etc.

Definition at line 13 of file ExtensionsToggle.cs.

Member Enumeration Documentation

◆ ToggleTransition

Enumerator
None 
Fade 

Definition at line 20 of file ExtensionsToggle.cs.

Constructor & Destructor Documentation

◆ ExtensionsToggle()

UnityEngine.UI.ExtensionsToggle.ExtensionsToggle ( )
protected

Definition at line 83 of file ExtensionsToggle.cs.

Member Function Documentation

◆ GraphicUpdateComplete()

virtual void UnityEngine.UI.ExtensionsToggle.GraphicUpdateComplete ( )
virtual

Definition at line 119 of file ExtensionsToggle.cs.

◆ LayoutComplete()

virtual void UnityEngine.UI.ExtensionsToggle.LayoutComplete ( )
virtual

Definition at line 116 of file ExtensionsToggle.cs.

◆ OnDidApplyAnimationProperties()

override void UnityEngine.UI.ExtensionsToggle.OnDidApplyAnimationProperties ( )
protected

Definition at line 135 of file ExtensionsToggle.cs.

◆ OnDisable()

override void UnityEngine.UI.ExtensionsToggle.OnDisable ( )
protected

Definition at line 129 of file ExtensionsToggle.cs.

◆ OnEnable()

override void UnityEngine.UI.ExtensionsToggle.OnEnable ( )
protected

Definition at line 122 of file ExtensionsToggle.cs.

◆ OnPointerClick()

virtual void UnityEngine.UI.ExtensionsToggle.OnPointerClick ( PointerEventData  eventData)
virtual

React to clicks.

Definition at line 256 of file ExtensionsToggle.cs.

◆ OnSubmit()

virtual void UnityEngine.UI.ExtensionsToggle.OnSubmit ( BaseEventData  eventData)
virtual

Definition at line 264 of file ExtensionsToggle.cs.

◆ Rebuild()

virtual void UnityEngine.UI.ExtensionsToggle.Rebuild ( CanvasUpdate  executing)
virtual

Definition at line 105 of file ExtensionsToggle.cs.

◆ Start()

override void UnityEngine.UI.ExtensionsToggle.Start ( )
protected

Assume the correct visual state.

Definition at line 240 of file ExtensionsToggle.cs.

Member Data Documentation

◆ graphic

Graphic UnityEngine.UI.ExtensionsToggle.graphic

Graphic the toggle should be working with.

Definition at line 42 of file ExtensionsToggle.cs.

◆ onToggleChanged

ToggleEventObject UnityEngine.UI.ExtensionsToggle.onToggleChanged = new ToggleEventObject()

Allow for delegate-based subscriptions for faster events than 'eventReceiver', and allowing for multiple receivers.

Definition at line 75 of file ExtensionsToggle.cs.

◆ onValueChanged

ToggleEvent UnityEngine.UI.ExtensionsToggle.onValueChanged = new ToggleEvent()

Allow for delegate-based subscriptions for faster events than 'eventReceiver', and allowing for multiple receivers.

Definition at line 68 of file ExtensionsToggle.cs.

◆ toggleTransition

ToggleTransition UnityEngine.UI.ExtensionsToggle.toggleTransition = ToggleTransition.Fade

Transition type.

Definition at line 37 of file ExtensionsToggle.cs.

◆ UniqueID

string UnityEngine.UI.ExtensionsToggle.UniqueID

Variable to identify this script, change the datatype if needed to fit your use case

Definition at line 18 of file ExtensionsToggle.cs.

Property Documentation

◆ Group

ExtensionsToggleGroup UnityEngine.UI.ExtensionsToggle.Group
getset

Definition at line 48 of file ExtensionsToggle.cs.

◆ IsOn

bool UnityEngine.UI.ExtensionsToggle.IsOn
getset

Whether the toggle is currently active.

Definition at line 179 of file ExtensionsToggle.cs.


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