Animations are just data containers, and must be added to nodes such as an [AnimationPlayer] to be played back.
Animations are just data containers, and must be added to nodes such as an [AnimationPlayer] to be played back. Animation tracks have different types, each with its own set of dedicated methods. Check [enum TrackType] to see available types.
Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track.
Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track.
[code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending.
</description>
</description>
</method>
</method>
<methodname="audio_track_set_key_end_offset">
<methodname="audio_track_set_key_end_offset">
...
@@ -121,6 +131,7 @@
...
@@ -121,6 +131,7 @@
<argumentindex="2"name="offset"type="float">
<argumentindex="2"name="offset"type="float">
</argument>
</argument>
<description>
<description>
Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
</description>
</description>
</method>
</method>
<methodname="audio_track_set_key_start_offset">
<methodname="audio_track_set_key_start_offset">
...
@@ -133,6 +144,7 @@
...
@@ -133,6 +144,7 @@
<argumentindex="2"name="offset"type="float">
<argumentindex="2"name="offset"type="float">
</argument>
</argument>
<description>
<description>
Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
</description>
</description>
</method>
</method>
<methodname="audio_track_set_key_stream">
<methodname="audio_track_set_key_stream">
...
@@ -145,6 +157,7 @@
...
@@ -145,6 +157,7 @@
<argumentindex="2"name="stream"type="Resource">
<argumentindex="2"name="stream"type="Resource">
</argument>
</argument>
<description>
<description>
Sets the stream of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track.
[code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point.
Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track.
</description>
</description>
</method>
</method>
<methodname="bezier_track_set_key_in_handle">
<methodname="bezier_track_set_key_in_handle">
...
@@ -213,6 +232,7 @@
...
@@ -213,6 +232,7 @@
<argumentindex="2"name="in_handle"type="Vector2">
<argumentindex="2"name="in_handle"type="Vector2">
</argument>
</argument>
<description>
<description>
Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.
Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.
</description>
</description>
</method>
</method>
<methodname="bezier_track_set_key_value">
<methodname="bezier_track_set_key_value">
...
@@ -237,6 +258,7 @@
...
@@ -237,6 +258,7 @@
<argumentindex="2"name="value"type="float">
<argumentindex="2"name="value"type="float">
</argument>
</argument>
<description>
<description>
Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track.
</description>
</description>
</method>
</method>
<methodname="clear">
<methodname="clear">
...
@@ -675,6 +697,7 @@
...
@@ -675,6 +697,7 @@
<signals>
<signals>
<signalname="tracks_changed">
<signalname="tracks_changed">
<description>
<description>
Emitted when there's a change in the list of tracks, e.g. tracks are added, moved or have changed paths.
</description>
</description>
</signal>
</signal>
</signals>
</signals>
...
@@ -689,10 +712,13 @@
...
@@ -689,10 +712,13 @@
Method tracks call functions with given arguments per key.
Method tracks call functions with given arguments per key.
Bezier tracks are used to interpolate a value using custom curves. They can also be used to animate sub-properties of vectors and colors (e.g. alpha value of a [Color]).
[AnimationTree] node resource that contains many blend type nodes.
</brief_description>
</brief_description>
<description>
<description>
This node may contain a sub-tree of any other blend type nodes, such as mix, blend2, blend3, one shot, etc. This is one of the most commonly used roots.
Plays an animation once in [AnimationNodeBlendTree].
</brief_description>
</brief_description>
<description>
<description>
A resource to add to an [AnimationNodeBlendTree]. This node will execute a sub-animation and return once it finishes. Blend times for fading in and out can be customized, as well as filters.
If [member autorestart] is [code]true[/code], a random additional delay (in seconds) between 0 and this value will be added to [member autorestart_delay].
A generic animation transition node for [AnimationTree].
</brief_description>
</brief_description>
<description>
<description>
Simple state machine for cases which don't require a more advanced [AnimationNodeStateMachine]. Animations can be connected to the inputs and transition times can be specified.
An object representing a method in a certain object that can be called.
</brief_description>
</brief_description>
<description>
<description>
[Callable] is a first class object which can be held in variables and passed to functions. It represents a given method in an [Object], and is typically used for signal callbacks.
[b]Example:[/b]
[codeblock]
var callable = Callable(self, "print_args")
func print_args(arg1, arg2, arg3 = ""):
prints(arg1, arg2, arg3)
func test():
callable.call("hello", "world") # Prints "hello world".
callable.call(Vector2.UP, 42, callable) # Prints "(0, -1) 42 Node(Node.gd)::print_args".
callable.call("invalid") # Invalid call, should have at least 2 arguments.
Creates a new [Callable] for the method called [code]method_name[/code] in the specified [code]object[/code].
</description>
</description>
</method>
</method>
<methodname="call"qualifiers="vararg">
<methodname="call"qualifiers="vararg">
<returntype="Variant">
<returntype="Variant">
</return>
</return>
<description>
<description>
Calls the method represented by this [Callable]. Arguments can be passed and should match the method's signature.
</description>
</description>
</method>
</method>
<methodname="call_deferred"qualifiers="vararg">
<methodname="call_deferred"qualifiers="vararg">
<returntype="void">
<returntype="void">
</return>
</return>
<description>
<description>
Calls the method represented by this [Callable] in deferred mode, i.e. during the idle frame. Arguments can be passed and should match the method's signature.
</description>
</description>
</method>
</method>
<methodname="get_method">
<methodname="get_method">
<returntype="StringName">
<returntype="StringName">
</return>
</return>
<description>
<description>
Returns the name of the method represented by this [Callable].
</description>
</description>
</method>
</method>
<methodname="get_object">
<methodname="get_object">
<returntype="Object">
<returntype="Object">
</return>
</return>
<description>
<description>
Returns the object on which this [Callable] is called.
</description>
</description>
</method>
</method>
<methodname="get_object_id">
<methodname="get_object_id">
<returntype="int">
<returntype="int">
</return>
</return>
<description>
<description>
Returns the ID of this [Callable]'s object (see [method Object.get_instance_id]).
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity.
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PackedVector2Array], not a reference.
The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PackedVector2Array], not a reference.
The margin used for one-way collision (in pixels).
The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity.
Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible.
</theme_item>
</theme_item>
<theme_itemname="bg"type="StyleBox">
<theme_itemname="bg"type="StyleBox">
</theme_item>
</theme_item>
<theme_itemname="grabber"type="Texture2D">
<theme_itemname="grabber"type="Texture2D">
The icon used for the grabber drawn in the middle area.
Replaces the texture's data with a new [code]image[/code]. If [code]immediate[/code] is [code]true[/code], it will take effect immediately after the call.
The local gesture position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] that received this gesture.
Returns the resource loaded by [method load_threaded_request].
If this is called before the loading thread is done (i.e. [method load_threaded_get_status] is not [constant THREAD_LOAD_LOADED]), the calling thread will be blocked until the resource has finished loading.
Returns the status of a threaded loading operation started with [method load_threaded_request] for the resource at [code]path[/code]. See [enum ThreadLoadStatus] for possible return values.
An array variable can optionally be passed via [code]progress[/code], and will return a one-element array containing the percentage of completion of the threaded loading.
Loads the resource using threads. If [code]use_sub_threads[/code] is [code]true[/code], multiple threads will be used to load the resource, which makes loading faster, but may affect the main thread (and thus cause game slowdowns).
[StringName]s are immutable strings designed for general-purpose represention of unique names. [StringName] ensures that only one instance of a given name exists (so two [StringName]s with the same value are the same object). Comparing them is much faster than with regular [String]s, because only the pointers are compared, not the whole strings.
</description>
</description>
<tutorials>
<tutorials>
</tutorials>
</tutorials>
...
@@ -13,6 +15,7 @@
...
@@ -13,6 +15,7 @@
<argumentindex="0"name="from"type="String">
<argumentindex="0"name="from"type="String">
</argument>
</argument>
<description>
<description>
Creates a new [StringName] from the given [String].
Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent.
Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor.
Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent.
Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor.
</theme_item>
</theme_item>
<theme_itemname="menu"type="Texture2D">
<theme_itemname="menu"type="Texture2D">
The icon for the menu button (see [method set_popup]).
</theme_item>
</theme_item>
<theme_itemname="menu_highlight"type="Texture2D">
<theme_itemname="menu_highlight"type="Texture2D">
The icon for the menu button (see [method set_popup]) when it's being hovered with the cursor.
Background of the close button when it's being hovered with the cursor.
</theme_item>
</theme_item>
<theme_itemname="button_pressed"type="StyleBox">
<theme_itemname="button_pressed"type="StyleBox">
Background of the close button when it's being pressed.
</theme_item>
</theme_item>
<theme_itemname="close"type="Texture2D">
<theme_itemname="close"type="Texture2D">
The icon for the close button (see [member tab_close_display_policy]).
</theme_item>
</theme_item>
<theme_itemname="decrement"type="Texture2D">
<theme_itemname="decrement"type="Texture2D">
Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent.
Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor.
Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent.
Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor.
Boolean value. If 1 ([code]true[/code]), the grabber will hide automatically when it isn't under the cursor. If 0 ([code]false[/code]), it's always visible.
</theme_item>
</theme_item>
<theme_itemname="bg"type="StyleBox">
<theme_itemname="bg"type="StyleBox">
</theme_item>
</theme_item>
<theme_itemname="grabber"type="Texture2D">
<theme_itemname="grabber"type="Texture2D">
The icon used for the grabber drawn in the middle area.
