diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AnimationPlayer.xml | 92 | ||||
| -rw-r--r-- | doc/classes/Node.xml | 2 | ||||
| -rw-r--r-- | doc/classes/PopupMenu.xml | 12 |
3 files changed, 76 insertions, 30 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index d61211bb6b..570f5e9741 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -90,6 +90,13 @@ Returns the list of stored animation names. </description> </method> + <method name="get_autoplay" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the name of the animation that will be automatically played when the scene is loaded. + </description> + </method> <method name="get_blend_time" qualifiers="const"> <return type="float"> </return> @@ -101,11 +108,18 @@ Get the blend time (in seconds) between two animations, referenced by their names. </description> </method> + <method name="get_current_animation" qualifiers="const"> + <return type="String"> + </return> + <description> + Returns the name of the animation being played. + </description> + </method> <method name="get_current_animation_length" qualifiers="const"> <return type="float"> </return> <description> - Get the length (in seconds) of the currently playing animation. + Get the length (in seconds) of the currently being played animation. </description> </method> <method name="get_current_animation_position" qualifiers="const"> @@ -115,6 +129,12 @@ Get the position (in seconds) of the currently playing animation. </description> </method> + <method name="get_speed_scale" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="has_animation" qualifiers="const"> <return type="bool"> </return> @@ -124,6 +144,13 @@ Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code]. </description> </method> + <method name="is_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if the player is active. + </description> + </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> @@ -143,7 +170,8 @@ <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> - Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. + Play the animation with key [code]name[/code]. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the + animation backwards. </description> </method> <method name="play_backwards"> @@ -194,7 +222,25 @@ <argument index="1" name="update" type="bool" default="false"> </argument> <description> - Seek the animation to the [code]seconds[/code] point in time (in seconds). If 'update' is true, the animation updates too, otherwise it updates at process time. + Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. + </description> + </method> + <method name="set_active"> + <return type="void"> + </return> + <argument index="0" name="active" type="bool"> + </argument> + <description> + Sets the player as active (playing). If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. + </description> + </method> + <method name="set_autoplay"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Defines the name of the animation to play when the scene loads. Default value: [code]""[/code]. </description> </method> <method name="set_blend_time"> @@ -210,34 +256,37 @@ Specify a blend time (in seconds) between two animations, referenced by their names. </description> </method> - <method name="stop"> + <method name="set_current_animation"> <return type="void"> </return> - <argument index="0" name="reset" type="bool" default="true"> + <argument index="0" name="anim" type="String"> </argument> <description> - Stop the currently playing animation. If [code]reset[/code] is [code]true[/code], the anim position is reset to [code]0[/code]. + Sets the name of the current animation. If already playing, restarts the animation. Ensure [member active] is [code]true[/code] to simulate [method play]. Default value: [code]""[/code]. </description> </method> - <method name="stop_all"> + <method name="set_speed_scale"> <return type="void"> </return> + <argument index="0" name="speed" type="float"> + </argument> <description> - Stop playback of animations (deprecated). + Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code]. + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <argument index="0" name="reset" type="bool" default="true"> + </argument> + <description> + Stop the currently playing animation. If [code]reset[/code] is [code]true[/code], the anim position is reset to [code]0[/code]. </description> </method> </methods> <members> - <member name="active" type="bool" setter="set_active" getter="is_active"> - If [code]true[/code] updates animations in response to process-related notifications. Default value: [code]true[/code]. - </member> - <member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay"> - The name of the animation to play when the scene loads. Default value: [code]""[/code]. - </member> - <member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation"> - The name of the current animation. Default value: [code]""[/code]. - </member> <member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time"> + The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code]. </member> <member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode"> The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. @@ -245,9 +294,6 @@ <member name="root_node" type="NodePath" setter="set_root" getter="get_root"> The node from which node path references will travel. Default value: [code]".."[/code]. </member> - <member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale"> - The speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code]. - </member> </members> <signals> <signal name="animation_changed"> @@ -256,21 +302,21 @@ <argument index="1" name="new_name" type="String"> </argument> <description> - Emitted when the [Animation] with key [member current_anim] is modified. + If the currently being played animation changes, this signal will notify of such change. </description> </signal> <signal name="animation_finished"> <argument index="0" name="name" type="String"> </argument> <description> - Emitted when an animation finishes. + Notifies when an animation finished playing. </description> </signal> <signal name="animation_started"> <argument index="0" name="name" type="String"> </argument> <description> - Emitted when an animation starts. + Notifies when an animation starts playing. </description> </signal> </signals> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index a36587c606..e56733f102 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -225,7 +225,7 @@ <argument index="0" name="path" type="NodePath"> </argument> <description> - Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and attempts to access it will result in an "Attempt to call <method> on a null instance." error. + Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and attempts to access it will result in an "Attempt to call <method> on a null instance." error. Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). [i]Example:[/i] Assume your current node is Character and the following tree: [codeblock] diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 372a97ecd9..13cf16d2ee 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -379,24 +379,24 @@ Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. </description> </method> - <method name="set_item_shortcut"> + <method name="set_item_multistate"> <return type="void"> </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="shortcut" type="ShortCut"> - </argument> - <argument index="2" name="global" type="bool" default="false"> + <argument index="1" name="state" type="int"> </argument> <description> </description> </method> - <method name="set_item_multistate"> + <method name="set_item_shortcut"> <return type="void"> </return> <argument index="0" name="idx" type="int"> </argument> - <argument index="1" name="state" type="int"> + <argument index="1" name="shortcut" type="ShortCut"> + </argument> + <argument index="2" name="global" type="bool" default="false"> </argument> <description> </description> |