v3.6.1 Documentation
Fungus.Condition Class Referenceabstract
Inheritance diagram for Fungus.Condition:
Fungus.Command Fungus.LuaCondition Fungus.VariableCondition Fungus.LuaElseIf Fungus.LuaIf Fungus.ElseIf Fungus.If Fungus.While

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...
 
- 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 bool HasReference (Variable variable)
 Returns true if this command references the variable. More...
 
virtual string GetSummary ()
 Returns the summary text to display in the command inspector. 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 Color GetButtonColor ()
 Return the color for the command background in inspector. 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...
 

Static Public Member Functions

static string GetOperatorDescription (CompareOperator compareOperator)
 

Protected Member Functions

virtual void EvaluateAndContinue ()
 
virtual void OnTrue ()
 
virtual void OnFalse ()
 
abstract bool EvaluateCondition ()
 
abstract bool HasNeededProperties ()
 

Properties

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...
 

Additional Inherited Members

- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Detailed Description

Definition at line 9 of file Condition.cs.

Member Function Documentation

◆ EvaluateAndContinue()

virtual void Fungus.Condition.EvaluateAndContinue ( )
protectedvirtual

Definition at line 111 of file Condition.cs.

◆ EvaluateCondition()

abstract bool Fungus.Condition.EvaluateCondition ( )
protectedpure virtual

◆ GetOperatorDescription()

static string Fungus.Condition.GetOperatorDescription ( CompareOperator  compareOperator)
static

Definition at line 11 of file Condition.cs.

◆ HasNeededProperties()

abstract bool Fungus.Condition.HasNeededProperties ( )
protectedpure virtual

◆ OnEnter()

override void Fungus.Condition.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Reimplemented in Fungus.While.

Definition at line 41 of file Condition.cs.

◆ OnFalse()

virtual void Fungus.Condition.OnFalse ( )
protectedvirtual

Definition at line 128 of file Condition.cs.

◆ OnTrue()

virtual void Fungus.Condition.OnTrue ( )
protectedvirtual

Definition at line 123 of file Condition.cs.

◆ OpenBlock()

override bool Fungus.Condition.OpenBlock ( )
virtual

Return true if this command opens a block of commands.

Used for indenting commands.

Reimplemented from Fungus.Command.

Reimplemented in Fungus.LuaCondition, Fungus.While, Fungus.ElseIf, and Fungus.LuaElseIf.

Definition at line 104 of file Condition.cs.

Property Documentation

◆ IsElseIf

virtual bool Fungus.Condition.IsElseIf
getprotected

Definition at line 190 of file Condition.cs.


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