Added VisualScript* descriptions

[ci skip]
This commit is contained in:
Chris Bradfield 2017-10-06 09:00:57 -07:00 committed by Rémi Verschelde
parent 9e93f5b478
commit bf0b328197
4 changed files with 26 additions and 5 deletions

View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<brief_description> <brief_description>
A Visual Script node used to store information for the developer. A Visual Script node used to annotate the script.
</brief_description> </brief_description>
<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. Comment nodes can be resized so they encompass a group of nodes.
</description> </description>
<tutorials> <tutorials>
@ -60,10 +60,10 @@
The text inside the comment node. The text inside the comment node.
</member> </member>
<member name="size" type="Vector2" setter="set_size" getter="get_size"> <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>
<member name="title" type="String" setter="set_title" getter="get_title"> <member name="title" type="String" setter="set_title" getter="get_title">
The title of the comment node. The comment node's title.
</member> </member>
</members> </members>
<constants> <constants>

View file

@ -4,7 +4,14 @@
A Visual Script node which branches the flow. A Visual Script node which branches the flow.
</brief_description> </brief_description>
<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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -3,6 +3,13 @@
<brief_description> <brief_description>
</brief_description> </brief_description>
<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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>

View file

@ -1,8 +1,14 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
<brief_description> <brief_description>
Node reference.
</brief_description> </brief_description>
<description> <description>
A direct reference to a node.
[b]Input Ports:[/b]
none
[b]Output Ports:[/b]
- Data: [code]node[/code] (obj)
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -26,6 +32,7 @@
</methods> </methods>
<members> <members>
<member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path"> <member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path">
The node's path in the scene tree.
</member> </member>
</members> </members>
<constants> <constants>