From aa6772d7abb3ff1ff77b1b658617904bb0af1fbb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 14 Dec 2017 00:07:39 +0100 Subject: Revert property changes in "[DOCS] AnimationPlayer new props, members/methods" This partially reverts commits e79456519d0c1dff98ffa5f39e8e7c962b7dd553 and 2d07fe29208b9ccef31ab654ca5405edac7a0de7, which introduced API changes needing more in-depth review at this stage. Kept the removal of "get_position" binding, redundant with "get_current_animation_position". Kept docs changes where applicable. Also removed the obsolete "stop_all" method which does the same as "stop". Fixes #14602. --- doc/classes/AnimationPlayer.xml | 92 ++++++++++++++++++++++++++++++----------- doc/classes/Node.xml | 2 +- doc/classes/PopupMenu.xml | 12 +++--- 3 files changed, 76 insertions(+), 30 deletions(-) (limited to 'doc/classes') 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. + + + + + Returns the name of the animation that will be automatically played when the scene is loaded. + + @@ -101,11 +108,18 @@ Get the blend time (in seconds) between two animations, referenced by their names. + + + + + Returns the name of the animation being played. + + - Get the length (in seconds) of the currently playing animation. + Get the length (in seconds) of the currently being played animation. @@ -115,6 +129,12 @@ Get the position (in seconds) of the currently playing animation. + + + + + + @@ -124,6 +144,13 @@ Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code]. + + + + + Returns [code]true[/code] if the player is active. + + @@ -143,7 +170,8 @@ - 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. @@ -194,7 +222,25 @@ - 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. + + + + + + + + + Sets the player as active (playing). If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. + + + + + + + + + Defines the name of the animation to play when the scene loads. Default value: [code]""[/code]. @@ -210,34 +256,37 @@ Specify a blend time (in seconds) between two animations, referenced by their names. - + - + - 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]. - + + + - 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]. + + + + + + + + + Stop the currently playing animation. If [code]reset[/code] is [code]true[/code], the anim position is reset to [code]0[/code]. - - If [code]true[/code] updates animations in response to process-related notifications. Default value: [code]true[/code]. - - - The name of the animation to play when the scene loads. Default value: [code]""[/code]. - - - The name of the current animation. Default value: [code]""[/code]. - + The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code]. The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. @@ -245,9 +294,6 @@ The node from which node path references will travel. Default value: [code]".."[/code]. - - The speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code]. - @@ -256,21 +302,21 @@ - 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. - Emitted when an animation finishes. + Notifies when an animation finished playing. - Emitted when an animation starts. + Notifies when an animation starts playing. 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 @@ - 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 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. - + - - - + - + - + + + -- cgit v1.2.3