From 477c29639ec8d5e9eb7c879633036d832610e282 Mon Sep 17 00:00:00 2001 From: Christopher Date: Fri, 2 Jun 2017 16:38:29 +0100 Subject: [PATCH] Updated command reference docs --- Docs/command_ref/flow_commands.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/Docs/command_ref/flow_commands.md b/Docs/command_ref/flow_commands.md index 168e7c87..1f6d170a 100644 --- a/Docs/command_ref/flow_commands.md +++ b/Docs/command_ref/flow_commands.md @@ -29,12 +29,12 @@ Defined in Fungus.ElseIf Property | Type | Description --- | --- | --- +Compare Operator | Fungus.CompareOperator | The type of comparison 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 -Compare Operator | Fungus.CompareOperator | The type of comparison to be performed # End # {#End} Marks the end of a conditional block. @@ -47,12 +47,12 @@ Defined in Fungus.If Property | Type | Description --- | --- | --- +Compare Operator | Fungus.CompareOperator | The type of comparison 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 -Compare Operator | Fungus.CompareOperator | The type of comparison to be performed # Jump # {#Jump} Move execution to a specific Label command in the same block @@ -82,6 +82,26 @@ Property | Type | Description _scene Name | Fungus.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 +# Lua Else If # {#LuaElseIf} +Marks the start of a command block to be executed when the preceding If statement is False and the test expression is true. + +Defined in Fungus.LuaElseIf + +Property | Type | Description + --- | --- | --- +Lua Environment | Fungus.LuaEnvironment | Lua Environment to use to execute this Lua script (null for global) +Lua Compare String | System.String | The lua comparison string to run; implicitly prepends 'return' onto this + +# Lua If # {#LuaIf} +If the test expression is true, execute the following command block. + +Defined in Fungus.LuaIf + +Property | Type | Description + --- | --- | --- +Lua Environment | Fungus.LuaEnvironment | Lua Environment to use to execute this Lua script (null for global) +Lua Compare String | System.String | The lua comparison string to run; implicitly prepends 'return' onto this + # Quit # {#Quit} Quits the application. Does not work in Editor or Webplayer builds. Shouldn't generally be used on iOS. @@ -96,6 +116,7 @@ Property | Type | Description Is Start Point | System.Boolean | Marks this Save Point as the starting point for Flowchart execution in the scene. Each scene in your game should have exactly one Save Point with this enabled. Key Mode | Fungus.SavePoint+KeyMode | How the Save Point Key for this Save Point is defined. Custom Key | System.String | A string key which uniquely identifies this save point. +Key Separator | System.String | A string to seperate the block name and custom key when using KeyMode.Both. Description Mode | Fungus.SavePoint+DescriptionMode | How the description for this Save Point is defined. Custom Description | System.String | A short description of this save point. Fire Event | System.Boolean | Fire a Save Point Loaded event when this command executes. @@ -169,10 +190,10 @@ Defined in Fungus.While Property | Type | Description --- | --- | --- +Compare Operator | Fungus.CompareOperator | The type of comparison 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 -Compare Operator | Fungus.CompareOperator | The type of comparison to be performed