Antura  1.1.0
Antura.UI.UIButton Class Reference

A general-purpose button More...

Inheritance diagram for Antura.UI.UIButton:
Antura.AnturaSpace.UI.AnturaSpaceCategoryButton Antura.AnturaSpace.UI.AnturaSpaceItemButton Antura.AnturaSpace.UI.AnturaSpaceModsButton Antura.AnturaSpace.UI.AnturaSpaceSwatchButton Antura.Map.AnturaButton Antura.UI.MenuButton Antura.UI.ProfileSelectorAvatarButton

Public Member Functions

virtual void Toggle (bool _activate, bool _animateClick=false)
 
virtual void Lock (bool _doLock)
 
void ChangeDefaultColors (Color _defaultColor, Color? _toggleOffColor=null)
 
void Pulse ()
 Pulsing stops automatically when the button is toggled or clicked (via AnimateClick) More...
 
void StopPulsing ()
 
void AnimateClick (bool _force=false)
 
void PlayClickFx ()
 

Public Attributes

Color BtToggleOffColor = Color.white
 
Color BtLockedColor = Color.red
 
bool ToggleIconAlpha = true
 
bool ToggleCanvasGroupAlpha = false
 
bool AutoAnimateClick = true
 
bool AutoPlayButtonFx = false
 
Color DefaultColor
 Default color of the button image More...
 

Protected Member Functions

virtual void Awake ()
 
virtual void OnDestroy ()
 

Properties

bool IsToggled [get]
 
bool IsLocked [get]
 
Button Bt [get]
 
RectTransform RectT [get]
 
Image BtImg [get]
 
Image Ico [get, set]
 
CanvasGroup CGroup [get]
 

Detailed Description

A general-purpose button

Member Function Documentation

◆ AnimateClick()

void Antura.UI.UIButton.AnimateClick ( bool  _force = false)

◆ Awake()

virtual void Antura.UI.UIButton.Awake ( )
protectedvirtual

◆ ChangeDefaultColors()

void Antura.UI.UIButton.ChangeDefaultColors ( Color  _defaultColor,
Color?  _toggleOffColor = null 
)

◆ Lock()

virtual void Antura.UI.UIButton.Lock ( bool  _doLock)
virtual

◆ OnDestroy()

virtual void Antura.UI.UIButton.OnDestroy ( )
protectedvirtual

◆ PlayClickFx()

void Antura.UI.UIButton.PlayClickFx ( )

◆ Pulse()

void Antura.UI.UIButton.Pulse ( )

Pulsing stops automatically when the button is toggled or clicked (via AnimateClick)

◆ StopPulsing()

void Antura.UI.UIButton.StopPulsing ( )

◆ Toggle()

virtual void Antura.UI.UIButton.Toggle ( bool  _activate,
bool  _animateClick = false 
)
virtual

Member Data Documentation

◆ AutoAnimateClick

bool Antura.UI.UIButton.AutoAnimateClick = true

◆ AutoPlayButtonFx

bool Antura.UI.UIButton.AutoPlayButtonFx = false

◆ BtLockedColor

Color Antura.UI.UIButton.BtLockedColor = Color.red

◆ BtToggleOffColor

Color Antura.UI.UIButton.BtToggleOffColor = Color.white

◆ DefaultColor

Color Antura.UI.UIButton.DefaultColor

Default color of the button image

◆ ToggleCanvasGroupAlpha

bool Antura.UI.UIButton.ToggleCanvasGroupAlpha = false

◆ ToggleIconAlpha

bool Antura.UI.UIButton.ToggleIconAlpha = true

Property Documentation

◆ Bt

Button Antura.UI.UIButton.Bt
get

◆ BtImg

Image Antura.UI.UIButton.BtImg
get

◆ CGroup

CanvasGroup Antura.UI.UIButton.CGroup
get

◆ Ico

Image Antura.UI.UIButton.Ico
getset

◆ IsLocked

bool Antura.UI.UIButton.IsLocked
get

◆ IsToggled

bool Antura.UI.UIButton.IsToggled
get

◆ RectT

RectTransform Antura.UI.UIButton.RectT
get

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