Arcade
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
GameAPI.BudgetBoy.Sequential Class Reference

An action that will run all contained actions in a linear sequence. More...

Inheritance diagram for GameAPI.BudgetBoy.Sequential:
GameAPI.BudgetBoy.Awaitable

Public Member Functions

 Sequential (WaitStyle waitStyle)
 Constructs a new Sequential. More...
 
 Sequential (params Object[] inner)
 Constructs a new Sequential. More...
 
void Add (Object inner)
 Adds a new Awaitable action to this action. More...
 
IEnumerator< AwaitableGetEnumerator ()
 
- Public Member Functions inherited from GameAPI.BudgetBoy.Awaitable
void Update ()
 Update the task represented by this Awaitable for one frame. More...
 

Protected Member Functions

override void OnUpdate ()
 Called when the task represented by this Awaitable should update for one frame. More...
 
- Protected Member Functions inherited from GameAPI.BudgetBoy.Awaitable
virtual void OnStarted ()
 Called when the Awaitable first begins updating its task. More...
 
virtual void OnCompleted ()
 Called when the Awaitable has completed its task. More...
 

Properties

override bool IsComplete [get]
 Completion criteria depends on the WaitStyle specified when this Awaitable was constructed. More...
 
- Properties inherited from GameAPI.BudgetBoy.Awaitable
abstract bool IsComplete [get]
 When overridden, returns true if the Awaitable's task has completed. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GameAPI.BudgetBoy.Awaitable
static Awaitable FromObject (Object obj)
 Attempts to convert an object into an Awaitable. If the object is an IEnumerator or a function returning an IEnumerator it is converted into a Coroutine, otherwise it is assumed to extend Awaitable. Returns null if the object cannot be converted. More...
 
- Events inherited from GameAPI.BudgetBoy.Awaitable
EventHandler< AwaitableEventArgsStarted
 Event called when the Awaitable first begins updating its task. More...
 
EventHandler< AwaitableEventArgsCompleted
 Event called when the Awaitable has completed its task. More...
 

Detailed Description

An action that will run all contained actions in a linear sequence.

Constructor & Destructor Documentation

GameAPI.BudgetBoy.Sequential.Sequential ( WaitStyle  waitStyle)
inline

Constructs a new Sequential.

Parameters
waitStyleWhen should this action be considered finished?
GameAPI.BudgetBoy.Sequential.Sequential ( params Object[]  inner)
inline

Constructs a new Sequential.

Parameters
innerChild Awaitable actions that will be run in sequence by this action.

Member Function Documentation

void GameAPI.BudgetBoy.Sequential.Add ( Object  inner)
inline

Adds a new Awaitable action to this action.

Parameters
innerThe child Awaitable action that will be run after all previously added child actions have been completed.
IEnumerator<Awaitable> GameAPI.BudgetBoy.Sequential.GetEnumerator ( )
inline
override void GameAPI.BudgetBoy.Sequential.OnUpdate ( )
inlineprotectedvirtual

Called when the task represented by this Awaitable should update for one frame.

Implements GameAPI.BudgetBoy.Awaitable.

Property Documentation

override bool GameAPI.BudgetBoy.Sequential.IsComplete
get

Completion criteria depends on the WaitStyle specified when this Awaitable was constructed.