C# Class Fungus.Block

Inheritance: Fungus.Node
Afficher le fichier Open project: snozbot/fungus Class Usage Examples

Protected Properties

Свойство Type Description
activeCommand Fungus.Command
executionCount int
executionInfoSet bool
executionState ExecutionState
jumpToCommandIndex int
previousActiveCommandIndex int

Méthodes publiques

Méthode Description
Execute ( int commandIndex, System.Action onComplete = null ) : IEnumerator

A coroutine method that executes all commands in the Block. Only one running instance of each Block is permitted.

GetConnectedBlocks ( ) : List

Returns a list of all Blocks connected to this one.

GetExecutionCount ( ) : int

Returns the number of times this Block has executed.

GetFlowchart ( ) : Flowchart

Returns the parent Flowchart for this Block.

GetLabelIndex ( string labelKey ) : int

Returns the index of the Label command with matching key, or -1 if not found.

GetPreviousActiveCommandType ( ) : Type

Returns the type of the previously executing command.

IsExecuting ( ) : bool

Returns true if the Block is executing a command.

StartExecution ( ) : void

Start a coroutine which executes all commands in the Block. Only one running instance of each Block is permitted.

Stop ( ) : void

Stop executing commands in this Block.

UpdateIndentLevels ( ) : void

Recalculate the indent levels for all commands in the list.

Méthodes protégées

Méthode Description
Awake ( ) : void
SetExecutionInfo ( ) : void

Populate the command metadata used to control execution.

Update ( ) : void

Method Details

Awake() protected méthode

protected Awake ( ) : void
Résultat void

Execute() public méthode

A coroutine method that executes all commands in the Block. Only one running instance of each Block is permitted.
public Execute ( int commandIndex, System.Action onComplete = null ) : IEnumerator
commandIndex int Index of command to start execution at
onComplete System.Action Delegate function to call when execution completes
Résultat IEnumerator

GetConnectedBlocks() public méthode

Returns a list of all Blocks connected to this one.
public GetConnectedBlocks ( ) : List
Résultat List

GetExecutionCount() public méthode

Returns the number of times this Block has executed.
public GetExecutionCount ( ) : int
Résultat int

GetFlowchart() public méthode

Returns the parent Flowchart for this Block.
public GetFlowchart ( ) : Flowchart
Résultat Flowchart

GetLabelIndex() public méthode

Returns the index of the Label command with matching key, or -1 if not found.
public GetLabelIndex ( string labelKey ) : int
labelKey string
Résultat int

GetPreviousActiveCommandType() public méthode

Returns the type of the previously executing command.
public GetPreviousActiveCommandType ( ) : Type
Résultat System.Type

IsExecuting() public méthode

Returns true if the Block is executing a command.
public IsExecuting ( ) : bool
Résultat bool

SetExecutionInfo() protected méthode

Populate the command metadata used to control execution.
protected SetExecutionInfo ( ) : void
Résultat void

StartExecution() public méthode

Start a coroutine which executes all commands in the Block. Only one running instance of each Block is permitted.
public StartExecution ( ) : void
Résultat void

Stop() public méthode

Stop executing commands in this Block.
public Stop ( ) : void
Résultat void

Update() protected méthode

protected Update ( ) : void
Résultat void

UpdateIndentLevels() public méthode

Recalculate the indent levels for all commands in the list.
public UpdateIndentLevels ( ) : void
Résultat void

Property Details

activeCommand protected_oe property

protected Command,Fungus activeCommand
Résultat Fungus.Command

executionCount protected_oe property

protected int executionCount
Résultat int

executionInfoSet protected_oe property

protected bool executionInfoSet
Résultat bool

executionState protected_oe property

protected ExecutionState executionState
Résultat ExecutionState

jumpToCommandIndex protected_oe property

protected int jumpToCommandIndex
Résultat int

previousActiveCommandIndex protected_oe property

Index of last command executed before the current one. -1 indicates no previous command.
protected int previousActiveCommandIndex
Résultat int