diff --git a/config.py b/config.py
index d10adb0..6b1ce41 100644
--- a/config.py
+++ b/config.py
@@ -1,14 +1,57 @@
-
-
def can_build(platform):
return True
-
def configure(env):
pass
def get_doc_classes():
- return ["VisualScriptEditor"]
+ return [
+ "VisualScriptBasicTypeConstant",
+ "VisualScriptBuiltinFunc",
+ "VisualScriptClassConstant",
+ "VisualScriptComment",
+ "VisualScriptCondition",
+ "VisualScriptConstant",
+ "VisualScriptConstructor",
+ "VisualScriptCustomNode",
+ "VisualScriptDeconstruct",
+ "VisualScriptEditor",
+ "VisualScriptEmitSignal",
+ "VisualScriptEngineSingleton",
+ "VisualScriptExpression",
+ "VisualScriptFunctionCall",
+ "VisualScriptFunctionState",
+ "VisualScriptFunction",
+ "VisualScriptGlobalConstant",
+ "VisualScriptIndexGet",
+ "VisualScriptIndexSet",
+ "VisualScriptInputAction",
+ "VisualScriptIterator",
+ "VisualScriptLocalVarSet",
+ "VisualScriptLocalVar",
+ "VisualScriptMathConstant",
+ "VisualScriptNode",
+ "VisualScriptOperator",
+ "VisualScriptPreload",
+ "VisualScriptPropertyGet",
+ "VisualScriptPropertySet",
+ "VisualScriptResourcePath",
+ "VisualScriptReturn",
+ "VisualScriptSceneNode",
+ "VisualScriptSceneTree",
+ "VisualScriptSelect",
+ "VisualScriptSelf",
+ "VisualScriptSequence",
+ "VisualScriptSubCall",
+ "VisualScriptSwitch",
+ "VisualScriptTypeCast",
+ "VisualScriptVariableGet",
+ "VisualScriptVariableSet",
+ "VisualScriptWhile",
+ "VisualScript",
+ "VisualScriptYieldSignal",
+ "VisualScriptYield",
+ ]
def get_doc_path():
return "doc_classes"
diff --git a/doc_classes/VisualScript.xml b/doc_classes/VisualScript.xml
new file mode 100644
index 0000000..80b1ed8
--- /dev/null
+++ b/doc_classes/VisualScript.xml
@@ -0,0 +1,515 @@
+
+
+
+ A script implemented in the Visual Script programming environment.
+
+
+ A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it.
+ [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes.
+ You are most likely to use this class via the Visual Script editor or when writing plugins for it.
+
+
+
+
+
+
+
+
+
+
+
+
+ Add a custom signal with the specified name to the VisualScript.
+
+
+
+
+
+
+
+
+ Add a function with the specified name to the VisualScript.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Add a node to a function of the VisualScript.
+
+
+
+
+
+
+
+
+
+
+
+
+ Add a variable to the VisualScript, optionally giving it a default value or marking it as exported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Add an argument to a custom signal added with [method add_custom_signal].
+
+
+
+
+
+
+
+
+ Get the count of a custom signal's arguments.
+
+
+
+
+
+
+
+
+
+
+ Get the name of a custom signal's argument.
+
+
+
+
+
+
+
+
+
+
+ Get the type of a custom signal's argument.
+
+
+
+
+
+
+
+
+
+
+ Remove a specific custom signal's argument.
+
+
+
+
+
+
+
+
+
+
+
+
+ Rename a custom signal's argument.
+
+
+
+
+
+
+
+
+
+
+
+
+ Change the type of a custom signal's argument.
+
+
+
+
+
+
+
+
+
+
+
+
+ Swap two of the arguments of a custom signal.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connect two data ports. The value of [code]from_node[/code]'s [code]from_port[/code] would be fed into [code]to_node[/code]'s [code]to_port[/code].
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Disconnect two data ports previously connected with [method data_connect].
+
+
+
+
+
+
+
+
+ Returns the id of a function's entry point node.
+
+
+
+
+
+
+
+
+ Returns the position of the center of the screen for a given function.
+
+
+
+
+
+
+
+
+
+
+ Returns a node given its id and its function.
+
+
+
+
+
+
+
+
+
+
+ Returns a node's position in pixels.
+
+
+
+
+
+
+
+
+ Returns the default (initial) value of a variable.
+
+
+
+
+
+
+
+
+ Returns whether a variable is exported.
+
+
+
+
+
+
+
+
+ Returns the info for a given variable as a dictionary. The information includes its name, type, hint and usage.
+
+
+
+
+
+
+
+
+ Returns whether a signal exists with the specified name.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns whether the specified data ports are connected.
+
+
+
+
+
+
+
+
+ Returns whether a function exists with the specified name.
+
+
+
+
+
+
+
+
+
+
+ Returns whether a node exists with the given id.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns whether the specified sequence ports are connected.
+
+
+
+
+
+
+
+
+ Returns whether a variable exists with the specified name.
+
+
+
+
+
+
+
+
+ Remove a custom signal with the given name.
+
+
+
+
+
+
+
+
+ Remove a specific function and its nodes from the script.
+
+
+
+
+
+
+
+
+
+
+ Remove a specific node.
+
+
+
+
+
+
+
+
+ Remove a variable with the given name.
+
+
+
+
+
+
+
+
+
+
+ Change the name of a custom signal.
+
+
+
+
+
+
+
+
+
+
+ Change the name of a function.
+
+
+
+
+
+
+
+
+
+
+ Change the name of a variable.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Connect two sequence ports. The execution will flow from of [code]from_node[/code]'s [code]from_output[/code] into [code]to_node[/code].
+ Unlike [method data_connect], there isn't a [code]to_port[/code], since the target node can have only one sequence port.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Disconnect two sequence ports previously connected with [method sequence_connect].
+
+
+
+
+
+
+
+
+
+
+ Position the center of the screen for a function.
+
+
+
+
+
+
+
+
+ Set the base type of the script.
+
+
+
+
+
+
+
+
+
+
+
+
+ Position a node on the screen.
+
+
+
+
+
+
+
+
+
+
+ Change the default (initial) value of a variable.
+
+
+
+
+
+
+
+
+
+
+ Change whether a variable is exported.
+
+
+
+
+
+
+
+
+
+
+ Set a variable's info, using the same format as [method get_variable_info].
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Emitted when the ports of a node are changed.
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptBasicTypeConstant.xml b/doc_classes/VisualScriptBasicTypeConstant.xml
new file mode 100644
index 0000000..6c028e5
--- /dev/null
+++ b/doc_classes/VisualScriptBasicTypeConstant.xml
@@ -0,0 +1,53 @@
+
+
+
+ A Visual Script node representing a constant from the base types.
+
+
+ A Visual Script node representing a constant from base types, such as [Vector3.AXIS_X].
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type to get the constant from.
+
+
+ The name of the constant to return.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptBuiltinFunc.xml b/doc_classes/VisualScriptBuiltinFunc.xml
new file mode 100644
index 0000000..2723157
--- /dev/null
+++ b/doc_classes/VisualScriptBuiltinFunc.xml
@@ -0,0 +1,219 @@
+
+
+
+ A Visual Script node used to call built-in functions.
+
+
+ A built-in function used inside a [VisualScript]. It is usually a math function or an utility function.
+ See also [@GDScript], for the same functions in the GDScript language.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The function to be executed.
+
+
+
+
+ Return the sine of the input.
+
+
+ Return the cosine of the input.
+
+
+ Return the tangent of the input.
+
+
+ Return the hyperbolic sine of the input.
+
+
+ Return the hyperbolic cosine of the input.
+
+
+ Return the hyperbolic tangent of the input.
+
+
+ Return the arc sine of the input.
+
+
+ Return the arc cosine of the input.
+
+
+ Return the arc tangent of the input.
+
+
+ Return the arc tangent of the input, using the signs of both parameters to determine the exact angle.
+
+
+ Return the square root of the input.
+
+
+ Return the remainder of one input divided by the other, using floating-point numbers.
+
+
+ Return the positive remainder of one input divided by the other, using floating-point numbers.
+
+
+ Return the input rounded down.
+
+
+ Return the input rounded up.
+
+
+ Return the input rounded to the nearest integer.
+
+
+ Return the absolute value of the input.
+
+
+ Return the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative.
+
+
+ Return the input raised to a given power.
+
+
+ Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use.
+
+
+ Return [b]e[/b] raised to the power of the input. [b]e[/b] sometimes called "Euler's number" is a mathematical constant whose value is approximately 2.71828.
+
+
+ Return whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist.
+
+
+ Return whether the input is an infinite floating-point number or not. Infinity is usually produced by dividing a number by 0, though other ways exist.
+
+
+ Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
+
+
+ Return the number of digit places after the decimal that the first non-zero digit occurs.
+
+
+ Return the input snapped to a given step.
+
+
+ Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code].
+
+
+
+
+
+
+ Return the result of 'value' decreased by 'step' * 'amount'.
+
+
+ Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
+
+
+ Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function.
+
+
+ Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication.
+
+
+ Return a random floating-point value between the two inputs.
+
+
+ Set the seed for the random number generator.
+
+
+ Return a random value from the given seed, along with the new seed.
+
+
+ Convert the input from degrees to radians.
+
+
+ Convert the input from radians to degrees.
+
+
+ Convert the input from linear volume to decibel volume.
+
+
+ Convert the input from decibel volume to linear volume.
+
+
+
+
+
+
+ Return the greater of the two numbers, also known as their maximum.
+
+
+ Return the lesser of the two numbers, also known as their minimum.
+
+
+ Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)`
+
+
+ Return the nearest power of 2 to the input.
+
+
+ Create a [WeakRef] from the input.
+
+
+ Create a [FuncRef] from the input.
+
+
+ Convert between types.
+
+
+ Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
+
+
+ Checks if a type is registered in the [ClassDB].
+
+
+ Return a character with the given ascii value.
+
+
+ Convert the input to a string.
+
+
+ Print the given string to the output window.
+
+
+ Print the given string to the standard error output.
+
+
+ Print the given string to the standard output, without adding a newline.
+
+
+ Serialize a [Variant] to a string.
+
+
+ Deserialize a [Variant] from a string serialized using [VAR_TO_STR].
+
+
+ Serialize a [Variant] to a [PoolByteArray].
+
+
+ Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES].
+
+
+ Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
+
+
+ The maximum value the [member function] property can have.
+
+
+
diff --git a/doc_classes/VisualScriptClassConstant.xml b/doc_classes/VisualScriptClassConstant.xml
new file mode 100644
index 0000000..e6498e9
--- /dev/null
+++ b/doc_classes/VisualScriptClassConstant.xml
@@ -0,0 +1,57 @@
+
+
+
+ Gets a constant from a given class.
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The constant's parent class.
+
+
+ The constant to return. See the given class for its available constants.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptComment.xml b/doc_classes/VisualScriptComment.xml
new file mode 100644
index 0000000..ea4545f
--- /dev/null
+++ b/doc_classes/VisualScriptComment.xml
@@ -0,0 +1,71 @@
+
+
+
+ A Visual Script node used to annotate the script.
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The text inside the comment node.
+
+
+ The comment node's size (in pixels).
+
+
+ The comment node's title.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptCondition.xml b/doc_classes/VisualScriptCondition.xml
new file mode 100644
index 0000000..2a30c60
--- /dev/null
+++ b/doc_classes/VisualScriptCondition.xml
@@ -0,0 +1,24 @@
+
+
+
+ A Visual Script node which branches the flow.
+
+
+ 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/VisualScriptConstant.xml b/doc_classes/VisualScriptConstant.xml
new file mode 100644
index 0000000..51c6d19
--- /dev/null
+++ b/doc_classes/VisualScriptConstant.xml
@@ -0,0 +1,57 @@
+
+
+
+ Gets a contant's value.
+
+
+ This node returns a constant's value.
+ [b]Input Ports:[/b]
+ none
+ [b]Output Ports:[/b]
+ - Data (variant): [code]get[/code]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The constant's type.
+
+
+ The constant's value.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptConstructor.xml b/doc_classes/VisualScriptConstructor.xml
new file mode 100644
index 0000000..91df52e
--- /dev/null
+++ b/doc_classes/VisualScriptConstructor.xml
@@ -0,0 +1,69 @@
+
+
+
+ A Visual Script node which calls a base type constructor.
+
+
+ A Visual Script node which calls a base type constructor. It can be used for type conversion as well.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The constructor function's method info. Has roughly the following structure:
+ [codeblock]
+ {
+ name = "string",
+ args = [{
+ name = "string"
+ class_name = "string"
+ type = TYPE_*
+ hint = PROPERTY_HINT_*
+ hint_string = "string"
+ }]
+ default_args = [] # Array of variants
+ flags = METHOD_FLAG_*
+ id = 0
+ return = {type = TYPE_*}
+ }
+ [/codeblock]
+
+
+ The type to be constructed.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptCustomNode.xml b/doc_classes/VisualScriptCustomNode.xml
new file mode 100644
index 0000000..38c325c
--- /dev/null
+++ b/doc_classes/VisualScriptCustomNode.xml
@@ -0,0 +1,165 @@
+
+
+
+ A scripted Visual Script node.
+
+
+ A custom Visual Script node which can be scripted in powerful ways.
+
+
+
+
+
+
+
+
+
+
+ Return the node's title.
+
+
+
+
+
+
+ Return the node's category.
+
+
+
+
+
+
+ Return the count of input value ports.
+
+
+
+
+
+
+
+
+ Return the specified input port's name.
+
+
+
+
+
+
+
+
+ Return the specified input port's type. See the TYPE_* enum in [@GlobalScope].
+
+
+
+
+
+
+ Return the amount of output [b]sequence[/b] ports.
+
+
+
+
+
+
+
+
+ Return the specified [b]sequence[/b] output's name.
+
+
+
+
+
+
+ Return the amount of output value ports.
+
+
+
+
+
+
+
+
+ Return the specified output's name.
+
+
+
+
+
+
+
+
+ Return the specified output's type. See the TYPE_* enum in [@GlobalScope].
+
+
+
+
+
+
+ Return the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it).
+
+
+
+
+
+
+ Return the size of the custom node's working memory. See [method _step] for more details.
+
+
+
+
+
+
+ Return whether the custom node has an input [b]sequence[/b] port.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Execute the custom node's logic, returning the index of the output sequence port to use or a [String] when there is an error.
+
+ The [code]inputs[/code] array contains the values of the input ports.
+ [code]outputs[/code] is an array whose indices should be set to the respective outputs.
+ The [code]start_mode[/code] is usually [code]START_MODE_BEGIN_SEQUENCE[/code], unless you have used the STEP_* constants.
+ [code]working_mem[/code] is an array which can be used to persist information between runs of the custom node.
+
+ When returning, you can mask the returned value with one of the STEP_* constants.
+
+
+
+
+
+ The start mode used the first time when [method _step] is called.
+
+
+ The start mode used when [method _step] is called after coming back from a STEP_PUSH_STACK_BIT.
+
+
+ The start mode used when [method _step] is called after resuming from STEP_YIELD_BIT.
+
+
+ Hint used by [method _step] to tell that control should return to it when there is no other node left to execute.
+ This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the true/false branch has finished execution.
+
+
+ Hint used by [method _step] to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function.
+
+
+
+
+ Hint used by [method _step] to tell that control should stop and exit the function.
+
+
+ Hint used by [method _step] to tell that the function should be yielded.
+ Using this requires you to have at least one working memory slot, which is used for the [VisualScriptFunctionState].
+
+
+
diff --git a/doc_classes/VisualScriptDeconstruct.xml b/doc_classes/VisualScriptDeconstruct.xml
new file mode 100644
index 0000000..cbed3ba
--- /dev/null
+++ b/doc_classes/VisualScriptDeconstruct.xml
@@ -0,0 +1,38 @@
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The type to deconstruct.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptEmitSignal.xml b/doc_classes/VisualScriptEmitSignal.xml
new file mode 100644
index 0000000..669276f
--- /dev/null
+++ b/doc_classes/VisualScriptEmitSignal.xml
@@ -0,0 +1,40 @@
+
+
+
+ Emits a specified signal.
+
+
+ Emits a specified signal when it is executed.
+ [b]Input Ports:[/b]
+ - Sequence: [code]emit[/code]
+ [b]Output Ports:[/b]
+ - Sequence
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The signal to emit.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptEngineSingleton.xml b/doc_classes/VisualScriptEngineSingleton.xml
new file mode 100644
index 0000000..6703ff4
--- /dev/null
+++ b/doc_classes/VisualScriptEngineSingleton.xml
@@ -0,0 +1,36 @@
+
+
+
+ A Visual Script node returning a singleton from [@GlobalScope]
+
+
+ A Visual Script node returning a singleton from [@GlobalScope]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The singleton's name.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptExpression.xml b/doc_classes/VisualScriptExpression.xml
new file mode 100644
index 0000000..fb3b6ef
--- /dev/null
+++ b/doc_classes/VisualScriptExpression.xml
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptFunction.xml b/doc_classes/VisualScriptFunction.xml
new file mode 100644
index 0000000..d771696
--- /dev/null
+++ b/doc_classes/VisualScriptFunction.xml
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptFunctionCall.xml b/doc_classes/VisualScriptFunctionCall.xml
new file mode 100644
index 0000000..7a0a7c9
--- /dev/null
+++ b/doc_classes/VisualScriptFunctionCall.xml
@@ -0,0 +1,199 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptFunctionState.xml b/doc_classes/VisualScriptFunctionState.xml
new file mode 100644
index 0000000..9b30f62
--- /dev/null
+++ b/doc_classes/VisualScriptFunctionState.xml
@@ -0,0 +1,41 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptGlobalConstant.xml b/doc_classes/VisualScriptGlobalConstant.xml
new file mode 100644
index 0000000..961244f
--- /dev/null
+++ b/doc_classes/VisualScriptGlobalConstant.xml
@@ -0,0 +1,33 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptIndexGet.xml b/doc_classes/VisualScriptIndexGet.xml
new file mode 100644
index 0000000..c5229f7
--- /dev/null
+++ b/doc_classes/VisualScriptIndexGet.xml
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptIndexSet.xml b/doc_classes/VisualScriptIndexSet.xml
new file mode 100644
index 0000000..27646b4
--- /dev/null
+++ b/doc_classes/VisualScriptIndexSet.xml
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptInputAction.xml b/doc_classes/VisualScriptInputAction.xml
new file mode 100644
index 0000000..7f6d132
--- /dev/null
+++ b/doc_classes/VisualScriptInputAction.xml
@@ -0,0 +1,57 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptIterator.xml b/doc_classes/VisualScriptIterator.xml
new file mode 100644
index 0000000..fc905d6
--- /dev/null
+++ b/doc_classes/VisualScriptIterator.xml
@@ -0,0 +1,24 @@
+
+
+
+ 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
new file mode 100644
index 0000000..ff77dfa
--- /dev/null
+++ b/doc_classes/VisualScriptLocalVar.xml
@@ -0,0 +1,57 @@
+
+
+
+ Gets a local variable's value.
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The local variable's type.
+
+
+ The local variable's name.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptLocalVarSet.xml b/doc_classes/VisualScriptLocalVarSet.xml
new file mode 100644
index 0000000..07b01d4
--- /dev/null
+++ b/doc_classes/VisualScriptLocalVarSet.xml
@@ -0,0 +1,59 @@
+
+
+
+ Changes a local variable's value.
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The local variable's type.
+
+
+ The local variable's name.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptMathConstant.xml b/doc_classes/VisualScriptMathConstant.xml
new file mode 100644
index 0000000..817bcb5
--- /dev/null
+++ b/doc_classes/VisualScriptMathConstant.xml
@@ -0,0 +1,66 @@
+
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The math constant.
+
+
+
+
+ Unity: [code]1[/code]
+
+
+ Pi: [code]3.141593[/code]
+
+
+ Pi divided by two: [code]1.570796[/code]
+
+
+ Tau: [code]6.283185[/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/VisualScriptNode.xml b/doc_classes/VisualScriptNode.xml
new file mode 100644
index 0000000..f6f2867
--- /dev/null
+++ b/doc_classes/VisualScriptNode.xml
@@ -0,0 +1,62 @@
+
+
+
+ A node which is part of a [VisualScript].
+
+
+ A node which is part of a [VisualScript]. Not to be confused with [Node], which is a part of a [SceneTree].
+
+
+
+
+
+
+
+
+
+
+
+
+ Returns the default value of a given port. The default value is used when nothing is connected to the port.
+
+
+
+
+
+
+ Returns the [VisualScript] instance the node is bound to.
+
+
+
+
+
+
+ Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] .
+
+
+
+
+
+
+
+
+
+
+ Change the default value of a given port.
+
+
+
+
+
+
+
+
+
+
+ Emitted when the available input/output ports are changed.
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptOperator.xml b/doc_classes/VisualScriptOperator.xml
new file mode 100644
index 0000000..bf4032c
--- /dev/null
+++ b/doc_classes/VisualScriptOperator.xml
@@ -0,0 +1,54 @@
+
+
+
+
+
+ [b]Input Ports:[/b]
+ - Data (variant): [code]A[/code]
+ - Data (variant): [code]B[/code]
+ [b]Output Ports:[/b]
+ - Data (variant): [code]result[/code]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptPreload.xml b/doc_classes/VisualScriptPreload.xml
new file mode 100644
index 0000000..4a71e23
--- /dev/null
+++ b/doc_classes/VisualScriptPreload.xml
@@ -0,0 +1,40 @@
+
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The [Resource] to load.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptPropertyGet.xml b/doc_classes/VisualScriptPropertyGet.xml
new file mode 100644
index 0000000..eb5c52f
--- /dev/null
+++ b/doc_classes/VisualScriptPropertyGet.xml
@@ -0,0 +1,137 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptPropertySet.xml b/doc_classes/VisualScriptPropertySet.xml
new file mode 100644
index 0000000..794caa2
--- /dev/null
+++ b/doc_classes/VisualScriptPropertySet.xml
@@ -0,0 +1,177 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptResourcePath.xml b/doc_classes/VisualScriptResourcePath.xml
new file mode 100644
index 0000000..274a852
--- /dev/null
+++ b/doc_classes/VisualScriptResourcePath.xml
@@ -0,0 +1,33 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptReturn.xml b/doc_classes/VisualScriptReturn.xml
new file mode 100644
index 0000000..4ac586a
--- /dev/null
+++ b/doc_classes/VisualScriptReturn.xml
@@ -0,0 +1,58 @@
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ If [code]true[/code] the [code]return[/code] input port is available.
+
+
+ The return value's data type.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptSceneNode.xml b/doc_classes/VisualScriptSceneNode.xml
new file mode 100644
index 0000000..e8fdb69
--- /dev/null
+++ b/doc_classes/VisualScriptSceneNode.xml
@@ -0,0 +1,40 @@
+
+
+
+ Node reference.
+
+
+ A direct reference to a node.
+ [b]Input Ports:[/b]
+ none
+ [b]Output Ports:[/b]
+ - Data: [code]node[/code] (obj)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The node's path in the scene tree.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptSceneTree.xml b/doc_classes/VisualScriptSceneTree.xml
new file mode 100644
index 0000000..e74c330
--- /dev/null
+++ b/doc_classes/VisualScriptSceneTree.xml
@@ -0,0 +1,15 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptSelect.xml b/doc_classes/VisualScriptSelect.xml
new file mode 100644
index 0000000..6a62e36
--- /dev/null
+++ b/doc_classes/VisualScriptSelect.xml
@@ -0,0 +1,42 @@
+
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The input variables' type.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptSelf.xml b/doc_classes/VisualScriptSelf.xml
new file mode 100644
index 0000000..f39a02b
--- /dev/null
+++ b/doc_classes/VisualScriptSelf.xml
@@ -0,0 +1,21 @@
+
+
+
+ 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
new file mode 100644
index 0000000..5123807
--- /dev/null
+++ b/doc_classes/VisualScriptSequence.xml
@@ -0,0 +1,42 @@
+
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The number of steps in the sequence.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptSubCall.xml b/doc_classes/VisualScriptSubCall.xml
new file mode 100644
index 0000000..381095f
--- /dev/null
+++ b/doc_classes/VisualScriptSubCall.xml
@@ -0,0 +1,23 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptSwitch.xml b/doc_classes/VisualScriptSwitch.xml
new file mode 100644
index 0000000..3c8a79f
--- /dev/null
+++ b/doc_classes/VisualScriptSwitch.xml
@@ -0,0 +1,26 @@
+
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptTypeCast.xml b/doc_classes/VisualScriptTypeCast.xml
new file mode 100644
index 0000000..417c0a5
--- /dev/null
+++ b/doc_classes/VisualScriptTypeCast.xml
@@ -0,0 +1,49 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptVariableGet.xml b/doc_classes/VisualScriptVariableGet.xml
new file mode 100644
index 0000000..1cad448
--- /dev/null
+++ b/doc_classes/VisualScriptVariableGet.xml
@@ -0,0 +1,40 @@
+
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The variable's name.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptVariableSet.xml b/doc_classes/VisualScriptVariableSet.xml
new file mode 100644
index 0000000..fa3befa
--- /dev/null
+++ b/doc_classes/VisualScriptVariableSet.xml
@@ -0,0 +1,41 @@
+
+
+
+ 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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The variable's name.
+
+
+
+
+
diff --git a/doc_classes/VisualScriptWhile.xml b/doc_classes/VisualScriptWhile.xml
new file mode 100644
index 0000000..f948660
--- /dev/null
+++ b/doc_classes/VisualScriptWhile.xml
@@ -0,0 +1,23 @@
+
+
+
+ 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]
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptYield.xml b/doc_classes/VisualScriptYield.xml
new file mode 100644
index 0000000..5474ee8
--- /dev/null
+++ b/doc_classes/VisualScriptYield.xml
@@ -0,0 +1,55 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc_classes/VisualScriptYieldSignal.xml b/doc_classes/VisualScriptYieldSignal.xml
new file mode 100644
index 0000000..a3b6982
--- /dev/null
+++ b/doc_classes/VisualScriptYieldSignal.xml
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+