Sansar Docs
Ask or search…
K

ICoroutine

ICoroutine Interface

Token representing a coroutine.

Syntax

public interface ICoroutine

Member Details

Abort Method

Stop the coroutine

Syntax

public void Abort ()

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

IsAlive Property

Is this coroutine is still working or waiting.

Syntax

public bool IsAlive { get; }
Value
Will return false if this coroutine has completed or had Abort() called on it or thrown an exception.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

IsWaiting Property

Is the coroutine waiting.

Syntax

public bool IsWaiting { get; }
Value
True if the coroutine is waiting for time or an event.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

Name Property

The name of the coroutine.

Syntax

public string Name { get; set; }
Value
Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

ResetSignals Method

Reset the signal count on a coroutine.

Syntax

public void ResetSignals ()

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

Signal Method

Send a signal to the coroutine and wake it up if it is waiting for a signal.

Syntax

public void Signal ()

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0