mirror of
https://github.com/godotengine/godot.git
synced 2026-01-03 18:11:19 +03:00
Rename the argument tag to param in XML documentation
This commit is contained in:
Yuri Sizov
@@ -17,30 +17,30 @@
|
||||
<methods>
|
||||
<method name="add_animation_library">
|
||||
<return type="int" enum="Error" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="library" type="AnimationLibrary" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="library" type="AnimationLibrary" />
|
||||
<description>
|
||||
Adds [code]library[/code] to the animation player, under the key [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="advance">
|
||||
<return type="void" />
|
||||
<argument index="0" name="delta" type="float" />
|
||||
<param index="0" name="delta" type="float" />
|
||||
<description>
|
||||
Shifts position in the animation timeline and immediately updates the animation. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled.
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_get_next" qualifiers="const">
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<param index="0" name="anim_from" type="StringName" />
|
||||
<description>
|
||||
Returns the key of the animation which is queued to play after the [code]anim_from[/code] animation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="animation_set_next">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<argument index="1" name="anim_to" type="StringName" />
|
||||
<param index="0" name="anim_from" type="StringName" />
|
||||
<param index="1" name="anim_to" type="StringName" />
|
||||
<description>
|
||||
Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes.
|
||||
</description>
|
||||
@@ -59,28 +59,28 @@
|
||||
</method>
|
||||
<method name="find_animation" qualifiers="const">
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="animation" type="Animation" />
|
||||
<param index="0" name="animation" type="Animation" />
|
||||
<description>
|
||||
Returns the key of [code]animation[/code] or an empty [StringName] if not found.
|
||||
</description>
|
||||
</method>
|
||||
<method name="find_animation_library" qualifiers="const">
|
||||
<return type="StringName" />
|
||||
<argument index="0" name="animation" type="Animation" />
|
||||
<param index="0" name="animation" type="Animation" />
|
||||
<description>
|
||||
Returns the key for the [AnimationLibrary] that contains [code]animation[/code] or an empty [StringName] if not found.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_animation" qualifiers="const">
|
||||
<return type="Animation" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_animation_library" qualifiers="const">
|
||||
<return type="AnimationLibrary" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns the first [AnimationLibrary] with key [code]name[/code] or [code]null[/code] if not found.
|
||||
</description>
|
||||
@@ -99,8 +99,8 @@
|
||||
</method>
|
||||
<method name="get_blend_time" qualifiers="const">
|
||||
<return type="float" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<argument index="1" name="anim_to" type="StringName" />
|
||||
<param index="0" name="anim_from" type="StringName" />
|
||||
<param index="1" name="anim_to" type="StringName" />
|
||||
<description>
|
||||
Gets the blend time (in seconds) between two animations, referenced by their keys.
|
||||
</description>
|
||||
@@ -119,14 +119,14 @@
|
||||
</method>
|
||||
<method name="has_animation" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_animation_library" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the [AnimationPlayer] stores an [AnimationLibrary] with key [code]name[/code].
|
||||
</description>
|
||||
@@ -139,10 +139,10 @@
|
||||
</method>
|
||||
<method name="play">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="StringName" default="""" />
|
||||
<argument index="1" name="custom_blend" type="float" default="-1" />
|
||||
<argument index="2" name="custom_speed" type="float" default="1.0" />
|
||||
<argument index="3" name="from_end" type="bool" default="false" />
|
||||
<param index="0" name="name" type="StringName" default="""" />
|
||||
<param index="1" name="custom_blend" type="float" default="-1" />
|
||||
<param index="2" name="custom_speed" type="float" default="1.0" />
|
||||
<param index="3" name="from_end" type="bool" default="false" />
|
||||
<description>
|
||||
Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]).
|
||||
The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing.
|
||||
@@ -151,8 +151,8 @@
|
||||
</method>
|
||||
<method name="play_backwards">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="StringName" default="""" />
|
||||
<argument index="1" name="custom_blend" type="float" default="-1" />
|
||||
<param index="0" name="name" type="StringName" default="""" />
|
||||
<param index="1" name="custom_blend" type="float" default="-1" />
|
||||
<description>
|
||||
Plays the animation with key [code]name[/code] in reverse.
|
||||
This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information.
|
||||
@@ -160,7 +160,7 @@
|
||||
</method>
|
||||
<method name="queue">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Queues an animation for playback once the current one is done.
|
||||
[b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow.
|
||||
@@ -168,23 +168,23 @@
|
||||
</method>
|
||||
<method name="remove_animation_library">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes the [AnimationLibrary] assosiated with the key [code]name[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="rename_animation_library">
|
||||
<return type="void" />
|
||||
<argument index="0" name="name" type="StringName" />
|
||||
<argument index="1" name="newname" type="StringName" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="newname" type="StringName" />
|
||||
<description>
|
||||
Moves the [AnimationLibrary] associated with the key [code]name[/code] to the key [code]newname[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="seek">
|
||||
<return type="void" />
|
||||
<argument index="0" name="seconds" type="float" />
|
||||
<argument index="1" name="update" type="bool" default="false" />
|
||||
<param index="0" name="seconds" type="float" />
|
||||
<param index="1" name="update" type="bool" default="false" />
|
||||
<description>
|
||||
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.
|
||||
[b]Note:[/b] Seeking to the end of the animation doesn't emit [signal animation_finished]. If you want to skip animation and emit the signal, use [method advance].
|
||||
@@ -192,16 +192,16 @@
|
||||
</method>
|
||||
<method name="set_blend_time">
|
||||
<return type="void" />
|
||||
<argument index="0" name="anim_from" type="StringName" />
|
||||
<argument index="1" name="anim_to" type="StringName" />
|
||||
<argument index="2" name="sec" type="float" />
|
||||
<param index="0" name="anim_from" type="StringName" />
|
||||
<param index="1" name="anim_to" type="StringName" />
|
||||
<param index="2" name="sec" type="float" />
|
||||
<description>
|
||||
Specifies a blend time (in seconds) between two animations, referenced by their keys.
|
||||
</description>
|
||||
</method>
|
||||
<method name="stop">
|
||||
<return type="void" />
|
||||
<argument index="0" name="reset" type="bool" default="true" />
|
||||
<param index="0" name="reset" type="bool" default="true" />
|
||||
<description>
|
||||
Stops or pauses 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], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation.
|
||||
@@ -254,22 +254,22 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="animation_changed">
|
||||
<argument index="0" name="old_name" type="StringName" />
|
||||
<argument index="1" name="new_name" type="StringName" />
|
||||
<param index="0" name="old_name" type="StringName" />
|
||||
<param index="1" name="new_name" type="StringName" />
|
||||
<description>
|
||||
Emitted when a queued animation plays after the previous animation finished. See [method queue].
|
||||
[b]Note:[/b] The signal is not emitted when the animation is changed via [method play] or by an [AnimationTree].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="animation_finished">
|
||||
<argument index="0" name="anim_name" type="StringName" />
|
||||
<param index="0" name="anim_name" type="StringName" />
|
||||
<description>
|
||||
Notifies when an animation finished playing.
|
||||
[b]Note:[/b] This signal is not emitted if an animation is looping.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="animation_started">
|
||||
<argument index="0" name="anim_name" type="StringName" />
|
||||
<param index="0" name="anim_name" type="StringName" />
|
||||
<description>
|
||||
Notifies when an animation starts playing.
|
||||
</description>
|
||||
|
||||
Reference in New Issue
Block a user