v3.6.1 Documentation
Fungus.LuaCondition Class Reference
Inheritance diagram for Fungus.LuaCondition:
Fungus.Condition Fungus.Command Fungus.LuaElseIf Fungus.LuaIf

Public Member Functions

override string GetSummary ()
 Returns the summary text to display in the command inspector. 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.Condition
override void OnEnter ()
 Called when this command starts execution. 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 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...
 

Public Attributes

string luaCompareString
 

Protected Member Functions

override bool EvaluateCondition ()
 
override bool HasNeededProperties ()
 
virtual void Start ()
 
virtual string GetLuaString ()
 
virtual void InitExecuteLua ()
 Initialises the Lua environment and compiles the Lua string for execution later on. More...
 
- Protected Member Functions inherited from Fungus.Condition
virtual void EvaluateAndContinue ()
 
virtual void OnTrue ()
 
virtual void OnFalse ()
 

Protected Attributes

LuaEnvironment luaEnvironment
 
bool initialised
 
string friendlyName = ""
 
Closure luaFunction
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Additional Inherited Members

- Static Public Member Functions inherited from Fungus.Condition
static string GetOperatorDescription (CompareOperator compareOperator)
 
- 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

Definition at line 9 of file LuaCondition.cs.

Member Function Documentation

◆ EvaluateCondition()

override bool Fungus.LuaCondition.EvaluateCondition ( )
protectedvirtual

Implements Fungus.Condition.

Definition at line 21 of file LuaCondition.cs.

◆ GetButtonColor()

override Color Fungus.LuaCondition.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Reimplemented in Fungus.LuaElseIf, and Fungus.LuaIf.

Definition at line 119 of file LuaCondition.cs.

◆ GetLuaString()

virtual string Fungus.LuaCondition.GetLuaString ( )
protectedvirtual

Definition at line 47 of file LuaCondition.cs.

◆ GetSummary()

override string Fungus.LuaCondition.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 103 of file LuaCondition.cs.

◆ HasNeededProperties()

override bool Fungus.LuaCondition.HasNeededProperties ( )
protectedvirtual

Implements Fungus.Condition.

Definition at line 37 of file LuaCondition.cs.

◆ InitExecuteLua()

virtual void Fungus.LuaCondition.InitExecuteLua ( )
protectedvirtual

Initialises the Lua environment and compiles the Lua string for execution later on.

Definition at line 55 of file LuaCondition.cs.

◆ OpenBlock()

override bool Fungus.LuaCondition.OpenBlock ( )
virtual

Return true if this command opens a block of commands.

Used for indenting commands.

Reimplemented from Fungus.Condition.

Reimplemented in Fungus.LuaElseIf.

Definition at line 114 of file LuaCondition.cs.

◆ Start()

virtual void Fungus.LuaCondition.Start ( )
protectedvirtual

Definition at line 42 of file LuaCondition.cs.

Member Data Documentation

◆ friendlyName

string Fungus.LuaCondition.friendlyName = ""
protected

Definition at line 18 of file LuaCondition.cs.

◆ initialised

bool Fungus.LuaCondition.initialised
protected

Definition at line 17 of file LuaCondition.cs.

◆ luaCompareString

string Fungus.LuaCondition.luaCompareString

Definition at line 16 of file LuaCondition.cs.

◆ luaEnvironment

LuaEnvironment Fungus.LuaCondition.luaEnvironment
protected

Definition at line 12 of file LuaCondition.cs.

◆ luaFunction

Closure Fungus.LuaCondition.luaFunction
protected

Definition at line 19 of file LuaCondition.cs.


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