mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2025-02-19 22:24:23 +01:00
Re-extracted the class docs.
This commit is contained in:
parent
327f58b236
commit
da03f96abe
@ -1572,70 +1572,82 @@
|
||||
<constant name="TYPE_VECTOR2" value="5" enum="Variant.Type">
|
||||
Variable is of type [Vector2].
|
||||
</constant>
|
||||
<constant name="TYPE_RECT2" value="6" enum="Variant.Type">
|
||||
<constant name="TYPE_VECTOR2I" value="6" enum="Variant.Type">
|
||||
</constant>
|
||||
<constant name="TYPE_RECT2" value="7" enum="Variant.Type">
|
||||
Variable is of type [Rect2].
|
||||
</constant>
|
||||
<constant name="TYPE_VECTOR3" value="7" enum="Variant.Type">
|
||||
<constant name="TYPE_RECT2I" value="8" enum="Variant.Type">
|
||||
</constant>
|
||||
<constant name="TYPE_VECTOR3" value="9" enum="Variant.Type">
|
||||
Variable is of type [Vector3].
|
||||
</constant>
|
||||
<constant name="TYPE_TRANSFORM2D" value="8" enum="Variant.Type">
|
||||
<constant name="TYPE_VECTOR3I" value="10" enum="Variant.Type">
|
||||
</constant>
|
||||
<constant name="TYPE_TRANSFORM2D" value="11" enum="Variant.Type">
|
||||
Variable is of type [Transform2D].
|
||||
</constant>
|
||||
<constant name="TYPE_PLANE" value="9" enum="Variant.Type">
|
||||
<constant name="TYPE_PLANE" value="12" enum="Variant.Type">
|
||||
Variable is of type [Plane].
|
||||
</constant>
|
||||
<constant name="TYPE_QUAT" value="10" enum="Variant.Type">
|
||||
<constant name="TYPE_QUAT" value="13" enum="Variant.Type">
|
||||
Variable is of type [Quat].
|
||||
</constant>
|
||||
<constant name="TYPE_AABB" value="11" enum="Variant.Type">
|
||||
<constant name="TYPE_AABB" value="14" enum="Variant.Type">
|
||||
Variable is of type [AABB].
|
||||
</constant>
|
||||
<constant name="TYPE_BASIS" value="12" enum="Variant.Type">
|
||||
<constant name="TYPE_BASIS" value="15" enum="Variant.Type">
|
||||
Variable is of type [Basis].
|
||||
</constant>
|
||||
<constant name="TYPE_TRANSFORM" value="13" enum="Variant.Type">
|
||||
<constant name="TYPE_TRANSFORM" value="16" enum="Variant.Type">
|
||||
Variable is of type [Transform].
|
||||
</constant>
|
||||
<constant name="TYPE_COLOR" value="14" enum="Variant.Type">
|
||||
<constant name="TYPE_COLOR" value="17" enum="Variant.Type">
|
||||
Variable is of type [Color].
|
||||
</constant>
|
||||
<constant name="TYPE_NODE_PATH" value="15" enum="Variant.Type">
|
||||
<constant name="TYPE_NODE_PATH" value="18" enum="Variant.Type">
|
||||
Variable is of type [NodePath].
|
||||
</constant>
|
||||
<constant name="TYPE_RID" value="16" enum="Variant.Type">
|
||||
<constant name="TYPE_RID" value="19" enum="Variant.Type">
|
||||
Variable is of type [RID].
|
||||
</constant>
|
||||
<constant name="TYPE_OBJECT" value="17" enum="Variant.Type">
|
||||
<constant name="TYPE_OBJECT" value="20" enum="Variant.Type">
|
||||
Variable is of type [Object].
|
||||
</constant>
|
||||
<constant name="TYPE_DICTIONARY" value="18" enum="Variant.Type">
|
||||
<constant name="TYPE_STRING_NAME" value="21" enum="Variant.Type">
|
||||
</constant>
|
||||
<constant name="TYPE_DICTIONARY" value="22" enum="Variant.Type">
|
||||
Variable is of type [Dictionary].
|
||||
</constant>
|
||||
<constant name="TYPE_ARRAY" value="19" enum="Variant.Type">
|
||||
<constant name="TYPE_ARRAY" value="23" enum="Variant.Type">
|
||||
Variable is of type [Array].
|
||||
</constant>
|
||||
<constant name="TYPE_RAW_ARRAY" value="20" enum="Variant.Type">
|
||||
<constant name="TYPE_RAW_ARRAY" value="24" enum="Variant.Type">
|
||||
Variable is of type [PoolByteArray].
|
||||
</constant>
|
||||
<constant name="TYPE_INT_ARRAY" value="21" enum="Variant.Type">
|
||||
<constant name="TYPE_INT_ARRAY" value="25" enum="Variant.Type">
|
||||
Variable is of type [PoolIntArray].
|
||||
</constant>
|
||||
<constant name="TYPE_REAL_ARRAY" value="22" enum="Variant.Type">
|
||||
<constant name="TYPE_REAL_ARRAY" value="26" enum="Variant.Type">
|
||||
Variable is of type [PoolRealArray].
|
||||
</constant>
|
||||
<constant name="TYPE_STRING_ARRAY" value="23" enum="Variant.Type">
|
||||
<constant name="TYPE_STRING_ARRAY" value="27" enum="Variant.Type">
|
||||
Variable is of type [PoolStringArray].
|
||||
</constant>
|
||||
<constant name="TYPE_VECTOR2_ARRAY" value="24" enum="Variant.Type">
|
||||
<constant name="TYPE_VECTOR2_ARRAY" value="28" enum="Variant.Type">
|
||||
Variable is of type [PoolVector2Array].
|
||||
</constant>
|
||||
<constant name="TYPE_VECTOR3_ARRAY" value="25" enum="Variant.Type">
|
||||
<constant name="TYPE_VECTOR2I_ARRAY" value="29" enum="Variant.Type">
|
||||
</constant>
|
||||
<constant name="TYPE_VECTOR3_ARRAY" value="30" enum="Variant.Type">
|
||||
Variable is of type [PoolVector3Array].
|
||||
</constant>
|
||||
<constant name="TYPE_COLOR_ARRAY" value="26" enum="Variant.Type">
|
||||
<constant name="TYPE_VECTOR3I_ARRAY" value="31" enum="Variant.Type">
|
||||
</constant>
|
||||
<constant name="TYPE_COLOR_ARRAY" value="32" enum="Variant.Type">
|
||||
Variable is of type [PoolColorArray].
|
||||
</constant>
|
||||
<constant name="TYPE_MAX" value="27" enum="Variant.Type">
|
||||
<constant name="TYPE_MAX" value="33" enum="Variant.Type">
|
||||
Represents the size of the [enum Variant.Type] enum.
|
||||
</constant>
|
||||
<constant name="OP_EQUAL" value="0" enum="Variant.Operator">
|
||||
|
||||
@ -14,10 +14,9 @@
|
||||
<methods>
|
||||
<method name="play">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" default="""" />
|
||||
<argument index="0" name="anim" type="StringName" default="@""" />
|
||||
<argument index="1" name="backwards" type="bool" default="false" />
|
||||
<description>
|
||||
Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse.
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop">
|
||||
@ -28,7 +27,7 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="animation" type="String" setter="set_animation" getter="get_animation" default=""default"">
|
||||
<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@"default"">
|
||||
The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.
|
||||
</member>
|
||||
<member name="centered" type="bool" setter="set_centered" getter="is_centered" default="true">
|
||||
|
||||
@ -18,9 +18,8 @@
|
||||
</method>
|
||||
<method name="play">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" default="""" />
|
||||
<argument index="0" name="anim" type="StringName" default="@""" />
|
||||
<description>
|
||||
Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played.
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop">
|
||||
@ -31,7 +30,7 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="animation" type="String" setter="set_animation" getter="get_animation" default=""default"">
|
||||
<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@"default"">
|
||||
The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.
|
||||
</member>
|
||||
<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_track_get_key_animation" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="track_idx" type="int" />
|
||||
<argument index="1" name="key_idx" type="int" />
|
||||
<description>
|
||||
@ -40,18 +40,16 @@
|
||||
<return type="int" />
|
||||
<argument index="0" name="track_idx" type="int" />
|
||||
<argument index="1" name="time" type="float" />
|
||||
<argument index="2" name="animation" type="String" />
|
||||
<argument index="2" name="animation" type="StringName" />
|
||||
<description>
|
||||
Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track.
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_track_set_key_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="track_idx" type="int" />
|
||||
<argument index="1" name="key_idx" type="int" />
|
||||
<argument index="2" name="animation" type="String" />
|
||||
<argument index="2" name="animation" type="StringName" />
|
||||
<description>
|
||||
Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track.
|
||||
</description>
|
||||
</method>
|
||||
<method name="audio_track_get_key_end_offset" qualifiers="const">
|
||||
@ -227,7 +225,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="method_track_get_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="track_idx" type="int" />
|
||||
<argument index="1" name="key_idx" type="int" />
|
||||
<description>
|
||||
|
||||
@ -20,13 +20,12 @@
|
||||
</method>
|
||||
<method name="blend_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="animation" type="String" />
|
||||
<argument index="0" name="animation" type="StringName" />
|
||||
<argument index="1" name="time" type="float" />
|
||||
<argument index="2" name="delta" type="float" />
|
||||
<argument index="3" name="seeked" type="bool" />
|
||||
<argument index="4" name="blend" type="float" />
|
||||
<description>
|
||||
Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend_input">
|
||||
@ -43,7 +42,7 @@
|
||||
</method>
|
||||
<method name="blend_node">
|
||||
<return type="float" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="node" type="AnimationNode" />
|
||||
<argument index="2" name="time" type="float" />
|
||||
<argument index="3" name="seek" type="bool" />
|
||||
@ -51,7 +50,6 @@
|
||||
<argument index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0" />
|
||||
<argument index="6" name="optimize" type="bool" default="true" />
|
||||
<description>
|
||||
Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_caption" qualifiers="virtual">
|
||||
@ -88,9 +86,8 @@
|
||||
</method>
|
||||
<method name="get_parameter" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_parameter_default_value" qualifiers="virtual">
|
||||
@ -146,10 +143,9 @@
|
||||
</method>
|
||||
<method name="set_parameter">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets a custom parameter. These are used as local memory, because resources can be reused across the tree or scenes.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="animation" type="String" setter="set_animation" getter="get_animation" default="""">
|
||||
<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@""">
|
||||
Animation to use as an output. It is one of the animations provided by [member AnimationTree.anim_player].
|
||||
</member>
|
||||
</members>
|
||||
|
||||
@ -12,72 +12,63 @@
|
||||
<methods>
|
||||
<method name="add_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="node" type="AnimationNode" />
|
||||
<argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )" />
|
||||
<description>
|
||||
Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later.
|
||||
</description>
|
||||
</method>
|
||||
<method name="connect_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="input_node" type="String" />
|
||||
<argument index="0" name="input_node" type="StringName" />
|
||||
<argument index="1" name="input_index" type="int" />
|
||||
<argument index="2" name="output_node" type="String" />
|
||||
<argument index="2" name="output_node" type="StringName" />
|
||||
<description>
|
||||
Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="disconnect_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="input_node" type="String" />
|
||||
<argument index="0" name="input_node" type="StringName" />
|
||||
<argument index="1" name="input_index" type="int" />
|
||||
<description>
|
||||
Disconnects the node connected to the specified input.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node" qualifiers="const">
|
||||
<return type="AnimationNode" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the sub-node with the specified [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_position" qualifiers="const">
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the position of the sub-node with the specified [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_node" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a sub-node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="new_name" type="StringName" />
|
||||
<description>
|
||||
Changes the name of a sub-node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_node_position">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="position" type="Vector2" />
|
||||
<description>
|
||||
Modifies the position of a sub-node.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -17,20 +17,18 @@
|
||||
<methods>
|
||||
<method name="add_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="node" type="AnimationNode" />
|
||||
<argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )" />
|
||||
<description>
|
||||
Adds a new node to the graph. The [code]position[/code] is used for display in the editor.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_transition">
|
||||
<return type="void" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="1" name="to" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="to" type="StringName" />
|
||||
<argument index="2" name="transition" type="AnimationNodeStateMachineTransition" />
|
||||
<description>
|
||||
Adds a transition between the given nodes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_end_node" qualifiers="const">
|
||||
@ -47,13 +45,12 @@
|
||||
</method>
|
||||
<method name="get_node" qualifiers="const">
|
||||
<return type="AnimationNode" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the animation node with the given name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="node" type="AnimationNode" />
|
||||
<description>
|
||||
Returns the given animation node's name.
|
||||
@ -61,9 +58,8 @@
|
||||
</method>
|
||||
<method name="get_node_position" qualifiers="const">
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the given node's coordinates. Used for display in the editor.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_start_node" qualifiers="const">
|
||||
@ -86,14 +82,14 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_transition_from" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the given transition's start node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_transition_to" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the given transition's end node.
|
||||
@ -101,32 +97,28 @@
|
||||
</method>
|
||||
<method name="has_node" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the graph contains the given node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_transition" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="1" name="to" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="to" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a transition between the given nodes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Deletes the given node from the graph.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_transition">
|
||||
<return type="void" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="1" name="to" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="to" type="StringName" />
|
||||
<description>
|
||||
Deletes the transition between the two specified nodes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_transition_by_index">
|
||||
@ -138,25 +130,22 @@
|
||||
</method>
|
||||
<method name="rename_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="new_name" type="StringName" />
|
||||
<description>
|
||||
Renames the given node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="replace_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="node" type="AnimationNode" />
|
||||
<description>
|
||||
Replaces the node and keeps its transitions unchanged.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_end_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Sets the given node as the graph end point.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_graph_offset">
|
||||
@ -168,17 +157,15 @@
|
||||
</method>
|
||||
<method name="set_node_position">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="position" type="Vector2" />
|
||||
<description>
|
||||
Sets the node's coordinates. Used for display in the editor.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_start_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Sets the given node as the graph start point.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -21,7 +21,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_current_node" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<description>
|
||||
Returns the currently playing animation state.
|
||||
</description>
|
||||
@ -46,9 +46,8 @@
|
||||
</method>
|
||||
<method name="start">
|
||||
<return type="void" />
|
||||
<argument index="0" name="node" type="String" />
|
||||
<argument index="0" name="node" type="StringName" />
|
||||
<description>
|
||||
Starts playing the given animation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop">
|
||||
@ -59,9 +58,8 @@
|
||||
</method>
|
||||
<method name="travel">
|
||||
<return type="void" />
|
||||
<argument index="0" name="to_node" type="String" />
|
||||
<argument index="0" name="to_node" type="StringName" />
|
||||
<description>
|
||||
Transitions from the current state to another one, following the shortest path.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition" default="""">
|
||||
<member name="advance_condition" type="StringName" setter="set_advance_condition" getter="get_advance_condition" default="@""">
|
||||
Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=$DOCS_URL/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to [code]"idle"[/code]:
|
||||
[codeblock]
|
||||
$animation_tree["parameters/conditions/idle"] = is_on_floor and (linear_velocity.x == 0)
|
||||
|
||||
@ -16,10 +16,9 @@
|
||||
<methods>
|
||||
<method name="add_animation">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="animation" type="Animation" />
|
||||
<description>
|
||||
Adds [code]animation[/code] to the player accessible with the key [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="advance">
|
||||
@ -30,18 +29,16 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_get_next" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="anim_from" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<description>
|
||||
Returns the name of the next animation in the queue.
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_set_next">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim_from" type="String" />
|
||||
<argument index="1" name="anim_to" type="String" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<argument index="1" name="anim_to" type="StringName" />
|
||||
<description>
|
||||
Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_caches">
|
||||
@ -57,7 +54,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="find_animation" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="animation" type="Animation" />
|
||||
<description>
|
||||
Returns the name of [code]animation[/code] or an empty string if not found.
|
||||
@ -65,9 +62,8 @@
|
||||
</method>
|
||||
<method name="get_animation" qualifiers="const">
|
||||
<return type="Animation" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_animation_list" qualifiers="const">
|
||||
@ -78,10 +74,9 @@
|
||||
</method>
|
||||
<method name="get_blend_time" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="anim_from" type="String" />
|
||||
<argument index="1" name="anim_to" type="String" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<argument index="1" name="anim_to" type="StringName" />
|
||||
<description>
|
||||
Gets the blend time (in seconds) between two animations, referenced by their names.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_playing_speed" qualifiers="const">
|
||||
@ -98,9 +93,8 @@
|
||||
</method>
|
||||
<method name="has_animation" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_playing" qualifiers="const">
|
||||
@ -111,46 +105,37 @@
|
||||
</method>
|
||||
<method name="play">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" default="""" />
|
||||
<argument index="1" name="custom_blend" type="float" default="-1" />
|
||||
<argument index="2" name="custom_speed" type="float" default="1.0" />
|
||||
<argument index="3" name="from_end" type="bool" default="false" />
|
||||
<description>
|
||||
Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]).
|
||||
The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing.
|
||||
[b]Note:[/b] The animation will be updated the next time the [AnimationPlayer] is processed. If other variables are updated at the same time this is called, they may be updated too early. To perform the update immediately, call [code]advance(0)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="play_backwards">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" default="""" />
|
||||
<argument index="1" name="custom_blend" type="float" default="-1" />
|
||||
<description>
|
||||
Plays the animation with key [code]name[/code] in reverse.
|
||||
This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="queue">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Queues an animation for playback once the current one is done.
|
||||
[b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes the animation with key [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="newname" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="newname" type="StringName" />
|
||||
<description>
|
||||
Renames an existing animation with key [code]name[/code] to [code]newname[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="seek">
|
||||
@ -163,11 +148,10 @@
|
||||
</method>
|
||||
<method name="set_blend_time">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim_from" type="String" />
|
||||
<argument index="1" name="anim_to" type="String" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<argument index="1" name="anim_to" type="StringName" />
|
||||
<argument index="2" name="sec" type="float" />
|
||||
<description>
|
||||
Specifies a blend time (in seconds) between two animations, referenced by their names.
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop">
|
||||
@ -221,7 +205,7 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="animation_changed">
|
||||
<argument index="0" name="old_name" type="String" />
|
||||
<argument index="0" name="old_name" type="StringName" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<description>
|
||||
Emitted when a queued animation plays after the previous animation was finished. See [method queue].
|
||||
@ -229,13 +213,13 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="animation_finished">
|
||||
<argument index="0" name="anim_name" type="String" />
|
||||
<argument index="0" name="anim_name" type="StringName" />
|
||||
<description>
|
||||
Notifies when an animation finished playing.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="animation_started">
|
||||
<argument index="0" name="anim_name" type="String" />
|
||||
<argument index="0" name="anim_name" type="StringName" />
|
||||
<description>
|
||||
Notifies when an animation starts playing.
|
||||
</description>
|
||||
|
||||
@ -15,9 +15,8 @@
|
||||
<method name="add_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="type" type="int" enum="AnimationTreePlayer.NodeType" />
|
||||
<argument index="1" name="id" type="String" />
|
||||
<argument index="1" name="id" type="StringName" />
|
||||
<description>
|
||||
Adds a [code]type[/code] node to the graph with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="advance">
|
||||
@ -29,134 +28,112 @@
|
||||
</method>
|
||||
<method name="animation_node_get_animation" qualifiers="const">
|
||||
<return type="Animation" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the [AnimationPlayer]'s [Animation] bound to the [AnimationTreePlayer]'s animation node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_get_master_animation" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the name of the [member master_player]'s [Animation] bound to this animation node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_get_position" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the absolute playback timestamp of the animation node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_set_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="animation" type="Animation" />
|
||||
<description>
|
||||
Binds a new [Animation] from the [member master_player] to the [AnimationTreePlayer]'s animation node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_set_filter_path">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="path" type="NodePath" />
|
||||
<argument index="2" name="enable" type="bool" />
|
||||
<description>
|
||||
If [code]enable[/code] is [code]true[/code], the animation node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate.
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_node_set_master_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="source" type="String" />
|
||||
<description>
|
||||
Binds the [Animation] named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches.
|
||||
</description>
|
||||
</method>
|
||||
<method name="are_nodes_connected" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="1" name="dst_id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="dst_id" type="StringName" />
|
||||
<argument index="2" name="dst_input_idx" type="int" />
|
||||
<description>
|
||||
Returns whether node [code]id[/code] and [code]dst_id[/code] are connected at the specified slot.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend2_node_get_amount" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the blend amount of a Blend2 node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend2_node_set_amount">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="blend" type="float" />
|
||||
<description>
|
||||
Sets the blend amount of a Blend2 node given its name and value.
|
||||
A Blend2 node blends two animations (A and B) with the amount between 0 and 1.
|
||||
At 0, output is input A. Towards 1, the influence of A gets lessened, the influence of B gets raised. At 1, output is input B.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend2_node_set_filter_path">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="path" type="NodePath" />
|
||||
<argument index="2" name="enable" type="bool" />
|
||||
<description>
|
||||
If [code]enable[/code] is [code]true[/code], the Blend2 node with name [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend3_node_get_amount" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the blend amount of a Blend3 node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend3_node_set_amount">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="blend" type="float" />
|
||||
<description>
|
||||
Sets the blend amount of a Blend3 node given its name and value.
|
||||
A Blend3 Node blends three animations (A, B-, B+) with the amount between -1 and 1.
|
||||
At -1, output is input B-. From -1 to 0, the influence of B- gets lessened, the influence of A gets raised and the influence of B+ is 0. At 0, output is input A. From 0 to 1, the influence of A gets lessened, the influence of B+ gets raised and the influence of B+ is 0. At 1, output is input B+.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend4_node_get_amount" qualifiers="const">
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the blend amount of a Blend4 node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="blend4_node_set_amount">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="blend" type="Vector2" />
|
||||
<description>
|
||||
Sets the blend amount of a Blend4 node given its name and value.
|
||||
A Blend4 Node blends two pairs of animations.
|
||||
The two pairs are blended like Blend2 and then added together.
|
||||
</description>
|
||||
</method>
|
||||
<method name="connect_nodes">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="1" name="dst_id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="dst_id" type="StringName" />
|
||||
<argument index="2" name="dst_input_idx" type="int" />
|
||||
<description>
|
||||
Connects node [code]id[/code] to [code]dst_id[/code] at the specified input slot.
|
||||
</description>
|
||||
</method>
|
||||
<method name="disconnect_nodes">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="dst_input_idx" type="int" />
|
||||
<description>
|
||||
Disconnects nodes connected to [code]id[/code] at the specified input slot.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_list">
|
||||
@ -167,175 +144,151 @@
|
||||
</method>
|
||||
<method name="mix_node_get_amount" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the mix amount of a Mix node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="mix_node_set_amount">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="ratio" type="float" />
|
||||
<description>
|
||||
Sets the mix amount of a Mix node given its name and value.
|
||||
A Mix node adds input b to input a by the amount given by ratio.
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_exists" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="node" type="String" />
|
||||
<argument index="0" name="node" type="StringName" />
|
||||
<description>
|
||||
Check if a node exists (by name).
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_get_input_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the input count for a given node. Different types of nodes have different amount of inputs.
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_get_input_source" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the input source for a given node input.
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_get_position" qualifiers="const">
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns position of a node in the graph given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_get_type" qualifiers="const">
|
||||
<return type="int" enum="AnimationTreePlayer.NodeType" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Gets the node type, will return from [enum NodeType] enum.
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_rename">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="node" type="String" />
|
||||
<argument index="1" name="new_name" type="String" />
|
||||
<argument index="0" name="node" type="StringName" />
|
||||
<argument index="1" name="new_name" type="StringName" />
|
||||
<description>
|
||||
Renames a node in the graph.
|
||||
</description>
|
||||
</method>
|
||||
<method name="node_set_position">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="screen_position" type="Vector2" />
|
||||
<description>
|
||||
Sets the position of a node in the graph given its name and position.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_get_autorestart_delay" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the autostart delay of a OneShot node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_get_autorestart_random_delay" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the autostart random delay of a OneShot node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_get_fadein_time" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the fade in time of a OneShot node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_get_fadeout_time" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the fade out time of a OneShot node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_has_autorestart" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns whether a OneShot node will auto restart given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_is_active" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns whether a OneShot node is active given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_set_autorestart">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="enable" type="bool" />
|
||||
<description>
|
||||
Sets the autorestart property of a OneShot node given its name and value.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_set_autorestart_delay">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="delay_sec" type="float" />
|
||||
<description>
|
||||
Sets the autorestart delay of a OneShot node given its name and value in seconds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_set_autorestart_random_delay">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="rand_sec" type="float" />
|
||||
<description>
|
||||
Sets the autorestart random delay of a OneShot node given its name and value in seconds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_set_fadein_time">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="time_sec" type="float" />
|
||||
<description>
|
||||
Sets the fade in time of a OneShot node given its name and value in seconds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_set_fadeout_time">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="time_sec" type="float" />
|
||||
<description>
|
||||
Sets the fade out time of a OneShot node given its name and value in seconds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_set_filter_path">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="path" type="NodePath" />
|
||||
<argument index="2" name="enable" type="bool" />
|
||||
<description>
|
||||
If [code]enable[/code] is [code]true[/code], the OneShot node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_start">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Starts a OneShot node given its name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="oneshot_node_stop">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Stops the OneShot node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="recompute_caches">
|
||||
@ -346,9 +299,8 @@
|
||||
</method>
|
||||
<method name="remove_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Removes the animation node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="reset">
|
||||
@ -359,98 +311,83 @@
|
||||
</method>
|
||||
<method name="timescale_node_get_scale" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the time scale value of the TimeScale node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="timescale_node_set_scale">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="scale" type="float" />
|
||||
<description>
|
||||
Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code].
|
||||
The TimeScale node is used to speed [Animation]s up if the scale is above 1 or slow them down if it is below 1.
|
||||
If applied after a blend or mix, affects all input animations to that blend or mix.
|
||||
</description>
|
||||
</method>
|
||||
<method name="timeseek_node_seek">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="seconds" type="float" />
|
||||
<description>
|
||||
Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code].
|
||||
This functions as a seek in the [Animation] or the blend or mix of [Animation]s input in it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_delete_input">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="input_idx" type="int" />
|
||||
<description>
|
||||
Deletes the input at [code]input_idx[/code] for the transition node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_get_current" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the index of the currently evaluated input for the transition node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_get_input_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the number of inputs for the transition node with name [code]id[/code]. You can add inputs by right-clicking on the transition node.
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_get_xfade_time" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<description>
|
||||
Returns the cross fade time for the transition node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_has_input_auto_advance" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="input_idx" type="int" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the input at [code]input_idx[/code] on the transition node with name [code]id[/code] is set to automatically advance to the next input upon completion.
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_set_current">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="input_idx" type="int" />
|
||||
<description>
|
||||
The transition node with name [code]id[/code] sets its current input at [code]input_idx[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_set_input_auto_advance">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="input_idx" type="int" />
|
||||
<argument index="2" name="enable" type="bool" />
|
||||
<description>
|
||||
The transition node with name [code]id[/code] advances to its next input automatically when the input at [code]input_idx[/code] completes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_set_input_count">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="count" type="int" />
|
||||
<description>
|
||||
Resizes the number of inputs available for the transition node with name [code]id[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="transition_node_set_xfade_time">
|
||||
<return type="void" />
|
||||
<argument index="0" name="id" type="String" />
|
||||
<argument index="0" name="id" type="StringName" />
|
||||
<argument index="1" name="time_sec" type="float" />
|
||||
<description>
|
||||
The transition node with name [code]id[/code] sets its cross fade time to [code]time_sec[/code].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -48,7 +48,7 @@
|
||||
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.
|
||||
See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping.
|
||||
</member>
|
||||
<member name="audio_bus_name" type="String" setter="set_audio_bus" getter="get_audio_bus" default=""Master"">
|
||||
<member name="audio_bus_name" type="StringName" setter="set_audio_bus" getter="get_audio_bus" default="@"Master"">
|
||||
The name of the area's audio bus.
|
||||
</member>
|
||||
<member name="audio_bus_override" type="bool" setter="set_audio_bus_override" getter="is_overriding_audio_bus" default="false">
|
||||
@ -85,7 +85,7 @@
|
||||
<member name="reverb_bus_enable" type="bool" setter="set_use_reverb_bus" getter="is_using_reverb_bus" default="false">
|
||||
If [code]true[/code], the area applies reverb to its associated audio.
|
||||
</member>
|
||||
<member name="reverb_bus_name" type="String" setter="set_reverb_bus" getter="get_reverb_bus" default=""Master"">
|
||||
<member name="reverb_bus_name" type="StringName" setter="set_reverb_bus" getter="get_reverb_bus" default="@"Master"">
|
||||
The reverb bus name to use for this area's associated audio.
|
||||
</member>
|
||||
<member name="reverb_bus_uniformity" type="float" setter="set_reverb_uniformity" getter="get_reverb_uniformity" default="0.0">
|
||||
|
||||
@ -50,7 +50,7 @@
|
||||
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.
|
||||
See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping.
|
||||
</member>
|
||||
<member name="audio_bus_name" type="String" setter="set_audio_bus_name" getter="get_audio_bus_name" default=""Master"">
|
||||
<member name="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="@"Master"">
|
||||
The name of the area's audio bus.
|
||||
</member>
|
||||
<member name="audio_bus_override" type="bool" setter="set_audio_bus_override" getter="is_overriding_audio_bus" default="false">
|
||||
|
||||
@ -34,6 +34,12 @@
|
||||
Constructs an array from a [PoolColorArray].
|
||||
</description>
|
||||
</method>
|
||||
<method name="Array">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="from" type="PoolVector3iArray" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="Array">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="from" type="PoolVector3Array" />
|
||||
@ -41,6 +47,12 @@
|
||||
Constructs an array from a [PoolVector3Array].
|
||||
</description>
|
||||
</method>
|
||||
<method name="Array">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="from" type="PoolVector2iArray" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="Array">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="from" type="PoolVector2Array" />
|
||||
|
||||
@ -31,9 +31,8 @@
|
||||
<methods>
|
||||
<method name="add_blend_shape">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_surface_from_arrays">
|
||||
@ -67,7 +66,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_blend_shape_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<description>
|
||||
Returns the name of the blend shape at this index.
|
||||
@ -82,7 +81,7 @@
|
||||
<method name="set_blend_shape_name">
|
||||
<return type="void" />
|
||||
<argument index="0" name="index" type="int" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
<member name="release_ms" type="float" setter="set_release_ms" getter="get_release_ms" default="250.0">
|
||||
Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000.
|
||||
</member>
|
||||
<member name="sidechain" type="String" setter="set_sidechain" getter="get_sidechain" default="""">
|
||||
<member name="sidechain" type="StringName" setter="set_sidechain" getter="get_sidechain" default="@""">
|
||||
Reduce the sound level using another audio bus for threshold detection.
|
||||
</member>
|
||||
<member name="threshold" type="float" setter="set_threshold" getter="get_threshold" default="0.0">
|
||||
|
||||
@ -74,9 +74,8 @@
|
||||
</method>
|
||||
<method name="get_bus_index" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="bus_name" type="String" />
|
||||
<argument index="0" name="bus_name" type="StringName" />
|
||||
<description>
|
||||
Returns the index of the bus with the name [code]bus_name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bus_name" qualifiers="const">
|
||||
@ -103,7 +102,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bus_send" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="bus_idx" type="int" />
|
||||
<description>
|
||||
Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to.
|
||||
@ -254,9 +253,8 @@
|
||||
<method name="set_bus_send">
|
||||
<return type="void" />
|
||||
<argument index="0" name="bus_idx" type="int" />
|
||||
<argument index="1" name="send" type="String" />
|
||||
<argument index="1" name="send" type="StringName" />
|
||||
<description>
|
||||
Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_bus_solo">
|
||||
|
||||
@ -53,7 +53,7 @@
|
||||
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false">
|
||||
If [code]true[/code], audio plays when added to scene tree.
|
||||
</member>
|
||||
<member name="bus" type="String" setter="set_bus" getter="get_bus" default=""Master"">
|
||||
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master"">
|
||||
Bus on which this audio is playing.
|
||||
</member>
|
||||
<member name="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0">
|
||||
|
||||
@ -55,7 +55,7 @@
|
||||
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false">
|
||||
If [code]true[/code], audio plays when added to scene tree.
|
||||
</member>
|
||||
<member name="bus" type="String" setter="set_bus" getter="get_bus" default=""Master"">
|
||||
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master"">
|
||||
Bus on which this audio is playing.
|
||||
</member>
|
||||
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="2000.0">
|
||||
|
||||
@ -62,7 +62,7 @@
|
||||
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false">
|
||||
If [code]true[/code], audio plays when the AudioStreamPlayer3D node is added to scene tree.
|
||||
</member>
|
||||
<member name="bus" type="String" setter="set_bus" getter="get_bus" default=""Master"">
|
||||
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master"">
|
||||
The bus on which this audio is playing.
|
||||
</member>
|
||||
<member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="AudioStreamPlayer3D.DopplerTracking" default="0">
|
||||
|
||||
@ -11,149 +11,130 @@
|
||||
<methods>
|
||||
<method name="can_instance" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_exists" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<description>
|
||||
Returns whether the specified [code]class[/code] is available or not.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_category" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<description>
|
||||
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_enum_constants" qualifiers="const">
|
||||
<return type="PoolStringArray" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="enum" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="enum" type="StringName" />
|
||||
<argument index="2" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns an array with all the keys in [code]enum[/code] of [code]class[/code] or its ancestry.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_enum_list" qualifiers="const">
|
||||
<return type="PoolStringArray" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns an array with all the enums of [code]class[/code] or its ancestry.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_integer_constant" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_integer_constant_enum" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns which enum the integer constant [code]name[/code] of [code]class[/code] or its ancestry belongs to.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_integer_constant_list" qualifiers="const">
|
||||
<return type="PoolStringArray" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns an array with the names all the integer constants of [code]class[/code] or its ancestry.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_method_list" qualifiers="const">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
|
||||
[b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_property" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="1" name="property" type="StringName" />
|
||||
<description>
|
||||
Returns the value of [code]property[/code] of [code]class[/code] or its ancestry.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_property_list" qualifiers="const">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_signal" qualifiers="const">
|
||||
<return type="Dictionary" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="signal" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="signal" type="StringName" />
|
||||
<description>
|
||||
Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_get_signal_list" qualifiers="const">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal].
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_has_enum" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns whether [code]class[/code] or its ancestry has an enum called [code]name[/code] or not.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_has_integer_constant" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_has_method" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<argument index="2" name="no_inheritance" type="bool" default="false" />
|
||||
<description>
|
||||
Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_has_signal" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="signal" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="signal" type="StringName" />
|
||||
<description>
|
||||
Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not.
|
||||
</description>
|
||||
</method>
|
||||
<method name="class_set_property" qualifiers="const">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="1" name="property" type="StringName" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets [code]property[/code] value of [code]class[/code] to [code]value[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_class_list" qualifiers="const">
|
||||
@ -164,38 +145,33 @@
|
||||
</method>
|
||||
<method name="get_inheriters_from_class" qualifiers="const">
|
||||
<return type="PoolStringArray" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<description>
|
||||
Returns the names of all the classes that directly or indirectly inherit from [code]class[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_parent_class" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<description>
|
||||
Returns the parent class of [code]class[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="instance" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<description>
|
||||
Creates an instance of [code]class[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_class_enabled" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<description>
|
||||
Returns whether this [code]class[/code] is enabled or not.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_parent_class" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="class" type="String" />
|
||||
<argument index="1" name="inherits" type="String" />
|
||||
<argument index="0" name="class" type="StringName" />
|
||||
<argument index="1" name="inherits" type="StringName" />
|
||||
<description>
|
||||
Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -88,78 +88,44 @@
|
||||
</method>
|
||||
<method name="add_color_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="color" type="Color" />
|
||||
<description>
|
||||
Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control.
|
||||
See also [method get_color], [method remove_color_override].
|
||||
[b]Example of overriding a label's color and resetting it later:[/b]
|
||||
[codeblock]
|
||||
# Given the child Label node "MyLabel", override its font color with a custom value.
|
||||
$MyLabel.add_color_override("font_color", Color(1, 0.5, 0))
|
||||
# Reset the font color of the child label.
|
||||
$MyLabel.add_color_override("font_color", get_color("font_color", "Label"))
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_constant_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="constant" type="int" />
|
||||
<description>
|
||||
Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control.
|
||||
See also [method get_constant], [method remove_constant_override].
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_font_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="font" type="Font" />
|
||||
<description>
|
||||
Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control.
|
||||
[b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_font_override] instead.
|
||||
See also [method get_font].
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_icon_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="texture" type="Texture" />
|
||||
<description>
|
||||
Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control.
|
||||
[b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_icon_override] instead.
|
||||
See also [method get_icon].
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_shader_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="shader" type="Shader" />
|
||||
<description>
|
||||
Creates a local override for a theme shader with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control.
|
||||
[b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_shader_override] instead.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_stylebox_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="stylebox" type="StyleBox" />
|
||||
<description>
|
||||
Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control.
|
||||
[b]Note:[/b] An override can be removed by assigning it a [code]null[/code] value. This behavior is deprecated and will be removed in 4.0, use [method remove_stylebox_override] instead.
|
||||
See also [method get_stylebox].
|
||||
[b]Example of modifying a property in a StyleBox by duplicating it:[/b]
|
||||
[codeblock]
|
||||
# The snippet below assumes the child node MyButton has a StyleBoxFlat assigned.
|
||||
# Resources are shared across instances, so we need to duplicate it
|
||||
# to avoid modifying the appearance of all other buttons.
|
||||
var new_stylebox_normal = $MyButton.get_stylebox("normal").duplicate()
|
||||
new_stylebox_normal.border_width_top = 3
|
||||
new_stylebox_normal.border_color = Color(0, 1, 0.5)
|
||||
$MyButton.add_stylebox_override("normal", new_stylebox_normal)
|
||||
# Remove the stylebox override.
|
||||
$MyButton.add_stylebox_override("normal", null)
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="can_drop_data" qualifiers="virtual">
|
||||
@ -228,18 +194,9 @@
|
||||
</method>
|
||||
<method name="get_color" qualifiers="const">
|
||||
<return type="Color" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance.
|
||||
For the current control its local overrides are considered first (see [method add_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used.
|
||||
[codeblock]
|
||||
func _ready():
|
||||
# Get the font color defined for the current Control's class, if it exists.
|
||||
modulate = get_color("font_color")
|
||||
# Get the font color defined for the Button class.
|
||||
modulate = get_color("font_color", "Button")
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_combined_minimum_size" qualifiers="const">
|
||||
@ -250,11 +207,9 @@
|
||||
</method>
|
||||
<method name="get_constant" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_cursor_shape" qualifiers="const">
|
||||
@ -299,11 +254,9 @@
|
||||
</method>
|
||||
<method name="get_font" qualifiers="const">
|
||||
<return type="Font" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_global_rect" qualifiers="const">
|
||||
@ -314,11 +267,9 @@
|
||||
</method>
|
||||
<method name="get_icon" qualifiers="const">
|
||||
<return type="Texture" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_margin" qualifiers="const">
|
||||
@ -360,11 +311,9 @@
|
||||
</method>
|
||||
<method name="get_stylebox" qualifiers="const">
|
||||
<return type="StyleBox" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_theme_default_font" qualifiers="const">
|
||||
@ -399,36 +348,28 @@
|
||||
</method>
|
||||
<method name="has_color" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_color_override" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node.
|
||||
See [method add_color_override].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_constant" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_constant_override" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node.
|
||||
See [method add_constant_override].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_focus" qualifiers="const">
|
||||
@ -439,36 +380,28 @@
|
||||
</method>
|
||||
<method name="has_font" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_font_override" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node.
|
||||
See [method add_font_override].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_icon" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_icon_override" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node.
|
||||
See [method add_icon_override].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_point" qualifiers="virtual">
|
||||
@ -482,27 +415,21 @@
|
||||
</method>
|
||||
<method name="has_shader_override" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme shader with the specified [code]name[/code] in this [Control] node.
|
||||
See [method add_shader_override].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_stylebox" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" default="""" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
See [method get_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_stylebox_override" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node.
|
||||
See [method add_stylebox_override].
|
||||
</description>
|
||||
</method>
|
||||
<method name="minimum_size_changed">
|
||||
@ -519,44 +446,38 @@
|
||||
</method>
|
||||
<method name="remove_color_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a theme override for a [Color] with the given [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_constant_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a theme override for a constant with the given [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_font_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a theme override for a [Font] with the given [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_icon_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a theme override for an icon with the given [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_shader_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a theme override for a shader with the given [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_stylebox_override">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a theme override for a [StyleBox] with the given [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_anchor">
|
||||
@ -855,7 +776,7 @@
|
||||
<member name="theme" type="Theme" setter="set_theme" getter="get_theme">
|
||||
Changing this property replaces the current [Theme] resource this node and all its [Control] children use.
|
||||
</member>
|
||||
<member name="theme_type_variation" type="String" setter="set_theme_type_variation" getter="get_theme_type_variation" default="""">
|
||||
<member name="theme_type_variation" type="StringName" setter="set_theme_type_variation" getter="get_theme_type_variation" default="@""">
|
||||
The name of a theme type variation used by this [Control] to look up its own theme items. When empty, the class name of the node is used (e.g. [code]Button[/code] for the [Button] control), as well as the class names of all parent classes (in order of inheritance).
|
||||
When set, this property gives the highest priority to the type of the specified name. This type can in turn extend another type, forming a dependency chain. See [method Theme.set_type_variation]. If the theme item cannot be found using this type or its base types, lookup falls back on the class names.
|
||||
[b]Note:[/b] To look up [Control]'s own items use various [code]get_*[/code] methods without specifying [code]theme_type[/code].
|
||||
|
||||
@ -65,7 +65,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_file_type" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the resource type of the file at index [code]idx[/code]. This returns a string such as [code]"Resource"[/code] or [code]"GDScript"[/code], [i]not[/i] a file extension such as [code]".gd"[/code].
|
||||
|
||||
@ -18,12 +18,11 @@
|
||||
</method>
|
||||
<method name="emit_changed">
|
||||
<return type="void" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<argument index="2" name="field" type="String" default="""" />
|
||||
<argument index="2" name="field" type="StringName" default="@""" />
|
||||
<argument index="3" name="changing" type="bool" default="false" />
|
||||
<description>
|
||||
If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_edited_object">
|
||||
@ -33,7 +32,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_edited_property">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<description>
|
||||
Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property.
|
||||
</description>
|
||||
@ -87,34 +86,34 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="object_id_selected">
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="id" type="int" />
|
||||
<description>
|
||||
Used by sub-inspectors. Emit it if what was selected was an Object ID.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="property_changed">
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Do not emit this manually, use the [method emit_changed] method instead.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="property_checked">
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="checked" type="bool" />
|
||||
<description>
|
||||
Emitted when a property was checked. Used internally.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="property_keyed">
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<description>
|
||||
Emit it if you want to add this value as an animation key (check for keying being enabled first).
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="property_keyed_with_value">
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Emit it if you want to key a property with a single value.
|
||||
|
||||
@ -28,22 +28,18 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="resource" type="Resource" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="receiver_func" type="String" />
|
||||
<argument index="2" name="receiver_func" type="StringName" />
|
||||
<argument index="3" name="userdata" type="Variant" />
|
||||
<description>
|
||||
Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
|
||||
[b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
|
||||
</description>
|
||||
</method>
|
||||
<method name="queue_resource_preview">
|
||||
<return type="void" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="receiver_func" type="String" />
|
||||
<argument index="2" name="receiver_func" type="StringName" />
|
||||
<argument index="3" name="userdata" type="Variant" />
|
||||
<description>
|
||||
Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
|
||||
[b]Note:[/b] If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_preview_generator">
|
||||
|
||||
@ -123,11 +123,10 @@
|
||||
</method>
|
||||
<method name="set_initial_value">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<argument index="2" name="update_current" type="bool" />
|
||||
<description>
|
||||
Sets the initial value of the setting specified by [code]name[/code] to [code]value[/code]. This is used to provide a value for the Revert button in the Editor Settings. If [code]update_current[/code] is true, the current value of the setting will be set to [code]value[/code] as well.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_project_metadata">
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="function" type="String" setter="set_function" getter="get_function" default="""">
|
||||
<member name="function" type="StringName" setter="set_function" getter="get_function" default="@""">
|
||||
The name of the referenced function.
|
||||
</member>
|
||||
</members>
|
||||
|
||||
@ -40,22 +40,20 @@
|
||||
</method>
|
||||
<method name="connect_node">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="from_port" type="int" />
|
||||
<argument index="2" name="to" type="String" />
|
||||
<argument index="2" name="to" type="StringName" />
|
||||
<argument index="3" name="to_port" type="int" />
|
||||
<description>
|
||||
Create a connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection already exists, no connection is created.
|
||||
</description>
|
||||
</method>
|
||||
<method name="disconnect_node">
|
||||
<return type="void" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="from_port" type="int" />
|
||||
<argument index="2" name="to" type="String" />
|
||||
<argument index="2" name="to" type="StringName" />
|
||||
<argument index="3" name="to_port" type="int" />
|
||||
<description>
|
||||
Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connection_list" qualifiers="const">
|
||||
@ -73,12 +71,11 @@
|
||||
</method>
|
||||
<method name="is_node_connected">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="from_port" type="int" />
|
||||
<argument index="2" name="to" type="String" />
|
||||
<argument index="2" name="to" type="StringName" />
|
||||
<argument index="3" name="to_port" type="int" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the [code]from_port[/code] slot of the [code]from[/code] GraphNode is connected to the [code]to_port[/code] slot of the [code]to[/code] GraphNode.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_valid_connection_type" qualifiers="const">
|
||||
@ -113,13 +110,12 @@
|
||||
</method>
|
||||
<method name="set_connection_activity">
|
||||
<return type="void" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="from_port" type="int" />
|
||||
<argument index="2" name="to" type="String" />
|
||||
<argument index="2" name="to" type="StringName" />
|
||||
<argument index="3" name="to_port" type="int" />
|
||||
<argument index="4" name="amount" type="float" />
|
||||
<description>
|
||||
Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [code]activity[/code] theme property.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_selected">
|
||||
@ -182,7 +178,7 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="connection_from_empty">
|
||||
<argument index="0" name="to" type="String" />
|
||||
<argument index="0" name="to" type="StringName" />
|
||||
<argument index="1" name="to_slot" type="int" />
|
||||
<argument index="2" name="release_position" type="Vector2" />
|
||||
<description>
|
||||
@ -190,7 +186,7 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="connection_request">
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="from_slot" type="int" />
|
||||
<argument index="2" name="to" type="String" />
|
||||
<argument index="3" name="to_slot" type="int" />
|
||||
@ -199,7 +195,7 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="connection_to_empty">
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="from_slot" type="int" />
|
||||
<argument index="2" name="release_position" type="Vector2" />
|
||||
<description>
|
||||
@ -217,7 +213,7 @@
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="disconnection_request">
|
||||
<argument index="0" name="from" type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<argument index="1" name="from_slot" type="int" />
|
||||
<argument index="2" name="to" type="String" />
|
||||
<argument index="3" name="to_slot" type="int" />
|
||||
|
||||
@ -14,19 +14,15 @@
|
||||
<methods>
|
||||
<method name="action_press">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="strength" type="float" default="1.0" />
|
||||
<description>
|
||||
This will simulate pressing the specified action.
|
||||
The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action.
|
||||
[b]Note:[/b] This method will not cause any [method Node._input] calls. It is intended to be used with [method is_action_pressed] and [method is_action_just_pressed]. If you want to simulate [code]_input[/code], use [method parse_input_event] instead.
|
||||
</description>
|
||||
</method>
|
||||
<method name="action_release">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<description>
|
||||
If the specified action is already pressed, this will release it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_joy_mapping">
|
||||
@ -54,29 +50,23 @@
|
||||
</method>
|
||||
<method name="get_action_raw_strength" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact" type="bool" default="false" />
|
||||
<description>
|
||||
Returns a value between 0 and 1 representing the raw intensity of the given action, ignoring the action's deadzone. In most cases, you should use [method get_action_strength] instead.
|
||||
If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_action_strength" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact" type="bool" default="false" />
|
||||
<description>
|
||||
Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1.
|
||||
If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_axis" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="negative_action" type="String" />
|
||||
<argument index="1" name="positive_action" type="String" />
|
||||
<argument index="0" name="negative_action" type="StringName" />
|
||||
<argument index="1" name="positive_action" type="StringName" />
|
||||
<description>
|
||||
Get axis input by specifying two actions, one negative and one positive.
|
||||
This is a shorthand for writing [code]Input.get_action_strength("positive_action") - Input.get_action_strength("negative_action")[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connected_joypads">
|
||||
@ -196,45 +186,33 @@
|
||||
</method>
|
||||
<method name="get_vector" qualifiers="const">
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="negative_x" type="String" />
|
||||
<argument index="1" name="positive_x" type="String" />
|
||||
<argument index="2" name="negative_y" type="String" />
|
||||
<argument index="3" name="positive_y" type="String" />
|
||||
<argument index="0" name="negative_x" type="StringName" />
|
||||
<argument index="1" name="positive_x" type="StringName" />
|
||||
<argument index="2" name="negative_y" type="StringName" />
|
||||
<argument index="3" name="positive_y" type="StringName" />
|
||||
<argument index="4" name="deadzone" type="float" default="-1.0" />
|
||||
<description>
|
||||
Gets an input vector by specifying four actions for the positive and negative X and Y axes.
|
||||
This method is useful when getting vector input, such as from a joystick, directional pad, arrows, or WASD. The vector has its length limited to 1 and has a circular deadzone, which is useful for using vector input as movement.
|
||||
By default, the deadzone is automatically calculated from the average of the action deadzones. However, you can override the deadzone to be whatever you want (on the range of 0 to 1).
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_action_just_pressed" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact" type="bool" default="false" />
|
||||
<description>
|
||||
Returns [code]true[/code] when the user starts pressing the action event, meaning it's [code]true[/code] only on the frame that the user pressed down the button.
|
||||
This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed.
|
||||
If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
[b]Note:[/b] Due to keyboard ghosting, [method is_action_just_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_action_just_released" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact" type="bool" default="false" />
|
||||
<description>
|
||||
Returns [code]true[/code] when the user stops pressing the action event, meaning it's [code]true[/code] only on the frame that the user released the button.
|
||||
If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_action_pressed" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact" type="bool" default="false" />
|
||||
<description>
|
||||
Returns [code]true[/code] if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed.
|
||||
If [code]exact[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
[b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_joy_button_pressed" qualifiers="const">
|
||||
|
||||
@ -29,40 +29,31 @@
|
||||
</method>
|
||||
<method name="get_action_strength" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact_match" type="bool" default="false" />
|
||||
<description>
|
||||
Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion].
|
||||
If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_action" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact_match" type="bool" default="false" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this input event matches a pre-defined action of any type.
|
||||
If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_action_pressed" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="allow_echo" type="bool" default="false" />
|
||||
<argument index="2" name="exact_match" type="bool" default="false" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
|
||||
If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
[b]Note:[/b] Due to keyboard ghosting, [method is_action_pressed] may return [code]false[/code] even if one of the action's keys is pressed. See [url=$DOCS_URL/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_action_released" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="exact_match" type="bool" default="false" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
|
||||
If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_action_type" qualifiers="const">
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="action" type="String" setter="set_action" getter="get_action" default="""">
|
||||
<member name="action" type="StringName" setter="set_action" getter="get_action" default="@""">
|
||||
The action's name. Actions are accessed via this [String].
|
||||
</member>
|
||||
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
|
||||
|
||||
@ -12,81 +12,69 @@
|
||||
<methods>
|
||||
<method name="action_add_event">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="event" type="InputEvent" />
|
||||
<description>
|
||||
Adds an [InputEvent] to an action. This [InputEvent] will trigger the action.
|
||||
</description>
|
||||
</method>
|
||||
<method name="action_erase_event">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="event" type="InputEvent" />
|
||||
<description>
|
||||
Removes an [InputEvent] from an action.
|
||||
</description>
|
||||
</method>
|
||||
<method name="action_erase_events">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<description>
|
||||
Removes all events from an action.
|
||||
</description>
|
||||
</method>
|
||||
<method name="action_get_deadzone">
|
||||
<return type="float" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<description>
|
||||
Returns a deadzone value for the action.
|
||||
</description>
|
||||
</method>
|
||||
<method name="action_has_event">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="event" type="InputEvent" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the action has the given [InputEvent] associated with it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="action_set_deadzone">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="deadzone" type="float" />
|
||||
<description>
|
||||
Sets a deadzone value for the action.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_action">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<argument index="1" name="deadzone" type="float" default="0.5" />
|
||||
<description>
|
||||
Adds an empty action to the [InputMap] with a configurable [code]deadzone[/code].
|
||||
An [InputEvent] can then be added to this action with [method action_add_event].
|
||||
</description>
|
||||
</method>
|
||||
<method name="erase_action">
|
||||
<return type="void" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<description>
|
||||
Removes an action from the [InputMap].
|
||||
</description>
|
||||
</method>
|
||||
<method name="event_is_action" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="event" type="InputEvent" />
|
||||
<argument index="1" name="action" type="String" />
|
||||
<argument index="1" name="action" type="StringName" />
|
||||
<argument index="2" name="exact_match" type="bool" default="false" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior.
|
||||
If [code]exact_match[/code] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_action_list">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<description>
|
||||
Returns an array of [InputEvent]s associated with a given action.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_actions">
|
||||
@ -97,9 +85,8 @@
|
||||
</method>
|
||||
<method name="has_action" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="action" type="String" />
|
||||
<argument index="0" name="action" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the [InputMap] has a registered action with the given name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="load_from_globals">
|
||||
|
||||
@ -14,9 +14,8 @@
|
||||
<method name="create_callback">
|
||||
<return type="JavaScriptObject" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<description>
|
||||
Creates a reference to a script function that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See [JavaScriptObject] for usage.
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_object" qualifiers="vararg">
|
||||
|
||||
@ -31,10 +31,9 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="agent" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<argument index="3" name="userdata" type="Variant" default="null" />
|
||||
<description>
|
||||
Callback called at the end of the RVO process.
|
||||
</description>
|
||||
</method>
|
||||
<method name="agent_set_map" qualifiers="const">
|
||||
|
||||
@ -127,7 +127,7 @@
|
||||
<member name="geometry/source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" enum="NavigationMesh.SourceGeometryMode" default="0">
|
||||
The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values.
|
||||
</member>
|
||||
<member name="geometry/source_group_name" type="String" setter="set_source_group_name" getter="get_source_group_name">
|
||||
<member name="geometry/source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name">
|
||||
The name of the group to scan for geometry.
|
||||
Only used when [member geometry/source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
|
||||
</member>
|
||||
|
||||
@ -31,10 +31,9 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="agent" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<argument index="3" name="userdata" type="Variant" default="null" />
|
||||
<description>
|
||||
Callback called at the end of the RVO process.
|
||||
</description>
|
||||
</method>
|
||||
<method name="agent_set_map" qualifiers="const">
|
||||
|
||||
@ -133,12 +133,9 @@
|
||||
</method>
|
||||
<method name="add_to_group">
|
||||
<return type="void" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="0" name="group" type="StringName" />
|
||||
<argument index="1" name="persistent" type="bool" default="false" />
|
||||
<description>
|
||||
Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). See notes in the description, and the group methods in [SceneTree].
|
||||
The [code]persistent[/code] option is used when packing node to [PackedScene] and saving to file. Non-persistent groups aren't stored.
|
||||
[b]Note:[/b] For performance reasons, the order of node groups is [i]not[/i] guaranteed. The order of node groups should not be relied upon as it can vary across project runs.
|
||||
</description>
|
||||
</method>
|
||||
<method name="can_process" qualifiers="const">
|
||||
@ -362,9 +359,8 @@
|
||||
</method>
|
||||
<method name="is_in_group" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="0" name="group" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_inside_tree" qualifiers="const">
|
||||
@ -482,11 +478,10 @@
|
||||
</method>
|
||||
<method name="propagate_call">
|
||||
<return type="void" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<argument index="1" name="args" type="Array" default="[ ]" />
|
||||
<argument index="2" name="parent_first" type="bool" default="false" />
|
||||
<description>
|
||||
Calls the given method (if present) with the arguments given in [code]args[/code] on this node and recursively on all its children. If the [code]parent_first[/code] argument is [code]true[/code], the method will be called on the current node first, then on all its children. If [code]parent_first[/code] is [code]false[/code], the children will be called first.
|
||||
</description>
|
||||
</method>
|
||||
<method name="propagate_notification">
|
||||
@ -525,9 +520,8 @@
|
||||
</method>
|
||||
<method name="remove_from_group">
|
||||
<return type="void" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="0" name="group" type="StringName" />
|
||||
<description>
|
||||
Removes a node from a group. See notes in the description, and the group methods in [SceneTree].
|
||||
</description>
|
||||
</method>
|
||||
<method name="replace_by">
|
||||
@ -557,83 +551,72 @@
|
||||
</method>
|
||||
<method name="rpc" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. See also [method rset] and [method rset_config] for properties. Returns an empty [Variant].
|
||||
[b]Note:[/b] You can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [SceneTree]. You also need to keep track of the connection state, either by the [SceneTree] signals like [code]server_disconnected[/code] or by checking [code]SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="rpc_config">
|
||||
<return type="void" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode" />
|
||||
<description>
|
||||
Changes the RPC mode for the given [code]method[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, methods are not exposed to networking (and RPCs). See also [method rset] and [method rset_config] for properties.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rpc_id" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<description>
|
||||
Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant].
|
||||
</description>
|
||||
</method>
|
||||
<method name="rpc_unreliable" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
Sends a [method rpc] using an unreliable protocol. Returns an empty [Variant].
|
||||
</description>
|
||||
</method>
|
||||
<method name="rpc_unreliable_id" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<description>
|
||||
Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant].
|
||||
</description>
|
||||
</method>
|
||||
<method name="rset">
|
||||
<return type="void" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see [method rset_config]. See also [method rpc] for RPCs for methods, most information applies to this method as well.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rset_config">
|
||||
<return type="void" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode" />
|
||||
<description>
|
||||
Changes the RPC mode for the given [code]property[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, properties are not exposed to networking (and RPCs). See also [method rpc] and [method rpc_config] for methods.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rset_id">
|
||||
<return type="void" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="1" name="property" type="StringName" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Remotely changes the property's value on a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="rset_unreliable">
|
||||
<return type="void" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Remotely changes the property's value on other peers (and locally) using an unreliable protocol.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rset_unreliable_id">
|
||||
<return type="void" />
|
||||
<argument index="0" name="peer_id" type="int" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="1" name="property" type="StringName" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Remotely changes property's value on a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_display_folded">
|
||||
@ -735,7 +718,7 @@
|
||||
<member name="multiplayer" type="MultiplayerAPI" setter="" getter="get_multiplayer">
|
||||
The [MultiplayerAPI] instance associated with this node. Either the [member custom_multiplayer], or the default SceneTree one (if inside tree).
|
||||
</member>
|
||||
<member name="name" type="String" setter="set_name" getter="get_name">
|
||||
<member name="name" type="StringName" setter="set_name" getter="get_name">
|
||||
The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.
|
||||
[b]Note:[/b] Auto-generated names might include the [code]@[/code] character, which is reserved for unique names when using [method add_child]. When setting the name manually, any [code]@[/code] will be removed.
|
||||
</member>
|
||||
|
||||
@ -27,10 +27,8 @@
|
||||
<methods>
|
||||
<method name="_get" qualifiers="virtual">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<description>
|
||||
Virtual method which can be overridden to customize the return value of [method get].
|
||||
Returns the given property. Returns [code]null[/code] if the [code]property[/code] does not exist.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_property_list" qualifiers="virtual">
|
||||
@ -56,11 +54,9 @@
|
||||
</method>
|
||||
<method name="_set" qualifiers="virtual">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Virtual method which can be overridden to customize the return value of [method set].
|
||||
Sets a property. Returns [code]true[/code] if the [code]property[/code] exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="_to_string" qualifiers="virtual">
|
||||
@ -80,35 +76,21 @@
|
||||
</method>
|
||||
<method name="call" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
Calls the [code]method[/code] on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
|
||||
[codeblock]
|
||||
call("set", "position", Vector2(42.0, 0.0))
|
||||
[/codeblock]
|
||||
[b]Note:[/b] In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
|
||||
</description>
|
||||
</method>
|
||||
<method name="call_deferred" qualifiers="vararg">
|
||||
<return type="void" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
Calls the [code]method[/code] on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
|
||||
[codeblock]
|
||||
call_deferred("set", "position", Vector2(42.0, 0.0))
|
||||
[/codeblock]
|
||||
[b]Note:[/b] In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
|
||||
</description>
|
||||
</method>
|
||||
<method name="callv">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<argument index="1" name="arg_array" type="Array" />
|
||||
<description>
|
||||
Calls the [code]method[/code] on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array].
|
||||
[codeblock]
|
||||
callv("set", [ "position", Vector2(42.0, 0.0) ])
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="can_translate_messages" qualifiers="const">
|
||||
@ -119,49 +101,26 @@
|
||||
</method>
|
||||
<method name="connect">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="signal" type="String" />
|
||||
<argument index="0" name="signal" type="StringName" />
|
||||
<argument index="1" name="target" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<argument index="3" name="binds" type="Array" default="[ ]" />
|
||||
<argument index="4" name="flags" type="int" default="0" />
|
||||
<description>
|
||||
Connects a [code]signal[/code] to a [code]method[/code] on a [code]target[/code] object. Pass optional [code]binds[/code] to the call as an [Array] of parameters. These parameters will be passed to the method after any parameter used in the call to [method emit_signal]. Use [code]flags[/code] to set deferred or one-shot connections. See [enum ConnectFlags] constants.
|
||||
A [code]signal[/code] can only be connected once to a [code]method[/code]. It will throw an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections.
|
||||
If the [code]target[/code] is destroyed in the game's lifecycle, the connection will be lost.
|
||||
Examples:
|
||||
[codeblock]
|
||||
connect("pressed", self, "_on_Button_pressed") # BaseButton signal
|
||||
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
|
||||
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal
|
||||
[/codeblock]
|
||||
An example of the relationship between [code]binds[/code] passed to [method connect] and parameters used when calling [method emit_signal]:
|
||||
[codeblock]
|
||||
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
|
||||
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
|
||||
func _on_Player_hit(hit_by, level, weapon_type, damage):
|
||||
print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="disconnect">
|
||||
<return type="void" />
|
||||
<argument index="0" name="signal" type="String" />
|
||||
<argument index="0" name="signal" type="StringName" />
|
||||
<argument index="1" name="target" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<description>
|
||||
Disconnects a [code]signal[/code] from a [code]method[/code] on the given [code]target[/code].
|
||||
If you try to disconnect a connection that does not exist, the method will throw an error. Use [method is_connected] to ensure that the connection exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="emit_signal" qualifiers="vararg">
|
||||
<return type="void" />
|
||||
<argument index="0" name="signal" type="String" />
|
||||
<argument index="0" name="signal" type="StringName" />
|
||||
<description>
|
||||
Emits the given [code]signal[/code]. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
|
||||
[codeblock]
|
||||
emit_signal("hit", weapon_type, damage)
|
||||
emit_signal("game_over")
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="free">
|
||||
@ -265,23 +224,20 @@
|
||||
</method>
|
||||
<method name="has_method" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the object contains the given [code]method[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_signal" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="signal" type="String" />
|
||||
<argument index="0" name="signal" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given [code]signal[/code] exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_user_signal" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="signal" type="String" />
|
||||
<argument index="0" name="signal" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given user-defined [code]signal[/code] exists. Only signals added using [method add_user_signal] are taken into account.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_blocking_signals" qualifiers="const">
|
||||
@ -300,11 +256,10 @@
|
||||
</method>
|
||||
<method name="is_connected" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="signal" type="String" />
|
||||
<argument index="0" name="signal" type="StringName" />
|
||||
<argument index="1" name="target" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if a connection exists for a given [code]signal[/code], [code]target[/code], and [code]method[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_queued_for_deletion" qualifiers="const">
|
||||
@ -353,11 +308,9 @@
|
||||
</method>
|
||||
<method name="set_deferred">
|
||||
<return type="void" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. [code]call_deferred("set", property, value)[/code].
|
||||
[b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_indexed">
|
||||
@ -405,11 +358,9 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="tr" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="message" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="message" type="StringName" />
|
||||
<description>
|
||||
Translates a message using translation catalogs configured in the Project Settings.
|
||||
Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] unchanged. See [method set_message_translation].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -124,7 +124,7 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="area" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -148,14 +148,8 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="area" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<description>
|
||||
Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
|
||||
1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area.
|
||||
2: [RID] of the object that entered/exited the area.
|
||||
3: Instance ID of the object that entered/exited the area.
|
||||
4: The shape index of the object that entered/exited the area.
|
||||
5: The shape index of the area where the object entered/exited.
|
||||
</description>
|
||||
</method>
|
||||
<method name="area_set_monitorable">
|
||||
@ -486,10 +480,9 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="body" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<argument index="3" name="userdata" type="Variant" default="null" />
|
||||
<description>
|
||||
Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_set_max_contacts_reported">
|
||||
|
||||
@ -118,7 +118,7 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="area" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -142,14 +142,8 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="area" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<description>
|
||||
Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters:
|
||||
1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area.
|
||||
2: [RID] of the object that entered/exited the area.
|
||||
3: Instance ID of the object that entered/exited the area.
|
||||
4: The shape index of the object that entered/exited the area.
|
||||
5: The shape index of the area where the object entered/exited.
|
||||
</description>
|
||||
</method>
|
||||
<method name="area_set_monitorable">
|
||||
@ -497,10 +491,9 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="body" type="RID" />
|
||||
<argument index="1" name="receiver" type="Object" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<argument index="3" name="userdata" type="Variant" default="null" />
|
||||
<description>
|
||||
Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_set_kinematic_safe_margin">
|
||||
|
||||
71
doc/classes/PoolVector2iArray.xml
Normal file
71
doc/classes/PoolVector2iArray.xml
Normal file
@ -0,0 +1,71 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="PoolVector2iArray" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="PoolVector2iArray">
|
||||
<return type="PoolVector2iArray" />
|
||||
<argument index="0" name="from" type="Array" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="append">
|
||||
<argument index="0" name="vector2i" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="append_array">
|
||||
<argument index="0" name="array" type="PoolVector2iArray" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="empty">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="insert">
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="vector2i" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="invert">
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="push_back">
|
||||
<argument index="0" name="vector2i" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove">
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="resize">
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set">
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="vector2i" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="size">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
71
doc/classes/PoolVector3iArray.xml
Normal file
71
doc/classes/PoolVector3iArray.xml
Normal file
@ -0,0 +1,71 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="PoolVector3iArray" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="PoolVector3iArray">
|
||||
<return type="PoolVector3iArray" />
|
||||
<argument index="0" name="from" type="Array" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="append">
|
||||
<argument index="0" name="vector3i" type="Vector3i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="append_array">
|
||||
<argument index="0" name="array" type="PoolVector3iArray" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="empty">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="insert">
|
||||
<return type="int" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="vector3i" type="Vector3i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="invert">
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="push_back">
|
||||
<argument index="0" name="vector3i" type="Vector3i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove">
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="resize">
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set">
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="vector3i" type="Vector3i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="size">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
@ -168,6 +168,10 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="NetworkSynchronizer/debug_doll_speedup" type="bool" setter="" getter="" default="false">
|
||||
</member>
|
||||
<member name="NetworkSynchronizer/debug_server_speedup" type="bool" setter="" getter="" default="false">
|
||||
</member>
|
||||
<member name="android/modules" type="String" setter="" getter="" default="""">
|
||||
Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. [code]"org/godotengine/godot/MyCustomSingleton,com/example/foo/FrenchFriesFactory"[/code].
|
||||
[b]Note:[/b] Since Godot 3.2.2, the [code]org/godotengine/godot/GodotPaymentV3[/code] module was deprecated and replaced by the [code]GodotPayment[/code] plugin which should be enabled in the Android export preset under [code]Plugins[/code] section. The singleton to access in code was also renamed to [code]GodotPayment[/code].
|
||||
@ -402,7 +406,7 @@
|
||||
<member name="debug/gdscript/warnings/void_assignment" type="bool" setter="" getter="" default="true">
|
||||
If [code]true[/code], enables warnings when assigning the result of a function that returns [code]void[/code] to a variable.
|
||||
</member>
|
||||
<member name="debug/settings/crash_handler/message" type="String" setter="" getter="" default=""Please include this when reporting the bug on https://github.com/godotengine/godot/issues"">
|
||||
<member name="debug/settings/crash_handler/message" type="String" setter="" getter="" default=""Please include this when reporting the bug on https://github.com/Relintai/pandemonium_engine/issues"">
|
||||
Message to be displayed before the backtrace when the engine crashes.
|
||||
</member>
|
||||
<member name="debug/settings/fps/force_fps" type="int" setter="" getter="" default="0">
|
||||
@ -1015,7 +1019,7 @@
|
||||
<member name="logging/file_logging/enable_file_logging.pc" type="bool" setter="" getter="" default="true">
|
||||
Desktop override for [member logging/file_logging/enable_file_logging], as log files are not readily accessible on mobile/Web platforms.
|
||||
</member>
|
||||
<member name="logging/file_logging/log_path" type="String" setter="" getter="" default=""user://logs/godot.log"">
|
||||
<member name="logging/file_logging/log_path" type="String" setter="" getter="" default=""user://logs/pandemonium.log"">
|
||||
Path to logs within the project. Using an [code]user://[/code] path is recommended.
|
||||
</member>
|
||||
<member name="logging/file_logging/max_log_files" type="int" setter="" getter="" default="5">
|
||||
@ -1029,7 +1033,6 @@
|
||||
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">
|
||||
This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number.
|
||||
</member>
|
||||
|
||||
<member name="network/limits/debugger_stdout/max_chars_per_second" type="int" setter="" getter="" default="2048">
|
||||
Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
|
||||
</member>
|
||||
@ -1149,9 +1152,6 @@
|
||||
<member name="physics/2d/use_bvh" type="bool" setter="" getter="" default="true">
|
||||
Enables the use of bounding volume hierarchy instead of hash grid for 2D physics spatial partitioning. This may give better performance.
|
||||
</member>
|
||||
<member name="physics/3d/active_soft_world" type="bool" setter="" getter="" default="true">
|
||||
Sets whether the 3D physics world will be created with support for [SoftBody] physics. Only applies to the Bullet physics engine.
|
||||
</member>
|
||||
<member name="physics/3d/default_angular_damp" type="float" setter="" getter="" default="0.1">
|
||||
The default angular damp in 3D.
|
||||
[b]Note:[/b] Good values are in the range [code]0[/code] to [code]1[/code]. At value [code]0[/code] objects will keep moving with the same velocity. Values greater than [code]1[/code] will aim to reduce the velocity to [code]0[/code] in less than a second e.g. a value of [code]2[/code] will aim to reduce the velocity to [code]0[/code] in half a second. A value equal to or greater than the physics frame rate ([member ProjectSettings.physics/common/physics_fps], [code]60[/code] by default) will bring the object to a stop in one iteration.
|
||||
@ -1176,22 +1176,24 @@
|
||||
The default linear damp in 3D.
|
||||
[b]Note:[/b] Good values are in the range [code]0[/code] to [code]1[/code]. At value [code]0[/code] objects will keep moving with the same velocity. Values greater than [code]1[/code] will aim to reduce the velocity to [code]0[/code] in less than a second e.g. a value of [code]2[/code] will aim to reduce the velocity to [code]0[/code] in half a second. A value equal to or greater than the physics frame rate ([member ProjectSettings.physics/common/physics_fps], [code]60[/code] by default) will bring the object to a stop in one iteration.
|
||||
</member>
|
||||
<member name="physics/3d/godot_physics/bvh_collision_margin" type="float" setter="" getter="" default="0.1">
|
||||
Additional expansion applied to object bounds in the 3D physics bounding volume hierarchy. This can reduce BVH processing at the cost of a slightly coarser broadphase, which can stress the physics more in some situations.
|
||||
The default value will work well in most situations. A value of 0.0 will turn this optimization off, and larger values may work better for larger, faster moving objects.
|
||||
[b]Note:[/b] Used only if [member ProjectSettings.physics/3d/godot_physics/use_bvh] is enabled.
|
||||
<member name="physics/3d/pandemonium_physics/bvh_collision_margin" type="float" setter="" getter="" default="0.1">
|
||||
</member>
|
||||
<member name="physics/3d/godot_physics/use_bvh" type="bool" setter="" getter="" default="true">
|
||||
Enables the use of bounding volume hierarchy instead of octree for 3D physics spatial partitioning. This may give better performance.
|
||||
<member name="physics/3d/pandemonium_physics/use_bvh" type="bool" setter="" getter="" default="true">
|
||||
</member>
|
||||
<member name="physics/3d/physics_engine" type="String" setter="" getter="" default=""DEFAULT"">
|
||||
Sets which physics engine to use for 3D physics.
|
||||
"DEFAULT" is currently the [url=https://bulletphysics.org]Bullet[/url] physics engine. The "GodotPhysics" engine is still supported as an alternative.
|
||||
</member>
|
||||
<member name="physics/3d/sleep_threshold_angular" type="float" setter="" getter="" default="0.139626">
|
||||
</member>
|
||||
<member name="physics/3d/sleep_threshold_linear" type="float" setter="" getter="" default="0.1">
|
||||
</member>
|
||||
<member name="physics/3d/smooth_trimesh_collision" type="bool" setter="" getter="" default="false">
|
||||
If [code]true[/code], smooths out collision with trimesh shapes ([ConcavePolygonShape]) by telling the Bullet physics engine to generate internal edge information for every trimesh shape created.
|
||||
[b]Note:[/b] Only effective if [member physics/3d/physics_engine] is set to [code]DEFAULT[/code] or [code]Bullet[/code], [i]not[/i] [code]GodotPhysics[/code].
|
||||
</member>
|
||||
<member name="physics/3d/time_before_sleep" type="float" setter="" getter="" default="0.5">
|
||||
</member>
|
||||
<member name="physics/common/enable_object_picking" type="bool" setter="" getter="" default="true">
|
||||
Enables [member Viewport.physics_object_picking] on the root viewport.
|
||||
</member>
|
||||
|
||||
@ -16,10 +16,8 @@
|
||||
<methods>
|
||||
<method name="Rect2">
|
||||
<return type="Rect2" />
|
||||
<argument index="0" name="position" type="Vector2" />
|
||||
<argument index="1" name="size" type="Vector2" />
|
||||
<argument index="0" name="from" type="Rect2i" />
|
||||
<description>
|
||||
Constructs a [Rect2] by position and size.
|
||||
</description>
|
||||
</method>
|
||||
<method name="Rect2">
|
||||
@ -32,6 +30,14 @@
|
||||
Constructs a [Rect2] by x, y, width, and height.
|
||||
</description>
|
||||
</method>
|
||||
<method name="Rect2">
|
||||
<return type="Rect2" />
|
||||
<argument index="0" name="position" type="Vector2" />
|
||||
<argument index="1" name="size" type="Vector2" />
|
||||
<description>
|
||||
Constructs a [Rect2] by position and size.
|
||||
</description>
|
||||
</method>
|
||||
<method name="abs">
|
||||
<return type="Rect2" />
|
||||
<description>
|
||||
|
||||
100
doc/classes/Rect2i.xml
Normal file
100
doc/classes/Rect2i.xml
Normal file
@ -0,0 +1,100 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="Rect2i" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="Rect2i">
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="from" type="Rect2" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="clip">
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="b" type="Rect2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="encloses">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="b" type="Rect2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="expand">
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="to" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_area">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_center">
|
||||
<return type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="grow">
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="by" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="grow_individual">
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="left" type="int" />
|
||||
<argument index="1" name="top" type="int" />
|
||||
<argument index="2" name="right" type="int" />
|
||||
<argument index="3" name=" bottom" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="grow_margin">
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="margin" type="int" />
|
||||
<argument index="1" name="by" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_no_area">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_point">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="point" type="Vector2" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="intersects">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="b" type="Rect2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="merge">
|
||||
<return type="Rect2i" />
|
||||
<argument index="0" name="b" type="Rect2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="end" type="Vector2i" setter="" getter="" default="Vector2i( 0, 0 )">
|
||||
</member>
|
||||
<member name="position" type="Vector2i" setter="" getter="" default="Vector2i( 0, 0 )">
|
||||
</member>
|
||||
<member name="size" type="Vector2i" setter="" getter="" default="Vector2i( 0, 0 )">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
@ -36,10 +36,8 @@
|
||||
</method>
|
||||
<method name="handles_type" qualifiers="virtual">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="typename" type="String" />
|
||||
<argument index="0" name="typename" type="StringName" />
|
||||
<description>
|
||||
Tells which resource class this loader can load.
|
||||
[b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them.
|
||||
</description>
|
||||
</method>
|
||||
<method name="load" qualifiers="virtual">
|
||||
|
||||
@ -12,17 +12,15 @@
|
||||
<methods>
|
||||
<method name="add_resource">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="resource" type="Resource" />
|
||||
<description>
|
||||
Adds a resource to the preloader with the given [code]name[/code]. If a resource with the given [code]name[/code] already exists, the new resource will be renamed to "[code]name[/code] N" where N is an incrementing number starting from 2.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_resource" qualifiers="const">
|
||||
<return type="Resource" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the resource associated to [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_resource_list" qualifiers="const">
|
||||
@ -33,24 +31,21 @@
|
||||
</method>
|
||||
<method name="has_resource" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_resource">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes the resource associated to [code]name[/code] from the preloader.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_resource">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="newname" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="newname" type="StringName" />
|
||||
<description>
|
||||
Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -32,14 +32,14 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connection_method" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the method connected to the signal at [code]idx[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connection_signal" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the name of the signal at [code]idx[/code].
|
||||
@ -95,7 +95,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the name of the node at [code]idx[/code].
|
||||
@ -126,7 +126,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_property_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<argument index="1" name="prop_idx" type="int" />
|
||||
<description>
|
||||
@ -142,7 +142,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_node_type" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the type of the node at [code]idx[/code].
|
||||
|
||||
@ -15,28 +15,17 @@
|
||||
<methods>
|
||||
<method name="call_group" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="0" name="group" type="StringName" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<description>
|
||||
Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. This method is equivalent of calling [method call_group_flags] with [constant GROUP_CALL_DEFAULT] flag.
|
||||
[b]Note:[/b] [code]method[/code] may only have 5 arguments at most (7 arguments passed to this method in total).
|
||||
[b]Note:[/b] Due to design limitations, [method call_group] will fail silently if one of the arguments is [code]null[/code].
|
||||
[b]Note:[/b] [method call_group] will always call methods with an one-frame delay, in a way similar to [method Object.call_deferred]. To call methods immediately, use [method call_group_flags] with the [constant GROUP_CALL_REALTIME] flag.
|
||||
</description>
|
||||
</method>
|
||||
<method name="call_group_flags" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="flags" type="int" />
|
||||
<argument index="1" name="group" type="String" />
|
||||
<argument index="2" name="method" type="String" />
|
||||
<argument index="1" name="group" type="StringName" />
|
||||
<argument index="2" name="method" type="StringName" />
|
||||
<description>
|
||||
Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call.
|
||||
[b]Note:[/b] [code]method[/code] may only have 5 arguments at most (8 arguments passed to this method in total).
|
||||
[b]Note:[/b] Due to design limitations, [method call_group_flags] will fail silently if one of the arguments is [code]null[/code].
|
||||
[codeblock]
|
||||
# Call the method immediately and in reverse order.
|
||||
get_tree().call_group_flags(SceneTree.GROUP_CALL_REALTIME | SceneTree.GROUP_CALL_REVERSE, "bases", "destroy")
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="change_scene">
|
||||
@ -99,9 +88,8 @@
|
||||
</method>
|
||||
<method name="get_nodes_in_group">
|
||||
<return type="Array" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="0" name="group" type="StringName" />
|
||||
<description>
|
||||
Returns a list of all nodes assigned to the given group.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_rpc_sender_id" qualifiers="const">
|
||||
@ -112,9 +100,8 @@
|
||||
</method>
|
||||
<method name="has_group" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given group exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_network_peer" qualifiers="const">
|
||||
@ -137,19 +124,17 @@
|
||||
</method>
|
||||
<method name="notify_group">
|
||||
<return type="void" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="0" name="group" type="StringName" />
|
||||
<argument index="1" name="notification" type="int" />
|
||||
<description>
|
||||
Sends the given notification to all members of the [code]group[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="notify_group_flags">
|
||||
<return type="void" />
|
||||
<argument index="0" name="call_flags" type="int" />
|
||||
<argument index="1" name="group" type="String" />
|
||||
<argument index="1" name="group" type="StringName" />
|
||||
<argument index="2" name="notification" type="int" />
|
||||
<description>
|
||||
Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags].
|
||||
</description>
|
||||
</method>
|
||||
<method name="queue_delete">
|
||||
@ -184,21 +169,19 @@
|
||||
</method>
|
||||
<method name="set_group">
|
||||
<return type="void" />
|
||||
<argument index="0" name="group" type="String" />
|
||||
<argument index="0" name="group" type="StringName" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets the given [code]property[/code] to [code]value[/code] on all members of the given group.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_group_flags">
|
||||
<return type="void" />
|
||||
<argument index="0" name="call_flags" type="int" />
|
||||
<argument index="1" name="group" type="String" />
|
||||
<argument index="1" name="group" type="StringName" />
|
||||
<argument index="2" name="property" type="String" />
|
||||
<argument index="3" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GroupCallFlags].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_input_as_handled">
|
||||
|
||||
@ -24,16 +24,15 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_instance_base_type" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<description>
|
||||
Returns the script's base type.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_property_default_value">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="property" type="String" />
|
||||
<argument index="0" name="property" type="StringName" />
|
||||
<description>
|
||||
Returns the default value of the specified property.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_script_constant_map">
|
||||
@ -62,9 +61,8 @@
|
||||
</method>
|
||||
<method name="has_script_signal" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="signal_name" type="String" />
|
||||
<argument index="0" name="signal_name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_source_code" qualifiers="const">
|
||||
|
||||
@ -13,10 +13,8 @@
|
||||
<methods>
|
||||
<method name="get_default_texture_param" qualifiers="const">
|
||||
<return type="Texture" />
|
||||
<argument index="0" name="param" type="String" />
|
||||
<argument index="0" name="param" type="StringName" />
|
||||
<description>
|
||||
Returns the texture that is set as default for the specified parameter.
|
||||
[b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_mode" qualifiers="const">
|
||||
@ -27,19 +25,15 @@
|
||||
</method>
|
||||
<method name="has_param" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the shader has this param defined as a uniform in its code.
|
||||
[b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_default_texture_param">
|
||||
<return type="void" />
|
||||
<argument index="0" name="param" type="String" />
|
||||
<argument index="0" name="param" type="StringName" />
|
||||
<argument index="1" name="texture" type="Texture" />
|
||||
<description>
|
||||
Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial].
|
||||
[b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -13,9 +13,8 @@
|
||||
<methods>
|
||||
<method name="get_shader_param" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="param" type="String" />
|
||||
<argument index="0" name="param" type="StringName" />
|
||||
<description>
|
||||
Returns the current value set for this material of a uniform in the shader.
|
||||
</description>
|
||||
</method>
|
||||
<method name="property_can_revert">
|
||||
@ -34,11 +33,9 @@
|
||||
</method>
|
||||
<method name="set_shader_param">
|
||||
<return type="void" />
|
||||
<argument index="0" name="param" type="String" />
|
||||
<argument index="0" name="param" type="StringName" />
|
||||
<argument index="1" name="value" type="Variant" />
|
||||
<description>
|
||||
Changes the value set for this material of a uniform in the shader.
|
||||
[b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -71,7 +71,7 @@
|
||||
<member name="override_tip_basis" type="bool" setter="set_override_tip_basis" getter="is_override_tip_basis" default="true">
|
||||
If [code]true[/code] overwrites the rotation of the tip bone with the rotation of the [member target] (or [member target_node] if defined).
|
||||
</member>
|
||||
<member name="root_bone" type="String" setter="set_root_bone" getter="get_root_bone" default="""">
|
||||
<member name="root_bone" type="StringName" setter="set_root_bone" getter="get_root_bone" default="@""">
|
||||
The name of the current root bone, the first bone in the IK chain.
|
||||
</member>
|
||||
<member name="target" type="Transform" setter="set_target_transform" getter="get_target_transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
|
||||
@ -80,7 +80,7 @@
|
||||
<member name="target_node" type="NodePath" setter="set_target_node" getter="get_target_node" default="NodePath("")">
|
||||
Target node [NodePath] for the IK chain. If available, the node's current [Transform] is used instead of the [member target] property.
|
||||
</member>
|
||||
<member name="tip_bone" type="String" setter="set_tip_bone" getter="get_tip_bone" default="""">
|
||||
<member name="tip_bone" type="StringName" setter="set_tip_bone" getter="get_tip_bone" default="@""">
|
||||
The name of the current tip bone, the last bone in the IK chain placed at the [member target] transform (or [member target_node] if defined).
|
||||
</member>
|
||||
<member name="use_magnet" type="bool" setter="set_use_magnet" getter="is_using_magnet" default="false">
|
||||
|
||||
@ -31,7 +31,7 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bind_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="bind_index" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
@ -58,7 +58,7 @@
|
||||
<method name="set_bind_name">
|
||||
<return type="void" />
|
||||
<argument index="0" name="bind_index" type="int" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -86,7 +86,7 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="areaAngular_stiffness" type="float" setter="set_areaAngular_stiffness" getter="get_areaAngular_stiffness" default="0.5">
|
||||
<member name="areaAngular_stiffness" type="float" setter="set_areaAngular_stiffness" getter="get_areaAngular_stiffness" default="0.0">
|
||||
</member>
|
||||
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer" default="1">
|
||||
The physics layers this SoftBody is in.
|
||||
@ -96,11 +96,11 @@
|
||||
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
|
||||
The physics layers this SoftBody scans for collisions. See [url=$DOCS_URL/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
|
||||
</member>
|
||||
<member name="damping_coefficient" type="float" setter="set_damping_coefficient" getter="get_damping_coefficient" default="0.01">
|
||||
<member name="damping_coefficient" type="float" setter="set_damping_coefficient" getter="get_damping_coefficient" default="0.0">
|
||||
</member>
|
||||
<member name="drag_coefficient" type="float" setter="set_drag_coefficient" getter="get_drag_coefficient" default="0.0">
|
||||
</member>
|
||||
<member name="linear_stiffness" type="float" setter="set_linear_stiffness" getter="get_linear_stiffness" default="0.5">
|
||||
<member name="linear_stiffness" type="float" setter="set_linear_stiffness" getter="get_linear_stiffness" default="0.0">
|
||||
</member>
|
||||
<member name="parent_collision_ignore" type="NodePath" setter="set_parent_collision_ignore" getter="get_parent_collision_ignore" default="NodePath("")">
|
||||
[NodePath] to a [CollisionObject] this SoftBody should avoid clipping.
|
||||
@ -115,13 +115,13 @@
|
||||
<member name="ray_pickable" type="bool" setter="set_ray_pickable" getter="is_ray_pickable" default="true">
|
||||
If [code]true[/code], the [SoftBody] will respond to [RayCast]s.
|
||||
</member>
|
||||
<member name="simulation_precision" type="int" setter="set_simulation_precision" getter="get_simulation_precision" default="5">
|
||||
<member name="simulation_precision" type="int" setter="set_simulation_precision" getter="get_simulation_precision" default="0">
|
||||
Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
|
||||
</member>
|
||||
<member name="total_mass" type="float" setter="set_total_mass" getter="get_total_mass" default="1.0">
|
||||
<member name="total_mass" type="float" setter="set_total_mass" getter="get_total_mass" default="0.0">
|
||||
The SoftBody's mass.
|
||||
</member>
|
||||
<member name="volume_stiffness" type="float" setter="set_volume_stiffness" getter="get_volume_stiffness" default="0.5">
|
||||
<member name="volume_stiffness" type="float" setter="set_volume_stiffness" getter="get_volume_stiffness" default="0.0">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
|
||||
@ -12,25 +12,22 @@
|
||||
<methods>
|
||||
<method name="add_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<description>
|
||||
Adds a new animation to the library.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_frame">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<argument index="1" name="frame" type="Texture" />
|
||||
<argument index="2" name="at_position" type="int" default="-1" />
|
||||
<description>
|
||||
Adds a frame to the given animation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<description>
|
||||
Removes all frames from the given animation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_all">
|
||||
@ -41,9 +38,8 @@
|
||||
</method>
|
||||
<method name="get_animation_loop" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_animation_names" qualifiers="const">
|
||||
@ -54,79 +50,69 @@
|
||||
</method>
|
||||
<method name="get_animation_speed" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<description>
|
||||
The animation's speed in frames per second.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_frame" qualifiers="const">
|
||||
<return type="Texture" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<argument index="1" name="idx" type="int" />
|
||||
<description>
|
||||
Returns the animation's selected frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_frame_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<description>
|
||||
Returns the number of frames in the animation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_animation" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<description>
|
||||
If [code]true[/code], the named animation exists.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<description>
|
||||
Removes the given animation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_frame">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<argument index="1" name="idx" type="int" />
|
||||
<description>
|
||||
Removes the animation's selected frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_animation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="1" name="newname" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<argument index="1" name="newname" type="StringName" />
|
||||
<description>
|
||||
Changes the animation's name to [code]newname[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_animation_loop">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<argument index="1" name="loop" type="bool" />
|
||||
<description>
|
||||
If [code]true[/code], the animation will loop.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_animation_speed">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<argument index="1" name="speed" type="float" />
|
||||
<description>
|
||||
The animation's speed in frames per second.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_frame">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim" type="String" />
|
||||
<argument index="0" name="anim" type="StringName" />
|
||||
<argument index="1" name="idx" type="int" />
|
||||
<argument index="2" name="txt" type="Texture" />
|
||||
<description>
|
||||
Sets the texture of the given frame.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -38,6 +38,12 @@
|
||||
Constructs a new String from the given [Vector2].
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="Rect2" />
|
||||
@ -45,6 +51,12 @@
|
||||
Constructs a new String from the given [Rect2].
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="Rect2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="Vector3" />
|
||||
@ -52,6 +64,12 @@
|
||||
Constructs a new String from the given [Vector3].
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="Vector3i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="Transform2D" />
|
||||
@ -115,6 +133,12 @@
|
||||
Constructs a new String from the given [RID].
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="Dictionary" />
|
||||
@ -164,6 +188,12 @@
|
||||
Constructs a new String from the given [PoolVector2Array].
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="PoolVector2iArray" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="PoolVector3Array" />
|
||||
@ -171,6 +201,12 @@
|
||||
Constructs a new String from the given [PoolVector3Array].
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="PoolVector3iArray" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="String">
|
||||
<return type="String" />
|
||||
<argument index="0" name="from" type="PoolColorArray" />
|
||||
|
||||
19
doc/classes/StringName.xml
Normal file
19
doc/classes/StringName.xml
Normal file
@ -0,0 +1,19 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="StringName" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="StringName">
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="from" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
@ -19,58 +19,51 @@
|
||||
</method>
|
||||
<method name="clear_color">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Clears the [Color] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_constant">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Clears the constant at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_font">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Clears the [Font] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_icon">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Clears the icon at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_stylebox">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Clears [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_theme_item">
|
||||
<return type="void" />
|
||||
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Clears the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_type_variation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="theme_type" type="String" />
|
||||
<argument index="0" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Unmarks [code]theme_type[/code] as being a variation of another theme type. See [method set_type_variation].
|
||||
</description>
|
||||
</method>
|
||||
<method name="copy_default_theme">
|
||||
@ -88,10 +81,9 @@
|
||||
</method>
|
||||
<method name="get_color" qualifiers="const">
|
||||
<return type="Color" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns the [Color] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_color_list" qualifiers="const">
|
||||
@ -109,10 +101,9 @@
|
||||
</method>
|
||||
<method name="get_constant" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns the constant at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_constant_list" qualifiers="const">
|
||||
@ -130,10 +121,9 @@
|
||||
</method>
|
||||
<method name="get_font" qualifiers="const">
|
||||
<return type="Font" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns the [Font] at [code]name[/code] if the theme has [code]node_type[/code]. If such item does not exist and [member default_font] is set on the theme, the default font will be returned.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_font_list" qualifiers="const">
|
||||
@ -151,10 +141,9 @@
|
||||
</method>
|
||||
<method name="get_icon" qualifiers="const">
|
||||
<return type="Texture" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns the icon [Texture] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_icon_list" qualifiers="const">
|
||||
@ -172,11 +161,9 @@
|
||||
</method>
|
||||
<method name="get_stylebox" qualifiers="const">
|
||||
<return type="StyleBox" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns the [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
Valid [code]name[/code]s may be found using [method get_stylebox_list]. Valid [code]node_type[/code]s may be found using [method get_stylebox_types].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_stylebox_list" qualifiers="const">
|
||||
@ -196,11 +183,9 @@
|
||||
<method name="get_theme_item" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code].
|
||||
Valid [code]name[/code]s may be found using [method get_theme_item_list] or a data type specific method. Valid [code]node_type[/code]s may be found using [method get_theme_item_types] or a data type specific method.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_theme_item_list" qualifiers="const">
|
||||
@ -228,35 +213,29 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_type_variation_base" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="theme_type" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns the name of the base theme type if [code]theme_type[/code] is a valid variation type. Returns an empty string otherwise.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_type_variation_list" qualifiers="const">
|
||||
<return type="PoolStringArray" />
|
||||
<argument index="0" name="base_type" type="String" />
|
||||
<argument index="0" name="base_type" type="StringName" />
|
||||
<description>
|
||||
Returns a list of all type variations for the given [code]base_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_color" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]node_type[/code].
|
||||
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_constant" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if constant with [code]name[/code] is in [code]node_type[/code].
|
||||
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_default_font" qualifiers="const">
|
||||
@ -267,47 +246,38 @@
|
||||
</method>
|
||||
<method name="has_font" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]node_type[/code].
|
||||
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_icon" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]node_type[/code].
|
||||
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_stylebox" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]node_type[/code].
|
||||
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_theme_item" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if a theme item of [code]data_type[/code] with [code]name[/code] is in [code]node_type[/code].
|
||||
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_type_variation" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="theme_type" type="String" />
|
||||
<argument index="1" name="base_type" type="String" />
|
||||
<argument index="0" name="theme_type" type="StringName" />
|
||||
<argument index="1" name="base_type" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="merge_with">
|
||||
@ -320,130 +290,107 @@
|
||||
</method>
|
||||
<method name="rename_color">
|
||||
<return type="void" />
|
||||
<argument index="0" name="old_name" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="0" name="old_name" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Renames the [Color] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_constant">
|
||||
<return type="void" />
|
||||
<argument index="0" name="old_name" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="0" name="old_name" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Renames the constant at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_font">
|
||||
<return type="void" />
|
||||
<argument index="0" name="old_name" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="0" name="old_name" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Renames the [Font] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_icon">
|
||||
<return type="void" />
|
||||
<argument index="0" name="old_name" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="0" name="old_name" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Renames the icon at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_stylebox">
|
||||
<return type="void" />
|
||||
<argument index="0" name="old_name" type="String" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="0" name="old_name" type="StringName" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Renames [StyleBox] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_theme_item">
|
||||
<return type="void" />
|
||||
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
|
||||
<argument index="1" name="old_name" type="String" />
|
||||
<argument index="2" name="name" type="String" />
|
||||
<argument index="3" name="theme_type" type="String" />
|
||||
<argument index="1" name="old_name" type="StringName" />
|
||||
<argument index="2" name="name" type="StringName" />
|
||||
<argument index="3" name="theme_type" type="StringName" />
|
||||
<description>
|
||||
Renames the theme item of [code]data_type[/code] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_color">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<argument index="2" name="color" type="Color" />
|
||||
<description>
|
||||
Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]node_type[/code].
|
||||
Creates [code]node_type[/code] if the theme does not have it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_constant">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<argument index="2" name="constant" type="int" />
|
||||
<description>
|
||||
Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]node_type[/code].
|
||||
Creates [code]node_type[/code] if the theme does not have it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_font">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<argument index="2" name="font" type="Font" />
|
||||
<description>
|
||||
Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]node_type[/code].
|
||||
Creates [code]node_type[/code] if the theme does not have it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_icon">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<argument index="2" name="texture" type="Texture" />
|
||||
<description>
|
||||
Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]node_type[/code].
|
||||
Creates [code]node_type[/code] if the theme does not have it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_stylebox">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="1" name="theme_type" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="theme_type" type="StringName" />
|
||||
<argument index="2" name="texture" type="StyleBox" />
|
||||
<description>
|
||||
Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]node_type[/code].
|
||||
Creates [code]node_type[/code] if the theme does not have it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_theme_item">
|
||||
<return type="void" />
|
||||
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="2" name="theme_type" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="theme_type" type="StringName" />
|
||||
<argument index="3" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets the theme item of [code]data_type[/code] to [code]value[/code] at [code]name[/code] in [code]node_type[/code].
|
||||
Does nothing if the [code]value[/code] type does not match [code]data_type[/code].
|
||||
Creates [code]node_type[/code] if the theme does not have it.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_type_variation">
|
||||
<return type="void" />
|
||||
<argument index="0" name="theme_type" type="String" />
|
||||
<argument index="1" name="base_type" type="String" />
|
||||
<argument index="0" name="theme_type" type="StringName" />
|
||||
<argument index="1" name="base_type" type="StringName" />
|
||||
<description>
|
||||
Marks [code]theme_type[/code] as a variation of [code]base_type[/code].
|
||||
This adds [code]theme_type[/code] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [code]base_type[/code] class.
|
||||
Variations can also be nested, i.e. [code]base_type[/code] can be another variation. If a chain of variations ends with a [code]base_type[/code] matching the class of the [Control], the whole chain is going to be suggested as options.
|
||||
[b]Note:[/b] Suggestions only show up if this theme resource is set as the project default theme. See [member ProjectSettings.gui/theme/custom].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -35,12 +35,10 @@
|
||||
<method name="start">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="instance" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<argument index="2" name="userdata" type="Variant" default="null" />
|
||||
<argument index="3" name="priority" type="int" enum="Thread.Priority" default="1" />
|
||||
<description>
|
||||
Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum.
|
||||
Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure.
|
||||
</description>
|
||||
</method>
|
||||
<method name="wait_to_finish">
|
||||
|
||||
@ -20,24 +20,21 @@
|
||||
</method>
|
||||
<method name="add_message">
|
||||
<return type="void" />
|
||||
<argument index="0" name="src_message" type="String" />
|
||||
<argument index="1" name="xlated_message" type="String" />
|
||||
<argument index="0" name="src_message" type="StringName" />
|
||||
<argument index="1" name="xlated_message" type="StringName" />
|
||||
<description>
|
||||
Adds a message if nonexistent, followed by its translation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="erase_message">
|
||||
<return type="void" />
|
||||
<argument index="0" name="src_message" type="String" />
|
||||
<argument index="0" name="src_message" type="StringName" />
|
||||
<description>
|
||||
Erases a message.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_message" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="src_message" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="src_message" type="StringName" />
|
||||
<description>
|
||||
Returns a message's translation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_message_count" qualifiers="const">
|
||||
|
||||
@ -60,10 +60,9 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="translate" qualifiers="const">
|
||||
<return type="String" />
|
||||
<argument index="0" name="message" type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="message" type="StringName" />
|
||||
<description>
|
||||
Returns the current locale's translation for the given message (key).
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -23,9 +23,8 @@
|
||||
</method>
|
||||
<method name="call_recursive" qualifiers="vararg">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="method" type="String" />
|
||||
<argument index="0" name="method" type="StringName" />
|
||||
<description>
|
||||
Calls the [code]method[/code] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_custom_bg_color">
|
||||
@ -371,10 +370,8 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="column" type="int" />
|
||||
<argument index="1" name="object" type="Object" />
|
||||
<argument index="2" name="callback" type="String" />
|
||||
<argument index="2" name="callback" type="StringName" />
|
||||
<description>
|
||||
Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code].
|
||||
The [code]callback[/code] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_editable">
|
||||
|
||||
@ -25,17 +25,15 @@
|
||||
<method name="follow_method">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<argument index="2" name="initial_val" type="Variant" />
|
||||
<argument index="3" name="target" type="Object" />
|
||||
<argument index="4" name="target_method" type="String" />
|
||||
<argument index="4" name="target_method" type="StringName" />
|
||||
<argument index="5" name="duration" type="float" />
|
||||
<argument index="6" name="trans_type" type="int" enum="Tween.TransitionType" default="0" />
|
||||
<argument index="7" name="ease_type" type="int" enum="Tween.EaseType" default="2" />
|
||||
<argument index="8" name="delay" type="float" default="0" />
|
||||
<description>
|
||||
Follows [code]method[/code] of [code]object[/code] and applies the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are called with consecutive values.
|
||||
Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="follow_property">
|
||||
@ -97,7 +95,7 @@
|
||||
<method name="interpolate_method">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<argument index="2" name="initial_val" type="Variant" />
|
||||
<argument index="3" name="final_val" type="Variant" />
|
||||
<argument index="4" name="duration" type="float" />
|
||||
@ -105,8 +103,6 @@
|
||||
<argument index="6" name="ease_type" type="int" enum="Tween.EaseType" default="2" />
|
||||
<argument index="7" name="delay" type="float" default="0" />
|
||||
<description>
|
||||
Animates [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are called with consecutive values.
|
||||
Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="interpolate_property">
|
||||
@ -134,9 +130,8 @@
|
||||
<method name="remove">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="key" type="String" default="""" />
|
||||
<argument index="1" name="key" type="StringName" default="""" />
|
||||
<description>
|
||||
Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_all">
|
||||
@ -148,9 +143,8 @@
|
||||
<method name="reset">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="key" type="String" default="""" />
|
||||
<argument index="1" name="key" type="StringName" default="""" />
|
||||
<description>
|
||||
Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="reset_all">
|
||||
@ -162,9 +156,8 @@
|
||||
<method name="resume">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="key" type="String" default="""" />
|
||||
<argument index="1" name="key" type="StringName" default="""" />
|
||||
<description>
|
||||
Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless [code]key[/code] is specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="resume_all">
|
||||
@ -196,9 +189,8 @@
|
||||
<method name="stop">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="key" type="String" default="""" />
|
||||
<argument index="1" name="key" type="StringName" default="""" />
|
||||
<description>
|
||||
Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless [code]key[/code] is specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop_all">
|
||||
@ -210,17 +202,15 @@
|
||||
<method name="targeting_method">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<argument index="2" name="initial" type="Object" />
|
||||
<argument index="3" name="initial_method" type="String" />
|
||||
<argument index="3" name="initial_method" type="StringName" />
|
||||
<argument index="4" name="final_val" type="Variant" />
|
||||
<argument index="5" name="duration" type="float" />
|
||||
<argument index="6" name="trans_type" type="int" enum="Tween.TransitionType" default="0" />
|
||||
<argument index="7" name="ease_type" type="int" enum="Tween.EaseType" default="2" />
|
||||
<argument index="8" name="delay" type="float" default="0" />
|
||||
<description>
|
||||
Animates [code]method[/code] of [code]object[/code] from the value returned by [code]initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values.
|
||||
Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information.
|
||||
</description>
|
||||
</method>
|
||||
<method name="targeting_property">
|
||||
|
||||
@ -42,10 +42,9 @@
|
||||
<method name="add_do_property">
|
||||
<return type="void" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="1" name="property" type="StringName" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Register a property value change for "do".
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_do_reference">
|
||||
@ -58,18 +57,16 @@
|
||||
<method name="add_undo_method" qualifiers="vararg">
|
||||
<return type="void" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<description>
|
||||
Register a method that will be called when the action is undone.
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_undo_property">
|
||||
<return type="void" />
|
||||
<argument index="0" name="object" type="Object" />
|
||||
<argument index="1" name="property" type="String" />
|
||||
<argument index="1" name="property" type="StringName" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Register a property value change for "undo".
|
||||
</description>
|
||||
</method>
|
||||
<method name="add_undo_reference">
|
||||
|
||||
@ -16,6 +16,12 @@
|
||||
<link title="All 2D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/2d</link>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="Vector2">
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="from" type="Vector2i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="Vector2">
|
||||
<return type="Vector2" />
|
||||
<argument index="0" name="x" type="float" />
|
||||
|
||||
55
doc/classes/Vector2i.xml
Normal file
55
doc/classes/Vector2i.xml
Normal file
@ -0,0 +1,55 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="Vector2i" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="Vector2i">
|
||||
<return type="Vector2i" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="Vector2i">
|
||||
<return type="Vector2i" />
|
||||
<argument index="0" name="from" type="Vector2" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="linear_interpolate">
|
||||
<return type="Vector2i" />
|
||||
<argument index="0" name="to" type="Vector2" />
|
||||
<argument index="1" name="weight" type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="x" type="int" setter="" getter="" default="0">
|
||||
</member>
|
||||
<member name="y" type="int" setter="" getter="" default="0">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="AXIS_X" value="0">
|
||||
</constant>
|
||||
<constant name="AXIS_Y" value="1">
|
||||
</constant>
|
||||
<constant name="ZERO" value="Vector2i( 0, 0 )">
|
||||
</constant>
|
||||
<constant name="ONE" value="Vector2i( 1, 1 )">
|
||||
</constant>
|
||||
<constant name="LEFT" value="Vector2i( -1, 0 )">
|
||||
</constant>
|
||||
<constant name="RIGHT" value="Vector2i( 1, 0 )">
|
||||
</constant>
|
||||
<constant name="UP" value="Vector2i( 0, -1 )">
|
||||
</constant>
|
||||
<constant name="DOWN" value="Vector2i( 0, 1 )">
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
@ -16,6 +16,12 @@
|
||||
<link title="All 3D Demos">https://github.com/godotengine/godot-demo-projects/tree/master/3d</link>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="Vector3">
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="from" type="Vector3i" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="Vector3">
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="x" type="float" />
|
||||
|
||||
84
doc/classes/Vector3i.xml
Normal file
84
doc/classes/Vector3i.xml
Normal file
@ -0,0 +1,84 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="Vector3i" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="Vector3i">
|
||||
<return type="Vector3i" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="Vector3i">
|
||||
<return type="Vector3i" />
|
||||
<argument index="0" name="from" type="Vector3" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="length">
|
||||
<return type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="length_squared">
|
||||
<return type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="linear_interpolate">
|
||||
<return type="Vector3i" />
|
||||
<argument index="0" name="to" type="Vector3i" />
|
||||
<argument index="1" name="weight" type="float" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="max_axis_index">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="min_axis_index">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="x" type="int" setter="" getter="" default="0">
|
||||
</member>
|
||||
<member name="y" type="int" setter="" getter="" default="0">
|
||||
</member>
|
||||
<member name="z" type="int" setter="" getter="" default="0">
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="AXIS_X" value="0">
|
||||
</constant>
|
||||
<constant name="AXIS_Y" value="1">
|
||||
</constant>
|
||||
<constant name="AXIS_Z" value="2">
|
||||
</constant>
|
||||
<constant name="ZERO" value="Vector3i( 0, 0, 0 )">
|
||||
</constant>
|
||||
<constant name="ONE" value="Vector3i( 1, 1, 1 )">
|
||||
</constant>
|
||||
<constant name="LEFT" value="Vector3i( -1, 0, 0 )">
|
||||
</constant>
|
||||
<constant name="RIGHT" value="Vector3i( 1, 0, 0 )">
|
||||
</constant>
|
||||
<constant name="UP" value="Vector3i( 0, 1, 0 )">
|
||||
</constant>
|
||||
<constant name="DOWN" value="Vector3i( 0, -1, 0 )">
|
||||
</constant>
|
||||
<constant name="FORWARD" value="Vector3i( 0, 0, -1 )">
|
||||
</constant>
|
||||
<constant name="BACK" value="Vector3i( 0, 0, 1 )">
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
@ -55,7 +55,7 @@
|
||||
<member name="buffering_msec" type="int" setter="set_buffering_msec" getter="get_buffering_msec" default="500">
|
||||
Amount of time in milliseconds to store in buffer while playing.
|
||||
</member>
|
||||
<member name="bus" type="String" setter="set_bus" getter="get_bus" default=""Master"">
|
||||
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master"">
|
||||
Audio bus to use for sound playback.
|
||||
</member>
|
||||
<member name="expand" type="bool" setter="set_expand" getter="has_expand" default="true">
|
||||
|
||||
@ -1443,17 +1443,15 @@
|
||||
<method name="material_get_param" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="material" type="RID" />
|
||||
<argument index="1" name="parameter" type="String" />
|
||||
<argument index="1" name="parameter" type="StringName" />
|
||||
<description>
|
||||
Returns the value of a certain material's parameter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="material_get_param_default" qualifiers="const">
|
||||
<return type="Variant" />
|
||||
<argument index="0" name="material" type="RID" />
|
||||
<argument index="1" name="parameter" type="String" />
|
||||
<argument index="1" name="parameter" type="StringName" />
|
||||
<description>
|
||||
Returns the default value for the param if available. Otherwise returns an empty [Variant].
|
||||
</description>
|
||||
</method>
|
||||
<method name="material_get_shader" qualifiers="const">
|
||||
@ -1482,10 +1480,9 @@
|
||||
<method name="material_set_param">
|
||||
<return type="void" />
|
||||
<argument index="0" name="material" type="RID" />
|
||||
<argument index="1" name="parameter" type="String" />
|
||||
<argument index="1" name="parameter" type="StringName" />
|
||||
<argument index="2" name="value" type="Variant" />
|
||||
<description>
|
||||
Sets a material's parameter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="material_set_render_priority">
|
||||
@ -1974,11 +1971,9 @@
|
||||
<method name="request_frame_drawn_callback">
|
||||
<return type="void" />
|
||||
<argument index="0" name="where" type="Object" />
|
||||
<argument index="1" name="method" type="String" />
|
||||
<argument index="1" name="method" type="StringName" />
|
||||
<argument index="2" name="userdata" type="Variant" />
|
||||
<description>
|
||||
Schedules a callback to the corresponding named [code]method[/code] on [code]where[/code] after a frame has been drawn.
|
||||
The callback method must use only 1 argument which will be called with [code]userdata[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="scenario_create">
|
||||
@ -2087,9 +2082,8 @@
|
||||
<method name="shader_get_default_texture_param" qualifiers="const">
|
||||
<return type="RID" />
|
||||
<argument index="0" name="shader" type="RID" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns a default texture from a shader searched by name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="shader_get_param_list" qualifiers="const">
|
||||
@ -2110,10 +2104,9 @@
|
||||
<method name="shader_set_default_texture_param">
|
||||
<return type="void" />
|
||||
<argument index="0" name="shader" type="RID" />
|
||||
<argument index="1" name="name" type="String" />
|
||||
<argument index="1" name="name" type="StringName" />
|
||||
<argument index="2" name="texture" type="RID" />
|
||||
<description>
|
||||
Sets a shader's default texture. Overwrites the texture given by name.
|
||||
</description>
|
||||
</method>
|
||||
<method name="skeleton_allocate">
|
||||
|
||||
@ -33,7 +33,7 @@
|
||||
<members>
|
||||
<member name="action_bar_id" type="int" setter="set_action_bar_id" getter="get_action_bar_id" default="0">
|
||||
</member>
|
||||
<member name="item_path" type="String" setter="set_item_path" getter="get_item_path" default="""">
|
||||
<member name="item_path" type="StringName" setter="set_item_path" getter="get_item_path" default="@""">
|
||||
</member>
|
||||
<member name="slot_id" type="int" setter="set_slot_id" getter="get_slot_id" default="0">
|
||||
</member>
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
</member>
|
||||
<member name="character_class_name" type="String" setter="set_character_class_name" getter="get_character_class_name" default="""">
|
||||
</member>
|
||||
<member name="class_path" type="String" setter="set_class_path" getter="get_class_path" default="""">
|
||||
<member name="class_path" type="StringName" setter="set_class_path" getter="get_class_path" default="@""">
|
||||
</member>
|
||||
<member name="level" type="int" setter="set_level" getter="get_level" default="1">
|
||||
</member>
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
<methods>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="item_path" type="String" setter="set_item_path" getter="get_item_path" default="""">
|
||||
<member name="item_path" type="StringName" setter="set_item_path" getter="get_item_path" default="@""">
|
||||
</member>
|
||||
<member name="origin" type="Node" setter="set_origin" getter="get_origin">
|
||||
</member>
|
||||
|
||||
@ -36,31 +36,31 @@
|
||||
</method>
|
||||
<method name="equip_slot_get_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="equip_slot_get_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="equip_slot_get_property_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="equip_slot_get_property_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="equip_slot_is_property" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -200,31 +200,31 @@
|
||||
</method>
|
||||
<method name="stat_get_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="stat_get_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="stat_get_property_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="stat_get_property_name" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="stat_is_property" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="String" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -244,7 +244,7 @@
|
||||
</member>
|
||||
<member name="class_xp_data" type="PoolIntArray" setter="set_class_xp_data" getter="get_class_xp_data" default="PoolIntArray( )">
|
||||
</member>
|
||||
<member name="default_ess_material_cache_class" type="String" setter="set_default_ess_material_cache_class" getter="get_default_ess_material_cache_class" default=""ESSMaterialCachePCM"">
|
||||
<member name="default_ess_material_cache_class" type="StringName" setter="set_default_ess_material_cache_class" getter="get_default_ess_material_cache_class" default="@"ESSMaterialCachePCM"">
|
||||
</member>
|
||||
<member name="entity_spawner" type="ESSEntitySpawner" setter="set_entity_spawner" getter="get_entity_spawner">
|
||||
</member>
|
||||
|
||||
@ -66,62 +66,62 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="craft_recipe_id_to_path" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="craft_recipe_path_to_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_data_id_to_path" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_data_path_to_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_resource_id_to_path" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_resource_path_to_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_skill_id_to_path" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_skill_path_to_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_species_id_to_path" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="entity_species_path_to_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -144,7 +144,7 @@
|
||||
</method>
|
||||
<method name="get_craft_recipe_path">
|
||||
<return type="CraftRecipe" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -172,7 +172,7 @@
|
||||
</method>
|
||||
<method name="get_entity_data_path">
|
||||
<return type="EntityData" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -200,7 +200,7 @@
|
||||
</method>
|
||||
<method name="get_entity_resource_path">
|
||||
<return type="EntityResource" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -228,7 +228,7 @@
|
||||
</method>
|
||||
<method name="get_entity_skill_path">
|
||||
<return type="EntitySkillData" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -256,7 +256,7 @@
|
||||
</method>
|
||||
<method name="get_entity_species_data_path">
|
||||
<return type="EntitySpeciesData" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -284,7 +284,7 @@
|
||||
</method>
|
||||
<method name="get_item_template_path">
|
||||
<return type="ItemTemplate" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -318,7 +318,7 @@
|
||||
</method>
|
||||
<method name="get_spell_path">
|
||||
<return type="Spell" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -333,14 +333,14 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="item_template_id_to_path" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="item_template_path_to_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
@ -394,14 +394,14 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="spell_id_to_path" qualifiers="const">
|
||||
<return type="String" />
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="id" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="spell_path_to_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<argument index="0" name="path" type="String" />
|
||||
<argument index="0" name="path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
</method>
|
||||
<method name="get_class_profile">
|
||||
<return type="ClassProfile" />
|
||||
<argument index="0" name="class_id" type="String" />
|
||||
<argument index="0" name="class_id" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -70,7 +70,7 @@
|
||||
</method>
|
||||
<method name="on_keybinds_changed">
|
||||
<return type="void" />
|
||||
<argument index="0" name="class_path" type="String" />
|
||||
<argument index="0" name="class_path" type="StringName" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -42,14 +42,14 @@
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="pandemonium_skin" type="Skin" setter="set_pandemonium_skin" getter="get_pandemonium_skin">
|
||||
</member>
|
||||
<member name="joints" type="PoolIntArray" setter="set_joints" getter="get_joints" default="PoolIntArray( )">
|
||||
</member>
|
||||
<member name="joints_original" type="PoolIntArray" setter="set_joints_original" getter="get_joints_original" default="PoolIntArray( )">
|
||||
</member>
|
||||
<member name="non_joints" type="PoolIntArray" setter="set_non_joints" getter="get_non_joints" default="PoolIntArray( )">
|
||||
</member>
|
||||
<member name="pandemonium_skin" type="Skin" setter="set_pandemonium_skin" getter="get_pandemonium_skin">
|
||||
</member>
|
||||
<member name="roots" type="PoolIntArray" setter="set_roots" getter="get_roots" default="PoolIntArray( )">
|
||||
</member>
|
||||
<member name="skeleton" type="int" setter="set_skeleton" getter="get_skeleton" default="-1">
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="DataBuffer" inherits="Object" version="4.0">
|
||||
<class name="DataBuffer" inherits="Object" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="Interpolator" inherits="Object" version="4.0">
|
||||
<class name="Interpolator" inherits="Object" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="NetworkedController" inherits="Node" version="4.0">
|
||||
<class name="NetworkedController" inherits="Node" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="SceneDiff" inherits="Object" version="4.0">
|
||||
<class name="SceneDiff" inherits="Object" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="SceneSynchronizer" inherits="Node" version="4.0">
|
||||
<class name="SceneSynchronizer" inherits="Node" version="3.5">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
@ -139,7 +139,7 @@
|
||||
<return type="void" />
|
||||
<argument index="0" name="node" type="Node" />
|
||||
<argument index="1" name="variable" type="StringName" />
|
||||
<argument index="2" name="on_change_notify" type="StringName" default="&""" />
|
||||
<argument index="2" name="on_change_notify" type="StringName" default="@""" />
|
||||
<argument index="3" name="flags" type="int" enum="NetEventFlag" default="17" />
|
||||
<description>
|
||||
</description>
|
||||
|
||||
@ -99,7 +99,7 @@
|
||||
<members>
|
||||
<member name="background_color" type="Color" setter="set_background_color" getter="get_background_color" default="Color( 0, 0, 0, 1 )">
|
||||
</member>
|
||||
<member name="default_prop_material_cache_class" type="String" setter="set_default_prop_material_cache_class" getter="get_default_prop_material_cache_class" default=""PropMaterialCachePCM"">
|
||||
<member name="default_prop_material_cache_class" type="StringName" setter="set_default_prop_material_cache_class" getter="get_default_prop_material_cache_class" default="@"PropMaterialCachePCM"">
|
||||
</member>
|
||||
<member name="keep_original_atlases" type="bool" setter="set_keep_original_atlases" getter="get_keep_original_atlases" default="false">
|
||||
</member>
|
||||
|
||||
@ -66,7 +66,7 @@
|
||||
</member>
|
||||
<member name="default_pixels_per_unit" type="float" setter="set_default_pixels_per_unit" getter="get_default_pixels_per_unit" default="64.0">
|
||||
</member>
|
||||
<member name="default_prop_material_cache_class" type="String" setter="set_default_prop_material_cache_class" getter="get_default_prop_material_cache_class" default=""Prop2DMaterialCachePCM"">
|
||||
<member name="default_prop_material_cache_class" type="StringName" setter="set_default_prop_material_cache_class" getter="get_default_prop_material_cache_class" default="@"Prop2DMaterialCachePCM"">
|
||||
</member>
|
||||
<member name="keep_original_atlases" type="bool" setter="set_keep_original_atlases" getter="get_keep_original_atlases" default="false">
|
||||
</member>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user