Merge pull request #42753 from KoBeWi/vs_docs
Document remaining Visual Script classes
This commit is contained in:
Rémi Verschelde
GitHub
commit
c0da57699b
|
|
@ -4,6 +4,7 @@
|
|||
Base class for nodes in a visual shader graph.
|
||||
</brief_description>
|
||||
<description>
|
||||
Visual shader graphs consist of various nodes. Each node in the graph is a separate object and they are represented as a rectangular boxes with title and a set of properties. Each node has also connection ports that allow to connect it to another nodes and control the flow of the shader.
|
||||
</description>
|
||||
<tutorials>
|
||||
<link title="VisualShaders">https://docs.godotengine.org/en/latest/tutorials/shading/visual_shaders.html</link>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualShaderNodeCurve3Texture" inherits="VisualShaderNodeResizableBase" version="4.0">
|
||||
<brief_description>
|
||||
Performs a [Curve3Texture] lookup within the visual shader graph.
|
||||
</brief_description>
|
||||
<description>
|
||||
Comes with a built-in editor for texture's curves.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="texture" type="Curve3Texture" setter="set_texture" getter="get_texture">
|
||||
The source texture.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualShaderNodeCurveTexture" inherits="VisualShaderNodeResizableBase" version="4.0">
|
||||
<brief_description>
|
||||
Performs a [CurveTexture] lookup within the visual shader graph.
|
||||
</brief_description>
|
||||
<description>
|
||||
Comes with a built-in editor for texture's curves.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
@ -10,6 +12,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="texture" type="CurveTexture" setter="set_texture" getter="get_texture">
|
||||
The source texture.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualShaderNodeResizableBase" inherits="VisualShaderNode" version="4.0">
|
||||
<brief_description>
|
||||
Base class for resizable nodes in a visual shader graph.
|
||||
</brief_description>
|
||||
<description>
|
||||
Resizable nodes have a handle that allows the user to adjust their size as needed.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptExpression" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptFunction" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptFunctionCall" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,46 +12,66 @@
|
|||
</methods>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptFunctionState" inherits="RefCounted" version="4.0">
|
||||
<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>
|
||||
|
|
@ -17,12 +19,14 @@
|
|||
<argument index="2" name="args" type="Array">
|
||||
</argument>
|
||||
<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">
|
||||
</return>
|
||||
<description>
|
||||
Returns whether the function state is valid.
|
||||
</description>
|
||||
</method>
|
||||
<method name="resume">
|
||||
|
|
@ -31,6 +35,7 @@
|
|||
<argument index="0" name="args" type="Array" default="[]">
|
||||
</argument>
|
||||
<description>
|
||||
Resumes the function to run from the point it was yielded.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptGlobalConstant" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,6 +12,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="constant" type="int" setter="set_global_constant" getter="get_global_constant" default="0">
|
||||
The constant to be used.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptIndexGet" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptIndexSet" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptInputAction" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,18 +12,24 @@
|
|||
</methods>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -19,6 +19,7 @@
|
|||
<argument index="2" name="index" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Adds an input port to the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_output_data_port">
|
||||
|
|
@ -31,6 +32,7 @@
|
|||
<argument index="2" name="index" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Adds an output port to the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_input_data_port">
|
||||
|
|
@ -39,6 +41,7 @@
|
|||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Removes an input port from the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_output_data_port">
|
||||
|
|
@ -47,6 +50,7 @@
|
|||
<argument index="0" name="index" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Removes an output port from the Visual Script node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_data_port_name">
|
||||
|
|
@ -57,6 +61,7 @@
|
|||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the name of an input port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_data_port_type">
|
||||
|
|
@ -67,6 +72,7 @@
|
|||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the type of an input port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_output_data_port_name">
|
||||
|
|
@ -77,6 +83,7 @@
|
|||
<argument index="1" name="name" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the name of an output port.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_output_data_port_type">
|
||||
|
|
@ -87,6 +94,7 @@
|
|||
<argument index="1" name="type" type="int" enum="Variant.Type">
|
||||
</argument>
|
||||
<description>
|
||||
Sets the type of an output port.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptOperator" inherits="VisualScriptNode" version="4.0">
|
||||
<brief_description>
|
||||
A Visual Script node that performs an operation on two values.
|
||||
</brief_description>
|
||||
<description>
|
||||
[b]Input Ports:[/b]
|
||||
|
|
@ -15,8 +16,10 @@
|
|||
</methods>
|
||||
<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>
|
||||
<constants>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptPropertyGet" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,28 +12,39 @@
|
|||
</methods>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptPropertySet" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,52 +12,75 @@
|
|||
</methods>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptSceneTree" inherits="VisualScriptNode" version="4.0">
|
||||
<brief_description>
|
||||
A Visual Script node for accessing [SceneTree] methods.
|
||||
</brief_description>
|
||||
<description>
|
||||
A Visual Script node for accessing [SceneTree] methods.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptSubCall" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -13,6 +15,7 @@
|
|||
<argument index="0" name="arguments" type="Variant">
|
||||
</argument>
|
||||
<description>
|
||||
Called by this node.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptTypeCast" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,8 +12,10 @@
|
|||
</methods>
|
||||
<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>
|
||||
<constants>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptYield" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,16 +12,21 @@
|
|||
</methods>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualScriptYieldSignal" inherits="VisualScriptNode" version="4.0">
|
||||
<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>
|
||||
|
|
@ -10,20 +12,27 @@
|
|||
</methods>
|
||||
<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>
|
||||
|
|
|
|||
Loading…
Reference in New Issue