From 6172f09703847aeac556abf2fca5169e73d22f97 Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sat, 14 Oct 2017 20:11:00 -0700 Subject: [PATCH] [DOCS] Update 12 VisualScript* nodes --- doc/classes/VisualScriptClassConstant.xml | 12 ++++++++---- doc/classes/VisualScriptConstant.xml | 8 ++++++-- doc/classes/VisualScriptEmitSignal.xml | 8 ++++++-- doc/classes/VisualScriptIterator.xml | 9 +++++++++ doc/classes/VisualScriptLocalVar.xml | 8 ++++++++ doc/classes/VisualScriptLocalVarSet.xml | 10 ++++++++++ doc/classes/VisualScriptMathConstant.xml | 15 +++++++++++++++ doc/classes/VisualScriptOperator.xml | 4 +--- doc/classes/VisualScriptReturn.xml | 9 +++++++++ doc/classes/VisualScriptSelf.xml | 6 ++++++ doc/classes/VisualScriptSequence.xml | 9 +++++++++ doc/classes/VisualScriptSwitch.xml | 11 +++++++++++ 12 files changed, 98 insertions(+), 11 deletions(-) diff --git a/doc/classes/VisualScriptClassConstant.xml b/doc/classes/VisualScriptClassConstant.xml index 70e7de5dd93..0377fa8f09b 100644 --- a/doc/classes/VisualScriptClassConstant.xml +++ b/doc/classes/VisualScriptClassConstant.xml @@ -1,10 +1,14 @@ - A Visual Script node representing a constant from a class. + Gets a constant from a given class. - A Visual Script node representing a constant from the classes, such as [@GlobalScope.TYPE_INT]. + This node returns a constant from a given class, such as [@GlobalScope.TYPE_INT]. See the given class' documentation for available constants. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]value[/code] @@ -42,10 +46,10 @@ - The type to get the constant from. + The constant's parent class. - The name of the constant to return. + The constant to return. See the given class for its available constants. diff --git a/doc/classes/VisualScriptConstant.xml b/doc/classes/VisualScriptConstant.xml index 508087a9285..2a704adecf9 100644 --- a/doc/classes/VisualScriptConstant.xml +++ b/doc/classes/VisualScriptConstant.xml @@ -1,10 +1,14 @@ - A Visual Script node which returns a constant value. + Gets a contant's value. - A Visual Script node which returns the specified constant value. + This node returns a constant's value. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] diff --git a/doc/classes/VisualScriptEmitSignal.xml b/doc/classes/VisualScriptEmitSignal.xml index 844b5a40ec3..8d132ed3210 100644 --- a/doc/classes/VisualScriptEmitSignal.xml +++ b/doc/classes/VisualScriptEmitSignal.xml @@ -1,10 +1,14 @@ - A Visual Script node which emits a specified signal. + Emits a specified signal. - A Visual Script node which emits a specified signal when it is executed. + Emits a specified signal when it is executed. + [b]Input Ports:[/b] + - Sequence: [code]emit[/code] + [b]Output Ports:[/b] + - Sequence diff --git a/doc/classes/VisualScriptIterator.xml b/doc/classes/VisualScriptIterator.xml index 74309fcf004..1f9a4fddde3 100644 --- a/doc/classes/VisualScriptIterator.xml +++ b/doc/classes/VisualScriptIterator.xml @@ -1,8 +1,17 @@ + Steps through items in a given input. + This node steps through each item in a given input. Input can be any sequence data type, such as an [Array] or [String]. When each item has been processed, execution passed out the [code]exit[/code] Sequence port. + [b]Input Ports:[/b] + - Sequence: [code]for (elem) in (input)[/code] + - Data (variant): [code]input[/code] + [b]Output Ports:[/b] + - Sequence: [code]each[/code] + - Sequence: [code]exit[/code] + - Data (variant): [code]elem[/code] diff --git a/doc/classes/VisualScriptLocalVar.xml b/doc/classes/VisualScriptLocalVar.xml index 7db550d5fe7..bca19d06d5f 100644 --- a/doc/classes/VisualScriptLocalVar.xml +++ b/doc/classes/VisualScriptLocalVar.xml @@ -1,8 +1,14 @@ + Gets a local variable's value. + This node returns a local variable's value. "Var Name" must be supplied, with an optional type. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] @@ -40,8 +46,10 @@ + The local variable's type. + The local variable's name. diff --git a/doc/classes/VisualScriptLocalVarSet.xml b/doc/classes/VisualScriptLocalVarSet.xml index 6e69f133838..67a5efa33e7 100644 --- a/doc/classes/VisualScriptLocalVarSet.xml +++ b/doc/classes/VisualScriptLocalVarSet.xml @@ -1,8 +1,16 @@ + 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. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]set[/code] + [b]Output Ports:[/b] + - Sequence + - Data (variant): [code]get[/code] @@ -40,8 +48,10 @@ + The local variable's type. + The local variable's name. diff --git a/doc/classes/VisualScriptMathConstant.xml b/doc/classes/VisualScriptMathConstant.xml index 1ef7d71e103..86744e5caf2 100644 --- a/doc/classes/VisualScriptMathConstant.xml +++ b/doc/classes/VisualScriptMathConstant.xml @@ -1,8 +1,14 @@ + Commonly used mathematical constants. + Provides common math constants, such as Pi or Euler's constant, on an output Data port. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] @@ -26,24 +32,33 @@ + The math constant. + Unity: [code]1[/code] + Pi: [code]3.141593[/code] + Pi times two: [code]6.283185[/code] + Pi divided by two: [code]1.570796[/code] + Natural log: [code]2.718282[/code] + Square root of two: [code]1.414214[/code] + Infinity: [code]inf[/code] + Not a number: [code]nan[/code] diff --git a/doc/classes/VisualScriptOperator.xml b/doc/classes/VisualScriptOperator.xml index 7e85af8af23..de08075af28 100644 --- a/doc/classes/VisualScriptOperator.xml +++ b/doc/classes/VisualScriptOperator.xml @@ -7,9 +7,7 @@ - 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] + - Data (variant): [code]result[/code] diff --git a/doc/classes/VisualScriptReturn.xml b/doc/classes/VisualScriptReturn.xml index 55c53e17a03..ad18e96230c 100644 --- a/doc/classes/VisualScriptReturn.xml +++ b/doc/classes/VisualScriptReturn.xml @@ -1,8 +1,15 @@ + Exits a function and returns an optional value. + Ends the execution of a function and returns control to the calling function. Optionally, it can return a [Variant] value. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]result[/code] (optional) + [b]Output Ports:[/b] + none @@ -40,8 +47,10 @@ + If [code]true[/code] the [code]return[/code] input port is available. + The return value's data type. diff --git a/doc/classes/VisualScriptSelf.xml b/doc/classes/VisualScriptSelf.xml index a60f7eee03e..723b1387222 100644 --- a/doc/classes/VisualScriptSelf.xml +++ b/doc/classes/VisualScriptSelf.xml @@ -1,8 +1,14 @@ + Outputs a reference to the current instance. + Provides a reference to the node running the visual script. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (object): [code]instance[/code] diff --git a/doc/classes/VisualScriptSequence.xml b/doc/classes/VisualScriptSequence.xml index a60c9e782b5..4ea4203407e 100644 --- a/doc/classes/VisualScriptSequence.xml +++ b/doc/classes/VisualScriptSequence.xml @@ -1,8 +1,16 @@ + Executes a series of Sequence ports. + Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item. + [b]Input Ports:[/b] + - Sequence: [code]in order[/code] + [b]Output Ports:[/b] + - Sequence: [code]1[/code] + - Sequence: [code]2 - n[/code] (optional) + - Data (int): [code]current[/code] @@ -26,6 +34,7 @@ + The number of steps in the sequence. diff --git a/doc/classes/VisualScriptSwitch.xml b/doc/classes/VisualScriptSwitch.xml index 95ed737372c..2540ae54cc3 100644 --- a/doc/classes/VisualScriptSwitch.xml +++ b/doc/classes/VisualScriptSwitch.xml @@ -1,8 +1,19 @@ + Branches program flow based on a given input's value. + Branches the flow based on an input's value. Use "Case Count" in the Inspector to set the number of branches and each comparison's optional type. + [b]Input Ports:[/b] + - Sequence: [code]'input' is[/code] + - Data (variant): [code]=[/code] + - Data (variant): [code]=[/code] (optional) + - Data (variant): [code]input[/code] + [b]Output Ports:[/b] + - Sequence + - Sequence (optional) + - Sequence: [code]done[/code]