Click or drag to resize

ActionRunCoroutine Class

Represents an action that runs a coroutine.
Inheritance Hierarchy
SystemObject
  TreeSharpComposite
    TreeSharpAction
      TreeSharpActionRunCoroutine

Namespace:  TreeSharp
Assembly:  RebornBuddy (in RebornBuddy.exe) Version: 3.3.1; net-4.5.win32; release
Syntax
C#
public class ActionRunCoroutine : Action

The ActionRunCoroutine type exposes the following members.

Constructors
  NameDescription
Public methodActionRunCoroutine(FuncObject, Coroutine)
Initializes a new instance with the specified coroutine producer.
Public methodActionRunCoroutine(FuncObject, CoroutineTaskBoolean)
Initializes a new instance with the specified coroutine task producer.
Public methodActionRunCoroutine(FuncObject, CoroutineTask)
Initializes a new instance with the specified coroutine task producer.
Public methodActionRunCoroutine(FuncObject, TaskBoolean)
Initializes a new instance with the specified task producer.
Public methodActionRunCoroutine(FuncObject, Task)
Initializes a new instance with the specified task producer.
Top
Properties
  NameDescription
Protected propertyCleanupHandlers (Inherited from Composite.)
Protected propertyContextChanger (Inherited from Composite.)
Public propertyGuid (Inherited from Composite.)
Public propertyIsRunning (Inherited from Composite.)
Public propertyLastStatus (Inherited from Composite.)
Public propertyParent (Inherited from Composite.)
Public propertyRunner (Inherited from Action.)
Public propertySucceedRunner (Inherited from Action.)
Top
Methods
  NameDescription
Protected methodCleanup (Inherited from Composite.)
Public methodEquals(Object) (Inherited from Composite.)
Public methodEquals(Composite) (Inherited from Composite.)
Protected methodExecute (Inherited from Action.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode (Inherited from Composite.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodRun (Overrides ActionRun(Object).)
Protected methodRunAction (Inherited from Action.)
Public methodStart (Overrides CompositeStart(Object).)
Public methodStop (Overrides CompositeStop(Object).)
Public methodTick (Inherited from Composite.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodExecuteCoroutine
Executes the composite inside a coroutine.
(Defined by CommonTasks.)
Top
Remarks

The RunStatus that this action returns depends on the Coroutine being run.

If the coroutine yields, the action returns Running and does not resume until next tick.

If the coroutine returns boolean false, the action returns Failure.

If the coroutine terminates with any other result than boolean false, the action returns Success.

See Also