v3.6.1 Documentation
Fungus.Flowchart Class Reference

Visual scripting controller for the Flowchart programming language. More...

Inheritance diagram for Fungus.Flowchart:

Public Member Functions

bool IsActive ()
 Returns true if the Flowchart gameobject is active. More...
 
string GetName ()
 Returns the Flowchart gameobject name. More...
 
int NextItemId ()
 Returns the next id to assign to a new flowchart item. More...
 
virtual Block CreateBlock (Vector2 position)
 Create a new block node which you can then add commands to. More...
 
virtual Block FindBlock (string blockName)
 Returns the named Block in the flowchart, or null if not found. More...
 
virtual void ExecuteBlock (string blockName)
 Execute a child block in the Flowchart. More...
 
virtual void StopBlock (string blockName)
 Stops an executing Block in the Flowchart. More...
 
virtual bool ExecuteBlock (Block block, int commandIndex=0, Action onComplete=null)
 Execute a child block in the flowchart. More...
 
virtual void StopAllBlocks ()
 Stop all executing Blocks in this Flowchart. More...
 
virtual void SendFungusMessage (string messageName)
 Sends a message to this Flowchart only. More...
 
virtual string GetUniqueVariableKey (string originalKey, Variable ignoreVariable=null)
 Returns a new variable key that is guaranteed not to clash with any existing variable in the list. More...
 
virtual string GetUniqueBlockKey (string originalKey, Block ignoreBlock=null)
 Returns a new Block key that is guaranteed not to clash with any existing Block in the Flowchart. More...
 
virtual string GetUniqueLabelKey (string originalKey, Label ignoreLabel)
 Returns a new Label key that is guaranteed not to clash with any existing Label in the Block. More...
 
Variable GetVariable (string key)
 Returns the variable with the specified key, or null if the key is not found. More...
 
GetVariable< T > (string key)
 Returns the variable with the specified key, or null if the key is not found. More...
 
void SetVariable< T > (string key, T newvariable)
 Register a new variable with the Flowchart at runtime. More...
 
virtual bool HasVariable (string key)
 Checks if a given variable exists in the flowchart. More...
 
virtual string [] GetVariableNames ()
 Returns the list of variable names in the Flowchart. More...
 
virtual List< VariableGetPublicVariables ()
 Gets a list of all variables with public scope in this Flowchart. More...
 
virtual bool GetBooleanVariable (string key)
 Gets the value of a boolean variable. More...
 
virtual void SetBooleanVariable (string key, bool value)
 Sets the value of a boolean variable. More...
 
virtual int GetIntegerVariable (string key)
 Gets the value of an integer variable. More...
 
virtual void SetIntegerVariable (string key, int value)
 Sets the value of an integer variable. More...
 
virtual float GetFloatVariable (string key)
 Gets the value of a float variable. More...
 
virtual void SetFloatVariable (string key, float value)
 Sets the value of a float variable. More...
 
virtual string GetStringVariable (string key)
 Gets the value of a string variable. More...
 
virtual void SetStringVariable (string key, string value)
 Sets the value of a string variable. More...
 
virtual GameObject GetGameObjectVariable (string key)
 Gets the value of a GameObject variable. More...
 
virtual void SetGameObjectVariable (string key, GameObject value)
 Sets the value of a GameObject variable. More...
 
virtual Transform GetTransformVariable (string key)
 Gets the value of a Transform variable. More...
 
virtual void SetTransformVariable (string key, Transform value)
 Sets the value of a Transform variable. More...
 
virtual void UpdateHideFlags ()
 Set the block objects to be hidden or visible depending on the hideComponents property. More...
 
virtual void ClearSelectedCommands ()
 Clears the list of selected commands. More...
 
virtual void AddSelectedCommand (Command command)
 Adds a command to the list of selected commands. More...
 
virtual void ClearSelectedBlocks ()
 Clears the list of selected blocks. More...
 
virtual void AddSelectedBlock (Block block)
 Adds a block to the list of selected blocks. More...
 
virtual void Reset (bool resetCommands, bool resetVariables)
 Reset the commands and variables in the Flowchart. More...
 
virtual bool IsCommandSupported (CommandInfoAttribute commandInfo)
 Override this in a Flowchart subclass to filter which commands are shown in the Add Command list. More...
 
virtual bool HasExecutingBlocks ()
 Returns true if there are any executing blocks in this Flowchart. More...
 
virtual List< BlockGetExecutingBlocks ()
 Returns a list of all executing blocks in this Flowchart. More...
 
virtual string SubstituteVariables (string input)
 Substitute variables in the input text with the format {$VarName} This will first match with private variables in this Flowchart, and then with public variables in all Flowcharts in the scene (and any component in the scene that implements StringSubstituter.ISubstitutionHandler). More...
 
virtual bool SubstituteStrings (StringBuilder input)
 Implementation of StringSubstituter.ISubstitutionHandler which matches any public variable in the Flowchart. More...
 

Static Public Member Functions

static void BroadcastFungusMessage (string messageName)
 Sends a message to all Flowchart objects in the current scene. More...
 

Protected Member Functions

virtual void OnLevelWasLoaded (int level)
 
virtual void LevelWasLoaded ()
 
virtual void Start ()
 
virtual void CheckEventSystem ()
 
virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual void UpdateVersion ()
 
virtual void CheckItemIds ()
 
virtual void CleanupComponents ()
 
virtual Block CreateBlockComponent (GameObject parent)
 

Protected Attributes

int version = 0
 
Vector2 scrollPos
 
Vector2 variablesScrollPos
 
bool variablesExpanded = true
 
float blockViewHeight = 400
 
float zoom = 1f
 
Rect scrollViewRect
 
List< BlockselectedBlocks = new List<Block>()
 
List< CommandselectedCommands = new List<Command>()
 
List< Variablevariables = new List<Variable>()
 
string description = ""
 
float stepPause = 0f
 
bool colorCommands = true
 
bool hideComponents = true
 
bool saveSelection = true
 
string localizationId = ""
 
bool showLineNumbers = false
 
List< string > hideCommands = new List<string>()
 
LuaEnvironment luaEnvironment
 
string luaBindingName = "flowchart"
 
StringSubstituter stringSubstituer
 

Static Protected Attributes

static List< FlowchartcachedFlowcharts = new List<Flowchart>()
 
static bool eventSystemPresent
 

Properties

static List< FlowchartCachedFlowcharts [get]
 Cached list of flowchart objects in the scene for fast lookup. More...
 
virtual Vector2 ScrollPos [get, set]
 Scroll position of Flowchart editor window. More...
 
virtual Vector2 VariablesScrollPos [get, set]
 Scroll position of Flowchart variables window. More...
 
virtual bool VariablesExpanded [get, set]
 Show the variables pane. More...
 
virtual float BlockViewHeight [get, set]
 Height of command block view in inspector. More...
 
virtual float Zoom [get, set]
 Zoom level of Flowchart editor window. More...
 
virtual Rect ScrollViewRect [get, set]
 Scrollable area for Flowchart editor window. More...
 
virtual Block SelectedBlock [get, set]
 Current actively selected block in the Flowchart editor. More...
 
virtual List< BlockSelectedBlocks [get, set]
 
virtual List< CommandSelectedCommands [get]
 Currently selected command in the Flowchart editor. More...
 
virtual List< VariableVariables [get]
 The list of variables that can be accessed by the Flowchart. More...
 
virtual string Description [get]
 Description text displayed in the Flowchart editor window More...
 
virtual float StepPause [get]
 Slow down execution in the editor to make it easier to visualise program flow. More...
 
virtual bool ColorCommands [get]
 Use command color when displaying the command list in the inspector. More...
 
virtual bool SaveSelection [get]
 Saves the selected block and commands when saving the scene. More...
 
virtual string LocalizationId [get]
 Unique identifier for identifying this flowchart in localized string keys. More...
 
virtual bool ShowLineNumbers [get]
 Display line numbers in the command list in the Block inspector. More...
 
virtual LuaEnvironment LuaEnv [get]
 Lua Environment to be used by default for all Execute Lua commands in this Flowchart. More...
 
virtual string LuaBindingName [get]
 The ExecuteLua command adds a global Lua variable with this name bound to the flowchart prior to executing. More...
 
virtual Vector2 CenterPosition [get, set]
 Position in the center of all blocks in the flowchart. More...
 
int Version [set]
 Variable to track flowchart's version so components can update to new versions. More...
 

Detailed Description

Visual scripting controller for the Flowchart programming language.

Flowchart objects may be edited visually using the Flowchart editor window.

Definition at line 19 of file Flowchart.cs.

Member Function Documentation

◆ AddSelectedBlock()

virtual void Fungus.Flowchart.AddSelectedBlock ( Block  block)
virtual

Adds a block to the list of selected blocks.

Definition at line 1090 of file Flowchart.cs.

◆ AddSelectedCommand()

virtual void Fungus.Flowchart.AddSelectedCommand ( Command  command)
virtual

Adds a command to the list of selected commands.

Definition at line 1071 of file Flowchart.cs.

◆ BroadcastFungusMessage()

static void Fungus.Flowchart.BroadcastFungusMessage ( string  messageName)
static

Sends a message to all Flowchart objects in the current scene.

Any block with a matching MessageReceived event handler will start executing.

Definition at line 291 of file Flowchart.cs.

◆ CheckEventSystem()

virtual void Fungus.Flowchart.CheckEventSystem ( )
protectedvirtual

Definition at line 118 of file Flowchart.cs.

◆ CheckItemIds()

virtual void Fungus.Flowchart.CheckItemIds ( )
protectedvirtual

Definition at line 184 of file Flowchart.cs.

◆ CleanupComponents()

virtual void Fungus.Flowchart.CleanupComponents ( )
protectedvirtual

Definition at line 212 of file Flowchart.cs.

◆ ClearSelectedBlocks()

virtual void Fungus.Flowchart.ClearSelectedBlocks ( )
virtual

Clears the list of selected blocks.

Definition at line 1082 of file Flowchart.cs.

◆ ClearSelectedCommands()

virtual void Fungus.Flowchart.ClearSelectedCommands ( )
virtual

Clears the list of selected commands.

Definition at line 1063 of file Flowchart.cs.

◆ CreateBlock()

virtual Block Fungus.Flowchart.CreateBlock ( Vector2  position)
virtual

Create a new block node which you can then add commands to.

Definition at line 452 of file Flowchart.cs.

◆ CreateBlockComponent()

virtual Block Fungus.Flowchart.CreateBlockComponent ( GameObject  parent)
protectedvirtual

Definition at line 274 of file Flowchart.cs.

◆ ExecuteBlock() [1/2]

virtual void Fungus.Flowchart.ExecuteBlock ( string  blockName)
virtual

Execute a child block in the Flowchart.

You can use this method in a UI event. e.g. to handle a button click.

Definition at line 483 of file Flowchart.cs.

◆ ExecuteBlock() [2/2]

virtual bool Fungus.Flowchart.ExecuteBlock ( Block  block,
int  commandIndex = 0,
Action  onComplete = null 
)
virtual

Execute a child block in the flowchart.

The block must be in an idle state to be executed. This version provides extra options to control how the block is executed. Returns true if the Block started execution.

Definition at line 524 of file Flowchart.cs.

◆ FindBlock()

virtual Block Fungus.Flowchart.FindBlock ( string  blockName)
virtual

Returns the named Block in the flowchart, or null if not found.

Definition at line 465 of file Flowchart.cs.

◆ GetBooleanVariable()

virtual bool Fungus.Flowchart.GetBooleanVariable ( string  key)
virtual

Gets the value of a boolean variable.

Returns false if the variable key does not exist.

Definition at line 834 of file Flowchart.cs.

◆ GetExecutingBlocks()

virtual List<Block> Fungus.Flowchart.GetExecutingBlocks ( )
virtual

Returns a list of all executing blocks in this Flowchart.

Definition at line 1161 of file Flowchart.cs.

◆ GetFloatVariable()

virtual float Fungus.Flowchart.GetFloatVariable ( string  key)
virtual

Gets the value of a float variable.

Returns 0 if the variable key does not exist.

Definition at line 894 of file Flowchart.cs.

◆ GetGameObjectVariable()

virtual GameObject Fungus.Flowchart.GetGameObjectVariable ( string  key)
virtual

Gets the value of a GameObject variable.

Returns null if the variable key does not exist.

Definition at line 954 of file Flowchart.cs.

◆ GetIntegerVariable()

virtual int Fungus.Flowchart.GetIntegerVariable ( string  key)
virtual

Gets the value of an integer variable.

Returns 0 if the variable key does not exist.

Definition at line 864 of file Flowchart.cs.

◆ GetName()

string Fungus.Flowchart.GetName ( )

Returns the Flowchart gameobject name.

Definition at line 420 of file Flowchart.cs.

◆ GetPublicVariables()

virtual List<Variable> Fungus.Flowchart.GetPublicVariables ( )
virtual

Gets a list of all variables with public scope in this Flowchart.

Definition at line 815 of file Flowchart.cs.

◆ GetStringVariable()

virtual string Fungus.Flowchart.GetStringVariable ( string  key)
virtual

Gets the value of a string variable.

Returns the empty string if the variable key does not exist.

Definition at line 924 of file Flowchart.cs.

◆ GetTransformVariable()

virtual Transform Fungus.Flowchart.GetTransformVariable ( string  key)
virtual

Gets the value of a Transform variable.

Returns null if the variable key does not exist.

Definition at line 985 of file Flowchart.cs.

◆ GetUniqueBlockKey()

virtual string Fungus.Flowchart.GetUniqueBlockKey ( string  originalKey,
Block  ignoreBlock = null 
)
virtual

Returns a new Block key that is guaranteed not to clash with any existing Block in the Flowchart.

Definition at line 630 of file Flowchart.cs.

◆ GetUniqueLabelKey()

virtual string Fungus.Flowchart.GetUniqueLabelKey ( string  originalKey,
Label  ignoreLabel 
)
virtual

Returns a new Label key that is guaranteed not to clash with any existing Label in the Block.

Definition at line 672 of file Flowchart.cs.

◆ GetUniqueVariableKey()

virtual string Fungus.Flowchart.GetUniqueVariableKey ( string  originalKey,
Variable  ignoreVariable = null 
)
virtual

Returns a new variable key that is guaranteed not to clash with any existing variable in the list.

Definition at line 583 of file Flowchart.cs.

◆ GetVariable()

Variable Fungus.Flowchart.GetVariable ( string  key)

Returns the variable with the specified key, or null if the key is not found.

You will need to cast the returned variable to the correct sub-type. You can then access the variable's value using the Value property. e.g. BooleanVariable boolVar = flowchart.GetVariable("MyBool") as BooleanVariable; boolVar.Value = false;

Definition at line 720 of file Flowchart.cs.

◆ GetVariable< T >()

T Fungus.Flowchart.GetVariable< T > ( string  key)

Returns the variable with the specified key, or null if the key is not found.

You can then access the variable's value using the Value property. e.g. BooleanVariable boolVar = flowchart.GetVariable<BooleanVariable>("MyBool"); boolVar.Value = false;

Type Constraints
T :Variable 

Definition at line 740 of file Flowchart.cs.

◆ GetVariableNames()

virtual string [] Fungus.Flowchart.GetVariableNames ( )
virtual

Returns the list of variable names in the Flowchart.

Definition at line 797 of file Flowchart.cs.

◆ HasExecutingBlocks()

virtual bool Fungus.Flowchart.HasExecutingBlocks ( )
virtual

Returns true if there are any executing blocks in this Flowchart.

Definition at line 1144 of file Flowchart.cs.

◆ HasVariable()

virtual bool Fungus.Flowchart.HasVariable ( string  key)
virtual

Checks if a given variable exists in the flowchart.

Definition at line 781 of file Flowchart.cs.

◆ IsActive()

bool Fungus.Flowchart.IsActive ( )

Returns true if the Flowchart gameobject is active.

Definition at line 412 of file Flowchart.cs.

◆ IsCommandSupported()

virtual bool Fungus.Flowchart.IsCommandSupported ( CommandInfoAttribute  commandInfo)
virtual

Override this in a Flowchart subclass to filter which commands are shown in the Add Command list.

Definition at line 1126 of file Flowchart.cs.

◆ LevelWasLoaded()

virtual void Fungus.Flowchart.LevelWasLoaded ( )
protectedvirtual

Definition at line 105 of file Flowchart.cs.

◆ NextItemId()

int Fungus.Flowchart.NextItemId ( )

Returns the next id to assign to a new flowchart item.

Item ids increase monotically so they are guaranteed to be unique within a Flowchart.

Definition at line 430 of file Flowchart.cs.

◆ OnDisable()

virtual void Fungus.Flowchart.OnDisable ( )
protectedvirtual

Definition at line 154 of file Flowchart.cs.

◆ OnEnable()

virtual void Fungus.Flowchart.OnEnable ( )
protectedvirtual

Definition at line 140 of file Flowchart.cs.

◆ OnLevelWasLoaded()

virtual void Fungus.Flowchart.OnLevelWasLoaded ( int  level)
protectedvirtual

Definition at line 99 of file Flowchart.cs.

◆ Reset()

virtual void Fungus.Flowchart.Reset ( bool  resetCommands,
bool  resetVariables 
)
virtual

Reset the commands and variables in the Flowchart.

Definition at line 1101 of file Flowchart.cs.

◆ SendFungusMessage()

virtual void Fungus.Flowchart.SendFungusMessage ( string  messageName)
virtual

Sends a message to this Flowchart only.

Any block with a matching MessageReceived event handler will start executing.

Definition at line 570 of file Flowchart.cs.

◆ SetBooleanVariable()

virtual void Fungus.Flowchart.SetBooleanVariable ( string  key,
bool  value 
)
virtual

Sets the value of a boolean variable.

The variable must already be added to the list of variables for this Flowchart.

Definition at line 851 of file Flowchart.cs.

◆ SetFloatVariable()

virtual void Fungus.Flowchart.SetFloatVariable ( string  key,
float  value 
)
virtual

Sets the value of a float variable.

The variable must already be added to the list of variables for this Flowchart.

Definition at line 911 of file Flowchart.cs.

◆ SetGameObjectVariable()

virtual void Fungus.Flowchart.SetGameObjectVariable ( string  key,
GameObject  value 
)
virtual

Sets the value of a GameObject variable.

The variable must already be added to the list of variables for this Flowchart.

Definition at line 972 of file Flowchart.cs.

◆ SetIntegerVariable()

virtual void Fungus.Flowchart.SetIntegerVariable ( string  key,
int  value 
)
virtual

Sets the value of an integer variable.

The variable must already be added to the list of variables for this Flowchart.

Definition at line 881 of file Flowchart.cs.

◆ SetStringVariable()

virtual void Fungus.Flowchart.SetStringVariable ( string  key,
string  value 
)
virtual

Sets the value of a string variable.

The variable must already be added to the list of variables for this Flowchart.

Definition at line 941 of file Flowchart.cs.

◆ SetTransformVariable()

virtual void Fungus.Flowchart.SetTransformVariable ( string  key,
Transform  value 
)
virtual

Sets the value of a Transform variable.

The variable must already be added to the list of variables for this Flowchart.

Definition at line 1003 of file Flowchart.cs.

◆ SetVariable< T >()

void Fungus.Flowchart.SetVariable< T > ( string  key,
newvariable 
)

Register a new variable with the Flowchart at runtime.

The variable should be added as a component on the Flowchart game object.

Type Constraints
T :Variable 

Definition at line 759 of file Flowchart.cs.

◆ Start()

virtual void Fungus.Flowchart.Start ( )
protectedvirtual

Definition at line 111 of file Flowchart.cs.

◆ StopAllBlocks()

virtual void Fungus.Flowchart.StopAllBlocks ( )
virtual

Stop all executing Blocks in this Flowchart.

Definition at line 553 of file Flowchart.cs.

◆ StopBlock()

virtual void Fungus.Flowchart.StopBlock ( string  blockName)
virtual

Stops an executing Block in the Flowchart.

Definition at line 502 of file Flowchart.cs.

◆ SubstituteStrings()

virtual bool Fungus.Flowchart.SubstituteStrings ( StringBuilder  input)
virtual

Implementation of StringSubstituter.ISubstitutionHandler which matches any public variable in the Flowchart.

To perform full variable substitution with all substitution handlers in the scene, you should use the SubstituteVariables() method instead.

Definition at line 1244 of file Flowchart.cs.

◆ SubstituteVariables()

virtual string Fungus.Flowchart.SubstituteVariables ( string  input)
virtual

Substitute variables in the input text with the format {$VarName} This will first match with private variables in this Flowchart, and then with public variables in all Flowcharts in the scene (and any component in the scene that implements StringSubstituter.ISubstitutionHandler).

Definition at line 1183 of file Flowchart.cs.

◆ UpdateHideFlags()

virtual void Fungus.Flowchart.UpdateHideFlags ( )
virtual

Set the block objects to be hidden or visible depending on the hideComponents property.

Definition at line 1015 of file Flowchart.cs.

◆ UpdateVersion()

virtual void Fungus.Flowchart.UpdateVersion ( )
protectedvirtual

Definition at line 161 of file Flowchart.cs.

Member Data Documentation

◆ blockViewHeight

float Fungus.Flowchart.blockViewHeight = 400
protected

Definition at line 34 of file Flowchart.cs.

◆ cachedFlowcharts

List<Flowchart> Fungus.Flowchart.cachedFlowcharts = new List<Flowchart>()
staticprotected

Definition at line 83 of file Flowchart.cs.

◆ colorCommands

bool Fungus.Flowchart.colorCommands = true
protected

Definition at line 60 of file Flowchart.cs.

◆ description

string Fungus.Flowchart.description = ""
protected

Definition at line 53 of file Flowchart.cs.

◆ eventSystemPresent

bool Fungus.Flowchart.eventSystemPresent
staticprotected

Definition at line 85 of file Flowchart.cs.

◆ hideCommands

List<string> Fungus.Flowchart.hideCommands = new List<string>()
protected

Definition at line 75 of file Flowchart.cs.

◆ hideComponents

bool Fungus.Flowchart.hideComponents = true
protected

Definition at line 63 of file Flowchart.cs.

◆ localizationId

string Fungus.Flowchart.localizationId = ""
protected

Definition at line 69 of file Flowchart.cs.

◆ luaBindingName

string Fungus.Flowchart.luaBindingName = "flowchart"
protected

Definition at line 81 of file Flowchart.cs.

◆ luaEnvironment

LuaEnvironment Fungus.Flowchart.luaEnvironment
protected

Definition at line 78 of file Flowchart.cs.

◆ saveSelection

bool Fungus.Flowchart.saveSelection = true
protected

Definition at line 66 of file Flowchart.cs.

◆ scrollPos

Vector2 Fungus.Flowchart.scrollPos
protected

Definition at line 25 of file Flowchart.cs.

◆ scrollViewRect

Rect Fungus.Flowchart.scrollViewRect
protected

Definition at line 40 of file Flowchart.cs.

◆ selectedBlocks

List<Block> Fungus.Flowchart.selectedBlocks = new List<Block>()
protected

Definition at line 43 of file Flowchart.cs.

◆ selectedCommands

List<Command> Fungus.Flowchart.selectedCommands = new List<Command>()
protected

Definition at line 46 of file Flowchart.cs.

◆ showLineNumbers

bool Fungus.Flowchart.showLineNumbers = false
protected

Definition at line 72 of file Flowchart.cs.

◆ stepPause

float Fungus.Flowchart.stepPause = 0f
protected

Definition at line 57 of file Flowchart.cs.

◆ stringSubstituer

StringSubstituter Fungus.Flowchart.stringSubstituer
protected

Definition at line 87 of file Flowchart.cs.

◆ variables

List<Variable> Fungus.Flowchart.variables = new List<Variable>()
protected

Definition at line 49 of file Flowchart.cs.

◆ variablesExpanded

bool Fungus.Flowchart.variablesExpanded = true
protected

Definition at line 31 of file Flowchart.cs.

◆ variablesScrollPos

Vector2 Fungus.Flowchart.variablesScrollPos
protected

Definition at line 28 of file Flowchart.cs.

◆ version

int Fungus.Flowchart.version = 0
protected

Definition at line 22 of file Flowchart.cs.

◆ zoom

float Fungus.Flowchart.zoom = 1f
protected

Definition at line 37 of file Flowchart.cs.

Property Documentation

◆ BlockViewHeight

virtual float Fungus.Flowchart.BlockViewHeight
getset

Height of command block view in inspector.

Definition at line 319 of file Flowchart.cs.

◆ CachedFlowcharts

List<Flowchart> Fungus.Flowchart.CachedFlowcharts
staticget

Cached list of flowchart objects in the scene for fast lookup.

Definition at line 285 of file Flowchart.cs.

◆ CenterPosition

virtual Vector2 Fungus.Flowchart.CenterPosition
getset

Position in the center of all blocks in the flowchart.

Definition at line 402 of file Flowchart.cs.

◆ ColorCommands

virtual bool Fungus.Flowchart.ColorCommands
get

Use command color when displaying the command list in the inspector.

Definition at line 372 of file Flowchart.cs.

◆ Description

virtual string Fungus.Flowchart.Description
get

Description text displayed in the Flowchart editor window

Definition at line 362 of file Flowchart.cs.

◆ LocalizationId

virtual string Fungus.Flowchart.LocalizationId
get

Unique identifier for identifying this flowchart in localized string keys.

Definition at line 382 of file Flowchart.cs.

◆ LuaBindingName

virtual string Fungus.Flowchart.LuaBindingName
get

The ExecuteLua command adds a global Lua variable with this name bound to the flowchart prior to executing.

Definition at line 397 of file Flowchart.cs.

◆ LuaEnv

virtual LuaEnvironment Fungus.Flowchart.LuaEnv
get

Lua Environment to be used by default for all Execute Lua commands in this Flowchart.

Definition at line 392 of file Flowchart.cs.

◆ SaveSelection

virtual bool Fungus.Flowchart.SaveSelection
get

Saves the selected block and commands when saving the scene.

Helps avoid version control conflicts if you've only changed the active selection.

Definition at line 377 of file Flowchart.cs.

◆ ScrollPos

virtual Vector2 Fungus.Flowchart.ScrollPos
getset

Scroll position of Flowchart editor window.

Definition at line 304 of file Flowchart.cs.

◆ ScrollViewRect

virtual Rect Fungus.Flowchart.ScrollViewRect
getset

Scrollable area for Flowchart editor window.

Definition at line 329 of file Flowchart.cs.

◆ SelectedBlock

virtual Block Fungus.Flowchart.SelectedBlock
getset

Current actively selected block in the Flowchart editor.

Definition at line 335 of file Flowchart.cs.

◆ SelectedBlocks

virtual List<Block> Fungus.Flowchart.SelectedBlocks
getset

Definition at line 347 of file Flowchart.cs.

◆ SelectedCommands

virtual List<Command> Fungus.Flowchart.SelectedCommands
get

Currently selected command in the Flowchart editor.

Definition at line 352 of file Flowchart.cs.

◆ ShowLineNumbers

virtual bool Fungus.Flowchart.ShowLineNumbers
get

Display line numbers in the command list in the Block inspector.

Definition at line 387 of file Flowchart.cs.

◆ StepPause

virtual float Fungus.Flowchart.StepPause
get

Slow down execution in the editor to make it easier to visualise program flow.

Definition at line 367 of file Flowchart.cs.

◆ Variables

virtual List<Variable> Fungus.Flowchart.Variables
get

The list of variables that can be accessed by the Flowchart.

Definition at line 357 of file Flowchart.cs.

◆ VariablesExpanded

virtual bool Fungus.Flowchart.VariablesExpanded
getset

Show the variables pane.

Definition at line 314 of file Flowchart.cs.

◆ VariablesScrollPos

virtual Vector2 Fungus.Flowchart.VariablesScrollPos
getset

Scroll position of Flowchart variables window.

Definition at line 309 of file Flowchart.cs.

◆ Version

int Fungus.Flowchart.Version
set

Variable to track flowchart's version so components can update to new versions.

Definition at line 407 of file Flowchart.cs.

◆ Zoom

virtual float Fungus.Flowchart.Zoom
getset

Zoom level of Flowchart editor window.

Definition at line 324 of file Flowchart.cs.


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