Proofread and improve the whole class reference
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
This commit is contained in:
Hugo Locurcio
parent
538c8eec15
commit
f7f6115f76
330 changed files with 2585 additions and 2474 deletions
|
|
@ -4,7 +4,7 @@
|
|||
Container and player of [Animation] resources.
|
||||
</brief_description>
|
||||
<description>
|
||||
An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.
|
||||
An animation player is used for general-purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels.
|
||||
</description>
|
||||
<tutorials>
|
||||
<link>https://docs.godotengine.org/en/latest/getting_started/step_by_step/animations.html</link>
|
||||
|
|
@ -55,7 +55,7 @@
|
|||
<return type="void">
|
||||
</return>
|
||||
<description>
|
||||
[AnimationPlayer] caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.
|
||||
[AnimationPlayer] caches animated nodes. It may not notice if a node disappears; [method clear_caches] forces it to update the cache again.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_queue">
|
||||
|
|
@ -98,14 +98,14 @@
|
|||
<argument index="1" name="anim_to" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Get the blend time (in seconds) between two animations, referenced by their names.
|
||||
Gets the blend time (in seconds) between two animations, referenced by their names.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_playing_speed" qualifiers="const">
|
||||
<return type="float">
|
||||
</return>
|
||||
<description>
|
||||
Get the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method.
|
||||
Gets the actual playing speed of current animation or 0 if not playing. This speed is the [code]playback_speed[/code] property multiplied by [code]custom_speed[/code] argument specified when calling the [code]play[/code] method.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_queue">
|
||||
|
|
@ -142,8 +142,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 [code]true[/code] can play the animation backwards.
|
||||
If the animation has been paused by [code]stop(true)[/code] it will be resumed. Calling [code]play()[/code] without arguments will also resume the animation.
|
||||
Plays the animation with key [code]name[/code]. Custom speed and blend times can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards.
|
||||
If the animation has been paused by [method stop], it will be resumed. Calling [method play] without arguments will also resume the animation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="play_backwards">
|
||||
|
|
@ -154,8 +154,8 @@
|
|||
<argument index="1" name="custom_blend" type="float" default="-1">
|
||||
</argument>
|
||||
<description>
|
||||
Play the animation with key [code]name[/code] in reverse.
|
||||
If the animation has been paused by [code]stop(true)[/code] it will be resumed backwards. Calling [code]play_backwards()[/code] without arguments will also resume the animation backwards.
|
||||
Plays the animation with key [code]name[/code] in reverse.
|
||||
If the animation has been paused by [code]stop(true)[/code], it will be resumed backwards. Calling [code]play_backwards()[/code] without arguments will also resume the animation backwards.
|
||||
</description>
|
||||
</method>
|
||||
<method name="queue">
|
||||
|
|
@ -164,7 +164,7 @@
|
|||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Queue an animation for playback once the current one is done.
|
||||
Queues an animation for playback once the current one is done.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_animation">
|
||||
|
|
@ -173,7 +173,7 @@
|
|||
<argument index="0" name="name" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Remove the animation with key [code]name[/code].
|
||||
Removes the animation with key [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_animation">
|
||||
|
|
@ -184,7 +184,7 @@
|
|||
<argument index="1" name="newname" type="String">
|
||||
</argument>
|
||||
<description>
|
||||
Rename an existing animation with key [code]name[/code] to [code]newname[/code].
|
||||
Renames an existing animation with key [code]name[/code] to [code]newname[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="seek">
|
||||
|
|
@ -195,7 +195,7 @@
|
|||
<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 [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped.
|
||||
Seeks 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. Events between the current frame and [code]seconds[/code] are skipped.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_blend_time">
|
||||
|
|
@ -208,7 +208,7 @@
|
|||
<argument index="2" name="sec" type="float">
|
||||
</argument>
|
||||
<description>
|
||||
Specify a blend time (in seconds) between two animations, referenced by their names.
|
||||
Specifies a blend time (in seconds) between two animations, referenced by their names.
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop">
|
||||
|
|
@ -217,8 +217,8 @@
|
|||
<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 animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code].
|
||||
If [code]reset[/code] is [code]false[/code], then calling [code]play()[/code] without arguments or [code]play("same_as_before")[/code] will resume the animation. Works the same for the [code]play_backwards()[/code] method.
|
||||
Stops the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code].
|
||||
If [code]reset[/code] is [code]false[/code], then calling [method play] without arguments or [code]play("same_as_before")[/code] will resume the animation. Works the same for the [method play_backwards].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
@ -251,7 +251,7 @@
|
|||
The process notification in which to update animations. Default value: [constant ANIMATION_PROCESS_IDLE].
|
||||
</member>
|
||||
<member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale">
|
||||
The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: [code]1[/code].
|
||||
The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed. Default value: [code]1[/code].
|
||||
</member>
|
||||
<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].
|
||||
|
|
@ -294,7 +294,7 @@
|
|||
Process animation during the idle process.
|
||||
</constant>
|
||||
<constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessMode">
|
||||
Do not process animation. Use the 'advance' method to process the animation manually.
|
||||
Do not process animation. Use [method advance] to process the animation manually.
|
||||
</constant>
|
||||
<constant name="ANIMATION_METHOD_CALL_DEFERRED" value="0" enum="AnimationMethodCallMode">
|
||||
Batch method calls during the animation process, then do the calls after events are processed. This avoids bugs involving deleting nodes or modifying the AnimationPlayer while playing.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue