IButton Interface Reference

Detailed Description

Gui Button

    Button.KeypadEnter.Clickable = false;
    Button.AnimHover = "FlashRed";
    Button.ColorPress = Color.yellow;
    Button.Text = "Lets do it";
    Button.Description = "This button wins the game";

Inherits IGuiControl.

Properties
string	Description [get, set]
string	Cursor [get, set]
string	Text [get, set]
string	Anim [get, set]
string	AnimHover [get, set]
string	AnimClick [get, set]
string	AnimOff [get, set]
Color	Color [get, set]
Color	ColorHover [get, set]
Color	ColorClick [get, set]
Color	ColorOff [get, set]
bool	Clickable [get, set]
bool	Animating [get]
Properties inherited from IGuiControl
MonoBehaviour	Instance [get]
	Access to the actual game object component in the scene. Note that controls themselves can be cast to their component type if known. More...
bool	Visible [get, set]
	Sets the control visible invisible the control. More...
Vector2	Position [get, set]
bool	Focused [get]
bool	HasKeyboardFocus [get, set]

Public Member Functions
void	PauseAnimation ()
void	ResumeAnimation ()
void	StopAnimation ()
Coroutine	PlayAnimation (string animName)
void	PlayAnimationBG (string animName)
void	AddAnimationTrigger (string triggerName, bool removeAfterTriggering, System.Action action)
void	RemoveAnimationTrigger (string triggerName)
Coroutine	WaitForAnimTrigger (string triggerName)
Coroutine	Fade (float start, float end, float duration, eEaseCurve curve=eEaseCurve.Smooth)
	Fade the sprite's alpha. More...
void	FadeBG (float start, float end, float duration, eEaseCurve curve=eEaseCurve.InOutSmooth)
	Fade the sprite's alpha (non-blocking) More...
Public Member Functions inherited from IGuiControl
void	Show ()
	Shows the control. More...
void	Hide ()
	Hides the control. More...
void	SetPosition (float x, float y)
	Sets the position of the control. Note that this will be overridden if using AlignTo or FitTo component. More...

Member Function Documentation

Fade()

Coroutine Fade	(	float	start,
		float	end,
		float	duration,
		eEaseCurve	curve = eEaseCurve.Smooth
	)

Fade the sprite's alpha.

FadeBG()

void FadeBG	(	float	start,
		float	end,
		float	duration,
		eEaseCurve	curve = eEaseCurve.InOutSmooth
	)

Fade the sprite's alpha (non-blocking)