C# Class UIRadioBtn, marblemadness

Inheritance: AutoSpriteControlBase, IRadioButton

Show file Open project: MtvnGames/marblemadness Class Usage Examples

Public Properties

Property	Type	Description
defaultValue	bool
delay	float
layers	SpriteRoot[],
methodToInvoke	string
radioGroup	int
scriptWithMethodToInvoke	MonoBehaviour
soundToPlay	UnityEngine.AudioSource
useParentForGrouping	bool
whenToInvoke	POINTER_INFO.INPUT_EVENT

Protected Properties

Property	Type	Description
btnValue	bool
group	RadioBtnGroup,
stateChangeWhileDeactivated	bool
stateIndices	].int[

Public Methods

Method	Description
Copy ( SpriteRoot, s ) : void
Copy ( SpriteRoot, s, ControlCopyFlags flags ) : void
Create ( string name, Vector3 pos ) : UIRadioBtn,	Creates a GameObject and attaches this component type to it.
Create ( string name, Vector3 pos, Quaternion rotation ) : UIRadioBtn,	Creates a GameObject and attaches this component type to it.
DrawPreTransitionUI ( int selState, IGUIScriptSelector gui ) : void
GetStateLabel ( int index ) : string
GetTransitions ( int index ) : EZTransitionList
InitUVs ( ) : void
OnDestroy ( ) : void
OnInput ( POINTER_INFO, &ptr ) : void
SetGroup ( GameObject parent ) : void	Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group.
SetGroup ( Transform parent ) : void	Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group.
SetGroup ( int groupID ) : void	Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group.
SetStateLabel ( int index, string label ) : void
Start ( ) : void

Protected Methods

Method	Description
Awake ( ) : void
DisableMe ( ) : void
OnEnable ( ) : void
PopOtherButtonsInGroup ( ) : void
SetButtonState ( ) : void
SetButtonState ( bool suppressTransition ) : void
SetLayerState ( CONTROL_STATE s ) : void
SetValue ( bool val ) : void
SetValue ( bool val, bool suppressTransition ) : void
StartTransition ( int newState, int prevState ) : void

Method Details

Awake() protected method

protected Awake ( ) : void
return	void

Copy() public method

public Copy ( SpriteRoot, s ) : void
s	SpriteRoot,
return	void

Copy() public method

public Copy ( SpriteRoot, s, ControlCopyFlags flags ) : void
s	SpriteRoot,
flags	ControlCopyFlags
return	void

Create() static public method

Creates a GameObject and attaches this component type to it.

static public Create ( string name, Vector3 pos ) : UIRadioBtn,
name	string	Name to give to the new GameObject.
pos	Vector3	Position, in world space, where the new object should be created.
return	UIRadioBtn,

Create() static public method

Creates a GameObject and attaches this component type to it.

static public Create ( string name, Vector3 pos, Quaternion rotation ) : UIRadioBtn,
name	string	Name to give to the new GameObject.
pos	Vector3	Position, in world space, where the new object should be created.
rotation	Quaternion	Rotation of the object.
return	UIRadioBtn,

DisableMe() protected method

protected DisableMe ( ) : void
return	void

DrawPreTransitionUI() public method

public DrawPreTransitionUI ( int selState, IGUIScriptSelector gui ) : void
selState	int
gui	IGUIScriptSelector
return	void

GetStateLabel() public method

public GetStateLabel ( int index ) : string
index	int
return	string

GetTransitions() public method

public GetTransitions ( int index ) : EZTransitionList
index	int
return	EZTransitionList

InitUVs() public method

public InitUVs ( ) : void
return	void

OnDestroy() public method

public OnDestroy ( ) : void
return	void

OnEnable() protected method

protected OnEnable ( ) : void
return	void

OnInput() public method

public OnInput ( POINTER_INFO, &ptr ) : void
ptr	POINTER_INFO,
return	void

PopOtherButtonsInGroup() protected method

protected PopOtherButtonsInGroup ( ) : void
return	void

SetButtonState() protected method

protected SetButtonState ( ) : void
return	void

SetButtonState() protected method

protected SetButtonState ( bool suppressTransition ) : void
suppressTransition	bool
return	void

SetGroup() public method

Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group.

public SetGroup ( GameObject parent ) : void
parent	GameObject
return	void

SetGroup() public method

Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group.

public SetGroup ( Transform parent ) : void
parent	Transform
return	void

SetGroup() public method

Makes the radio button a part of the specified group and it will thenceforth be mutually exclusive to all other radio buttons in the same group.

public SetGroup ( int groupID ) : void
groupID	int
return	void

SetLayerState() protected method

protected SetLayerState ( CONTROL_STATE s ) : void
s	CONTROL_STATE
return	void

SetStateLabel() public method

public SetStateLabel ( int index, string label ) : void
index	int
label	string
return	void

SetValue() protected method

protected SetValue ( bool val ) : void
val	bool
return	void

SetValue() protected method

protected SetValue ( bool val, bool suppressTransition ) : void
val	bool
suppressTransition	bool
return	void

Start() public method

public Start ( ) : void
return	void

StartTransition() protected method

protected StartTransition ( int newState, int prevState ) : void
newState	int
prevState	int
return	void

Property Details

btnValue protected property

protected bool btnValue
return	bool

defaultValue public property

The default value of the button

public bool defaultValue
return	bool

delay public property

Delay, in seconds, between the time the control is tapped and the time the method is executed.

public float delay
return	float

group protected property

protected RadioBtnGroup, group
return	RadioBtnGroup,

layers public property

An array of references to sprites which will visually represent this control. Each element (layer) represents another layer to be drawn. This allows you to use multiple sprites to draw a single control, achieving a sort of layered effect. Ex: You can use a second layer to overlay a button with a highlight effect.

public SpriteRoot[], layers
return	SpriteRoot[],

methodToInvoke public property

A string containing the name of the method to be invoked.

public string methodToInvoke
return	string

radioGroup public property

The numbered group to which this radio button belongs. Buttons that share a group will be mutually exclusive to one another. This value is only available if RADIOBTN_USE_PARENT is not defined. Otherwise, by default, radio buttons group themselves according to a common parent GameObject.

public int radioGroup
return	int

scriptWithMethodToInvoke public property

Reference to the script component with the method you wish to invoke when the button changes states.

public MonoBehaviour scriptWithMethodToInvoke
return	MonoBehaviour

soundToPlay public property

Sound that will be played when the button is tapped.

public AudioSource,UnityEngine soundToPlay
return	UnityEngine.AudioSource

stateChangeWhileDeactivated protected property

protected bool stateChangeWhileDeactivated
return	bool

stateIndices protected property

protected int[,] stateIndices
return	].int[

useParentForGrouping public property

When true, the radio button will group itself with other radio buttons based on whether they share the same parent GameObject.

public bool useParentForGrouping
return	bool

whenToInvoke public property

Sets what event should have occurred to invoke the associated MonoBehaviour method. Defaults to TAP.

public POINTER_INFO.INPUT_EVENT whenToInvoke
return	POINTER_INFO.INPUT_EVENT