Skip to content
shalliwell edited this page May 25, 2020 · 2 revisions

Variable commands

Delete Save Key

Deletes a saved value from permanent storage.

Defined in Fungus.DeleteSaveKey

Property Type Description
Key System.String Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber}

From String

Attempts to parse a string into a given fungus variable type, such as integer or float

Defined in Fungus.FromString

Property Type Description
Source String Fungus.StringVariable Source of string data to parse into another variables value
Out Value Fungus.Variable The variable type to be parsed and value stored within

Load Variable

Loads a saved value and stores it in a Boolean, Integer, Float or String variable. If the key is not found then the variable is not modified.

Defined in Fungus.LoadVariable

Property Type Description
Key System.String Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber}"
Variable Fungus.Variable Variable to store the value in.

Random Float

Sets an float variable to a random value in the defined range.

Defined in Fungus.RandomFloat

Property Type Description
Variable Fungus.FloatVariable The variable whos value will be set
Min Value Fungus.FloatData Minimum value for random range
Max Value Fungus.FloatData Maximum value for random range

Random Integer

Sets an integer variable to a random value in the defined range.

Defined in Fungus.RandomInteger

Property Type Description
Variable Fungus.IntegerVariable The variable whos value will be set
Min Value Fungus.IntegerData Minimum value for random range
Max Value Fungus.IntegerData Maximum value for random range

Read Text File

Reads in a text file and stores the contents in a string variable

Defined in Fungus.ReadTextFile

Property Type Description
Text File UnityEngine.TextAsset Text file to read into the string variable
String Variable Fungus.StringVariable String variable to store the tex file contents in

Reset

Resets the state of all commands and variables in the Flowchart.

Defined in Fungus.Reset

Property Type Description
Reset Commands System.Boolean Reset state of all commands in the script
Reset Variables System.Boolean Reset variables back to their default values

Save Variable

Save an Boolean, Integer, Float or String variable to persistent storage using a string key. The value can be loaded again later using the Load Variable command. You can also use the Set Save Profile command to manage separate save profiles for multiple players.

Defined in Fungus.SaveVariable

Property Type Description
Key System.String Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber}
Variable Fungus.Variable Variable to read the value from. Only Boolean, Integer, Float and String are supported.

Set Save Profile

Sets the active profile that the Save Variable and Load Variable commands will use. This is useful to crete multiple player save games. Once set, the profile applies across all Flowcharts and will also persist across scene loads.

Defined in Fungus.SetSaveProfile

Property Type Description
Save Profile Name System.String Name of save profile to make active.

Set Variable

Sets a Boolean, Integer, Float or String variable to a new value using a simple arithmetic operation. The value can be a constant or reference another variable of the same type.

Defined in Fungus.SetVariable

Property Type Description
Set Operator Fungus.SetOperator The type of math operation to be performed
Variable Fungus.Variable Variable to use in expression
Boolean Data Fungus.BooleanData Boolean value to compare against
Integer Data Fungus.IntegerData Integer value to compare against
Float Data Fungus.FloatData Float value to compare against
String Data Fungus.StringDataMulti String value to compare against
Animator Data Fungus.AnimatorData Animator value to compare against
Audio Source Data Fungus.AudioSourceData AudioSource value to compare against
Color Data Fungus.ColorData Color value to compare against
Game Object Data Fungus.GameObjectData GameObject value to compare against
Material Data Fungus.MaterialData Material value to compare against
Object Data Fungus.ObjectData Object value to compare against
Rigidbody2 D Data Fungus.Rigidbody2DData Rigidbody2D value to compare against
Sprite Data Fungus.SpriteData Sprite value to compare against
Texture Data Fungus.TextureData Texture value to compare against
Transform Data Fungus.TransformData Transform value to compare against
Vector2 Data Fungus.Vector2Data Vector2 value to compare against
Vector3 Data Fungus.Vector3Data Vector3 value to compare against

To String

Stores the result of a ToString on given variable in a string.

Defined in Fungus.ToString

Property Type Description
Variable Fungus.Variable Target variable to get String of.
Out Value Fungus.StringVariable Variable to store the result of ToString

Auto-Generated by Fungus.ExportReferenceDocs

Clone this wiki locally