Merge pull request #12126 from cbscribe/kcc_vsdocs2
[DOCS] Various VisualScript* nodes [ci skip]
This commit is contained in:
commit
0d0cb01f33
7 changed files with 41 additions and 2 deletions
|
@ -4,7 +4,7 @@
|
|||
Gets a local variable's value.
|
||||
</brief_description>
|
||||
<description>
|
||||
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]
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
Changes a local variable's value.
|
||||
</brief_description>
|
||||
<description>
|
||||
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]
|
||||
|
|
|
@ -1,8 +1,14 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptPreload" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
|
||||
<brief_description>
|
||||
Creates a new [Resource] or loads one from the filesystem.
|
||||
</brief_description>
|
||||
<description>
|
||||
Creates a new [Resource] or loads one from the filesystem.
|
||||
[b]Input Ports:[/b]
|
||||
none
|
||||
[b]Output Ports:[/b]
|
||||
- Data (object): [code]res[/code]
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
@ -26,6 +32,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="resource" type="Resource" setter="set_preload" getter="get_preload">
|
||||
The [Resource] to load.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
@ -1,8 +1,16 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptSelect" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
|
||||
<brief_description>
|
||||
Chooses between two input values.
|
||||
</brief_description>
|
||||
<description>
|
||||
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]
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
@ -26,6 +34,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type">
|
||||
The input variables' type.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
@ -1,8 +1,14 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptVariableGet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
|
||||
<brief_description>
|
||||
Gets a variable's value.
|
||||
</brief_description>
|
||||
<description>
|
||||
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]
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
@ -26,6 +32,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="var_name" type="String" setter="set_variable" getter="get_variable">
|
||||
The variable's name.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
@ -1,8 +1,15 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptVariableSet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
|
||||
<brief_description>
|
||||
Changes a variable's value.
|
||||
</brief_description>
|
||||
<description>
|
||||
Changes a variable's value to the given input.
|
||||
[b]Input Ports:[/b]
|
||||
- Sequence
|
||||
- Data (variant): [code]set[/code]
|
||||
[b]Output Ports:[/b]
|
||||
- Sequence
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
@ -26,6 +33,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="var_name" type="String" setter="set_variable" getter="get_variable">
|
||||
The variable's name.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
@ -1,8 +1,16 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptWhile" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build">
|
||||
<brief_description>
|
||||
Conditional loop.
|
||||
</brief_description>
|
||||
<description>
|
||||
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]
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
Loading…
Reference in a new issue