godotengine/godot-visual-script
1
0
Fork 0
mirror of https://github.com/godotengine/godot-visual-script.git synced 2026-01-04 18:10:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: Sync with current source

Browse Source 
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
This commit is contained in:
Rémi Verschelde
2018-01-25 08:50:56 +01:00
parent bd42ba7d0c
commit 0ddacdab12
45 changed files with 45 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc_classes/VisualScript.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScript" inherits="Script" category="Core" version="3.0-rc1"> <class name="VisualScript" inherits="Script" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A script implemented in the Visual Script programming environment. A script implemented in the Visual Script programming environment.
</brief_description> </brief_description>

2
doc_classes/VisualScriptBasicTypeConstant.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptBasicTypeConstant" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptBasicTypeConstant" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A Visual Script node representing a constant from the base types. A Visual Script node representing a constant from the base types.
</brief_description> </brief_description>

2
doc_classes/VisualScriptBuiltinFunc.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptBuiltinFunc" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptBuiltinFunc" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A Visual Script node used to call built-in functions. A Visual Script node used to call built-in functions.
</brief_description> </brief_description>

2
doc_classes/VisualScriptClassConstant.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptClassConstant" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptClassConstant" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Gets a constant from a given class. Gets a constant from a given class.
</brief_description> </brief_description>

2
doc_classes/VisualScriptComment.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptComment" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A Visual Script node used to annotate the script. A Visual Script node used to annotate the script.
</brief_description> </brief_description>

2
doc_classes/VisualScriptCondition.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptCondition" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptCondition" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A Visual Script node which branches the flow. A Visual Script node which branches the flow.
</brief_description> </brief_description>

2
doc_classes/VisualScriptConstant.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptConstant" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptConstant" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Gets a contant's value. Gets a contant's value.
</brief_description> </brief_description>

2
doc_classes/VisualScriptConstructor.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptConstructor" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptConstructor" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A Visual Script node which calls a base type constructor. A Visual Script node which calls a base type constructor.
</brief_description> </brief_description>

2
doc_classes/VisualScriptCustomNode.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptCustomNode" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptCustomNode" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A scripted Visual Script node. A scripted Visual Script node.
</brief_description> </brief_description>

2
doc_classes/VisualScriptDeconstruct.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptDeconstruct" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptDeconstruct" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A Visual Script node which deconstructs a base type instance into its parts. A Visual Script node which deconstructs a base type instance into its parts.
</brief_description> </brief_description>

2
doc_classes/VisualScriptEditor.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptEditor" inherits="Object" category="Core" version="3.0-rc1"> <class name="VisualScriptEditor" inherits="Object" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptEmitSignal.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptEmitSignal" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptEmitSignal" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Emits a specified signal. Emits a specified signal.
</brief_description> </brief_description>

2
doc_classes/VisualScriptEngineSingleton.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptEngineSingleton" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptEngineSingleton" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A Visual Script node returning a singleton from [@GlobalScope] A Visual Script node returning a singleton from [@GlobalScope]
</brief_description> </brief_description>

2
doc_classes/VisualScriptExpression.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptExpression" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptExpression" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptFunction.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunction" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptFunction" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptFunctionCall.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunctionCall" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptFunctionCall" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptFunctionState.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptFunctionState" inherits="Reference" category="Core" version="3.0-rc1"> <class name="VisualScriptFunctionState" inherits="Reference" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptGlobalConstant.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptGlobalConstant" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptGlobalConstant" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptIndexGet.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptIndexGet" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptIndexGet" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptIndexSet.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptIndexSet" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptIndexSet" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptInputAction.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptInputAction" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptInputAction" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptIterator.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptIterator" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptIterator" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Steps through items in a given input. Steps through items in a given input.
</brief_description> </brief_description>

2
doc_classes/VisualScriptLocalVar.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptLocalVar" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptLocalVar" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Gets a local variable's value. Gets a local variable's value.
</brief_description> </brief_description>

2
doc_classes/VisualScriptLocalVarSet.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptLocalVarSet" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptLocalVarSet" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Changes a local variable's value. Changes a local variable's value.
</brief_description> </brief_description>

2
doc_classes/VisualScriptMathConstant.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Commonly used mathematical constants. Commonly used mathematical constants.
</brief_description> </brief_description>

2
doc_classes/VisualScriptNode.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptNode" inherits="Resource" category="Core" version="3.0-rc1"> <class name="VisualScriptNode" inherits="Resource" category="Core" version="3.0-stable">
<brief_description> <brief_description>
A node which is part of a [VisualScript]. A node which is part of a [VisualScript].
</brief_description> </brief_description>

2
doc_classes/VisualScriptOperator.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptOperator" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptOperator" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptPreload.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptPreload" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptPreload" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Creates a new [Resource] or loads one from the filesystem. Creates a new [Resource] or loads one from the filesystem.
</brief_description> </brief_description>

2
doc_classes/VisualScriptPropertyGet.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptPropertyGet" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptPropertyGet" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptPropertySet.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptPropertySet" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptPropertySet" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptResourcePath.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptResourcePath" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptResourcePath" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptReturn.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Exits a function and returns an optional value. Exits a function and returns an optional value.
</brief_description> </brief_description>

2
doc_classes/VisualScriptSceneNode.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptSceneNode" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Node reference. Node reference.
</brief_description> </brief_description>

2
doc_classes/VisualScriptSceneTree.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSceneTree" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptSceneTree" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptSelect.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSelect" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptSelect" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Chooses between two input values. Chooses between two input values.
</brief_description> </brief_description>

2
doc_classes/VisualScriptSelf.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSelf" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptSelf" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Outputs a reference to the current instance. Outputs a reference to the current instance.
</brief_description> </brief_description>

2
doc_classes/VisualScriptSequence.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Executes a series of Sequence ports. Executes a series of Sequence ports.
</brief_description> </brief_description>

2
doc_classes/VisualScriptSubCall.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSubCall" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptSubCall" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptSwitch.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptSwitch" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptSwitch" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Branches program flow based on a given input's value. Branches program flow based on a given input's value.
</brief_description> </brief_description>

2
doc_classes/VisualScriptTypeCast.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptTypeCast" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptTypeCast" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptVariableGet.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptVariableGet" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptVariableGet" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Gets a variable's value. Gets a variable's value.
</brief_description> </brief_description>

2
doc_classes/VisualScriptVariableSet.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptVariableSet" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptVariableSet" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Changes a variable's value. Changes a variable's value.
</brief_description> </brief_description>

2
doc_classes/VisualScriptWhile.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptWhile" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptWhile" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
Conditional loop. Conditional loop.
</brief_description> </brief_description>

2
doc_classes/VisualScriptYield.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptYield" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptYield" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>

2
doc_classes/VisualScriptYieldSignal.xml
View File

@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptYieldSignal" inherits="VisualScriptNode" category="Core" version="3.0-rc1"> <class name="VisualScriptYieldSignal" inherits="VisualScriptNode" category="Core" version="3.0-stable">
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>