v3.6.1 Documentation
Fungus.CommandCopyBuffer Class Reference

Temporary buffer object used when copying and pasting commands. More...

Inheritance diagram for Fungus.CommandCopyBuffer:
Fungus.Block Fungus.Node

Public Member Functions

virtual bool HasCommands ()
 
virtual Command [] GetCommands ()
 
virtual void Clear ()
 
- Public Member Functions inherited from Fungus.Block
virtual Flowchart GetFlowchart ()
 Returns the parent Flowchart for this Block. More...
 
virtual bool IsExecuting ()
 Returns true if the Block is executing a command. More...
 
virtual int GetExecutionCount ()
 Returns the number of times this Block has executed. More...
 
virtual void StartExecution ()
 Start a coroutine which executes all commands in the Block. More...
 
virtual IEnumerator Execute (int commandIndex=0, Action onComplete=null)
 A coroutine method that executes all commands in the Block. More...
 
virtual void Stop ()
 Stop executing commands in this Block. More...
 
virtual List< BlockGetConnectedBlocks ()
 Returns a list of all Blocks connected to this one. More...
 
virtual System.Type GetPreviousActiveCommandType ()
 Returns the type of the previously executing command. More...
 
virtual void UpdateIndentLevels ()
 Recalculate the indent levels for all commands in the list. More...
 
virtual int GetLabelIndex (string labelKey)
 Returns the index of the Label command with matching key, or -1 if not found. More...
 

Static Public Member Functions

static CommandCopyBuffer GetInstance ()
 Returns the CommandCopyBuffer singleton instance. More...
 

Protected Member Functions

virtual void Start ()
 
- Protected Member Functions inherited from Fungus.Block
virtual void Awake ()
 
virtual void SetExecutionInfo ()
 Populate the command metadata used to control execution. More...
 

Static Protected Attributes

static CommandCopyBuffer instance
 

Additional Inherited Members

- Protected Attributes inherited from Fungus.Block
int itemId = -1
 
string blockName = "New Block"
 
string description = ""
 
EventHandler eventHandler
 
List< CommandcommandList = new List<Command>()
 
ExecutionState executionState
 
Command activeCommand
 
int previousActiveCommandIndex = -1
 
int jumpToCommandIndex = -1
 
int executionCount
 
bool executionInfoSet = false
 
- Protected Attributes inherited from Fungus.Node
Rect nodeRect = new Rect(0, 0, 120, 30)
 
Color tint = Color.white
 
bool useCustomTint = false
 
- Properties inherited from Fungus.Block
virtual ExecutionState State [get]
 The execution state of the Block. More...
 
virtual int ItemId [get, set]
 Unique identifier for the Block. More...
 
virtual string BlockName [get, set]
 The name of the block node as displayed in the Flowchart window. More...
 
virtual string Description [get]
 Description text to display under the block node More...
 
virtual EventHandler _EventHandler [get, set]
 An optional Event Handler which can execute the block when an event occurs. More...
 
virtual Command ActiveCommand [get]
 The currently executing command. More...
 
virtual float ExecutingIconTimer [get, set]
 Timer for fading Block execution icon. More...
 
virtual List< CommandCommandList [get]
 The list of commands in the sequence. More...
 
virtual int JumpToCommandIndex [set]
 Controls the next command to execute in the block execution coroutine. More...
 
- Properties inherited from Fungus.Node
virtual Rect _NodeRect [get, set]
 
virtual Color Tint [get, set]
 
virtual bool UseCustomTint [get, set]
 

Detailed Description

Temporary buffer object used when copying and pasting commands.

Definition at line 12 of file CommandCopyBuffer.cs.

Member Function Documentation

◆ Clear()

virtual void Fungus.CommandCopyBuffer.Clear ( )
virtual

Definition at line 63 of file CommandCopyBuffer.cs.

◆ GetCommands()

virtual Command [] Fungus.CommandCopyBuffer.GetCommands ( )
virtual

Definition at line 58 of file CommandCopyBuffer.cs.

◆ GetInstance()

static CommandCopyBuffer Fungus.CommandCopyBuffer.GetInstance ( )
static

Returns the CommandCopyBuffer singleton instance.

Will create a CommandCopyBuffer game object if none currently exists.

Definition at line 30 of file CommandCopyBuffer.cs.

◆ HasCommands()

virtual bool Fungus.CommandCopyBuffer.HasCommands ( )
virtual

Definition at line 53 of file CommandCopyBuffer.cs.

◆ Start()

virtual void Fungus.CommandCopyBuffer.Start ( )
protectedvirtual

Definition at line 16 of file CommandCopyBuffer.cs.

Member Data Documentation

◆ instance

CommandCopyBuffer Fungus.CommandCopyBuffer.instance
staticprotected

Definition at line 14 of file CommandCopyBuffer.cs.


The documentation for this class was generated from the following file: