v3.9.1 Documentation
Fungus.While Class Reference

Continuously loop through a block of commands while the condition is true. More...

Inheritance diagram for Fungus.While:
Fungus.If Fungus.VariableCondition Fungus.Condition Fungus.Command

Public Member Functions

override void OnEnter ()
 Called when this command starts execution. More...
 
override bool OpenBlock ()
 Return true if this command opens a block of commands. More...
 
override Color GetButtonColor ()
 Return the color for the command background in inspector. More...
 
- Public Member Functions inherited from Fungus.VariableCondition
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...
 
- 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 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Fungus.Condition
static string GetOperatorDescription (CompareOperator compareOperator)
 
- Static Public Attributes inherited from Fungus.VariableCondition
static readonly Dictionary< System.Type, CompareOperator[]> operatorsByVariableType
 
- Protected Member Functions inherited from Fungus.VariableCondition
override bool EvaluateCondition ()
 
override bool HasNeededProperties ()
 
- Protected Member Functions inherited from Fungus.Condition
virtual void EvaluateAndContinue ()
 
virtual void OnTrue ()
 
virtual void OnFalse ()
 
- Protected Attributes inherited from Fungus.VariableCondition
CompareOperator compareOperator
 
Variable variable
 
BooleanData booleanData
 
IntegerData integerData
 
FloatData floatData
 
StringDataMulti stringData
 
AnimatorData animatorData
 
AudioSourceData audioSourceData
 
ColorData colorData
 
GameObjectData gameObjectData
 
MaterialData materialData
 
ObjectData objectData
 
Rigidbody2DData rigidbody2DData
 
SpriteData spriteData
 
TextureData textureData
 
TransformData transformData
 
Vector2Data vector2Data
 
Vector3Data vector3Data
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 
- Properties inherited from Fungus.VariableCondition
virtual CompareOperator _CompareOperator [get]
 The type of comparison operation to be performed. More...
 
- Properties inherited from Fungus.Condition
virtual bool IsElseIf [get]
 
- 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

Continuously loop through a block of commands while the condition is true.

Use the Break command to force the loop to terminate immediately.

Definition at line 15 of file While.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.While.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.If.

Definition at line 59 of file While.cs.

◆ OnEnter()

override void Fungus.While.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Condition.

Definition at line 19 of file While.cs.

◆ OpenBlock()

override bool Fungus.While.OpenBlock ( )
virtual

Return true if this command opens a block of commands.

Used for indenting commands.

Reimplemented from Fungus.Condition.

Definition at line 54 of file While.cs.


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