Draws a fullscreen texture over the scene to give a fade effect. Setting Target Alpha to 1 will obscure the screen, alpha 0 will reveal the screen. If no Fade Texture is provided then a default flat color texture is used.
Target Flowchart | Fungus.Flowchart | Flowchart which contains the block to execute. If none is specified then the current Flowchart is used.
Target Block | Fungus.Block | Block to start executing
Start Index | System.Int32 | Command index to start executing
Call Mode | Fungus.Call+CallMode | Select if the calling block should stop or continue executing commands, or wait until the called block finishes.
Call Mode | Fungus.Commands.CallMode | Select if the calling block should stop or continue executing commands, or wait until the called block finishes.
## Else
Marks the start of a command block to be executed when the preceding If statement is False.
@ -18,10 +20,10 @@ Marks the start of a command block to be executed when the preceding If statemen
Property | Type | Description
--- | --- | ---
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
Boolean Data | Fungus.Variables.BooleanData | Boolean value to compare against
Integer Data | Fungus.Variables.IntegerData | Integer value to compare against
Float Data | Fungus.Variables.FloatData | Float value to compare against
String Data | Fungus.Variables.StringDataMulti | String value to compare against
Compare Operator | Fungus.CompareOperator | The type of comparison to be performed
## End
@ -32,10 +34,10 @@ If the test expression is true, execute the following command block.
Property | Type | Description
--- | --- | ---
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
Boolean Data | Fungus.Variables.BooleanData | Boolean value to compare against
Integer Data | Fungus.Variables.IntegerData | Integer value to compare against
Float Data | Fungus.Variables.FloatData | Float value to compare against
String Data | Fungus.Variables.StringDataMulti | String value to compare against
Compare Operator | Fungus.CompareOperator | The type of comparison to be performed
## Jump
@ -43,7 +45,7 @@ Move execution to a specific Label command in the same block
Property | Type | Description
--- | --- | ---
_target Label | Fungus.StringData | Name of a label in this block to jump to
_target Label | Fungus.Variables.StringData | Name of a label in this block to jump to
## Label
Marks a position in the command list for execution to jump to.
@ -57,7 +59,7 @@ Loads a new Unity scene and displays an optional loading image. This is useful f
Property | Type | Description
--- | --- | ---
_scene Name | Fungus.StringData | Name of the scene to load. The scene must also be added to the build settings.
_scene Name | Fungus.Variables.StringData | Name of the scene to load. The scene must also be added to the build settings.
Loading Image | UnityEngine.Texture2D | Image to display while loading the scene
## Quit
@ -67,8 +69,8 @@ Sends a message to either the owner Flowchart or all Flowcharts in the scene. Bl
Property | Type | Description
--- | --- | ---
Message Target | Fungus.SendMessage+MessageTarget | Target flowchart(s) to send the message to
_message | Fungus.StringData | Name of the message to send
Message Target | Fungus.Commands.MessageTarget | Target flowchart(s) to send the message to
_message | Fungus.Variables.StringData | Name of the message to send
## Stop
Stop executing the Block that contains this command.
@ -78,7 +80,7 @@ Stops executing the named Block
Property | Type | Description
--- | --- | ---
Flowchart | Fungus.Flowchart | Flowchart containing the Block. If none is specified, the parent Flowchart is used.
Block Name | Fungus.StringData | Name of the Block to stop
Block Name | Fungus.Variables.StringData | Name of the Block to stop
## Stop Flowchart
Stops execution of all Blocks in a Flowchart
@ -93,7 +95,7 @@ Waits for period of time before executing the next command in the block.
Property | Type | Description
--- | --- | ---
_duration | Fungus.FloatData | Duration to wait for
_duration | Fungus.Variables.FloatData | Duration to wait for
## WaitInput
Waits for a period of time or for player input before executing the next command in the block.
@ -108,9 +110,9 @@ Continuously loop through a block of commands while the condition is true. Use t
Property | Type | Description
--- | --- | ---
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
Boolean Data | Fungus.Variables.BooleanData | Boolean value to compare against
Integer Data | Fungus.Variables.IntegerData | Integer value to compare against
Float Data | Fungus.Variables.FloatData | Float value to compare against
String Data | Fungus.Variables.StringDataMulti | String value to compare against
Compare Operator | Fungus.CompareOperator | The type of comparison to be performed
Use comments to record design notes and reminders about your game.
@ -20,15 +22,15 @@ Writes a log message to the debug console.
Property | Type | Description
--- | --- | ---
Log Type | Fungus.DebugLog+DebugLogType | Display type of debug log info
Log Message | Fungus.StringDataMulti | Text to write to the debug log. Supports variable substitution, e.g. {$Myvar}
Log Type | Fungus.Commands.DebugLogType | Display type of debug log info
Log Message | Fungus.Variables.StringDataMulti | Text to write to the debug log. Supports variable substitution, e.g. {$Myvar}
## Destroy
Destroys a specified game object in the scene.
Property | Type | Description
--- | --- | ---
_target Game Object | Fungus.GameObjectData | Reference to game object to destroy
_target Game Object | Fungus.Variables.GameObjectData | Reference to game object to destroy
## Execute Lua
Executes a Lua code chunk using a Lua Environment.
@ -49,14 +51,14 @@ Property | Type | Description
--- | --- | ---
Delay | System.Single | Delay (in seconds) before the methods will be called
Static Event | UnityEngine.Events.UnityEvent | List of methods to call. Supports methods with no parameters or exactly one string, int, float or object parameter.
Boolean Parameter | Fungus.BooleanData | Boolean parameter to pass to the invoked methods.
Boolean Event | Fungus.InvokeEvent+BooleanEvent | List of methods to call. Supports methods with one boolean parameter.
Integer Parameter | Fungus.IntegerData | Integer parameter to pass to the invoked methods.
Integer Event | Fungus.InvokeEvent+IntegerEvent | List of methods to call. Supports methods with one integer parameter.
Float Parameter | Fungus.FloatData | Float parameter to pass to the invoked methods.
Float Event | Fungus.InvokeEvent+FloatEvent | List of methods to call. Supports methods with one float parameter.
String Parameter | Fungus.StringDataMulti | String parameter to pass to the invoked methods.
String Event | Fungus.InvokeEvent+StringEvent | List of methods to call. Supports methods with one string parameter.
Boolean Parameter | Fungus.Variables.BooleanData | Boolean parameter to pass to the invoked methods.
Boolean Event | Fungus.Commands.InvokeEvent+BooleanEvent | List of methods to call. Supports methods with one boolean parameter.
Integer Parameter | Fungus.Variables.IntegerData | Integer parameter to pass to the invoked methods.
Integer Event | Fungus.Commands.InvokeEvent+IntegerEvent | List of methods to call. Supports methods with one integer parameter.
Float Parameter | Fungus.Variables.FloatData | Float parameter to pass to the invoked methods.
Float Event | Fungus.Commands.InvokeEvent+FloatEvent | List of methods to call. Supports methods with one float parameter.
String Parameter | Fungus.Variables.StringDataMulti | String parameter to pass to the invoked methods.
String Event | Fungus.Commands.InvokeEvent+StringEvent | List of methods to call. Supports methods with one string parameter.
## Invoke Method
Invokes a method of a component via reflection. Supports passing multiple parameters and storing returned values in a Fungus variable.
@ -69,35 +71,35 @@ Target Component Fullname | System.String | Full name of the target component
Target Component Text | System.String | Display name of the target component
Target Method | System.String | Name of target method to invoke on the target component
Target Method Text | System.String | Display name of target method to invoke on the target component
Method Parameters | Fungus.InvokeMethodParameter[] | List of parameters to pass to the invoked method
Method Parameters | Fungus.Commands.InvokeMethodParameter[] | List of parameters to pass to the invoked method
Save Return Value | System.Boolean | If true, store the return value in a flowchart variable of the same type.
Return Value Variable Key | System.String | Name of Fungus variable to store the return value in
Return Value Type | System.String | The type of the return value
Show Inherited | System.Boolean | If true, list all inherited methods for the component
Call Mode | Fungus.Call+CallMode | The coroutine call behavior for methods that return IEnumerator
Call Mode | Fungus.Commands.CallMode | The coroutine call behavior for methods that return IEnumerator
## Open URL
Opens the specified URL in the browser.
Property | Type | Description
--- | --- | ---
Url | Fungus.StringData | URL to open in the browser
Url | Fungus.Variables.StringData | URL to open in the browser
## Set Active
Sets a game object in the scene to be active / inactive.
Property | Type | Description
--- | --- | ---
_target Game Object | Fungus.GameObjectData | Reference to game object to enable / disable
Active State | Fungus.BooleanData | Set to true to enable the game object
_target Game Object | Fungus.Variables.GameObjectData | Reference to game object to enable / disable
Active State | Fungus.Variables.BooleanData | Set to true to enable the game object
## Spawn Object
Spawns a new object based on a reference to a scene or prefab game object.
Property | Type | Description
--- | --- | ---
_source Object | Fungus.GameObjectData | Game object to copy when spawning. Can be a scene object or a prefab.
_parent Transform | Fungus.TransformData | Transform to use for position of newly spawned object.
_spawn Position | Fungus.Vector3Data | Local position of newly spawned object.
_spawn Rotation | Fungus.Vector3Data | Local rotation of newly spawned object.
_source Object | Fungus.Variables.GameObjectData | Game object to copy when spawning. Can be a scene object or a prefab.
_parent Transform | Fungus.Variables.TransformData | Transform to use for position of newly spawned object.
_spawn Position | Fungus.Variables.Vector3Data | Local position of newly spawned object.
_spawn Rotation | Fungus.Variables.Vector3Data | Local rotation of newly spawned object.
Fades a sprite to a target color over a period of time.
Property | Type | Description
--- | --- | ---
Sprite Renderer | UnityEngine.SpriteRenderer | Sprite object to be faded
_duration | Fungus.FloatData | Length of time to perform the fade
_target Color | Fungus.ColorData | Target color to fade to. To only fade transparency level, set the color to white and set the alpha to required transparency.
_duration | Fungus.Variables.FloatData | Length of time to perform the fade
_target Color | Fungus.Variables.ColorData | Target color to fade to. To only fade transparency level, set the color to white and set the alpha to required transparency.
Wait Until Finished | System.Boolean | Wait until the fade has finished before executing the next command
## Set Clickable 2D
@ -14,7 +16,7 @@ Sets a Clickable2D component to be clickable / non-clickable.
Property | Type | Description
--- | --- | ---
Target Clickable2 D | Fungus.Clickable2D | Reference to Clickable2D component on a gameobject
Active State | Fungus.BooleanData | Set to true to enable the component
Active State | Fungus.Variables.BooleanData | Set to true to enable the component
## Set Collider
Sets all collider (2d or 3d) components on the target objects to be active / inactive
@ -23,7 +25,7 @@ Property | Type | Description
--- | --- | ---
Target Objects | System.Collections.Generic.List`1[UnityEngine.GameObject] | A list of gameobjects containing collider components to be set active / inactive
Target Tag | System.String | All objects with this tag will have their collider set active / inactive
Active State | Fungus.BooleanData | Set to true to enable the collider components
Active State | Fungus.Variables.BooleanData | Set to true to enable the collider components
## Set Draggable 2D
Sets a Draggable2D component to be draggable / non-draggable.
@ -31,7 +33,7 @@ Sets a Draggable2D component to be draggable / non-draggable.
Property | Type | Description
--- | --- | ---
Target Draggable2 D | Fungus.Draggable2D | Reference to Draggable2D component on a gameobject
Active State | Fungus.BooleanData | Set to true to enable the component
Active State | Fungus.Variables.BooleanData | Set to true to enable the component
## Set Mouse Cursor
Sets the mouse cursor sprite.
@ -55,7 +57,7 @@ Controls the render order of sprites by setting the Order In Layer property of a
Property | Type | Description
--- | --- | ---
Target Sprites | System.Collections.Generic.List`1[UnityEngine.SpriteRenderer] | List of sprites to set the order in layer property on
Order In Layer | Fungus.IntegerData | The order in layer value to set on the target sprites
Order In Layer | Fungus.Variables.IntegerData | The order in layer value to set on the target sprites
## Show Sprite
Makes a sprite visible / invisible by setting the color alpha.
@ -63,6 +65,6 @@ Makes a sprite visible / invisible by setting the color alpha.
Property | Type | Description
--- | --- | ---
Sprite Renderer | UnityEngine.SpriteRenderer | Sprite object to be made visible / invisible
_visible | Fungus.BooleanData | Make the sprite visible or invisible
_visible | Fungus.Variables.BooleanData | Make the sprite visible or invisible
Affect Children | System.Boolean | Affect the visibility of child sprites