Tanoda
UnityEngine.UI.Extensions.CooldownButton Class Reference
Inheritance diagram for UnityEngine.UI.Extensions.CooldownButton:

Classes

class  CooldownButtonEvent
 

Public Member Functions

void PauseCooldown ()
 Pause Cooldown without resetting values, allows Restarting of cooldown More...
 
void RestartCooldown ()
 Restart a paused cooldown More...
 
void StartCooldown ()
 Start a cooldown from outside More...
 
void StopCooldown ()
 Stop a running Cooldown and reset all values More...
 
void CancelCooldown ()
 Stop a running Cooldown and retain current values More...
 

Public Attributes

CooldownButtonEvent OnCooldownStart
 
CooldownButtonEvent OnButtonClickDuringCooldown
 
CooldownButtonEvent OnCoolDownFinish
 

Properties

float CooldownTimeout [get, set]
 
float CooldownSpeed [get, set]
 
bool CooldownInEffect [get]
 
bool CooldownActive [get, set]
 
float CooldownTimeElapsed [get, set]
 
float CooldownTimeRemaining [get]
 
int CooldownPercentRemaining [get]
 
int CooldownPercentComplete [get]
 

Detailed Description

Definition at line 10 of file CooldownButton.cs.

Member Function Documentation

◆ CancelCooldown()

void UnityEngine.UI.Extensions.CooldownButton.CancelCooldown ( )

Stop a running Cooldown and retain current values

Definition at line 170 of file CooldownButton.cs.

◆ PauseCooldown()

void UnityEngine.UI.Extensions.CooldownButton.PauseCooldown ( )

Pause Cooldown without resetting values, allows Restarting of cooldown

Definition at line 123 of file CooldownButton.cs.

◆ RestartCooldown()

void UnityEngine.UI.Extensions.CooldownButton.RestartCooldown ( )

Restart a paused cooldown

Definition at line 134 of file CooldownButton.cs.

◆ StartCooldown()

void UnityEngine.UI.Extensions.CooldownButton.StartCooldown ( )

Start a cooldown from outside

Definition at line 145 of file CooldownButton.cs.

◆ StopCooldown()

void UnityEngine.UI.Extensions.CooldownButton.StopCooldown ( )

Stop a running Cooldown and reset all values

Definition at line 157 of file CooldownButton.cs.

Member Data Documentation

◆ OnButtonClickDuringCooldown

CooldownButtonEvent UnityEngine.UI.Extensions.CooldownButton.OnButtonClickDuringCooldown

Definition at line 91 of file CooldownButton.cs.

◆ OnCoolDownFinish

CooldownButtonEvent UnityEngine.UI.Extensions.CooldownButton.OnCoolDownFinish

Definition at line 93 of file CooldownButton.cs.

◆ OnCooldownStart

CooldownButtonEvent UnityEngine.UI.Extensions.CooldownButton.OnCooldownStart

Definition at line 89 of file CooldownButton.cs.

Property Documentation

◆ CooldownActive

bool UnityEngine.UI.Extensions.CooldownButton.CooldownActive
getset

Definition at line 58 of file CooldownButton.cs.

◆ CooldownInEffect

bool UnityEngine.UI.Extensions.CooldownButton.CooldownInEffect
get

Definition at line 53 of file CooldownButton.cs.

◆ CooldownPercentComplete

int UnityEngine.UI.Extensions.CooldownButton.CooldownPercentComplete
get

Definition at line 80 of file CooldownButton.cs.

◆ CooldownPercentRemaining

int UnityEngine.UI.Extensions.CooldownButton.CooldownPercentRemaining
get

Definition at line 75 of file CooldownButton.cs.

◆ CooldownSpeed

float UnityEngine.UI.Extensions.CooldownButton.CooldownSpeed
getset

Definition at line 47 of file CooldownButton.cs.

◆ CooldownTimeElapsed

float UnityEngine.UI.Extensions.CooldownButton.CooldownTimeElapsed
getset

Definition at line 64 of file CooldownButton.cs.

◆ CooldownTimeout

float UnityEngine.UI.Extensions.CooldownButton.CooldownTimeout
getset

Definition at line 41 of file CooldownButton.cs.

◆ CooldownTimeRemaining

float UnityEngine.UI.Extensions.CooldownButton.CooldownTimeRemaining
get

Definition at line 70 of file CooldownButton.cs.


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