diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-08-24 12:05:37 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-08-24 12:08:17 +0200 |
| commit | b1f392c25e214b331f87737d9e27aad30e95f201 (patch) | |
| tree | 2a9b5071d74546fd23c28a3736f13e878f4c8bcc /modules/visual_script/doc_classes | |
| parent | 0626ce50cfd35d1eb81c6c9627f8540be9636b4b (diff) | |
Remove VisualScript module for 4.0
As announced in https://godotengine.org/article/godot-4-will-discontinue-visual-scripting,
Godot maintainers have agreed to discontinue the current implementation of
our VisualScript language.
The way it had been designed was not user-friendly enough and we did not
succeed in improving its usability to actually make it a good low-code
solution for users who need one.
So we prefer to remove it for Godot 4.0 and leave the door open for new,
innovative ideas around visual scripting, to be developed as plugins or
extensions now that Godot provides sufficient functionality for this
(notably via GDExtension and the godot-cpp C++ bindings).
The current module has been moved to a dedicated repository (with full Git
history extracted with `git filter-branch`):
https://github.com/godotengine/godot-visual-script
It can still be compiled as a C++ module (for now, but will likely require
work to be kept in sync with the engine repository), but our hope is that
contributors will port it to GDExtension (which is quite compatibile with
the existing C++ module code when using the godot-cpp C++ bindings).
Diffstat (limited to 'modules/visual_script/doc_classes')
47 files changed, 0 insertions, 1903 deletions
diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml deleted file mode 100644 index ff6b7a8b5f..0000000000 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ /dev/null @@ -1,357 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScript" inherits="Script" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A script implemented in the Visual Script programming environment. - </brief_description> - <description> - 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. - </description> - <tutorials> - <link title="VisualScript documentation index">$DOCS_URL/tutorials/scripting/visual_script/index.html</link> - </tutorials> - <methods> - <method name="add_custom_signal"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <description> - Add a custom signal with the specified name to the VisualScript. - </description> - </method> - <method name="add_function"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="func_node_id" type="int" /> - <description> - Add a function with the specified name to the VisualScript, and assign the root [VisualScriptFunction] node's id as [code]func_node_id[/code]. - </description> - </method> - <method name="add_node"> - <return type="void" /> - <param index="0" name="id" type="int" /> - <param index="1" name="node" type="VisualScriptNode" /> - <param index="2" name="position" type="Vector2" default="Vector2(0, 0)" /> - <description> - Add a node to the VisualScript. - </description> - </method> - <method name="add_variable"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="default_value" type="Variant" default="null" /> - <param index="2" name="export" type="bool" default="false" /> - <description> - Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. - </description> - </method> - <method name="custom_signal_add_argument"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="type" type="int" enum="Variant.Type" /> - <param index="2" name="argname" type="String" /> - <param index="3" name="index" type="int" default="-1" /> - <description> - Add an argument to a custom signal added with [method add_custom_signal]. - </description> - </method> - <method name="custom_signal_get_argument_count" qualifiers="const"> - <return type="int" /> - <param index="0" name="name" type="StringName" /> - <description> - Get the count of a custom signal's arguments. - </description> - </method> - <method name="custom_signal_get_argument_name" qualifiers="const"> - <return type="String" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="argidx" type="int" /> - <description> - Get the name of a custom signal's argument. - </description> - </method> - <method name="custom_signal_get_argument_type" qualifiers="const"> - <return type="int" enum="Variant.Type" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="argidx" type="int" /> - <description> - Get the type of a custom signal's argument. - </description> - </method> - <method name="custom_signal_remove_argument"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="argidx" type="int" /> - <description> - Remove a specific custom signal's argument. - </description> - </method> - <method name="custom_signal_set_argument_name"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="argidx" type="int" /> - <param index="2" name="argname" type="String" /> - <description> - Rename a custom signal's argument. - </description> - </method> - <method name="custom_signal_set_argument_type"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="argidx" type="int" /> - <param index="2" name="type" type="int" enum="Variant.Type" /> - <description> - Change the type of a custom signal's argument. - </description> - </method> - <method name="custom_signal_swap_argument"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="argidx" type="int" /> - <param index="2" name="withidx" type="int" /> - <description> - Swap two of the arguments of a custom signal. - </description> - </method> - <method name="data_connect"> - <return type="void" /> - <param index="0" name="from_node" type="int" /> - <param index="1" name="from_port" type="int" /> - <param index="2" name="to_node" type="int" /> - <param index="3" name="to_port" type="int" /> - <description> - 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]. - </description> - </method> - <method name="data_disconnect"> - <return type="void" /> - <param index="0" name="from_node" type="int" /> - <param index="1" name="from_port" type="int" /> - <param index="2" name="to_node" type="int" /> - <param index="3" name="to_port" type="int" /> - <description> - Disconnect two data ports previously connected with [method data_connect]. - </description> - </method> - <method name="get_function_node_id" qualifiers="const"> - <return type="int" /> - <param index="0" name="name" type="StringName" /> - <description> - Returns the id of a function's entry point node. - </description> - </method> - <method name="get_node" qualifiers="const"> - <return type="VisualScriptNode" /> - <param index="0" name="id" type="int" /> - <description> - Returns a node given its id. - </description> - </method> - <method name="get_node_position" qualifiers="const"> - <return type="Vector2" /> - <param index="0" name="id" type="int" /> - <description> - Returns a node's position in pixels. - </description> - </method> - <method name="get_scroll" qualifiers="const"> - <return type="Vector2" /> - <description> - Returns the current position of the center of the screen. - </description> - </method> - <method name="get_variable_default_value" qualifiers="const"> - <return type="Variant" /> - <param index="0" name="name" type="StringName" /> - <description> - Returns the default (initial) value of a variable. - </description> - </method> - <method name="get_variable_export" qualifiers="const"> - <return type="bool" /> - <param index="0" name="name" type="StringName" /> - <description> - Returns whether a variable is exported. - </description> - </method> - <method name="get_variable_info" qualifiers="const"> - <return type="Dictionary" /> - <param index="0" name="name" type="StringName" /> - <description> - Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. - </description> - </method> - <method name="has_custom_signal" qualifiers="const"> - <return type="bool" /> - <param index="0" name="name" type="StringName" /> - <description> - Returns whether a signal exists with the specified name. - </description> - </method> - <method name="has_data_connection" qualifiers="const"> - <return type="bool" /> - <param index="0" name="from_node" type="int" /> - <param index="1" name="from_port" type="int" /> - <param index="2" name="to_node" type="int" /> - <param index="3" name="to_port" type="int" /> - <description> - Returns whether the specified data ports are connected. - </description> - </method> - <method name="has_function" qualifiers="const"> - <return type="bool" /> - <param index="0" name="name" type="StringName" /> - <description> - Returns whether a function exists with the specified name. - </description> - </method> - <method name="has_node" qualifiers="const"> - <return type="bool" /> - <param index="0" name="id" type="int" /> - <description> - Returns whether a node exists with the given id. - </description> - </method> - <method name="has_sequence_connection" qualifiers="const"> - <return type="bool" /> - <param index="0" name="from_node" type="int" /> - <param index="1" name="from_output" type="int" /> - <param index="2" name="to_node" type="int" /> - <description> - Returns whether the specified sequence ports are connected. - </description> - </method> - <method name="has_variable" qualifiers="const"> - <return type="bool" /> - <param index="0" name="name" type="StringName" /> - <description> - Returns whether a variable exists with the specified name. - </description> - </method> - <method name="remove_custom_signal"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <description> - Remove a custom signal with the given name. - </description> - </method> - <method name="remove_function"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <description> - Remove a specific function and its nodes from the script. - </description> - </method> - <method name="remove_node"> - <return type="void" /> - <param index="0" name="id" type="int" /> - <description> - Remove the node with the specified id. - </description> - </method> - <method name="remove_variable"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <description> - Remove a variable with the given name. - </description> - </method> - <method name="rename_custom_signal"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="new_name" type="StringName" /> - <description> - Change the name of a custom signal. - </description> - </method> - <method name="rename_function"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="new_name" type="StringName" /> - <description> - Change the name of a function. - </description> - </method> - <method name="rename_variable"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="new_name" type="StringName" /> - <description> - Change the name of a variable. - </description> - </method> - <method name="sequence_connect"> - <return type="void" /> - <param index="0" name="from_node" type="int" /> - <param index="1" name="from_output" type="int" /> - <param index="2" name="to_node" type="int" /> - <description> - 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. - </description> - </method> - <method name="sequence_disconnect"> - <return type="void" /> - <param index="0" name="from_node" type="int" /> - <param index="1" name="from_output" type="int" /> - <param index="2" name="to_node" type="int" /> - <description> - Disconnect two sequence ports previously connected with [method sequence_connect]. - </description> - </method> - <method name="set_instance_base_type"> - <return type="void" /> - <param index="0" name="type" type="StringName" /> - <description> - Set the base type of the script. - </description> - </method> - <method name="set_node_position"> - <return type="void" /> - <param index="0" name="id" type="int" /> - <param index="1" name="position" type="Vector2" /> - <description> - Set the node position in the VisualScript graph. - </description> - </method> - <method name="set_scroll"> - <return type="void" /> - <param index="0" name="offset" type="Vector2" /> - <description> - Set the screen center to the given position. - </description> - </method> - <method name="set_variable_default_value"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="value" type="Variant" /> - <description> - Change the default (initial) value of a variable. - </description> - </method> - <method name="set_variable_export"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="enable" type="bool" /> - <description> - Change whether a variable is exported. - </description> - </method> - <method name="set_variable_info"> - <return type="void" /> - <param index="0" name="name" type="StringName" /> - <param index="1" name="value" type="Dictionary" /> - <description> - Set a variable's info, using the same format as [method get_variable_info]. - </description> - </method> - </methods> - <signals> - <signal name="node_ports_changed"> - <param index="0" name="id" type="int" /> - <description> - Emitted when the ports of a node are changed. - </description> - </signal> - </signals> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml b/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml deleted file mode 100644 index 0ed66f44e1..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptBasicTypeConstant.xml +++ /dev/null @@ -1,19 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptBasicTypeConstant" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node representing a constant from the base types. - </brief_description> - <description> - A Visual Script node representing a constant from base types, such as [constant Vector3.AXIS_X]. - </description> - <tutorials> - </tutorials> - <members> - <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type" default="0"> - The type to get the constant from. - </member> - <member name="constant" type="StringName" setter="set_basic_type_constant" getter="get_basic_type_constant"> - The name of the constant to return. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml deleted file mode 100644 index 647b627d25..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml +++ /dev/null @@ -1,221 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptBuiltinFunc" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node used to call built-in functions. - </brief_description> - <description> - 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. - </description> - <tutorials> - </tutorials> - <members> - <member name="function" type="int" setter="set_func" getter="get_func" enum="VisualScriptBuiltinFunc.BuiltinFunc" default="0"> - The function to be executed. - </member> - </members> - <constants> - <constant name="MATH_SIN" value="0" enum="BuiltinFunc"> - Returns the sine of the input. - </constant> - <constant name="MATH_COS" value="1" enum="BuiltinFunc"> - Returns the cosine of the input. - </constant> - <constant name="MATH_TAN" value="2" enum="BuiltinFunc"> - Returns the tangent of the input. - </constant> - <constant name="MATH_SINH" value="3" enum="BuiltinFunc"> - Returns the hyperbolic sine of the input. - </constant> - <constant name="MATH_COSH" value="4" enum="BuiltinFunc"> - Returns the hyperbolic cosine of the input. - </constant> - <constant name="MATH_TANH" value="5" enum="BuiltinFunc"> - Returns the hyperbolic tangent of the input. - </constant> - <constant name="MATH_ASIN" value="6" enum="BuiltinFunc"> - Returns the arc sine of the input. - </constant> - <constant name="MATH_ACOS" value="7" enum="BuiltinFunc"> - Returns the arc cosine of the input. - </constant> - <constant name="MATH_ATAN" value="8" enum="BuiltinFunc"> - Returns the arc tangent of the input. - </constant> - <constant name="MATH_ATAN2" value="9" enum="BuiltinFunc"> - Returns the arc tangent of the input, using the signs of both parameters to determine the exact angle. - </constant> - <constant name="MATH_SQRT" value="10" enum="BuiltinFunc"> - Returns the square root of the input. - </constant> - <constant name="MATH_FMOD" value="11" enum="BuiltinFunc"> - Returns the remainder of one input divided by the other, using floating-point numbers. - </constant> - <constant name="MATH_FPOSMOD" value="12" enum="BuiltinFunc"> - Returns the positive remainder of one input divided by the other, using floating-point numbers. - </constant> - <constant name="MATH_FLOOR" value="13" enum="BuiltinFunc"> - Returns the input rounded down. - </constant> - <constant name="MATH_CEIL" value="14" enum="BuiltinFunc"> - Returns the input rounded up. - </constant> - <constant name="MATH_ROUND" value="15" enum="BuiltinFunc"> - Returns the input rounded to the nearest integer. - </constant> - <constant name="MATH_ABS" value="16" enum="BuiltinFunc"> - Returns the absolute value of the input. - </constant> - <constant name="MATH_SIGN" value="17" enum="BuiltinFunc"> - Returns the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative. - </constant> - <constant name="MATH_POW" value="18" enum="BuiltinFunc"> - Returns the input raised to a given power. - </constant> - <constant name="MATH_LOG" value="19" enum="BuiltinFunc"> - Returns the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use. - </constant> - <constant name="MATH_EXP" value="20" enum="BuiltinFunc"> - Returns the mathematical constant [b]e[/b] raised to the specified power of the input. [b]e[/b] has an approximate value of 2.71828. - </constant> - <constant name="MATH_ISNAN" value="21" enum="BuiltinFunc"> - Returns whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist. - </constant> - <constant name="MATH_ISINF" value="22" enum="BuiltinFunc"> - Returns 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. - </constant> - <constant name="MATH_EASE" value="23" enum="BuiltinFunc"> - 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. - </constant> - <constant name="MATH_STEP_DECIMALS" value="24" enum="BuiltinFunc"> - Returns the number of digit places after the decimal that the first non-zero digit occurs. - </constant> - <constant name="MATH_SNAPPED" value="25" enum="BuiltinFunc"> - Returns the input snapped to a given step. - </constant> - <constant name="MATH_LERP" value="26" enum="BuiltinFunc"> - Returns a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. - </constant> - <constant name="MATH_CUBIC_INTERPOLATE" value="27" enum="BuiltinFunc"> - </constant> - <constant name="MATH_INVERSE_LERP" value="28" enum="BuiltinFunc"> - </constant> - <constant name="MATH_RANGE_LERP" value="29" enum="BuiltinFunc"> - </constant> - <constant name="MATH_MOVE_TOWARD" value="30" enum="BuiltinFunc"> - Moves the number toward a value, based on the third input. - </constant> - <constant name="MATH_RANDOMIZE" value="31" enum="BuiltinFunc"> - Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. - </constant> - <constant name="MATH_RANDI" value="32" enum="BuiltinFunc"> - Returns 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. - </constant> - <constant name="MATH_RANDF" value="33" enum="BuiltinFunc"> - Returns a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. - </constant> - <constant name="MATH_RANDI_RANGE" value="34" enum="BuiltinFunc"> - Returns a random 32-bit integer value between the two inputs. - </constant> - <constant name="MATH_RANDF_RANGE" value="35" enum="BuiltinFunc"> - Returns a random floating-point value between the two inputs. - </constant> - <constant name="MATH_RANDFN" value="36" enum="BuiltinFunc"> - Returns a normally-distributed pseudo-random number, using Box-Muller transform with the specified mean and a standard deviation. This is also called Gaussian distribution. - </constant> - <constant name="MATH_SEED" value="37" enum="BuiltinFunc"> - Set the seed for the random number generator. - </constant> - <constant name="MATH_RANDSEED" value="38" enum="BuiltinFunc"> - Returns a random value from the given seed, along with the new seed. - </constant> - <constant name="MATH_DEG2RAD" value="39" enum="BuiltinFunc"> - Convert the input from degrees to radians. - </constant> - <constant name="MATH_RAD2DEG" value="40" enum="BuiltinFunc"> - Convert the input from radians to degrees. - </constant> - <constant name="MATH_LINEAR2DB" value="41" enum="BuiltinFunc"> - Convert the input from linear volume to decibel volume. - </constant> - <constant name="MATH_DB2LINEAR" value="42" enum="BuiltinFunc"> - Convert the input from decibel volume to linear volume. - </constant> - <constant name="MATH_WRAP" value="43" enum="BuiltinFunc"> - </constant> - <constant name="MATH_WRAPF" value="44" enum="BuiltinFunc"> - </constant> - <constant name="MATH_PINGPONG" value="45" enum="BuiltinFunc"> - Returns the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive. - </constant> - <constant name="LOGIC_MAX" value="46" enum="BuiltinFunc"> - Returns the greater of the two numbers, also known as their maximum. - </constant> - <constant name="LOGIC_MIN" value="47" enum="BuiltinFunc"> - Returns the lesser of the two numbers, also known as their minimum. - </constant> - <constant name="LOGIC_CLAMP" value="48" enum="BuiltinFunc"> - Returns the input clamped inside the given range, ensuring the result is never outside it. Equivalent to [code]min(max(input, range_low), range_high)[/code]. - </constant> - <constant name="LOGIC_NEAREST_PO2" value="49" enum="BuiltinFunc"> - Returns the nearest power of 2 to the input. - </constant> - <constant name="OBJ_WEAKREF" value="50" enum="BuiltinFunc"> - Create a [WeakRef] from the input. - </constant> - <constant name="TYPE_CONVERT" value="51" enum="BuiltinFunc"> - Convert between types. - </constant> - <constant name="TYPE_OF" value="52" enum="BuiltinFunc"> - Returns the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. - </constant> - <constant name="TYPE_EXISTS" value="53" enum="BuiltinFunc"> - Checks if a type is registered in the [ClassDB]. - </constant> - <constant name="TEXT_CHAR" value="54" enum="BuiltinFunc"> - Returns a character with the given ascii value. - </constant> - <constant name="TEXT_STR" value="55" enum="BuiltinFunc"> - Convert the input to a string. - </constant> - <constant name="TEXT_PRINT" value="56" enum="BuiltinFunc"> - Print the given string to the output window. - </constant> - <constant name="TEXT_PRINTERR" value="57" enum="BuiltinFunc"> - Print the given string to the standard error output. - </constant> - <constant name="TEXT_PRINTRAW" value="58" enum="BuiltinFunc"> - Print the given string to the standard output, without adding a newline. - </constant> - <constant name="TEXT_PRINT_VERBOSE" value="59" enum="BuiltinFunc"> - </constant> - <constant name="VAR_TO_STR" value="60" enum="BuiltinFunc"> - Serialize a [Variant] to a string. - </constant> - <constant name="STR_TO_VAR" value="61" enum="BuiltinFunc"> - Deserialize a [Variant] from a string serialized using [constant VAR_TO_STR]. - </constant> - <constant name="VAR_TO_BYTES" value="62" enum="BuiltinFunc"> - Serialize a [Variant] to a [PackedByteArray]. - </constant> - <constant name="BYTES_TO_VAR" value="63" enum="BuiltinFunc"> - Deserialize a [Variant] from a [PackedByteArray] serialized using [constant VAR_TO_BYTES]. - </constant> - <constant name="MATH_SMOOTHSTEP" value="64" enum="BuiltinFunc"> - Returns a number smoothly interpolated between the first two inputs, based on the third input. Similar to [constant MATH_LERP], but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula: - [codeblock] - var t = clamp((weight - from) / (to - from), 0.0, 1.0) - return t * t * (3.0 - 2.0 * t) - [/codeblock] - </constant> - <constant name="MATH_POSMOD" value="65" enum="BuiltinFunc"> - </constant> - <constant name="MATH_LERP_ANGLE" value="66" enum="BuiltinFunc"> - </constant> - <constant name="TEXT_ORD" value="67" enum="BuiltinFunc"> - </constant> - <constant name="FUNC_MAX" value="68" enum="BuiltinFunc"> - Represents the size of the [enum BuiltinFunc] enum. - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptClassConstant.xml b/modules/visual_script/doc_classes/VisualScriptClassConstant.xml deleted file mode 100644 index 2509084f0e..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptClassConstant.xml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptClassConstant" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Gets a constant from a given class. - </brief_description> - <description> - This node returns a constant from a given class, such as [constant TYPE_INT]. See the given class' documentation for available constants. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]value[/code] - </description> - <tutorials> - </tutorials> - <members> - <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&"Object""> - The constant's parent class. - </member> - <member name="constant" type="StringName" setter="set_class_constant" getter="get_class_constant" default="&"""> - The constant to return. See the given class for its available constants. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptComment.xml b/modules/visual_script/doc_classes/VisualScriptComment.xml deleted file mode 100644 index cf4b57ca19..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptComment.xml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptComment" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node used to annotate the script. - </brief_description> - <description> - 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. - </description> - <tutorials> - </tutorials> - <members> - <member name="description" type="String" setter="set_description" getter="get_description" default=""""> - The text inside the comment node. - </member> - <member name="size" type="Vector2" setter="set_size" getter="get_size" default="Vector2(150, 150)"> - The comment node's size (in pixels). - </member> - <member name="title" type="String" setter="set_title" getter="get_title" default=""Comment""> - The comment node's title. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptComposeArray.xml b/modules/visual_script/doc_classes/VisualScriptComposeArray.xml deleted file mode 100644 index ea73867c4b..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptComposeArray.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptComposeArray" inherits="VisualScriptLists" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script Node used to create array from a list of items. - </brief_description> - <description> - A Visual Script Node used to compose array from the list of elements provided with custom in-graph UI hard coded in the VisualScript Editor. - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptCondition.xml b/modules/visual_script/doc_classes/VisualScriptCondition.xml deleted file mode 100644 index a29388569f..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptCondition.xml +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptCondition" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node which branches the flow. - </brief_description> - <description> - 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] - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptConstant.xml b/modules/visual_script/doc_classes/VisualScriptConstant.xml deleted file mode 100644 index 645ede9001..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptConstant.xml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptConstant" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Gets a contant's value. - </brief_description> - <description> - This node returns a constant's value. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]get[/code] - </description> - <tutorials> - </tutorials> - <members> - <member name="type" type="int" setter="set_constant_type" getter="get_constant_type" enum="Variant.Type" default="0"> - The constant's type. - </member> - <member name="value" type="Variant" setter="set_constant_value" getter="get_constant_value"> - The constant's value. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptConstructor.xml b/modules/visual_script/doc_classes/VisualScriptConstructor.xml deleted file mode 100644 index a003f21ab9..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptConstructor.xml +++ /dev/null @@ -1,35 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptConstructor" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node which calls a base type constructor. - </brief_description> - <description> - A Visual Script node which calls a base type constructor. It can be used for type conversion as well. - </description> - <tutorials> - </tutorials> - <methods> - <method name="get_constructor" qualifiers="const"> - <return type="Dictionary" /> - <description> - </description> - </method> - <method name="get_constructor_type" qualifiers="const"> - <return type="int" enum="Variant.Type" /> - <description> - </description> - </method> - <method name="set_constructor"> - <return type="void" /> - <param index="0" name="constructor" type="Dictionary" /> - <description> - </description> - </method> - <method name="set_constructor_type"> - <return type="void" /> - <param index="0" name="type" type="int" enum="Variant.Type" /> - <description> - </description> - </method> - </methods> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml deleted file mode 100644 index 6e522b2f84..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ /dev/null @@ -1,166 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptCustomNode" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A scripted Visual Script node. - </brief_description> - <description> - A custom Visual Script node which can be scripted in powerful ways. - </description> - <tutorials> - </tutorials> - <methods> - <method name="_get_caption" qualifiers="virtual const"> - <return type="String" /> - <description> - Returns the node's title. - </description> - </method> - <method name="_get_category" qualifiers="virtual const"> - <return type="String" /> - <description> - Returns the node's category. - </description> - </method> - <method name="_get_input_value_port_count" qualifiers="virtual const"> - <return type="int" /> - <description> - Returns the count of input value ports. - </description> - </method> - <method name="_get_input_value_port_hint" qualifiers="virtual const"> - <return type="int" /> - <param index="0" name="input_idx" type="int" /> - <description> - Returns the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. - </description> - </method> - <method name="_get_input_value_port_hint_string" qualifiers="virtual const"> - <return type="String" /> - <param index="0" name="input_idx" type="int" /> - <description> - Returns the specified input port's hint string. - </description> - </method> - <method name="_get_input_value_port_name" qualifiers="virtual const"> - <return type="String" /> - <param index="0" name="input_idx" type="int" /> - <description> - Returns the specified input port's name. - </description> - </method> - <method name="_get_input_value_port_type" qualifiers="virtual const"> - <return type="int" /> - <param index="0" name="input_idx" type="int" /> - <description> - Returns the specified input port's type. See the [enum Variant.Type] values. - </description> - </method> - <method name="_get_output_sequence_port_count" qualifiers="virtual const"> - <return type="int" /> - <description> - Returns the amount of output [b]sequence[/b] ports. - </description> - </method> - <method name="_get_output_sequence_port_text" qualifiers="virtual const"> - <return type="String" /> - <param index="0" name="seq_idx" type="int" /> - <description> - Returns the specified [b]sequence[/b] output's name. - </description> - </method> - <method name="_get_output_value_port_count" qualifiers="virtual const"> - <return type="int" /> - <description> - Returns the amount of output value ports. - </description> - </method> - <method name="_get_output_value_port_hint" qualifiers="virtual const"> - <return type="int" /> - <param index="0" name="output_idx" type="int" /> - <description> - Returns the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. - </description> - </method> - <method name="_get_output_value_port_hint_string" qualifiers="virtual const"> - <return type="String" /> - <param index="0" name="output_idx" type="int" /> - <description> - Returns the specified output port's hint string. - </description> - </method> - <method name="_get_output_value_port_name" qualifiers="virtual const"> - <return type="String" /> - <param index="0" name="output_idx" type="int" /> - <description> - Returns the specified output port's name. - </description> - </method> - <method name="_get_output_value_port_type" qualifiers="virtual const"> - <return type="int" /> - <param index="0" name="output_idx" type="int" /> - <description> - Returns the specified output port's type. See the [enum Variant.Type] values. - </description> - </method> - <method name="_get_text" qualifiers="virtual const"> - <return type="String" /> - <description> - Returns 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). - </description> - </method> - <method name="_get_working_memory_size" qualifiers="virtual const"> - <return type="int" /> - <description> - Returns the size of the custom node's working memory. See [method _step] for more details. - </description> - </method> - <method name="_has_input_sequence_port" qualifiers="virtual const"> - <return type="bool" /> - <description> - Returns whether the custom node has an input [b]sequence[/b] port. - </description> - </method> - <method name="_step" qualifiers="virtual const"> - <return type="Variant" /> - <param index="0" name="inputs" type="Array" /> - <param index="1" name="outputs" type="Array" /> - <param index="2" name="start_mode" type="int" /> - <param index="3" name="working_mem" type="Array" /> - <description> - 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 [constant START_MODE_BEGIN_SEQUENCE], unless you have used the [code]STEP_*[/code] constants. - [code]working_mem[/code] is an array which can be used to persist information between runs of the custom node. The size needs to be predefined using [method _get_working_memory_size]. - When returning, you can mask the returned value with one of the [code]STEP_*[/code] constants. - </description> - </method> - </methods> - <constants> - <constant name="START_MODE_BEGIN_SEQUENCE" value="0" enum="StartMode"> - The start mode used the first time when [method _step] is called. - </constant> - <constant name="START_MODE_CONTINUE_SEQUENCE" value="1" enum="StartMode"> - The start mode used when [method _step] is called after coming back from a [constant STEP_PUSH_STACK_BIT]. - </constant> - <constant name="START_MODE_RESUME_YIELD" value="2" enum="StartMode"> - The start mode used when [method _step] is called after resuming from [constant STEP_YIELD_BIT]. - </constant> - <constant name="STEP_PUSH_STACK_BIT" value="16777216"> - 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 [code]true[/code]/[code]false[/code] branch has finished execution. - </constant> - <constant name="STEP_GO_BACK_BIT" value="33554432"> - Hint used by [method _step] to tell that control should return back, either hitting a previous [constant STEP_PUSH_STACK_BIT] or exiting the function. - </constant> - <constant name="STEP_NO_ADVANCE_BIT" value="67108864"> - </constant> - <constant name="STEP_EXIT_FUNCTION_BIT" value="134217728"> - Hint used by [method _step] to tell that control should stop and exit the function. - </constant> - <constant name="STEP_YIELD_BIT" value="268435456"> - 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]. - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml b/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml deleted file mode 100644 index 48d7975051..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml +++ /dev/null @@ -1,37 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptCustomNodes" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Manages custom nodes for the Visual Script editor. - </brief_description> - <description> - This singleton can be used to manage (i.e., add or remove) custom nodes for the Visual Script editor. - </description> - <tutorials> - </tutorials> - <methods> - <method name="add_custom_node"> - <return type="void" /> - <param index="0" name="name" type="String" /> - <param index="1" name="category" type="String" /> - <param index="2" name="script" type="Script" /> - <description> - Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter. - </description> - </method> - <method name="remove_custom_node"> - <return type="void" /> - <param index="0" name="name" type="String" /> - <param index="1" name="category" type="String" /> - <description> - Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. - </description> - </method> - </methods> - <signals> - <signal name="custom_nodes_updated"> - <description> - Emitted when a custom Visual Script node is added or removed. - </description> - </signal> - </signals> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml b/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml deleted file mode 100644 index b544fd9d90..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptDeconstruct.xml +++ /dev/null @@ -1,16 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptDeconstruct" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node which deconstructs a base type instance into its parts. - </brief_description> - <description> - A Visual Script node which deconstructs a base type instance into its parts. - </description> - <tutorials> - </tutorials> - <members> - <member name="type" type="int" setter="set_deconstruct_type" getter="get_deconstruct_type" enum="Variant.Type" default="0"> - The type to deconstruct. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml b/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml deleted file mode 100644 index c0cefa0ab7..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptEmitSignal.xml +++ /dev/null @@ -1,20 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptEmitSignal" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Emits a specified signal. - </brief_description> - <description> - Emits a specified signal when it is executed. - [b]Input Ports:[/b] - - Sequence: [code]emit[/code] - [b]Output Ports:[/b] - - Sequence - </description> - <tutorials> - </tutorials> - <members> - <member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="&"""> - The signal to emit. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml b/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml deleted file mode 100644 index f60a048845..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptEngineSingleton.xml +++ /dev/null @@ -1,16 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptEngineSingleton" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node returning a singleton from [@GlobalScope]. - </brief_description> - <description> - A Visual Script node returning a singleton from [@GlobalScope]. - </description> - <tutorials> - </tutorials> - <members> - <member name="constant" type="String" setter="set_singleton" getter="get_singleton" default=""""> - The singleton's name. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptExpression.xml b/modules/visual_script/doc_classes/VisualScriptExpression.xml deleted file mode 100644 index 14750e7c8d..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptExpression.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptExpression" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node that can execute a custom expression. - </brief_description> - <description> - A Visual Script node that can execute a custom expression. Values can be provided for the input and the expression result can be retrieved from the output. - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptFunction.xml b/modules/visual_script/doc_classes/VisualScriptFunction.xml deleted file mode 100644 index 74d9f194eb..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptFunction.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptFunction" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node representing a function. - </brief_description> - <description> - [VisualScriptFunction] represents a function header. It is the starting point for the function body and can be used to tweak the function's properties (e.g. RPC mode). - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml b/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml deleted file mode 100644 index 543263ff8e..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptFunctionCall.xml +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptFunctionCall" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node for calling a function. - </brief_description> - <description> - [VisualScriptFunctionCall] is created when you add or drag and drop a function onto the Visual Script graph. It allows to tweak parameters of the call, e.g. what object the function is called on. - </description> - <tutorials> - </tutorials> - <members> - <member name="base_script" type="String" setter="set_base_script" getter="get_base_script"> - The script to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE]. - </member> - <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&"Object""> - The base type to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE]. - </member> - <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type"> - The type to be used when [member call_mode] is set to [constant CALL_MODE_BASIC_TYPE]. - </member> - <member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptFunctionCall.CallMode" default="0"> - [code]call_mode[/code] determines the target object on which the method will be called. See [enum CallMode] for options. - </member> - <member name="function" type="StringName" setter="set_function" getter="get_function" default="&"""> - The name of the function to be called. - </member> - <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> - The node path to use when [member call_mode] is set to [constant CALL_MODE_NODE_PATH]. - </member> - <member name="rpc_call_mode" type="int" setter="set_rpc_call_mode" getter="get_rpc_call_mode" enum="VisualScriptFunctionCall.RPCCallMode" default="0"> - The mode for RPC calls. See [method Node.rpc] for more details and [enum RPCCallMode] for available options. - </member> - <member name="singleton" type="StringName" setter="set_singleton" getter="get_singleton"> - The singleton to call the method on. Used when [member call_mode] is set to [constant CALL_MODE_SINGLETON]. - </member> - <member name="use_default_args" type="int" setter="set_use_default_args" getter="get_use_default_args"> - Number of default arguments that will be used when calling the function. Can't be higher than the number of available default arguments in the method's declaration. - </member> - <member name="validate" type="bool" setter="set_validate" getter="get_validate" default="true"> - If [code]false[/code], call errors (e.g. wrong number of arguments) will be ignored. - </member> - </members> - <constants> - <constant name="CALL_MODE_SELF" value="0" enum="CallMode"> - The method will be called on this [Object]. - </constant> - <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode"> - The method will be called on the given [Node] in the scene tree. - </constant> - <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode"> - The method will be called on an instanced node with the given type and script. - </constant> - <constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode"> - The method will be called on a GDScript basic type (e.g. [Vector2]). - </constant> - <constant name="CALL_MODE_SINGLETON" value="4" enum="CallMode"> - The method will be called on a singleton. - </constant> - <constant name="RPC_DISABLED" value="0" enum="RPCCallMode"> - The method will be called locally. - </constant> - <constant name="RPC_RELIABLE" value="1" enum="RPCCallMode"> - The method will be called remotely. - </constant> - <constant name="RPC_UNRELIABLE" value="2" enum="RPCCallMode"> - The method will be called remotely using an unreliable protocol. - </constant> - <constant name="RPC_RELIABLE_TO_ID" value="3" enum="RPCCallMode"> - The method will be called remotely for the given peer. - </constant> - <constant name="RPC_UNRELIABLE_TO_ID" value="4" enum="RPCCallMode"> - The method will be called remotely for the given peer, using an unreliable protocol. - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml deleted file mode 100644 index 03fef9c13b..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml +++ /dev/null @@ -1,35 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptFunctionState" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node representing a function state. - </brief_description> - <description> - [VisualScriptFunctionState] is returned from [VisualScriptYield] and can be used to resume a paused function call. - </description> - <tutorials> - </tutorials> - <methods> - <method name="connect_to_signal"> - <return type="void" /> - <param index="0" name="obj" type="Object" /> - <param index="1" name="signals" type="String" /> - <param index="2" name="args" type="Array" /> - <description> - Connects this [VisualScriptFunctionState] to a signal in the given object to automatically resume when it's emitted. - </description> - </method> - <method name="is_valid" qualifiers="const"> - <return type="bool" /> - <description> - Returns whether the function state is valid. - </description> - </method> - <method name="resume"> - <return type="Variant" /> - <param index="0" name="args" type="Array" default="[]" /> - <description> - Resumes the function to run from the point it was yielded. - </description> - </method> - </methods> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml b/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml deleted file mode 100644 index 42ada99257..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptGlobalConstant.xml +++ /dev/null @@ -1,16 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptGlobalConstant" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node returning a constant from [@GlobalScope]. - </brief_description> - <description> - A Visual Script node returning a constant from [@GlobalScope]. - </description> - <tutorials> - </tutorials> - <members> - <member name="constant" type="int" setter="set_global_constant" getter="get_global_constant" default="0"> - The constant to be used. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptIndexGet.xml b/modules/visual_script/doc_classes/VisualScriptIndexGet.xml deleted file mode 100644 index 8828bf9039..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptIndexGet.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptIndexGet" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node for getting a value from an array or a dictionary. - </brief_description> - <description> - [VisualScriptIndexGet] will return the value stored in an array or a dictionary under the given index. - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptIndexSet.xml b/modules/visual_script/doc_classes/VisualScriptIndexSet.xml deleted file mode 100644 index 5c81dcd339..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptIndexSet.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptIndexSet" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node for setting a value in an array or a dictionary. - </brief_description> - <description> - [VisualScriptIndexSet] will set the value stored in an array or a dictionary under the given index to the provided new value. - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptInputAction.xml b/modules/visual_script/doc_classes/VisualScriptInputAction.xml deleted file mode 100644 index 51c2eaf353..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptInputAction.xml +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptInputAction" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node returning a state of an action. - </brief_description> - <description> - [VisualScriptInputAction] can be used to check if an action is pressed or released. - </description> - <tutorials> - </tutorials> - <members> - <member name="action" type="StringName" setter="set_action_name" getter="get_action_name" default="&"""> - Name of the action. - </member> - <member name="mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="VisualScriptInputAction.Mode" default="0"> - State of the action to check. See [enum Mode] for options. - </member> - </members> - <constants> - <constant name="MODE_PRESSED" value="0" enum="Mode"> - [code]True[/code] if action is pressed. - </constant> - <constant name="MODE_RELEASED" value="1" enum="Mode"> - [code]True[/code] if action is released (i.e. not pressed). - </constant> - <constant name="MODE_JUST_PRESSED" value="2" enum="Mode"> - [code]True[/code] on the frame the action was pressed. - </constant> - <constant name="MODE_JUST_RELEASED" value="3" enum="Mode"> - [code]True[/code] on the frame the action was released. - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptIterator.xml b/modules/visual_script/doc_classes/VisualScriptIterator.xml deleted file mode 100644 index ef6846deba..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptIterator.xml +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptIterator" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Steps through items in a given input. - </brief_description> - <description> - 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] - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptLists.xml b/modules/visual_script/doc_classes/VisualScriptLists.xml deleted file mode 100644 index 607965bf71..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptLists.xml +++ /dev/null @@ -1,77 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptLists" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script virtual class for in-graph editable nodes. - </brief_description> - <description> - A Visual Script virtual class that defines the shape and the default behavior of the nodes that have to be in-graph editable nodes. - </description> - <tutorials> - </tutorials> - <methods> - <method name="add_input_data_port"> - <return type="void" /> - <param index="0" name="type" type="int" enum="Variant.Type" /> - <param index="1" name="name" type="String" /> - <param index="2" name="index" type="int" /> - <description> - Adds an input port to the Visual Script node. - </description> - </method> - <method name="add_output_data_port"> - <return type="void" /> - <param index="0" name="type" type="int" enum="Variant.Type" /> - <param index="1" name="name" type="String" /> - <param index="2" name="index" type="int" /> - <description> - Adds an output port to the Visual Script node. - </description> - </method> - <method name="remove_input_data_port"> - <return type="void" /> - <param index="0" name="index" type="int" /> - <description> - Removes an input port from the Visual Script node. - </description> - </method> - <method name="remove_output_data_port"> - <return type="void" /> - <param index="0" name="index" type="int" /> - <description> - Removes an output port from the Visual Script node. - </description> - </method> - <method name="set_input_data_port_name"> - <return type="void" /> - <param index="0" name="index" type="int" /> - <param index="1" name="name" type="String" /> - <description> - Sets the name of an input port. - </description> - </method> - <method name="set_input_data_port_type"> - <return type="void" /> - <param index="0" name="index" type="int" /> - <param index="1" name="type" type="int" enum="Variant.Type" /> - <description> - Sets the type of an input port. - </description> - </method> - <method name="set_output_data_port_name"> - <return type="void" /> - <param index="0" name="index" type="int" /> - <param index="1" name="name" type="String" /> - <description> - Sets the name of an output port. - </description> - </method> - <method name="set_output_data_port_type"> - <return type="void" /> - <param index="0" name="index" type="int" /> - <param index="1" name="type" type="int" enum="Variant.Type" /> - <description> - Sets the type of an output port. - </description> - </method> - </methods> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptLocalVar.xml b/modules/visual_script/doc_classes/VisualScriptLocalVar.xml deleted file mode 100644 index dbf9049f0a..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptLocalVar.xml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptLocalVar" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Gets a local variable's value. - </brief_description> - <description> - 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] - </description> - <tutorials> - </tutorials> - <members> - <member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type" default="0"> - The local variable's type. - </member> - <member name="var_name" type="StringName" setter="set_var_name" getter="get_var_name" default="&"new_local""> - The local variable's name. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml b/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml deleted file mode 100644 index 1ae4e20f97..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptLocalVarSet.xml +++ /dev/null @@ -1,25 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptLocalVarSet" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Changes a local variable's value. - </brief_description> - <description> - 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] - </description> - <tutorials> - </tutorials> - <members> - <member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type" default="0"> - The local variable's type. - </member> - <member name="var_name" type="StringName" setter="set_var_name" getter="get_var_name" default="&"new_local""> - The local variable's name. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml b/modules/visual_script/doc_classes/VisualScriptMathConstant.xml deleted file mode 100644 index 01c36e763b..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptMathConstant.xml +++ /dev/null @@ -1,49 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptMathConstant" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Commonly used mathematical constants. - </brief_description> - <description> - Provides common math constants, such as Pi, on an output Data port. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (variant): [code]get[/code] - </description> - <tutorials> - </tutorials> - <members> - <member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant" default="0"> - The math constant. - </member> - </members> - <constants> - <constant name="MATH_CONSTANT_ONE" value="0" enum="MathConstant"> - Unity: [code]1[/code]. - </constant> - <constant name="MATH_CONSTANT_PI" value="1" enum="MathConstant"> - Pi: [code]3.141593[/code]. - </constant> - <constant name="MATH_CONSTANT_HALF_PI" value="2" enum="MathConstant"> - Pi divided by two: [code]1.570796[/code]. - </constant> - <constant name="MATH_CONSTANT_TAU" value="3" enum="MathConstant"> - Tau: [code]6.283185[/code]. - </constant> - <constant name="MATH_CONSTANT_E" value="4" enum="MathConstant"> - Mathematical constant [code]e[/code], the natural log base: [code]2.718282[/code]. - </constant> - <constant name="MATH_CONSTANT_SQRT2" value="5" enum="MathConstant"> - Square root of two: [code]1.414214[/code]. - </constant> - <constant name="MATH_CONSTANT_INF" value="6" enum="MathConstant"> - Infinity: [code]inf[/code]. - </constant> - <constant name="MATH_CONSTANT_NAN" value="7" enum="MathConstant"> - Not a number: [code]nan[/code]. - </constant> - <constant name="MATH_CONSTANT_MAX" value="8" enum="MathConstant"> - Represents the size of the [enum MathConstant] enum. - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptNode.xml b/modules/visual_script/doc_classes/VisualScriptNode.xml deleted file mode 100644 index 97c4f8ce76..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptNode.xml +++ /dev/null @@ -1,47 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptNode" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A node which is part of a [VisualScript]. - </brief_description> - <description> - A node which is part of a [VisualScript]. Not to be confused with [Node], which is a part of a [SceneTree]. - </description> - <tutorials> - </tutorials> - <methods> - <method name="get_default_input_value" qualifiers="const"> - <return type="Variant" /> - <param index="0" name="port_idx" type="int" /> - <description> - Returns the default value of a given port. The default value is used when nothing is connected to the port. - </description> - </method> - <method name="get_visual_script" qualifiers="const"> - <return type="VisualScript" /> - <description> - Returns the [VisualScript] instance the node is bound to. - </description> - </method> - <method name="ports_changed_notify"> - <return type="void" /> - <description> - Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] . - </description> - </method> - <method name="set_default_input_value"> - <return type="void" /> - <param index="0" name="port_idx" type="int" /> - <param index="1" name="value" type="Variant" /> - <description> - Change the default value of a given port. - </description> - </method> - </methods> - <signals> - <signal name="ports_changed"> - <description> - Emitted when the available input/output ports are changed. - </description> - </signal> - </signals> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptOperator.xml b/modules/visual_script/doc_classes/VisualScriptOperator.xml deleted file mode 100644 index 47ca6ddb90..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptOperator.xml +++ /dev/null @@ -1,23 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptOperator" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node that performs an operation on two values. - </brief_description> - <description> - [b]Input Ports:[/b] - - Data (variant): [code]A[/code] - - Data (variant): [code]B[/code] - [b]Output Ports:[/b] - - Data (variant): [code]result[/code] - </description> - <tutorials> - </tutorials> - <members> - <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="Variant.Operator" default="6"> - The operation to be performed. See [enum Variant.Operator] for available options. - </member> - <member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type" default="0"> - The type of the values for this operation. See [enum Variant.Type] for available options. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptPreload.xml b/modules/visual_script/doc_classes/VisualScriptPreload.xml deleted file mode 100644 index 146d6cd9c3..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptPreload.xml +++ /dev/null @@ -1,20 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptPreload" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <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> - <members> - <member name="resource" type="Resource" setter="set_preload" getter="get_preload"> - The [Resource] to load. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml b/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml deleted file mode 100644 index 77cd6393a9..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml +++ /dev/null @@ -1,48 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptPropertyGet" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node returning a value of a property from an [Object]. - </brief_description> - <description> - [VisualScriptPropertyGet] can return a value of any property from the current object or other objects. - </description> - <tutorials> - </tutorials> - <members> - <member name="base_script" type="String" setter="set_base_script" getter="get_base_script"> - The script to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE]. - </member> - <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&"Object""> - The base type to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE]. - </member> - <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type"> - The type to be used when [member set_mode] is set to [constant CALL_MODE_BASIC_TYPE]. - </member> - <member name="index" type="StringName" setter="set_index" getter="get_index"> - The indexed name of the property to retrieve. See [method Object.get_indexed] for details. - </member> - <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> - The node path to use when [member set_mode] is set to [constant CALL_MODE_NODE_PATH]. - </member> - <member name="property" type="StringName" setter="set_property" getter="get_property" default="&"""> - The name of the property to retrieve. Changing this will clear [member index]. - </member> - <member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0"> - [code]set_mode[/code] determines the target object from which the property will be retrieved. See [enum CallMode] for options. - </member> - </members> - <constants> - <constant name="CALL_MODE_SELF" value="0" enum="CallMode"> - The property will be retrieved from this [Object]. - </constant> - <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode"> - The property will be retrieved from the given [Node] in the scene tree. - </constant> - <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode"> - The property will be retrieved from an instanced node with the given type and script. - </constant> - <constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode"> - The property will be retrieved from a GDScript basic type (e.g. [Vector2]). - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml b/modules/visual_script/doc_classes/VisualScriptPropertySet.xml deleted file mode 100644 index 6cffa328c7..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptPropertySet.xml +++ /dev/null @@ -1,84 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptPropertySet" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node that sets a property of an [Object]. - </brief_description> - <description> - [VisualScriptPropertySet] can set the value of any property from the current object or other objects. - </description> - <tutorials> - </tutorials> - <members> - <member name="assign_op" type="int" setter="set_assign_op" getter="get_assign_op" enum="VisualScriptPropertySet.AssignOp" default="0"> - The additional operation to perform when assigning. See [enum AssignOp] for options. - </member> - <member name="base_script" type="String" setter="set_base_script" getter="get_base_script"> - The script to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE]. - </member> - <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&"Object""> - The base type to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE]. - </member> - <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type"> - The type to be used when [member set_mode] is set to [constant CALL_MODE_BASIC_TYPE]. - </member> - <member name="index" type="StringName" setter="set_index" getter="get_index"> - The indexed name of the property to set. See [method Object.set_indexed] for details. - </member> - <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> - The node path to use when [member set_mode] is set to [constant CALL_MODE_NODE_PATH]. - </member> - <member name="property" type="StringName" setter="set_property" getter="get_property" default="&"""> - The name of the property to set. Changing this will clear [member index]. - </member> - <member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertySet.CallMode" default="0"> - [code]set_mode[/code] determines the target object on which the property will be set. See [enum CallMode] for options. - </member> - </members> - <constants> - <constant name="CALL_MODE_SELF" value="0" enum="CallMode"> - The property will be set on this [Object]. - </constant> - <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode"> - The property will be set on the given [Node] in the scene tree. - </constant> - <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode"> - The property will be set on an instanced node with the given type and script. - </constant> - <constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode"> - The property will be set on a GDScript basic type (e.g. [Vector2]). - </constant> - <constant name="ASSIGN_OP_NONE" value="0" enum="AssignOp"> - The property will be assigned regularly. - </constant> - <constant name="ASSIGN_OP_ADD" value="1" enum="AssignOp"> - The value will be added to the property. Equivalent of doing [code]+=[/code]. - </constant> - <constant name="ASSIGN_OP_SUB" value="2" enum="AssignOp"> - The value will be subtracted from the property. Equivalent of doing [code]-=[/code]. - </constant> - <constant name="ASSIGN_OP_MUL" value="3" enum="AssignOp"> - The property will be multiplied by the value. Equivalent of doing [code]*=[/code]. - </constant> - <constant name="ASSIGN_OP_DIV" value="4" enum="AssignOp"> - The property will be divided by the value. Equivalent of doing [code]/=[/code]. - </constant> - <constant name="ASSIGN_OP_MOD" value="5" enum="AssignOp"> - A modulo operation will be performed on the property and the value. Equivalent of doing [code]%=[/code]. - </constant> - <constant name="ASSIGN_OP_SHIFT_LEFT" value="6" enum="AssignOp"> - The property will be binarly shifted to the left by the given value. Equivalent of doing [code]<<[/code]. - </constant> - <constant name="ASSIGN_OP_SHIFT_RIGHT" value="7" enum="AssignOp"> - The property will be binarly shifted to the right by the given value. Equivalent of doing [code]>>[/code]. - </constant> - <constant name="ASSIGN_OP_BIT_AND" value="8" enum="AssignOp"> - A binary [code]AND[/code] operation will be performed on the property. Equivalent of doing [code]&=[/code]. - </constant> - <constant name="ASSIGN_OP_BIT_OR" value="9" enum="AssignOp"> - A binary [code]OR[/code] operation will be performed on the property. Equivalent of doing [code]|=[/code]. - </constant> - <constant name="ASSIGN_OP_BIT_XOR" value="10" enum="AssignOp"> - A binary [code]XOR[/code] operation will be performed on the property. Equivalent of doing [code]^=[/code]. - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptResourcePath.xml b/modules/visual_script/doc_classes/VisualScriptResourcePath.xml deleted file mode 100644 index 6ca8260ade..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptResourcePath.xml +++ /dev/null @@ -1,13 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptResourcePath" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <members> - <member name="path" type="String" setter="set_resource_path" getter="get_resource_path" default=""""> - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptReturn.xml b/modules/visual_script/doc_classes/VisualScriptReturn.xml deleted file mode 100644 index 1d59392782..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptReturn.xml +++ /dev/null @@ -1,24 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptReturn" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Exits a function and returns an optional value. - </brief_description> - <description> - 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 - </description> - <tutorials> - </tutorials> - <members> - <member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled" default="false"> - If [code]true[/code], the [code]return[/code] input port is available. - </member> - <member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type" default="0"> - The return value's data type. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptSceneNode.xml b/modules/visual_script/doc_classes/VisualScriptSceneNode.xml deleted file mode 100644 index a769d11d94..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptSceneNode.xml +++ /dev/null @@ -1,20 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptSceneNode" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Node reference. - </brief_description> - <description> - A direct reference to a node. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data: [code]node[/code] (obj) - </description> - <tutorials> - </tutorials> - <members> - <member name="node_path" type="NodePath" setter="set_node_path" getter="get_node_path" default="NodePath(".")"> - The node's path in the scene tree. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptSceneTree.xml b/modules/visual_script/doc_classes/VisualScriptSceneTree.xml deleted file mode 100644 index 84ab90892f..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptSceneTree.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptSceneTree" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node for accessing [SceneTree] methods. - </brief_description> - <description> - A Visual Script node for accessing [SceneTree] methods. - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptSelect.xml b/modules/visual_script/doc_classes/VisualScriptSelect.xml deleted file mode 100644 index 1aa916f779..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptSelect.xml +++ /dev/null @@ -1,22 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptSelect" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <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> - <members> - <member name="type" type="int" setter="set_typed" getter="get_typed" enum="Variant.Type" default="0"> - The input variables' type. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptSelf.xml b/modules/visual_script/doc_classes/VisualScriptSelf.xml deleted file mode 100644 index 8cc59dbccd..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptSelf.xml +++ /dev/null @@ -1,15 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptSelf" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Outputs a reference to the current instance. - </brief_description> - <description> - Provides a reference to the node running the visual script. - [b]Input Ports:[/b] - none - [b]Output Ports:[/b] - - Data (object): [code]instance[/code] - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptSequence.xml b/modules/visual_script/doc_classes/VisualScriptSequence.xml deleted file mode 100644 index 9adbc30e0d..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptSequence.xml +++ /dev/null @@ -1,22 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptSequence" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Executes a series of Sequence ports. - </brief_description> - <description> - 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] - </description> - <tutorials> - </tutorials> - <members> - <member name="steps" type="int" setter="set_steps" getter="get_steps" default="1"> - The number of steps in the sequence. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptSubCall.xml b/modules/visual_script/doc_classes/VisualScriptSubCall.xml deleted file mode 100644 index 535e89fc82..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptSubCall.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptSubCall" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Calls a method called [code]_subcall[/code] in this object. - </brief_description> - <description> - [VisualScriptSubCall] will call method named [code]_subcall[/code] in the current script. It will fail if the method doesn't exist or the provided arguments are wrong. - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptSwitch.xml b/modules/visual_script/doc_classes/VisualScriptSwitch.xml deleted file mode 100644 index 7befe89f50..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptSwitch.xml +++ /dev/null @@ -1,20 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptSwitch" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - Branches program flow based on a given input's value. - </brief_description> - <description> - Branches the flow based on an input's value. Use [b]Case Count[/b] 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] - </description> - <tutorials> - </tutorials> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptTypeCast.xml b/modules/visual_script/doc_classes/VisualScriptTypeCast.xml deleted file mode 100644 index ec84a75601..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptTypeCast.xml +++ /dev/null @@ -1,19 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptTypeCast" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node that casts the given value to another type. - </brief_description> - <description> - [VisualScriptTypeCast] will perform a type conversion to an [Object]-derived type. - </description> - <tutorials> - </tutorials> - <members> - <member name="base_script" type="String" setter="set_base_script" getter="get_base_script" default=""""> - The target script class to be converted to. If none, only the [member base_type] will be used. - </member> - <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&"Object""> - The target type to be converted to. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptVariableGet.xml b/modules/visual_script/doc_classes/VisualScriptVariableGet.xml deleted file mode 100644 index 8d99b4b9d0..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptVariableGet.xml +++ /dev/null @@ -1,20 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptVariableGet" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <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> - <members> - <member name="var_name" type="StringName" setter="set_variable" getter="get_variable" default="&"""> - The variable's name. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptVariableSet.xml b/modules/visual_script/doc_classes/VisualScriptVariableSet.xml deleted file mode 100644 index 4f568cc0f6..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptVariableSet.xml +++ /dev/null @@ -1,21 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptVariableSet" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <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> - <members> - <member name="var_name" type="StringName" setter="set_variable" getter="get_variable" default="&"""> - The variable's name. - </member> - </members> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptWhile.xml b/modules/visual_script/doc_classes/VisualScriptWhile.xml deleted file mode 100644 index 4e7cccef17..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptWhile.xml +++ /dev/null @@ -1,17 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptWhile" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <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> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptYield.xml b/modules/visual_script/doc_classes/VisualScriptYield.xml deleted file mode 100644 index ec757a3ac4..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptYield.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptYield" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node used to pause a function execution. - </brief_description> - <description> - [VisualScriptYield] will pause the function call and return [VisualScriptFunctionState], which can be used to resume the function. - </description> - <tutorials> - </tutorials> - <members> - <member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode" default="1"> - The mode to use for yielding. See [enum YieldMode] for available options. - </member> - <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time"> - The time to wait when [member mode] is set to [constant YIELD_WAIT]. - </member> - </members> - <constants> - <constant name="YIELD_FRAME" value="1" enum="YieldMode"> - Yields during an idle frame. - </constant> - <constant name="YIELD_PHYSICS_FRAME" value="2" enum="YieldMode"> - Yields during a physics frame. - </constant> - <constant name="YIELD_WAIT" value="3" enum="YieldMode"> - Yields a function and waits the given time. - </constant> - </constants> -</class> diff --git a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml b/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml deleted file mode 100644 index c3f4bc49c5..0000000000 --- a/modules/visual_script/doc_classes/VisualScriptYieldSignal.xml +++ /dev/null @@ -1,36 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptYieldSignal" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> - <brief_description> - A Visual Script node yielding for a signal. - </brief_description> - <description> - [VisualScriptYieldSignal] will pause the function execution until the provided signal is emitted. - </description> - <tutorials> - </tutorials> - <members> - <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&"Object""> - The base type to be used when [member call_mode] is set to [constant CALL_MODE_INSTANCE]. - </member> - <member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0"> - [code]call_mode[/code] determines the target object to wait for the signal emission. See [enum CallMode] for options. - </member> - <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path"> - The node path to use when [member call_mode] is set to [constant CALL_MODE_NODE_PATH]. - </member> - <member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="&"""> - The signal name to be waited for. - </member> - </members> - <constants> - <constant name="CALL_MODE_SELF" value="0" enum="CallMode"> - A signal from this [Object] will be used. - </constant> - <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode"> - A signal from the given [Node] in the scene tree will be used. - </constant> - <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode"> - A signal from an instanced node with the given type will be used. - </constant> - </constants> -</class> |