summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Bradfield <chris@kidscancode.org>2017-10-06 09:00:57 -0700
committerRémi Verschelde <rverschelde@gmail.com>2017-10-09 12:57:21 +0200
commitbf0b32819766124c9d0ddaf63eb59d54959c8bef (patch)
treeb416472f6dc0bb60f6877ada0a22a3a16d4101ab
parent9e93f5b478c8ee15dcec54df90e74dca09245a94 (diff)
Added VisualScript* descriptions
[ci skip]
-rw-r--r--doc/classes/VisualScriptComment.xml8
-rw-r--r--doc/classes/VisualScriptCondition.xml9
-rw-r--r--doc/classes/VisualScriptOperator.xml7
-rw-r--r--doc/classes/VisualScriptSceneNode.xml7
4 files changed, 26 insertions, 5 deletions
diff --git a/doc/classes/VisualScriptComment.xml b/doc/classes/VisualScriptComment.xml
index da65998e78..69126052d0 100644
--- a/doc/classes/VisualScriptComment.xml
+++ b/doc/classes/VisualScriptComment.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<brief_description>
- A Visual Script node used to store information for the developer.
+ A Visual Script node used to annotate the script.
</brief_description>
<description>
- A Visual Script node used to display text, so that code is more readable and better documented.
+ A Visual Script node used to display annotations in the script, so that code may be documented.
Comment nodes can be resized so they encompass a group of nodes.
</description>
<tutorials>
@@ -60,10 +60,10 @@
The text inside the comment node.
</member>
<member name="size" type="Vector2" setter="set_size" getter="get_size">
- The size (in pixels) of the comment node.
+ The comment node's size (in pixels).
</member>
<member name="title" type="String" setter="set_title" getter="get_title">
- The title of the comment node.
+ The comment node's title.
</member>
</members>
<constants>
diff --git a/doc/classes/VisualScriptCondition.xml b/doc/classes/VisualScriptCondition.xml
index de814a6b17..a776c9bc9b 100644
--- a/doc/classes/VisualScriptCondition.xml
+++ b/doc/classes/VisualScriptCondition.xml
@@ -4,7 +4,14 @@
A Visual Script node which branches the flow.
</brief_description>
<description>
- A Visual Script node which switches the flow based on a boolean. It acts similar to if/else in typical programming languages.
+ A Visual Script node that checks a [bool] input port. If [code]true[/code] it will exit via the “true” sequence port. If [code]false[/code] it will exit via the "false" sequence port. After exiting either, it exits via the “done” port. Sequence ports may be left disconnected.
+ [b]Input Ports:[/b]
+ - Sequence: [code]if (cond) is[/code]
+ - Data (boolean): [code]cond[/code]
+ [b]Output Ports:[/b]
+ - Sequence: [code]true[/code]
+ - Sequence: [code]false[/code]
+ - Sequence: [code]done[/code]
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/VisualScriptOperator.xml b/doc/classes/VisualScriptOperator.xml
index 82951c9e0c..7e85af8af2 100644
--- a/doc/classes/VisualScriptOperator.xml
+++ b/doc/classes/VisualScriptOperator.xml
@@ -3,6 +3,13 @@
<brief_description>
</brief_description>
<description>
+ [b]Input Ports:[/b]
+ - Data (variant): [code]A[/code]
+ - Data (variant): [code]B[/code]
+ [b]Output Ports:[/b]
+ - Sequence: [code]true[/code]
+ - Sequence: [code]false[/code]
+ - Sequence: [code]done[/code]
</description>
<tutorials>
</tutorials>
diff --git a/doc/classes/VisualScriptSceneNode.xml b/doc/classes/VisualScriptSceneNode.xml
index 90a8f132c0..b71bd9adfb 100644
--- a/doc/classes/VisualScriptSceneNode.xml
+++ b/doc/classes/VisualScriptSceneNode.xml
@@ -1,8 +1,14 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<brief_description>
+ Node reference.
</brief_description>
<description>
+ A direct reference to a node.
+ [b]Input Ports:[/b]
+ none
+ [b]Output Ports:[/b]
+ - Data: [code]node[/code] (obj)
</description>
<tutorials>
</tutorials>
@@ -26,6 +32,7 @@
</methods>
<members>
<member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path">
+ The node's path in the scene tree.
</member>
</members>
<constants>