Class DotAnimation
Object handling a dot animation on a UI object. Once initialized, call the UpdateDisplay method during the waiting loop.
Inheritance
Namespace: Appearition.Example
Assembly: Assembly-CSharp.dll
Syntax
public class DotAnimation : IDisposable
Constructors
DotAnimation(List<Button>, Text, Single, Int32)
UI animation object which adds dots at the end of a given text, and changes the interactible state of several button. Best used in a USING statement around a loop in a coroutine.
Declaration
public DotAnimation(List<Button> newButtonsToTurnOff, Text newDisplayText, float newDelayBetweenDots, int newMaxAmountOfDots)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<UnityEngine.UI.Button> | newButtonsToTurnOff | New buttons to turn off. |
UnityEngine.UI.Text | newDisplayText | New display text. |
System.Single | newDelayBetweenDots | New delay between dots. |
System.Int32 | newMaxAmountOfDots | New max amount of dots. |
DotAnimation(Button, Text, Single, Int32)
UI animation object which adds dots at the end of a given text, and changes the interactive state of a single button. Best used in a USING statement around a loop in a coroutine.
Declaration
public DotAnimation(Button newButtonToTurnOff, Text newDisplayText, float newDelayBetweenDots, int newMaxAmountOfDots)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.UI.Button | newButtonToTurnOff | New button to turn off. |
UnityEngine.UI.Text | newDisplayText | New display text. |
System.Single | newDelayBetweenDots | New delay between dots. |
System.Int32 | newMaxAmountOfDots | New max amount of dots. |
DotAnimation(Text, Single, Int32)
UI animation object which adds dots at the end of a given text. Best used in a USING statement around a loop in a coroutine.
Declaration
public DotAnimation(Text newDisplayText, float newDelayBetweenDots, int newMaxAmountOfDots)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.UI.Text | newDisplayText | New display text. |
System.Single | newDelayBetweenDots | New delay between dots. |
System.Int32 | newMaxAmountOfDots | New max amount of dots. |
Methods
Dispose()
Called whenever the object is not used anymore.
Declaration
public void Dispose()
Remarks
Call Dispose() when you are finished using the DotAnimation. The Dispose() method leaves the DotAnimation in an unusable state. After calling Dispose(), you must release all references to the DotAnimation so the garbage collector can reclaim the memory that the DotAnimation was occupying.
UpdateDisplay()
Declaration
public void UpdateDisplay()