v3.6.1 Documentation
Fungus.SetVariable Class Reference

Sets a Boolean, Integer, Float or String variable to a new value using a simple arithmetic operation. More...

Inheritance diagram for Fungus.SetVariable:
Fungus.Command

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
override string GetSummary ()
 Returns the summary text to display in the command inspector. More...
 
override bool HasReference (Variable variable)
 Returns true if this command references the variable. More...
 
override Color GetButtonColor ()
 Return the color for the command background in inspector. More...
 
- Public Member Functions inherited from Fungus.Command
virtual Flowchart GetFlowchart ()
 Returns the Flowchart that this command belongs to. More...
 
virtual void Execute ()
 Execute the command. More...
 
virtual void Continue ()
 End execution of this command and continue execution at the next command. More...
 
virtual void Continue (int nextCommandIndex)
 End execution of this command and continue execution at a specific command index. More...
 
virtual void StopParentBlock ()
 Stops the parent Block executing. More...
 
virtual void OnStopExecuting ()
 Called when the parent block has been requested to stop executing, and this command is the currently executing command. More...
 
virtual void OnCommandAdded (Block parentBlock)
 Called when the new command is added to a block in the editor. More...
 
virtual void OnCommandRemoved (Block parentBlock)
 Called when the command is deleted from a block in the editor. More...
 
virtual void OnExit ()
 Called when this command ends execution. More...
 
virtual void OnReset ()
 Called when this command is reset. More...
 
virtual void GetConnectedBlocks (ref List< Block > connectedBlocks)
 Populates a list with the Blocks that this command references. More...
 
virtual string GetHelpText ()
 Returns the help text to display for this command. More...
 
virtual bool OpenBlock ()
 Return true if this command opens a block of commands. More...
 
virtual bool CloseBlock ()
 Return true if this command closes a block of commands. More...
 
virtual bool IsPropertyVisible (string propertyName)
 Returns true if the specified property should be displayed in the inspector. More...
 
virtual bool IsReorderableArray (string propertyName)
 Returns true if the specified property should be displayed as a reorderable list in the inspector. More...
 
virtual string GetFlowchartLocalizationId ()
 Returns the localization id for the Flowchart that contains this command. More...
 

Protected Member Functions

virtual void DoSetOperation ()
 

Protected Attributes

Variable variable
 
SetOperator setOperator
 
BooleanData booleanData
 
IntegerData integerData
 
FloatData floatData
 
StringDataMulti stringData
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Properties

virtual SetOperator _SetOperator [get]
 The type of math operation to be performed. More...
 
- Properties inherited from Fungus.Command
virtual int ItemId [get, set]
 Unique identifier for this command. More...
 
virtual string ErrorMessage [get]
 Error message to display in the command inspector. More...
 
virtual int IndentLevel [get, set]
 Indent depth of the current commands. More...
 
virtual int CommandIndex [get, set]
 Index of the command in the parent block's command list. More...
 
virtual bool IsExecuting [get, set]
 Set to true by the parent block while the command is executing. More...
 
virtual float ExecutingIconTimer [get, set]
 Timer used to control appearance of executing icon in inspector. More...
 
virtual Block ParentBlock [get, set]
 Reference to the Block object that this command belongs to. More...
 

Detailed Description

Sets a Boolean, Integer, Float or String variable to a new value using a simple arithmetic operation.

The value can be a constant or reference another variable of the same type.

Definition at line 34 of file SetVariable.cs.

Member Function Documentation

◆ DoSetOperation()

virtual void Fungus.SetVariable.DoSetOperation ( )
protectedvirtual

Definition at line 58 of file SetVariable.cs.

◆ GetButtonColor()

override Color Fungus.SetVariable.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 220 of file SetVariable.cs.

◆ GetSummary()

override string Fungus.SetVariable.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 163 of file SetVariable.cs.

◆ HasReference()

override bool Fungus.SetVariable.HasReference ( Variable  variable)
virtual

Returns true if this command references the variable.

Used to highlight variables in the variable list when a command is selected.

Reimplemented from Fungus.Command.

Definition at line 215 of file SetVariable.cs.

◆ OnEnter()

override void Fungus.SetVariable.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 156 of file SetVariable.cs.

Member Data Documentation

◆ booleanData

BooleanData Fungus.SetVariable.booleanData
protected

Definition at line 47 of file SetVariable.cs.

◆ floatData

FloatData Fungus.SetVariable.floatData
protected

Definition at line 53 of file SetVariable.cs.

◆ integerData

IntegerData Fungus.SetVariable.integerData
protected

Definition at line 50 of file SetVariable.cs.

◆ setOperator

SetOperator Fungus.SetVariable.setOperator
protected

Definition at line 44 of file SetVariable.cs.

◆ stringData

StringDataMulti Fungus.SetVariable.stringData
protected

Definition at line 56 of file SetVariable.cs.

◆ variable

Variable Fungus.SetVariable.variable
protected

Definition at line 41 of file SetVariable.cs.

Property Documentation

◆ _SetOperator

virtual SetOperator Fungus.SetVariable._SetOperator
get

The type of math operation to be performed.

Definition at line 154 of file SetVariable.cs.


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