GameAPI.BudgetBoy.PlayAnimation Class Reference

Basic Awaitable used to delay execution of a coroutine until an Animation completes. More...

Inheritance diagram for GameAPI.BudgetBoy.PlayAnimation:

Public Member Functions
	PlayAnimation (Stage stage, Animation anim, bool advancedElsewhere, Awaitable @while=null)
	Constructs a new PlayAnimation Awaitable for the given animation and optionally an inner Awaitable to be used to prematurely stop the animation when it completes. More...
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]
	Returns true if the Animation has finished, or if the inner Awaitable has completed if one was specified. 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< AwaitableEventArgs >	Started
	Event called when the Awaitable first begins updating its task. More...
EventHandler< AwaitableEventArgs >	Completed
	Event called when the Awaitable has completed its task. More...

Detailed Description

Basic Awaitable used to delay execution of a coroutine until an Animation completes.

Constructor & Destructor Documentation

GameAPI.BudgetBoy.PlayAnimation.PlayAnimation ( Stage  stage, Animation  anim, bool  advancedElsewhere, Awaitable @  while = null  )

inline

Constructs a new PlayAnimation Awaitable for the given animation and optionally an inner Awaitable to be used to prematurely stop the animation when it completes.

Parameters

stage	Stage the Animation is within, used to find the time step value.
anim	Animation to wait for.
advancedElsewhere	If false, the Animation will be advanced each update by this Awaitable.
while	Optional inner Awaitable, this Awaitable will complete when the inner Awaitable finishes.

Member Function Documentation

override void GameAPI.BudgetBoy.PlayAnimation.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.PlayAnimation.IsComplete

get

Returns true if the Animation has finished, or if the inner Awaitable has completed if one was specified.