From ec0ade0dde8eafe2c6d5df0669175c56fb8ce67a Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sun, 15 Oct 2017 11:48:13 -0700 Subject: [DOCS] Various VisualScript* nodes --- doc/classes/VisualScriptLocalVar.xml | 2 +- doc/classes/VisualScriptLocalVarSet.xml | 2 +- doc/classes/VisualScriptPreload.xml | 7 +++++++ doc/classes/VisualScriptSelect.xml | 9 +++++++++ doc/classes/VisualScriptVariableGet.xml | 7 +++++++ doc/classes/VisualScriptVariableSet.xml | 8 ++++++++ doc/classes/VisualScriptWhile.xml | 8 ++++++++ 7 files changed, 41 insertions(+), 2 deletions(-) diff --git a/doc/classes/VisualScriptLocalVar.xml b/doc/classes/VisualScriptLocalVar.xml index bca19d06d5..3101b3e34b 100644 --- a/doc/classes/VisualScriptLocalVar.xml +++ b/doc/classes/VisualScriptLocalVar.xml @@ -4,7 +4,7 @@ Gets a local variable's value. - This node returns a local variable's value. "Var Name" must be supplied, with an optional type. + Returns a local variable's value. "Var Name" must be supplied, with an optional type. [b]Input Ports:[/b] none [b]Output Ports:[/b] diff --git a/doc/classes/VisualScriptLocalVarSet.xml b/doc/classes/VisualScriptLocalVarSet.xml index 67a5efa33e..e039a7204e 100644 --- a/doc/classes/VisualScriptLocalVarSet.xml +++ b/doc/classes/VisualScriptLocalVarSet.xml @@ -4,7 +4,7 @@ Changes a local variable's value. - The node changes a local variable's value to the given input. The new value is also provided on an output Data port. + Changes a local variable's value to the given input. The new value is also provided on an output Data port. [b]Input Ports:[/b] - Sequence - Data (variant): [code]set[/code] diff --git a/doc/classes/VisualScriptPreload.xml b/doc/classes/VisualScriptPreload.xml index b68bf5546b..b683439751 100644 --- a/doc/classes/VisualScriptPreload.xml +++ b/doc/classes/VisualScriptPreload.xml @@ -1,8 +1,14 @@ + Creates a new [Resource] or loads one from the filesystem. + Creates a new [Resource] or loads one from the filesystem. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (object): [code]res[/code] @@ -26,6 +32,7 @@ + The [Resource] to load. diff --git a/doc/classes/VisualScriptSelect.xml b/doc/classes/VisualScriptSelect.xml index 855da76e6c..f265c57645 100644 --- a/doc/classes/VisualScriptSelect.xml +++ b/doc/classes/VisualScriptSelect.xml @@ -1,8 +1,16 @@ + Chooses between two input values. + Chooses between two input values based on a Boolean condition. + [b]Input Ports:[/b] + - Data (boolean): [code]cond[/code] + - Data (variant): [code]a[/code] + - Data (variant): [code]b[/code] + [b]Output Ports:[/b] + - Data (variant): [code]out[/code] @@ -26,6 +34,7 @@ + The input variables' type. diff --git a/doc/classes/VisualScriptVariableGet.xml b/doc/classes/VisualScriptVariableGet.xml index 8411933756..5b45dd0cc4 100644 --- a/doc/classes/VisualScriptVariableGet.xml +++ b/doc/classes/VisualScriptVariableGet.xml @@ -1,8 +1,14 @@ + Gets a variable's value. + Returns a variable's value. "Var Name" must be supplied, with an optional type. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]value[/code] @@ -26,6 +32,7 @@ + The variable's name. diff --git a/doc/classes/VisualScriptVariableSet.xml b/doc/classes/VisualScriptVariableSet.xml index fbe0f8e275..51f85f6881 100644 --- a/doc/classes/VisualScriptVariableSet.xml +++ b/doc/classes/VisualScriptVariableSet.xml @@ -1,8 +1,15 @@ + Changes a variable's value. + Changes a variable's value to the given input. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]set[/code] + [b]Output Ports:[/b] + - Sequence @@ -26,6 +33,7 @@ + The variable's name. diff --git a/doc/classes/VisualScriptWhile.xml b/doc/classes/VisualScriptWhile.xml index b49678582e..60bf161339 100644 --- a/doc/classes/VisualScriptWhile.xml +++ b/doc/classes/VisualScriptWhile.xml @@ -1,8 +1,16 @@ + Conditional loop. + Loops while a condition is [code]true[/code]. Execution continues out the [code]exit[/code] Sequence port when the loop terminates. + [b]Input Ports:[/b] + - Sequence: [code]while(cond)[/code] + - Data (bool): [code]cond[/code] + [b]Output Ports:[/b] + - Sequence: [code]repeat[/code] + - Sequence: [code]exit[/code] -- cgit v1.2.3