Updated command docs

snozbot · May 11, 2016 · 3834b9a · 3834b9a
1 parent 6aee2c8
commit 3834b9a
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 20 deletions.
diff --git a/commands/audio_commands/index.html b/commands/audio_commands/index.html
@@ -502,7 +502,7 @@ <h2 id="play-usfxr-sound">Play Usfxr Sound</h2>
 </tr>
 <tr>
 <td>_ Settings String</td>
-<td>Fungus.StringData</td>
+<td>Fungus.StringDataMulti</td>
 <td>Settings string which describes the audio</td>
 </tr>
 <tr>

diff --git a/commands/flow_commands/index.html b/commands/flow_commands/index.html
@@ -391,6 +391,9 @@
         <li class="main "><a href="#stop">Stop</a></li>
 
 
+        <li class="main "><a href="#stop-block">Stop Block</a></li>
+
+
         <li class="main "><a href="#stop-flowchart">Stop Flowchart</a></li>
 
 
@@ -472,7 +475,7 @@ <h2 id="else-if">Else If</h2>
 </tr>
 <tr>
 <td>String Data</td>
-<td>Fungus.StringData</td>
+<td>Fungus.StringDataMulti</td>
 <td>String value to compare against</td>
 </tr>
 <tr>
@@ -517,7 +520,7 @@ <h2 id="if">If</h2>
 </tr>
 <tr>
 <td>String Data</td>
-<td>Fungus.StringData</td>
+<td>Fungus.StringDataMulti</td>
 <td>String value to compare against</td>
 </tr>
 <tr>
@@ -613,6 +616,29 @@ <h2 id="send-message">Send Message</h2>
 </table>
 <h2 id="stop">Stop</h2>
 <p>Stop executing the Block that contains this command.</p>
+<h2 id="stop-block">Stop Block</h2>
+<p>Stops executing the named Block</p>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Type</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Flowchart</td>
+<td>Fungus.Flowchart</td>
+<td>Flowchart containing the Block. If none is specified, the parent Flowchart is used.</td>
+</tr>
+<tr>
+<td>Block Name</td>
+<td>Fungus.StringData</td>
+<td>Name of the Block to stop</td>
+</tr>
+</tbody>
+</table>
 <h2 id="stop-flowchart">Stop Flowchart</h2>
 <p>Stops execution of all Blocks in a Flowchart</p>
 <table>
@@ -705,7 +731,7 @@ <h2 id="while">While</h2>
 </tr>
 <tr>
 <td>String Data</td>
-<td>Fungus.StringData</td>
+<td>Fungus.StringDataMulti</td>
 <td>String value to compare against</td>
 </tr>
 <tr>

diff --git a/commands/scripting_commands/index.html b/commands/scripting_commands/index.html
@@ -458,7 +458,7 @@ <h2 id="debug-log">Debug Log</h2>
 </tr>
 <tr>
 <td>Log Message</td>
-<td>Fungus.StringData</td>
+<td>Fungus.StringDataMulti</td>
 <td>Text to write to the debug log. Supports variable substitution, e.g. {$Myvar}</td>
 </tr>
 </tbody>
@@ -498,9 +498,14 @@ <h2 id="execute-lua">Execute Lua</h2>
 <td>Lua Environment to use to execute this Lua script</td>
 </tr>
 <tr>
+<td>Lua File</td>
+<td>UnityEngine.TextAsset</td>
+<td>A text file containing Lua script to execute.</td>
+</tr>
+<tr>
 <td>Lua Script</td>
 <td>System.String</td>
-<td>Lua script to execute. Use {$VarName} to insert a Flowchart variable in the Lua script.</td>
+<td>Lua script to execute. This text is appended to the contents of Lua file (if one is specified).</td>
 </tr>
 <tr>
 <td>Run As Coroutine</td>
@@ -572,7 +577,7 @@ <h2 id="invoke-event">Invoke Event</h2>
 </tr>
 <tr>
 <td>String Parameter</td>
-<td>Fungus.StringData</td>
+<td>Fungus.StringDataMulti</td>
 <td>String parameter to pass to the invoked methods.</td>
 </tr>
 <tr>

diff --git a/commands/variable_commands/index.html b/commands/variable_commands/index.html
@@ -608,7 +608,7 @@ <h2 id="set-variable">Set Variable</h2>
 </tr>
 <tr>
 <td>String Data</td>
-<td>Fungus.StringData</td>
+<td>Fungus.StringDataMulti</td>
 <td>String value to set with</td>
 </tr>
 </tbody>