From bf0b32819766124c9d0ddaf63eb59d54959c8bef Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Fri, 6 Oct 2017 09:00:57 -0700 Subject: [PATCH] Added VisualScript* descriptions [ci skip] --- doc/classes/VisualScriptComment.xml | 8 ++++---- doc/classes/VisualScriptCondition.xml | 9 ++++++++- doc/classes/VisualScriptOperator.xml | 7 +++++++ doc/classes/VisualScriptSceneNode.xml | 7 +++++++ 4 files changed, 26 insertions(+), 5 deletions(-) diff --git a/doc/classes/VisualScriptComment.xml b/doc/classes/VisualScriptComment.xml index da65998e787..69126052d0f 100644 --- a/doc/classes/VisualScriptComment.xml +++ b/doc/classes/VisualScriptComment.xml @@ -1,10 +1,10 @@ - A Visual Script node used to store information for the developer. + A Visual Script node used to annotate the script. - 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. @@ -60,10 +60,10 @@ The text inside the comment node. - The size (in pixels) of the comment node. + The comment node's size (in pixels). - The title of the comment node. + The comment node's title. diff --git a/doc/classes/VisualScriptCondition.xml b/doc/classes/VisualScriptCondition.xml index de814a6b171..a776c9bc9bd 100644 --- a/doc/classes/VisualScriptCondition.xml +++ b/doc/classes/VisualScriptCondition.xml @@ -4,7 +4,14 @@ A Visual Script node which branches the flow. - 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] diff --git a/doc/classes/VisualScriptOperator.xml b/doc/classes/VisualScriptOperator.xml index 82951c9e0ce..7e85af8af23 100644 --- a/doc/classes/VisualScriptOperator.xml +++ b/doc/classes/VisualScriptOperator.xml @@ -3,6 +3,13 @@ + [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] diff --git a/doc/classes/VisualScriptSceneNode.xml b/doc/classes/VisualScriptSceneNode.xml index 90a8f132c09..b71bd9adfbf 100644 --- a/doc/classes/VisualScriptSceneNode.xml +++ b/doc/classes/VisualScriptSceneNode.xml @@ -1,8 +1,14 @@ + Node reference. + A direct reference to a node. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data: [code]node[/code] (obj) @@ -26,6 +32,7 @@ + The node's path in the scene tree.