doc: Sync classref with StringName/Callable changes

This commit is contained in:
Rémi Verschelde 2020-02-22 14:59:09 +01:00
parent bf7d6de556
commit fea37cfb52
83 changed files with 689 additions and 457 deletions

View file

@ -1507,43 +1507,49 @@
<constant name="TYPE_COLOR" value="14" enum="Variant.Type">
Variable is of type [Color].
</constant>
<constant name="TYPE_NODE_PATH" value="15" enum="Variant.Type">
<constant name="TYPE_STRING_NAME" value="15" enum="Variant.Type">
</constant>
<constant name="TYPE_NODE_PATH" value="16" enum="Variant.Type">
Variable is of type [NodePath].
</constant>
<constant name="TYPE_RID" value="16" enum="Variant.Type">
<constant name="TYPE_RID" value="17" enum="Variant.Type">
Variable is of type [RID].
</constant>
<constant name="TYPE_OBJECT" value="17" enum="Variant.Type">
<constant name="TYPE_OBJECT" value="18" enum="Variant.Type">
Variable is of type [Object].
</constant>
<constant name="TYPE_DICTIONARY" value="18" enum="Variant.Type">
<constant name="TYPE_CALLABLE" value="19" enum="Variant.Type">
</constant>
<constant name="TYPE_SIGNAL" value="20" enum="Variant.Type">
</constant>
<constant name="TYPE_DICTIONARY" value="21" enum="Variant.Type">
Variable is of type [Dictionary].
</constant>
<constant name="TYPE_ARRAY" value="19" enum="Variant.Type">
<constant name="TYPE_ARRAY" value="22" 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="23" enum="Variant.Type">
Variable is of type [PackedByteArray].
</constant>
<constant name="TYPE_INT_ARRAY" value="21" enum="Variant.Type">
<constant name="TYPE_INT_ARRAY" value="24" enum="Variant.Type">
Variable is of type [PackedIntArray].
</constant>
<constant name="TYPE_REAL_ARRAY" value="22" enum="Variant.Type">
<constant name="TYPE_REAL_ARRAY" value="25" enum="Variant.Type">
Variable is of type [PackedRealArray].
</constant>
<constant name="TYPE_STRING_ARRAY" value="23" enum="Variant.Type">
<constant name="TYPE_STRING_ARRAY" value="26" enum="Variant.Type">
Variable is of type [PackedStringArray].
</constant>
<constant name="TYPE_VECTOR2_ARRAY" value="24" enum="Variant.Type">
<constant name="TYPE_VECTOR2_ARRAY" value="27" enum="Variant.Type">
Variable is of type [PackedVector2Array].
</constant>
<constant name="TYPE_VECTOR3_ARRAY" value="25" enum="Variant.Type">
<constant name="TYPE_VECTOR3_ARRAY" value="28" enum="Variant.Type">
Variable is of type [PackedVector3Array].
</constant>
<constant name="TYPE_COLOR_ARRAY" value="26" enum="Variant.Type">
<constant name="TYPE_COLOR_ARRAY" value="29" enum="Variant.Type">
Variable is of type [PackedColorArray].
</constant>
<constant name="TYPE_MAX" value="27" enum="Variant.Type">
<constant name="TYPE_MAX" value="30" enum="Variant.Type">
Represents the size of the [enum Variant.Type] enum.
</constant>
<constant name="OP_EQUAL" value="0" enum="Variant.Operator">

View file

@ -26,7 +26,7 @@
</description>
</method>
<method name="get_name" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<description>
Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc).

View file

@ -34,7 +34,7 @@
</description>
</method>
<method name="get_name" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<description>
Returns the controller or anchor point's name if available.

View file

@ -120,21 +120,21 @@
</members>
<signals>
<signal name="interface_added">
<argument index="0" name="interface_name" type="String">
<argument index="0" name="interface_name" type="StringName">
</argument>
<description>
Emitted when a new interface has been added.
</description>
</signal>
<signal name="interface_removed">
<argument index="0" name="interface_name" type="String">
<argument index="0" name="interface_name" type="StringName">
</argument>
<description>
Emitted when an interface is removed.
</description>
</signal>
<signal name="tracker_added">
<argument index="0" name="tracker_name" type="String">
<argument index="0" name="tracker_name" type="StringName">
</argument>
<argument index="1" name="type" type="int">
</argument>
@ -145,7 +145,7 @@
</description>
</signal>
<signal name="tracker_removed">
<argument index="0" name="tracker_name" type="String">
<argument index="0" name="tracker_name" type="StringName">
</argument>
<argument index="1" name="type" type="int">
</argument>

View file

@ -76,7 +76,7 @@
</description>
</signal>
<signal name="custom_action">
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
Emitted when a custom button is pressed. See [method add_button].

View file

@ -19,7 +19,7 @@
<method name="play">
<return type="void">
</return>
<argument index="0" name="anim" type="String" default="&quot;&quot;">
<argument index="0" name="anim" type="StringName" default="@&quot;&quot;">
</argument>
<argument index="1" name="backwards" type="bool" default="false">
</argument>
@ -36,7 +36,7 @@
</method>
</methods>
<members>
<member name="animation" type="String" setter="set_animation" getter="get_animation" default="&quot;default&quot;">
<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@&quot;default&quot;">
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">

View file

@ -19,7 +19,7 @@
<method name="play">
<return type="void">
</return>
<argument index="0" name="anim" type="String" default="&quot;&quot;">
<argument index="0" name="anim" type="StringName" default="@&quot;&quot;">
</argument>
<description>
Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played.
@ -34,7 +34,7 @@
</method>
</methods>
<members>
<member name="animation" type="String" setter="set_animation" getter="get_animation" default="&quot;default&quot;">
<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@&quot;default&quot;">
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">

View file

@ -32,7 +32,7 @@
</description>
</method>
<method name="animation_track_get_key_animation" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="track_idx" type="int">
</argument>
@ -48,7 +48,7 @@
</argument>
<argument index="1" name="time" type="float">
</argument>
<argument index="2" name="animation" type="String">
<argument index="2" name="animation" type="StringName">
</argument>
<description>
</description>
@ -60,7 +60,7 @@
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="animation" type="String">
<argument index="2" name="animation" type="StringName">
</argument>
<description>
</description>
@ -287,7 +287,7 @@
</description>
</method>
<method name="method_track_get_name" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="track_idx" type="int">
</argument>

View file

@ -23,7 +23,7 @@
<method name="blend_animation">
<return type="void">
</return>
<argument index="0" name="animation" type="String">
<argument index="0" name="animation" type="StringName">
</argument>
<argument index="1" name="time" type="float">
</argument>
@ -59,7 +59,7 @@
<method name="blend_node">
<return type="float">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="node" type="AnimationNode">
</argument>
@ -119,7 +119,7 @@
<method name="get_parameter" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<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.
@ -128,7 +128,7 @@
<method name="get_parameter_default_value" qualifiers="virtual">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
@ -142,7 +142,7 @@
</description>
</method>
<method name="has_filter" qualifiers="virtual">
<return type="String">
<return type="bool">
</return>
<description>
Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node.
@ -193,7 +193,7 @@
<method name="set_parameter">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>

View file

@ -12,7 +12,7 @@
<methods>
</methods>
<members>
<member name="animation" type="String" setter="set_animation" getter="get_animation" default="&quot;&quot;">
<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="@&quot;&quot;">
Animation to use as an output. It is one of the animations provided by [member AnimationTree.anim_player].
</member>
</members>

View file

@ -11,7 +11,7 @@
<method name="add_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="node" type="AnimationNode">
</argument>
@ -23,11 +23,11 @@
<method name="connect_node">
<return type="void">
</return>
<argument index="0" name="input_node" type="String">
<argument index="0" name="input_node" type="StringName">
</argument>
<argument index="1" name="input_index" type="int">
</argument>
<argument index="2" name="output_node" type="String">
<argument index="2" name="output_node" type="StringName">
</argument>
<description>
</description>
@ -35,7 +35,7 @@
<method name="disconnect_node">
<return type="void">
</return>
<argument index="0" name="input_node" type="String">
<argument index="0" name="input_node" type="StringName">
</argument>
<argument index="1" name="input_index" type="int">
</argument>
@ -45,7 +45,7 @@
<method name="get_node" qualifiers="const">
<return type="AnimationNode">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
</description>
@ -53,7 +53,7 @@
<method name="get_node_position" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
</description>
@ -61,7 +61,7 @@
<method name="has_node" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
</description>
@ -69,7 +69,7 @@
<method name="remove_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
</description>
@ -77,9 +77,9 @@
<method name="rename_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
</description>
@ -87,7 +87,7 @@
<method name="set_node_position">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="position" type="Vector2">
</argument>

View file

@ -18,7 +18,7 @@
<method name="add_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="node" type="AnimationNode">
</argument>
@ -31,9 +31,9 @@
<method name="add_transition">
<return type="void">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="to" type="String">
<argument index="1" name="to" type="StringName">
</argument>
<argument index="2" name="transition" type="AnimationNodeStateMachineTransition">
</argument>
@ -58,14 +58,14 @@
<method name="get_node" qualifiers="const">
<return type="AnimationNode">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the animation node with the given name.
</description>
</method>
<method name="get_node_name" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="node" type="AnimationNode">
</argument>
@ -76,7 +76,7 @@
<method name="get_node_position" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the given node's coordinates. Used for display in the editor.
@ -106,7 +106,7 @@
</description>
</method>
<method name="get_transition_from" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -115,7 +115,7 @@
</description>
</method>
<method name="get_transition_to" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -126,7 +126,7 @@
<method name="has_node" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the graph contains the given node.
@ -135,9 +135,9 @@
<method name="has_transition" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="to" type="String">
<argument index="1" name="to" type="StringName">
</argument>
<description>
Returns [code]true[/code] if there is a transition between the given nodes.
@ -146,7 +146,7 @@
<method name="remove_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Deletes the given node from the graph.
@ -155,9 +155,9 @@
<method name="remove_transition">
<return type="void">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="to" type="String">
<argument index="1" name="to" type="StringName">
</argument>
<description>
Deletes the transition between the two specified nodes.
@ -175,9 +175,9 @@
<method name="rename_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
Renames the given node.
@ -186,7 +186,7 @@
<method name="set_end_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Sets the given node as the graph end point.
@ -204,7 +204,7 @@
<method name="set_node_position">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
@ -215,7 +215,7 @@
<method name="set_start_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Sets the given node as the graph start point.

View file

@ -16,7 +16,7 @@
</tutorials>
<methods>
<method name="get_current_node" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<description>
Returns the currently playing animation state.
@ -39,7 +39,7 @@
<method name="start">
<return type="void">
</return>
<argument index="0" name="node" type="String">
<argument index="0" name="node" type="StringName">
</argument>
<description>
Starts playing the given animation.
@ -55,7 +55,7 @@
<method name="travel">
<return type="void">
</return>
<argument index="0" name="to_node" type="String">
<argument index="0" name="to_node" type="StringName">
</argument>
<description>
Transitions from the current state to another one, following the shortest path.

View file

@ -10,7 +10,7 @@
<methods>
</methods>
<members>
<member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition" default="&quot;&quot;">
<member name="advance_condition" type="StringName" setter="set_advance_condition" getter="get_advance_condition" default="@&quot;&quot;">
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=https://docs.godotengine.org/en/latest/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)

View file

@ -16,7 +16,7 @@
<method name="add_animation">
<return type="int" enum="Error">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="animation" type="Animation">
</argument>
@ -34,9 +34,9 @@
</description>
</method>
<method name="animation_get_next" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="anim_from" type="String">
<argument index="0" name="anim_from" type="StringName">
</argument>
<description>
Returns the name of the next animation in the queue.
@ -45,9 +45,9 @@
<method name="animation_set_next">
<return type="void">
</return>
<argument index="0" name="anim_from" type="String">
<argument index="0" name="anim_from" type="StringName">
</argument>
<argument index="1" name="anim_to" type="String">
<argument index="1" name="anim_to" type="StringName">
</argument>
<description>
Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes.
@ -68,7 +68,7 @@
</description>
</method>
<method name="find_animation" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="animation" type="Animation">
</argument>
@ -79,7 +79,7 @@
<method name="get_animation" qualifiers="const">
<return type="Animation">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found.
@ -95,9 +95,9 @@
<method name="get_blend_time" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="anim_from" type="String">
<argument index="0" name="anim_from" type="StringName">
</argument>
<argument index="1" name="anim_to" type="String">
<argument index="1" name="anim_to" type="StringName">
</argument>
<description>
Gets the blend time (in seconds) between two animations, referenced by their names.
@ -120,7 +120,7 @@
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code].
@ -136,7 +136,7 @@
<method name="play">
<return type="void">
</return>
<argument index="0" name="name" type="String" default="&quot;&quot;">
<argument index="0" name="name" type="StringName" default="&quot;&quot;">
</argument>
<argument index="1" name="custom_blend" type="float" default="-1">
</argument>
@ -153,7 +153,7 @@
<method name="play_backwards">
<return type="void">
</return>
<argument index="0" name="name" type="String" default="&quot;&quot;">
<argument index="0" name="name" type="StringName" default="&quot;&quot;">
</argument>
<argument index="1" name="custom_blend" type="float" default="-1">
</argument>
@ -165,7 +165,7 @@
<method name="queue">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Queues an animation for playback once the current one is done.
@ -175,7 +175,7 @@
<method name="remove_animation">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Removes the animation with key [code]name[/code].
@ -184,9 +184,9 @@
<method name="rename_animation">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="newname" type="String">
<argument index="1" name="newname" type="StringName">
</argument>
<description>
Renames an existing animation with key [code]name[/code] to [code]newname[/code].
@ -206,9 +206,9 @@
<method name="set_blend_time">
<return type="void">
</return>
<argument index="0" name="anim_from" type="String">
<argument index="0" name="anim_from" type="StringName">
</argument>
<argument index="1" name="anim_to" type="String">
<argument index="1" name="anim_to" type="StringName">
</argument>
<argument index="2" name="sec" type="float">
</argument>
@ -264,23 +264,23 @@
</members>
<signals>
<signal name="animation_changed">
<argument index="0" name="old_name" type="String">
<argument index="0" name="old_name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
If the currently being played animation changes, this signal will notify of such change.
</description>
</signal>
<signal name="animation_finished">
<argument index="0" name="anim_name" type="String">
<argument index="0" name="anim_name" type="StringName">
</argument>
<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">
</argument>
<description>
Notifies when an animation starts playing.

View file

@ -89,7 +89,7 @@
<member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.1">
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).
</member>
<member name="audio_bus_name" type="String" setter="set_audio_bus" getter="get_audio_bus" default="&quot;Master&quot;">
<member name="audio_bus_name" type="StringName" setter="set_audio_bus" getter="get_audio_bus" default="@&quot;Master&quot;">
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">
@ -131,7 +131,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="&quot;Master&quot;">
<member name="reverb_bus_name" type="StringName" setter="set_reverb_bus" getter="get_reverb_bus" default="@&quot;Master&quot;">
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">

View file

@ -90,7 +90,7 @@
<member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="1.0">
The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping).
</member>
<member name="audio_bus_name" type="String" setter="set_audio_bus_name" getter="get_audio_bus_name" default="&quot;Master&quot;">
<member name="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="@&quot;Master&quot;">
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">

View file

@ -30,7 +30,7 @@
<method name="add_blend_shape">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added.
@ -80,7 +80,7 @@
</description>
</method>
<method name="get_blend_shape_name" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="index" type="int">
</argument>

View file

@ -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="&quot;&quot;">
<member name="sidechain" type="StringName" setter="set_sidechain" getter="get_sidechain" default="@&quot;&quot;">
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">

View file

@ -107,7 +107,7 @@
<method name="get_bus_index" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="bus_name" type="String">
<argument index="0" name="bus_name" type="StringName">
</argument>
<description>
Returns the index of the bus with the name [code]bus_name[/code].
@ -145,7 +145,7 @@
</description>
</method>
<method name="get_bus_send" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="bus_idx" type="int">
</argument>
@ -341,7 +341,7 @@
</return>
<argument index="0" name="bus_idx" type="int">
</argument>
<argument index="1" name="send" type="String">
<argument index="1" name="send" type="StringName">
</argument>
<description>
Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code].

View file

@ -54,7 +54,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="&quot;Master&quot;">
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@&quot;Master&quot;">
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">

View file

@ -60,7 +60,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="&quot;Master&quot;">
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@&quot;Master&quot;">
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">

View file

@ -66,7 +66,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="&quot;Master&quot;">
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@&quot;Master&quot;">
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">

77
doc/classes/Callable.xml Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Callable" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="Callable">
<return type="Callable">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method_name" type="StringName">
</argument>
<description>
</description>
</method>
<method name="call" qualifiers="vararg">
<return type="Variant">
</return>
<description>
</description>
</method>
<method name="call_deferred" qualifiers="vararg">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_method">
<return type="StringName">
</return>
<description>
</description>
</method>
<method name="get_object">
<return type="Object">
</return>
<description>
</description>
</method>
<method name="get_object_id">
<return type="int">
</return>
<description>
</description>
</method>
<method name="hash">
<return type="int">
</return>
<description>
</description>
</method>
<method name="is_custom">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_null">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_standard">
<return type="bool">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

View file

@ -12,7 +12,7 @@
<method name="can_instance" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<description>
Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case.
@ -21,16 +21,16 @@
<method name="class_exists" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<description>
Returns whether the specified [code]class[/code] is available or not.
</description>
</method>
<method name="class_get_category" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<description>
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
@ -39,9 +39,9 @@
<method name="class_get_integer_constant" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="name" type="String">
<argument index="1" name="name" type="StringName">
</argument>
<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.
@ -50,7 +50,7 @@
<method name="class_get_integer_constant_list" qualifiers="const">
<return type="PackedStringArray">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
@ -61,7 +61,7 @@
<method name="class_get_method_list" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
@ -74,7 +74,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<description>
Returns the value of [code]property[/code] of [code]class[/code] or its ancestry.
@ -83,7 +83,7 @@
<method name="class_get_property_list" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
@ -94,9 +94,9 @@
<method name="class_get_signal" qualifiers="const">
<return type="Dictionary">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="signal" type="String">
<argument index="1" name="signal" type="StringName">
</argument>
<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].
@ -105,7 +105,7 @@
<method name="class_get_signal_list" qualifiers="const">
<return type="Array">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
@ -116,9 +116,9 @@
<method name="class_has_integer_constant" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="name" type="String">
<argument index="1" name="name" type="StringName">
</argument>
<description>
Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not.
@ -127,9 +127,9 @@
<method name="class_has_method" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<argument index="2" name="no_inheritance" type="bool" default="false">
</argument>
@ -140,9 +140,9 @@
<method name="class_has_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="signal" type="String">
<argument index="1" name="signal" type="StringName">
</argument>
<description>
Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not.
@ -153,7 +153,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
@ -171,16 +171,16 @@
<method name="get_inheriters_from_class" qualifiers="const">
<return type="PackedStringArray">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<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">
<return type="StringName">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<description>
Returns the parent class of [code]class[/code].
@ -189,7 +189,7 @@
<method name="instance" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<description>
Creates an instance of [code]class[/code].
@ -198,7 +198,7 @@
<method name="is_class_enabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<description>
Returns whether this [code]class[/code] is enabled or not.
@ -207,9 +207,9 @@
<method name="is_parent_class" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class" type="String">
<argument index="0" name="class" type="StringName">
</argument>
<argument index="1" name="inherits" type="String">
<argument index="1" name="inherits" type="StringName">
</argument>
<description>
Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not.

View file

@ -90,7 +90,7 @@
<method name="add_color_override">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="color" type="Color">
</argument>
@ -101,7 +101,7 @@
<method name="add_constant_override">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="constant" type="int">
</argument>
@ -112,7 +112,7 @@
<method name="add_font_override">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="font" type="Font">
</argument>
@ -123,7 +123,7 @@
<method name="add_icon_override">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
@ -134,7 +134,7 @@
<method name="add_shader_override">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="shader" type="Shader">
</argument>
@ -145,7 +145,7 @@
<method name="add_stylebox_override">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="stylebox" type="StyleBox">
</argument>
@ -220,9 +220,9 @@
<method name="get_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns a color from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].
@ -242,9 +242,9 @@
<method name="get_constant" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns a constant from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].
@ -301,9 +301,9 @@
<method name="get_font" qualifiers="const">
<return type="Font">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns a font from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].
@ -319,9 +319,9 @@
<method name="get_icon" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns an icon from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].
@ -374,9 +374,9 @@
<method name="get_stylebox" qualifiers="const">
<return type="StyleBox">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns a [StyleBox] from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].
@ -412,9 +412,9 @@
<method name="has_color" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns [code]true[/code] if [Color] with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].
@ -423,7 +423,7 @@
<method name="has_color_override" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if [Color] with given [code]name[/code] has a valid override in this [Control] node.
@ -432,9 +432,9 @@
<method name="has_constant" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns [code]true[/code] if constant with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].
@ -443,7 +443,7 @@
<method name="has_constant_override" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if constant with given [code]name[/code] has a valid override in this [Control] node.
@ -459,9 +459,9 @@
<method name="has_font" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns [code]true[/code] if font with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].
@ -470,7 +470,7 @@
<method name="has_font_override" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if font with given [code]name[/code] has a valid override in this [Control] node.
@ -479,9 +479,9 @@
<method name="has_icon" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns [code]true[/code] if icon with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].
@ -490,7 +490,7 @@
<method name="has_icon_override" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if icon with given [code]name[/code] has a valid override in this [Control] node.
@ -510,7 +510,7 @@
<method name="has_shader_override" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if [Shader] with given [code]name[/code] has a valid override in this [Control] node.
@ -519,9 +519,9 @@
<method name="has_stylebox" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String" default="&quot;&quot;">
<argument index="1" name="type" type="StringName" default="&quot;&quot;">
</argument>
<description>
Returns [code]true[/code] if [StyleBox] with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].
@ -530,7 +530,7 @@
<method name="has_stylebox_override" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if [StyleBox] with given [code]name[/code] has a valid override in this [Control] node.

View file

@ -18,7 +18,7 @@
<method name="is_class_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="String">
<argument index="0" name="class_name" type="StringName">
</argument>
<description>
</description>
@ -26,7 +26,7 @@
<method name="is_class_editor_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="String">
<argument index="0" name="class_name" type="StringName">
</argument>
<description>
</description>
@ -34,9 +34,9 @@
<method name="is_class_property_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="class_name" type="String">
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<description>
</description>
@ -68,7 +68,7 @@
<method name="set_disable_class">
<return type="void">
</return>
<argument index="0" name="class_name" type="String">
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
@ -78,7 +78,7 @@
<method name="set_disable_class_editor">
<return type="void">
</return>
<argument index="0" name="class_name" type="String">
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="disable" type="bool">
</argument>
@ -88,9 +88,9 @@
<method name="set_disable_class_property">
<return type="void">
</return>
<argument index="0" name="class_name" type="String">
<argument index="0" name="class_name" type="StringName">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="disable" type="bool">
</argument>

View file

@ -78,7 +78,7 @@
</description>
</method>
<method name="get_file_type" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>

View file

@ -21,11 +21,11 @@
<method name="emit_changed">
<return type="void">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<argument index="2" name="field" type="String" default="&quot;&quot;">
<argument index="2" name="field" type="StringName" default="@&quot;&quot;">
</argument>
<argument index="3" name="changing" type="bool" default="false">
</argument>
@ -41,7 +41,7 @@
</description>
</method>
<method name="get_edited_property">
<return type="String">
<return type="StringName">
</return>
<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.
@ -102,7 +102,7 @@
</description>
</signal>
<signal name="object_id_selected">
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -111,7 +111,7 @@
</description>
</signal>
<signal name="property_changed">
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
@ -120,7 +120,7 @@
</description>
</signal>
<signal name="property_checked">
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="bool" type="String">
</argument>
@ -129,14 +129,14 @@
</description>
</signal>
<signal name="property_keyed">
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<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>
<argument index="1" name="value" type="Variant">
</argument>

View file

@ -34,7 +34,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="receiver_func" type="String">
<argument index="2" name="receiver_func" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant">
</argument>
@ -49,7 +49,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="receiver_func" type="String">
<argument index="2" name="receiver_func" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant">
</argument>

View file

@ -135,7 +135,7 @@
<method name="set_initial_value">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>

View file

@ -36,7 +36,7 @@
<method name="set_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
The name of the referenced function to call on the object, without parentheses or any parameters.

View file

@ -49,11 +49,11 @@
<method name="connect_node">
<return type="int" enum="Error">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
<argument index="2" name="to" type="StringName">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
@ -64,11 +64,11 @@
<method name="disconnect_node">
<return type="void">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
<argument index="2" name="to" type="StringName">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
@ -94,11 +94,11 @@
<method name="is_node_connected">
<return type="bool">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
<argument index="2" name="to" type="StringName">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
@ -149,11 +149,11 @@
<method name="set_connection_activity">
<return type="void">
</return>
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="from_port" type="int">
</argument>
<argument index="2" name="to" type="String">
<argument index="2" name="to" type="StringName">
</argument>
<argument index="3" name="to_port" type="int">
</argument>
@ -204,7 +204,7 @@
</description>
</signal>
<signal name="connection_from_empty">
<argument index="0" name="to" type="String">
<argument index="0" name="to" type="StringName">
</argument>
<argument index="1" name="to_slot" type="int">
</argument>
@ -215,11 +215,11 @@
</description>
</signal>
<signal name="connection_request">
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="from_slot" type="int">
</argument>
<argument index="2" name="to" type="String">
<argument index="2" name="to" type="StringName">
</argument>
<argument index="3" name="to_slot" type="int">
</argument>
@ -228,7 +228,7 @@
</description>
</signal>
<signal name="connection_to_empty">
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="from_slot" type="int">
</argument>
@ -249,11 +249,11 @@
</description>
</signal>
<signal name="disconnection_request">
<argument index="0" name="from" type="String">
<argument index="0" name="from" type="StringName">
</argument>
<argument index="1" name="from_slot" type="int">
</argument>
<argument index="2" name="to" type="String">
<argument index="2" name="to" type="StringName">
</argument>
<argument index="3" name="to_slot" type="int">
</argument>

View file

@ -13,7 +13,7 @@
<method name="action_press">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="strength" type="float" default="1.0">
</argument>
@ -26,7 +26,7 @@
<method name="action_release">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
If the specified action is already pressed, this will release it.
@ -54,7 +54,7 @@
<method name="get_action_strength" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<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.
@ -202,7 +202,7 @@
<method name="is_action_just_pressed" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<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.
@ -212,7 +212,7 @@
<method name="is_action_just_released" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<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.
@ -221,7 +221,7 @@
<method name="is_action_pressed" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<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.

View file

@ -31,7 +31,7 @@
<method name="get_action_strength" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<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].
@ -40,7 +40,7 @@
<method name="is_action" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
Returns [code]true[/code] if this input event matches a pre-defined action of any type.
@ -49,7 +49,7 @@
<method name="is_action_pressed" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="allow_echo" type="bool" default="false">
</argument>
@ -60,7 +60,7 @@
<method name="is_action_released" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].

View file

@ -12,7 +12,7 @@
<methods>
</methods>
<members>
<member name="action" type="String" setter="set_action" getter="get_action" default="&quot;&quot;">
<member name="action" type="StringName" setter="set_action" getter="get_action" default="@&quot;&quot;">
The action's name. Actions are accessed via this [String].
</member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">

View file

@ -13,7 +13,7 @@
<method name="action_add_event">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
@ -24,7 +24,7 @@
<method name="action_erase_event">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
@ -35,7 +35,7 @@
<method name="action_erase_events">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
Removes all events from an action.
@ -44,7 +44,7 @@
<method name="action_has_event">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
@ -55,7 +55,7 @@
<method name="action_set_deadzone">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="deadzone" type="float">
</argument>
@ -66,7 +66,7 @@
<method name="add_action">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="deadzone" type="float" default="0.5">
</argument>
@ -78,7 +78,7 @@
<method name="erase_action">
<return type="void">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
Removes an action from the [InputMap].
@ -89,7 +89,7 @@
</return>
<argument index="0" name="event" type="InputEvent">
</argument>
<argument index="1" name="action" type="String">
<argument index="1" name="action" type="StringName">
</argument>
<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.
@ -98,7 +98,7 @@
<method name="get_action_list">
<return type="Array">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
Returns an array of [InputEvent]s associated with a given action.
@ -114,7 +114,7 @@
<method name="has_action" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
<argument index="0" name="action" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the [InputMap] has a registered action with the given name.

View file

@ -32,7 +32,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant" default="null">
</argument>

View file

@ -109,7 +109,7 @@
</member>
<member name="geometry/source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" default="0">
</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">
</member>
<member name="polygon/verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly" default="6.0">
</member>

View file

@ -32,7 +32,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant" default="null">
</argument>

View file

@ -149,7 +149,7 @@
<method name="add_to_group">
<return type="void">
</return>
<argument index="0" name="group" type="String">
<argument index="0" name="group" type="StringName">
</argument>
<argument index="1" name="persistent" type="bool" default="false">
</argument>
@ -410,7 +410,7 @@
<method name="is_in_group" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="group" type="String">
<argument index="0" name="group" type="StringName">
</argument>
<description>
Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree].
@ -532,7 +532,7 @@
<method name="propagate_call">
<return type="void">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<argument index="1" name="args" type="Array" default="[ ]">
</argument>
@ -584,7 +584,7 @@
<method name="remove_from_group">
<return type="void">
</return>
<argument index="0" name="group" type="String">
<argument index="0" name="group" type="StringName">
</argument>
<description>
Removes a node from a group. See notes in the description, and the group methods in [SceneTree].
@ -611,7 +611,7 @@
<method name="rpc" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<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].
@ -621,7 +621,7 @@
<method name="rpc_config">
<return type="int">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode">
</argument>
@ -634,7 +634,7 @@
</return>
<argument index="0" name="peer_id" type="int">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<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].
@ -643,7 +643,7 @@
<method name="rpc_unreliable" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<description>
Sends a [method rpc] using an unreliable protocol. Returns an empty [Variant].
@ -654,7 +654,7 @@
</return>
<argument index="0" name="peer_id" type="int">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<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].
@ -663,7 +663,7 @@
<method name="rset">
<return type="void">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
@ -674,7 +674,7 @@
<method name="rset_config">
<return type="int">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="mode" type="int" enum="MultiplayerAPI.RPCMode">
</argument>
@ -687,7 +687,7 @@
</return>
<argument index="0" name="peer_id" type="int">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
@ -698,7 +698,7 @@
<method name="rset_unreliable">
<return type="void">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
@ -711,7 +711,7 @@
</return>
<argument index="0" name="peer_id" type="int">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
@ -830,7 +830,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.
</member>
<member name="owner" type="Node" setter="set_owner" getter="get_owner">

View file

@ -23,7 +23,7 @@
<method name="_get" qualifiers="virtual">
<return type="Variant">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<description>
Virtual method which can be overridden to customize the return value of [method get].
@ -58,7 +58,7 @@
<method name="_set" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
@ -89,7 +89,7 @@
<method name="call" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<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:
@ -101,7 +101,7 @@
<method name="call_deferred" qualifiers="vararg">
<return type="void">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<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:
@ -113,7 +113,7 @@
<method name="callv">
<return type="Variant">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<argument index="1" name="arg_array" type="Array">
</argument>
@ -134,17 +134,16 @@
<method name="connect">
<return type="int" enum="Error">
</return>
<argument index="0" name="signal" type="String">
<argument index="0" name="signal" type="StringName">
</argument>
<argument index="1" name="target" type="Object">
<argument index="1" name="callable" type="Callable">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="binds" type="Array" default="[ ]">
</argument>
<argument index="3" name="binds" type="Array" default="[ ]">
</argument>
<argument index="4" name="flags" type="int" default="0">
<argument index="3" name="flags" type="int" default="0">
</argument>
<description>
[b]FIXME:[/b] The syntax changed with the addition of [Callable], this should be updated.
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.
@ -166,13 +165,12 @@
<method name="disconnect">
<return type="void">
</return>
<argument index="0" name="signal" type="String">
<argument index="0" name="signal" type="StringName">
</argument>
<argument index="1" name="target" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="1" name="callable" type="Callable">
</argument>
<description>
[b]FIXME:[/b] The syntax changed with the addition of [Callable], this should be updated.
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>
@ -180,7 +178,7 @@
<method name="emit_signal" qualifiers="vararg">
<return type="void">
</return>
<argument index="0" name="signal" type="String">
<argument index="0" name="signal" type="StringName">
</argument>
<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:
@ -307,7 +305,7 @@
<method name="has_method" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the object contains the given [code]method[/code].
@ -316,7 +314,7 @@
<method name="has_user_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="signal" type="String">
<argument index="0" name="signal" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the given user-defined [code]signal[/code] exists.
@ -341,13 +339,12 @@
<method name="is_connected" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="signal" type="String">
<argument index="0" name="signal" type="StringName">
</argument>
<argument index="1" name="target" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="1" name="callable" type="Callable">
</argument>
<description>
[b]FIXME:[/b] The syntax changed with the addition of [Callable], this should be updated.
Returns [code]true[/code] if a connection exists for a given [code]signal[/code], [code]target[/code], and [code]method[/code].
</description>
</method>
@ -409,7 +406,7 @@
<method name="set_deferred">
<return type="void">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
@ -472,9 +469,9 @@
</description>
</method>
<method name="tr" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="message" type="String">
<argument index="0" name="message" type="StringName">
</argument>
<description>
Translates a message using translation catalogs configured in the Project Settings.

View file

@ -165,7 +165,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<description>
</description>
@ -199,7 +199,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<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:
@ -661,7 +661,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant" default="null">
</argument>

View file

@ -156,7 +156,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<description>
</description>
@ -190,7 +190,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<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:
@ -678,7 +678,7 @@
</argument>
<argument index="1" name="receiver" type="Object">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant" default="null">
</argument>

View file

@ -43,7 +43,7 @@
<method name="handles_type" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="typename" type="String">
<argument index="0" name="typename" type="StringName">
</argument>
<description>
Tells which resource class this loader can load.

View file

@ -13,7 +13,7 @@
<method name="add_resource">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="resource" type="Resource">
</argument>
@ -24,7 +24,7 @@
<method name="get_resource" qualifiers="const">
<return type="Resource">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the resource associated to [code]name[/code].
@ -40,7 +40,7 @@
<method name="has_resource" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code].
@ -49,7 +49,7 @@
<method name="remove_resource">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Removes the resource associated to [code]name[/code] from the preloader.
@ -58,9 +58,9 @@
<method name="rename_resource">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="newname" type="String">
<argument index="1" name="newname" type="StringName">
</argument>
<description>
Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code].

View file

@ -37,7 +37,7 @@
</description>
</method>
<method name="get_connection_method" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -46,7 +46,7 @@
</description>
</method>
<method name="get_connection_signal" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -117,7 +117,7 @@
</description>
</method>
<method name="get_node_name" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -157,7 +157,7 @@
</description>
</method>
<method name="get_node_property_name" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>
@ -179,7 +179,7 @@
</description>
</method>
<method name="get_node_type" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="idx" type="int">
</argument>

View file

@ -16,9 +16,9 @@
<method name="call_group" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="group" type="String">
<argument index="0" name="group" type="StringName">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<description>
Calls [code]method[/code] on each member of the given group.
@ -29,9 +29,9 @@
</return>
<argument index="0" name="flags" type="int">
</argument>
<argument index="1" name="group" type="String">
<argument index="1" name="group" type="StringName">
</argument>
<argument index="2" name="method" type="String">
<argument index="2" name="method" type="StringName">
</argument>
<description>
Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags].
@ -106,7 +106,7 @@
<method name="get_nodes_in_group">
<return type="Array">
</return>
<argument index="0" name="group" type="String">
<argument index="0" name="group" type="StringName">
</argument>
<description>
Returns a list of all nodes assigned to the given group.
@ -122,7 +122,7 @@
<method name="has_group" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the given group exists.
@ -152,7 +152,7 @@
<method name="notify_group">
<return type="void">
</return>
<argument index="0" name="group" type="String">
<argument index="0" name="group" type="StringName">
</argument>
<argument index="1" name="notification" type="int">
</argument>
@ -165,7 +165,7 @@
</return>
<argument index="0" name="call_flags" type="int">
</argument>
<argument index="1" name="group" type="String">
<argument index="1" name="group" type="StringName">
</argument>
<argument index="2" name="notification" type="int">
</argument>
@ -212,7 +212,7 @@
<method name="set_group">
<return type="void">
</return>
<argument index="0" name="group" type="String">
<argument index="0" name="group" type="StringName">
</argument>
<argument index="1" name="property" type="String">
</argument>
@ -227,7 +227,7 @@
</return>
<argument index="0" name="call_flags" type="int">
</argument>
<argument index="1" name="group" type="String">
<argument index="1" name="group" type="StringName">
</argument>
<argument index="2" name="property" type="String">
</argument>

View file

@ -26,7 +26,7 @@
</description>
</method>
<method name="get_instance_base_type" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<description>
Returns the script's base type.
@ -35,7 +35,7 @@
<method name="get_property_default_value">
<return type="Variant">
</return>
<argument index="0" name="property" type="String">
<argument index="0" name="property" type="StringName">
</argument>
<description>
</description>
@ -67,7 +67,7 @@
<method name="has_script_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="signal_name" type="String">
<argument index="0" name="signal_name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the script, or a base class, defines a signal with the given name.

View file

@ -14,7 +14,7 @@
<method name="get_default_texture_param" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="param" type="String">
<argument index="0" name="param" type="StringName">
</argument>
<description>
Returns the texture that is set as default for the specified parameter.
@ -31,7 +31,7 @@
<method name="has_param" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns [code]true[/code] if the shader has this param defined as a uniform in its code.
@ -41,7 +41,7 @@
<method name="set_default_texture_param">
<return type="void">
</return>
<argument index="0" name="param" type="String">
<argument index="0" name="param" type="StringName">
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>

View file

@ -13,7 +13,7 @@
<method name="get_shader_param" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="param" type="String">
<argument index="0" name="param" type="StringName">
</argument>
<description>
Returns the current value set for this material of a uniform in the shader.
@ -40,7 +40,7 @@
<method name="set_shader_param">
<return type="void">
</return>
<argument index="0" name="param" type="String">
<argument index="0" name="param" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>

87
doc/classes/Signal.xml Normal file
View file

@ -0,0 +1,87 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Signal" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="Signal">
<return type="Signal">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="signal_name" type="StringName">
</argument>
<description>
</description>
</method>
<method name="connect">
<return type="int">
</return>
<argument index="0" name="callable" type="Callable">
</argument>
<argument index="1" name="binds" type="Array" default="[]">
</argument>
<argument index="2" name="flags" type="int" default="0">
</argument>
<description>
</description>
</method>
<method name="disconnect">
<return type="void">
</return>
<argument index="0" name="callable" type="Callable">
</argument>
<description>
</description>
</method>
<method name="emit" qualifiers="vararg">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_connections">
<return type="Array">
</return>
<description>
</description>
</method>
<method name="get_name">
<return type="StringName">
</return>
<description>
</description>
</method>
<method name="get_object">
<return type="Object">
</return>
<description>
</description>
</method>
<method name="get_object_id">
<return type="int">
</return>
<description>
</description>
</method>
<method name="is_connected">
<return type="bool">
</return>
<argument index="0" name="callable" type="Callable">
</argument>
<description>
</description>
</method>
<method name="is_null">
<return type="bool">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

View file

@ -45,13 +45,13 @@
</member>
<member name="override_tip_basis" type="bool" setter="set_override_tip_basis" getter="is_override_tip_basis" default="true">
</member>
<member name="root_bone" type="String" setter="set_root_bone" getter="get_root_bone" default="&quot;&quot;">
<member name="root_bone" type="StringName" setter="set_root_bone" getter="get_root_bone" default="@&quot;&quot;">
</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 )">
</member>
<member name="target_node" type="NodePath" setter="set_target_node" getter="get_target_node" default="NodePath(&quot;&quot;)">
</member>
<member name="tip_bone" type="String" setter="set_tip_bone" getter="get_tip_bone" default="&quot;&quot;">
<member name="tip_bone" type="StringName" setter="set_tip_bone" getter="get_tip_bone" default="@&quot;&quot;">
</member>
<member name="use_magnet" type="bool" setter="set_use_magnet" getter="is_using_magnet" default="false">
</member>

View file

@ -37,6 +37,14 @@
<description>
</description>
</method>
<method name="get_bind_name" qualifiers="const">
<return type="StringName">
</return>
<argument index="0" name="bind_index" type="int">
</argument>
<description>
</description>
</method>
<method name="get_bind_pose" qualifiers="const">
<return type="Transform">
</return>
@ -63,6 +71,16 @@
<description>
</description>
</method>
<method name="set_bind_name">
<return type="void">
</return>
<argument index="0" name="bind_index" type="int">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<description>
</description>
</method>
<method name="set_bind_pose">
<return type="void">
</return>

View file

@ -12,7 +12,7 @@
<method name="add_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<description>
Adds a new animation to the library.
@ -21,7 +21,7 @@
<method name="add_frame">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<argument index="1" name="frame" type="Texture2D">
</argument>
@ -34,7 +34,7 @@
<method name="clear">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<description>
Removes all frames from the given animation.
@ -50,7 +50,7 @@
<method name="get_animation_loop" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<description>
If [code]true[/code], the given animation will loop.
@ -66,7 +66,7 @@
<method name="get_animation_speed" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<description>
The animation's speed in frames per second.
@ -75,7 +75,7 @@
<method name="get_frame" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<argument index="1" name="idx" type="int">
</argument>
@ -86,7 +86,7 @@
<method name="get_frame_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<description>
Returns the number of frames in the animation.
@ -95,7 +95,7 @@
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<description>
If [code]true[/code], the named animation exists.
@ -104,7 +104,7 @@
<method name="remove_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<description>
Removes the given animation.
@ -113,7 +113,7 @@
<method name="remove_frame">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<argument index="1" name="idx" type="int">
</argument>
@ -124,9 +124,9 @@
<method name="rename_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<argument index="1" name="newname" type="String">
<argument index="1" name="newname" type="StringName">
</argument>
<description>
Changes the animation's name to [code]newname[/code].
@ -135,7 +135,7 @@
<method name="set_animation_loop">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<argument index="1" name="loop" type="bool">
</argument>
@ -146,7 +146,7 @@
<method name="set_animation_speed">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<argument index="1" name="speed" type="float">
</argument>
@ -157,7 +157,7 @@
<method name="set_frame">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
<argument index="0" name="anim" type="StringName">
</argument>
<argument index="1" name="idx" type="int">
</argument>

View file

@ -127,6 +127,14 @@
Constructs a new String from the given [Color].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="StringName">
</argument>
<description>
</description>
</method>
<method name="String">
<return type="String">
</return>
@ -145,6 +153,22 @@
Constructs a new String from the given [RID].
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Callable">
</argument>
<description>
</description>
</method>
<method name="String">
<return type="String">
</return>
<argument index="0" name="from" type="Signal">
</argument>
<description>
</description>
</method>
<method name="String">
<return type="String">
</return>
@ -322,6 +346,8 @@
</description>
</method>
<method name="erase">
<return type="void">
</return>
<argument index="0" name="position" type="int">
</argument>
<argument index="1" name="chars" type="int">

View file

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StringName" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="StringName">
<return type="StringName">
</return>
<argument index="0" name="from" type="String">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

View file

@ -21,9 +21,9 @@
<method name="clear_color">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Clears the [Color] at [code]name[/code] if the theme has [code]type[/code].
@ -32,9 +32,9 @@
<method name="clear_constant">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Clears the constant at [code]name[/code] if the theme has [code]type[/code].
@ -43,9 +43,9 @@
<method name="clear_font">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Clears the [Font] at [code]name[/code] if the theme has [code]type[/code].
@ -54,9 +54,9 @@
<method name="clear_icon">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Clears the icon at [code]name[/code] if the theme has [code]type[/code].
@ -65,9 +65,9 @@
<method name="clear_stylebox">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Clears [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
@ -92,9 +92,9 @@
<method name="get_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns the [Color] at [code]name[/code] if the theme has [code]type[/code].
@ -112,9 +112,9 @@
<method name="get_constant" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns the constant at [code]name[/code] if the theme has [code]type[/code].
@ -132,9 +132,9 @@
<method name="get_font" qualifiers="const">
<return type="Font">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns the [Font] at [code]name[/code] if the theme has [code]type[/code].
@ -152,9 +152,9 @@
<method name="get_icon" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns the icon [Texture2D] at [code]name[/code] if the theme has [code]type[/code].
@ -172,9 +172,9 @@
<method name="get_stylebox" qualifiers="const">
<return type="StyleBox">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns the icon [StyleBox] at [code]name[/code] if the theme has [code]type[/code].
@ -208,9 +208,9 @@
<method name="has_color" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code].
@ -220,9 +220,9 @@
<method name="has_constant" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code].
@ -232,9 +232,9 @@
<method name="has_font" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code].
@ -244,9 +244,9 @@
<method name="has_icon" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns [code]true[/code] if icon [Texture2D] with [code]name[/code] is in [code]type[/code].
@ -256,9 +256,9 @@
<method name="has_stylebox" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<description>
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code].
@ -268,9 +268,9 @@
<method name="set_color">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<argument index="2" name="color" type="Color">
</argument>
@ -282,9 +282,9 @@
<method name="set_constant">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<argument index="2" name="constant" type="int">
</argument>
@ -296,9 +296,9 @@
<method name="set_font">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<argument index="2" name="font" type="Font">
</argument>
@ -310,9 +310,9 @@
<method name="set_icon">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<argument index="2" name="texture" type="Texture2D">
</argument>
@ -324,9 +324,9 @@
<method name="set_stylebox">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="String">
<argument index="1" name="type" type="StringName">
</argument>
<argument index="2" name="texture" type="StyleBox">
</argument>

View file

@ -29,7 +29,7 @@
</return>
<argument index="0" name="instance" type="Object">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<argument index="2" name="userdata" type="Variant" default="null">
</argument>

View file

@ -14,9 +14,9 @@
<method name="add_message">
<return type="void">
</return>
<argument index="0" name="src_message" type="String">
<argument index="0" name="src_message" type="StringName">
</argument>
<argument index="1" name="xlated_message" type="String">
<argument index="1" name="xlated_message" type="StringName">
</argument>
<description>
Adds a message if nonexistent, followed by its translation.
@ -25,16 +25,16 @@
<method name="erase_message">
<return type="void">
</return>
<argument index="0" name="src_message" type="String">
<argument index="0" name="src_message" type="StringName">
</argument>
<description>
Erases a message.
</description>
</method>
<method name="get_message" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="src_message" type="String">
<argument index="0" name="src_message" type="StringName">
</argument>
<description>
Returns a message's translation.

View file

@ -69,9 +69,9 @@
</description>
</method>
<method name="translate" qualifiers="const">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="message" type="String">
<argument index="0" name="message" type="StringName">
</argument>
<description>
Returns the current locale's translation for the given message (key).

View file

@ -30,7 +30,7 @@
<method name="call_recursive" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<description>
Calls the [code]method[/code] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list.
@ -452,7 +452,7 @@
</argument>
<argument index="1" name="object" type="Object">
</argument>
<argument index="2" name="callback" type="String">
<argument index="2" name="callback" type="StringName">
</argument>
<description>
Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code].

View file

@ -25,13 +25,13 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<argument index="2" name="initial_val" type="Variant">
</argument>
<argument index="3" name="target" type="Object">
</argument>
<argument index="4" name="target_method" type="String">
<argument index="4" name="target_method" type="StringName">
</argument>
<argument index="5" name="duration" type="float">
</argument>
@ -130,7 +130,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<argument index="2" name="initial_val" type="Variant">
</argument>
@ -186,7 +186,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="key" type="String" default="&quot;&quot;">
<argument index="1" name="key" type="StringName" default="&quot;&quot;">
</argument>
<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.
@ -204,7 +204,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="key" type="String" default="&quot;&quot;">
<argument index="1" name="key" type="StringName" default="&quot;&quot;">
</argument>
<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.
@ -222,7 +222,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="key" type="String" default="&quot;&quot;">
<argument index="1" name="key" type="StringName" default="&quot;&quot;">
</argument>
<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.
@ -265,7 +265,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="key" type="String" default="&quot;&quot;">
<argument index="1" name="key" type="StringName" default="&quot;&quot;">
</argument>
<description>
Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless [code]key[/code] is specified.
@ -283,11 +283,11 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<argument index="2" name="initial" type="Object">
</argument>
<argument index="3" name="initial_method" type="String">
<argument index="3" name="initial_method" type="StringName">
</argument>
<argument index="4" name="final_val" type="Variant">
</argument>

View file

@ -36,7 +36,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<description>
Register a method that will be called when the action is committed.
@ -47,7 +47,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
@ -69,7 +69,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<description>
Register a method that will be called when the action is undone.
@ -80,7 +80,7 @@
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="property" type="String">
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="value" type="Variant">
</argument>

View file

@ -58,7 +58,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="&quot;Master&quot;">
<member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@&quot;Master&quot;">
Audio bus to use for sound playback.
</member>
<member name="expand" type="bool" setter="set_expand" getter="has_expand" default="true">

View file

@ -1671,7 +1671,7 @@
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="parameter" type="String">
<argument index="1" name="parameter" type="StringName">
</argument>
<description>
Returns the value of a certain material's parameter.
@ -1693,7 +1693,7 @@
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="parameter" type="String">
<argument index="1" name="parameter" type="StringName">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
@ -2503,7 +2503,7 @@
</return>
<argument index="0" name="where" type="Object">
</argument>
<argument index="1" name="method" type="String">
<argument index="1" name="method" type="StringName">
</argument>
<argument index="2" name="userdata" type="Variant">
</argument>
@ -2609,7 +2609,7 @@
</return>
<argument index="0" name="shader" type="RID">
</argument>
<argument index="1" name="name" type="String">
<argument index="1" name="name" type="StringName">
</argument>
<description>
Returns a default texture from a shader searched by name.
@ -2620,7 +2620,7 @@
</return>
<argument index="0" name="material" type="RID">
</argument>
<argument index="1" name="parameter" type="String">
<argument index="1" name="parameter" type="StringName">
</argument>
<description>
</description>
@ -2650,7 +2650,7 @@
</return>
<argument index="0" name="shader" type="RID">
</argument>
<argument index="1" name="name" type="String">
<argument index="1" name="name" type="StringName">
</argument>
<argument index="2" name="texture" type="RID">
</argument>

View file

@ -72,7 +72,7 @@
</description>
</method>
<method name="_get_input_port_name" qualifiers="virtual">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="port" type="int">
</argument>
@ -108,7 +108,7 @@
</description>
</method>
<method name="_get_output_port_name" qualifiers="virtual">
<return type="String">
<return type="StringName">
</return>
<argument index="0" name="port" type="int">
</argument>

View file

@ -10,9 +10,9 @@
<method name="call_native">
<return type="Variant">
</return>
<argument index="0" name="calling_type" type="String">
<argument index="0" name="calling_type" type="StringName">
</argument>
<argument index="1" name="procedure_name" type="String">
<argument index="1" name="procedure_name" type="StringName">
</argument>
<argument index="2" name="arguments" type="Array">
</argument>

View file

@ -17,7 +17,7 @@
<method name="get_method_documentation" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="method" type="String">
<argument index="0" name="method" type="StringName">
</argument>
<description>
Returns the documentation string that was previously set with [code]godot_nativescript_set_method_documentation[/code].
@ -26,7 +26,7 @@
<method name="get_property_documentation" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="path" type="String">
<argument index="0" name="path" type="StringName">
</argument>
<description>
Returns the documentation string that was previously set with [code]godot_nativescript_set_property_documentation[/code].
@ -35,7 +35,7 @@
<method name="get_signal_documentation" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="signal_name" type="String">
<argument index="0" name="signal_name" type="StringName">
</argument>
<description>
Returns the documentation string that was previously set with [code]godot_nativescript_set_signal_documentation[/code].

View file

@ -15,7 +15,7 @@
<method name="add_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Add a custom signal with the specified name to the VisualScript.
@ -24,7 +24,7 @@
<method name="add_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Add a function with the specified name to the VisualScript.
@ -33,7 +33,7 @@
<method name="add_node">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -48,7 +48,7 @@
<method name="add_variable">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="default_value" type="Variant" default="null">
</argument>
@ -61,7 +61,7 @@
<method name="custom_signal_add_argument">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="type" type="int" enum="Variant.Type">
</argument>
@ -76,7 +76,7 @@
<method name="custom_signal_get_argument_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Get the count of a custom signal's arguments.
@ -85,7 +85,7 @@
<method name="custom_signal_get_argument_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -96,7 +96,7 @@
<method name="custom_signal_get_argument_type" qualifiers="const">
<return type="int" enum="Variant.Type">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -107,7 +107,7 @@
<method name="custom_signal_remove_argument">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -118,7 +118,7 @@
<method name="custom_signal_set_argument_name">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -131,7 +131,7 @@
<method name="custom_signal_set_argument_type">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -144,7 +144,7 @@
<method name="custom_signal_swap_argument">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="argidx" type="int">
</argument>
@ -157,7 +157,7 @@
<method name="data_connect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -174,7 +174,7 @@
<method name="data_disconnect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -191,7 +191,7 @@
<method name="get_function_node_id" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the id of a function's entry point node.
@ -200,7 +200,7 @@
<method name="get_function_scroll" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the position of the center of the screen for a given function.
@ -209,7 +209,7 @@
<method name="get_node" qualifiers="const">
<return type="VisualScriptNode">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -220,7 +220,7 @@
<method name="get_node_position" qualifiers="const">
<return type="Vector2">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -231,7 +231,7 @@
<method name="get_variable_default_value" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the default (initial) value of a variable.
@ -240,7 +240,7 @@
<method name="get_variable_export" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a variable is exported.
@ -249,7 +249,7 @@
<method name="get_variable_info" qualifiers="const">
<return type="Dictionary">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage.
@ -258,7 +258,7 @@
<method name="has_custom_signal" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a signal exists with the specified name.
@ -267,7 +267,7 @@
<method name="has_data_connection" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -284,7 +284,7 @@
<method name="has_function" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a function exists with the specified name.
@ -293,7 +293,7 @@
<method name="has_node" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -304,7 +304,7 @@
<method name="has_sequence_connection" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -319,7 +319,7 @@
<method name="has_variable" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Returns whether a variable exists with the specified name.
@ -328,7 +328,7 @@
<method name="remove_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Remove a custom signal with the given name.
@ -337,7 +337,7 @@
<method name="remove_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Remove a specific function and its nodes from the script.
@ -346,7 +346,7 @@
<method name="remove_node">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -357,7 +357,7 @@
<method name="remove_variable">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<description>
Remove a variable with the given name.
@ -366,9 +366,9 @@
<method name="rename_custom_signal">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
Change the name of a custom signal.
@ -377,9 +377,9 @@
<method name="rename_function">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
Change the name of a function.
@ -388,9 +388,9 @@
<method name="rename_variable">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="new_name" type="String">
<argument index="1" name="new_name" type="StringName">
</argument>
<description>
Change the name of a variable.
@ -399,7 +399,7 @@
<method name="sequence_connect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -415,7 +415,7 @@
<method name="sequence_disconnect">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="from_node" type="int">
</argument>
@ -430,7 +430,7 @@
<method name="set_function_scroll">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="ofs" type="Vector2">
</argument>
@ -441,7 +441,7 @@
<method name="set_instance_base_type">
<return type="void">
</return>
<argument index="0" name="type" type="String">
<argument index="0" name="type" type="StringName">
</argument>
<description>
Set the base type of the script.
@ -450,7 +450,7 @@
<method name="set_node_position">
<return type="void">
</return>
<argument index="0" name="func" type="String">
<argument index="0" name="func" type="StringName">
</argument>
<argument index="1" name="id" type="int">
</argument>
@ -463,7 +463,7 @@
<method name="set_variable_default_value">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
@ -474,7 +474,7 @@
<method name="set_variable_export">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="enable" type="bool">
</argument>
@ -485,7 +485,7 @@
<method name="set_variable_info">
<return type="void">
</return>
<argument index="0" name="name" type="String">
<argument index="0" name="name" type="StringName">
</argument>
<argument index="1" name="value" type="Dictionary">
</argument>

View file

@ -14,7 +14,7 @@
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type" default="0">
The type to get the constant from.
</member>
<member name="constant" type="String" setter="set_basic_type_constant" getter="get_basic_type_constant">
<member name="constant" type="StringName" setter="set_basic_type_constant" getter="get_basic_type_constant">
The name of the constant to return.
</member>
</members>

View file

@ -15,10 +15,10 @@
<methods>
</methods>
<members>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
The constant's parent class.
</member>
<member name="constant" type="String" setter="set_class_constant" getter="get_class_constant" default="&quot;&quot;">
<member name="constant" type="StringName" setter="set_class_constant" getter="get_class_constant" default="@&quot;&quot;">
The constant to return. See the given class for its available constants.
</member>
</members>

View file

@ -15,7 +15,7 @@
<methods>
</methods>
<members>
<member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
<member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="@&quot;&quot;">
The signal to emit.
</member>
</members>

View file

@ -11,19 +11,19 @@
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
</member>
<member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptFunctionCall.CallMode" default="0">
</member>
<member name="function" type="String" setter="set_function" getter="get_function" default="&quot;&quot;">
<member name="function" type="StringName" setter="set_function" getter="get_function" default="@&quot;&quot;">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="rpc_call_mode" type="int" setter="set_rpc_call_mode" getter="get_rpc_call_mode" enum="VisualScriptFunctionCall.RPCCallMode" default="0">
</member>
<member name="singleton" type="String" setter="set_singleton" getter="get_singleton">
<member name="singleton" type="StringName" setter="set_singleton" getter="get_singleton">
</member>
<member name="use_default_args" type="int" setter="set_use_default_args" getter="get_use_default_args">
</member>

View file

@ -9,7 +9,7 @@
<methods>
</methods>
<members>
<member name="action" type="String" setter="set_action_name" getter="get_action_name" default="&quot;&quot;">
<member name="action" type="StringName" setter="set_action_name" getter="get_action_name" default="@&quot;&quot;">
</member>
<member name="mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="VisualScriptInputAction.Mode" default="0">
</member>

View file

@ -18,7 +18,7 @@
<member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type" default="0">
The local variable's type.
</member>
<member name="var_name" type="String" setter="set_var_name" getter="get_var_name" default="&quot;new_local&quot;">
<member name="var_name" type="StringName" setter="set_var_name" getter="get_var_name" default="@&quot;new_local&quot;">
The local variable's name.
</member>
</members>

View file

@ -20,7 +20,7 @@
<member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type" default="0">
The local variable's type.
</member>
<member name="var_name" type="String" setter="set_var_name" getter="get_var_name" default="&quot;new_local&quot;">
<member name="var_name" type="StringName" setter="set_var_name" getter="get_var_name" default="@&quot;new_local&quot;">
The local variable's name.
</member>
</members>

View file

@ -11,15 +11,15 @@
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
</member>
<member name="index" type="String" setter="set_index" getter="get_index">
<member name="index" type="StringName" setter="set_index" getter="get_index">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="property" type="String" setter="set_property" getter="get_property" default="&quot;&quot;">
<member name="property" type="StringName" setter="set_property" getter="get_property" default="@&quot;&quot;">
</member>
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0">
</member>

View file

@ -13,15 +13,15 @@
</member>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
</member>
<member name="index" type="String" setter="set_index" getter="get_index">
<member name="index" type="StringName" setter="set_index" getter="get_index">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="property" type="String" setter="set_property" getter="get_property" default="&quot;&quot;">
<member name="property" type="StringName" setter="set_property" getter="get_property" default="@&quot;&quot;">
</member>
<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertySet.CallMode" default="0">
</member>

View file

@ -11,7 +11,7 @@
<members>
<member name="base_script" type="String" setter="set_base_script" getter="get_base_script" default="&quot;&quot;">
</member>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
</members>
<constants>

View file

@ -15,7 +15,7 @@
<methods>
</methods>
<members>
<member name="var_name" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
<member name="var_name" type="StringName" setter="set_variable" getter="get_variable" default="@&quot;&quot;">
The variable's name.
</member>
</members>

View file

@ -16,7 +16,7 @@
<methods>
</methods>
<members>
<member name="var_name" type="String" setter="set_variable" getter="get_variable" default="&quot;&quot;">
<member name="var_name" type="StringName" setter="set_variable" getter="get_variable" default="@&quot;&quot;">
The variable's name.
</member>
</members>

View file

@ -9,13 +9,13 @@
<methods>
</methods>
<members>
<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
<member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="@&quot;Object&quot;">
</member>
<member name="call_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptYieldSignal.CallMode" default="0">
</member>
<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
</member>
<member name="signal" type="String" setter="set_signal" getter="get_signal" default="&quot;&quot;">
<member name="signal" type="StringName" setter="set_signal" getter="get_signal" default="@&quot;&quot;">
</member>
</members>
<constants>