v3.6.1 Documentation
Fungus.ExecuteLua Class Reference

Executes a Lua code chunk using a Lua Environment. More...

Inheritance diagram for Fungus.ExecuteLua:
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 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 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 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 Start ()
 
virtual void InitExecuteLua ()
 Initialises the Lua environment and compiles the Lua string for execution later on. More...
 
virtual string GetLuaString ()
 
virtual void StoreReturnVariable (DynValue returnValue)
 

Protected Attributes

LuaEnvironment luaEnvironment
 
TextAsset luaFile
 
string luaScript
 
bool runAsCoroutine = true
 
bool waitUntilFinished = true
 
Variable returnVariable
 
string friendlyName = ""
 
bool initialised
 
Closure luaFunction
 
- Protected Attributes inherited from Fungus.Command
int itemId = -1
 
int indentLevel
 
string errorMessage = ""
 

Additional Inherited Members

- 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

Executes a Lua code chunk using a Lua Environment.

Definition at line 15 of file ExecuteLua.cs.

Member Function Documentation

◆ GetButtonColor()

override Color Fungus.ExecuteLua.GetButtonColor ( )
virtual

Return the color for the command background in inspector.

Returns
The button color.

Reimplemented from Fungus.Command.

Definition at line 201 of file ExecuteLua.cs.

◆ GetLuaString()

virtual string Fungus.ExecuteLua.GetLuaString ( )
protectedvirtual

Definition at line 98 of file ExecuteLua.cs.

◆ GetSummary()

override string Fungus.ExecuteLua.GetSummary ( )
virtual

Returns the summary text to display in the command inspector.

Reimplemented from Fungus.Command.

Definition at line 196 of file ExecuteLua.cs.

◆ InitExecuteLua()

virtual void Fungus.ExecuteLua.InitExecuteLua ( )
protectedvirtual

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

Definition at line 52 of file ExecuteLua.cs.

◆ OnEnter()

override void Fungus.ExecuteLua.OnEnter ( )
virtual

Called when this command starts execution.

Reimplemented from Fungus.Command.

Definition at line 173 of file ExecuteLua.cs.

◆ Start()

virtual void Fungus.ExecuteLua.Start ( )
protectedvirtual

Definition at line 44 of file ExecuteLua.cs.

◆ StoreReturnVariable()

virtual void Fungus.ExecuteLua.StoreReturnVariable ( DynValue  returnValue)
protectedvirtual

Definition at line 108 of file ExecuteLua.cs.

Member Data Documentation

◆ friendlyName

string Fungus.ExecuteLua.friendlyName = ""
protected

Definition at line 37 of file ExecuteLua.cs.

◆ initialised

bool Fungus.ExecuteLua.initialised
protected

Definition at line 39 of file ExecuteLua.cs.

◆ luaEnvironment

LuaEnvironment Fungus.ExecuteLua.luaEnvironment
protected

Definition at line 18 of file ExecuteLua.cs.

◆ luaFile

TextAsset Fungus.ExecuteLua.luaFile
protected

Definition at line 21 of file ExecuteLua.cs.

◆ luaFunction

Closure Fungus.ExecuteLua.luaFunction
protected

Definition at line 42 of file ExecuteLua.cs.

◆ luaScript

string Fungus.ExecuteLua.luaScript
protected

Definition at line 25 of file ExecuteLua.cs.

◆ returnVariable

Variable Fungus.ExecuteLua.returnVariable
protected

Definition at line 35 of file ExecuteLua.cs.

◆ runAsCoroutine

bool Fungus.ExecuteLua.runAsCoroutine = true
protected

Definition at line 28 of file ExecuteLua.cs.

◆ waitUntilFinished

bool Fungus.ExecuteLua.waitUntilFinished = true
protected

Definition at line 31 of file ExecuteLua.cs.


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