'w Coroutine (Nu) | Nu

'w Coroutine Type

Namespace: Nu
Assembly: Nu.dll
Base Type: obj

A coroutine in Nu allows easy definition of static behavior over multiple frames.

Union cases

Union case	Description
`Cancel` Full Usage: `Cancel`
`Coroutine 'w -> unit` Full Usage: `Coroutine 'w -> unit` Parameters: Item : `'w -> unit`	Item : `'w -> unit`
`Coroutines 'w Coroutine list` Full Usage: `Coroutines 'w Coroutine list` Parameters: Item : `'w Coroutine list`	Item : `'w Coroutine list`
`Sleep GameTime` Full Usage: `Sleep GameTime` Parameters: Item : `GameTime`	Item : `GameTime`

Instance members

Instance member	Description
`this.IsCancel` Full Usage: `this.IsCancel` Returns: `bool`	Returns: `bool`
`this.IsCoroutine` Full Usage: `this.IsCoroutine` Returns: `bool`	Returns: `bool`
`this.IsCoroutines` Full Usage: `this.IsCoroutines` Returns: `bool`	Returns: `bool`
`this.IsSleep` Full Usage: `this.IsSleep` Returns: `bool`	Returns: `bool`

Static members

Static member	Description
`Coroutine.cancel` Full Usage: `Coroutine.cancel` Returns: `'w Coroutine`	A coroutine that cancels the entire tree. Returns: `'w Coroutine`
`Coroutine.pass` Full Usage: `Coroutine.pass` Returns: `'w Coroutine`	A coroutine that sleeps for the length of one frame (the shortest possible one in DynamicFrameRate mode. Returns: `'w Coroutine`
`Coroutine.prepare coroutine gameTime` Full Usage: `Coroutine.prepare coroutine gameTime` Parameters: coroutine : `'w Coroutine` gameTime : `GameTime` Returns: `GameTime * 'w Coroutine`	Prepare a coroutine for execution at the given starting game time. coroutine : `'w Coroutine` gameTime : `GameTime` Returns: `GameTime * 'w Coroutine`
`Coroutine.sleep gameTime` Full Usage: `Coroutine.sleep gameTime` Parameters: gameTime : `GameTime` Returns: `'w Coroutine`	A coroutine that sleeps until the given game time. gameTime : `GameTime` Returns: `'w Coroutine`
`Coroutine.step pred coroutine gameTime world` Full Usage: `Coroutine.step pred coroutine gameTime world` Parameters: pred : `'w -> bool` coroutine : `'w Coroutine` gameTime : `GameTime` world : `'w` Returns: `'w CoroutineResult`	Step a coroutine. pred : `'w -> bool` coroutine : `'w Coroutine` gameTime : `GameTime` world : `'w` Returns: `'w CoroutineResult`