Basic Awaitable used to delay execution of a coroutine while a predicate evaluates to true. More...

Inheritance diagram for GameAPI.BudgetBoy.While:

Public Member Functions
	While (Func< bool > predicate)
	Constructs a new While Awaitable using the given predicate. 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 predicate evaluated as false last update. 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 while a predicate evaluates to true.

Constructor & Destructor Documentation

GameAPI.BudgetBoy.While.While ( Func< bool > predicate )

inline

Constructs a new While Awaitable using the given predicate.

Parameters

predicate Predicate to test each update.

override void GameAPI.BudgetBoy.While.OnUpdate ( )

inlineprotectedvirtual

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

override bool GameAPI.BudgetBoy.While.IsComplete

get

Returns true if the predicate evaluated as false last update.