Merge pull request #93233 from dalexeev/anim-doc-sprite-frames-frame-duration

Animation: Document frame duration units in `SpriteFrames`
This commit is contained in:
Rémi Verschelde 2024-06-17 10:59:06 +02:00
commit 63cb43a059
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -23,7 +23,7 @@
<param index="2" name="duration" type="float" default="1.0" /> <param index="2" name="duration" type="float" default="1.0" />
<param index="3" name="at_position" type="int" default="-1" /> <param index="3" name="at_position" type="int" default="-1" />
<description> <description>
Adds a frame to the [param anim] animation. If [param at_position] is [code]-1[/code], the frame will be added to the end of the animation. Adds a frame to the [param anim] animation. If [param at_position] is [code]-1[/code], the frame will be added to the end of the animation. [param duration] specifies the relative duration, see [method get_frame_duration] for details.
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
@ -139,7 +139,7 @@
<param index="2" name="texture" type="Texture2D" /> <param index="2" name="texture" type="Texture2D" />
<param index="3" name="duration" type="float" default="1.0" /> <param index="3" name="duration" type="float" default="1.0" />
<description> <description>
Sets the [param texture] and the [param duration] of the frame [param idx] in the [param anim] animation. Sets the [param texture] and the [param duration] of the frame [param idx] in the [param anim] animation. [param duration] specifies the relative duration, see [method get_frame_duration] for details.
</description> </description>
</method> </method>
</methods> </methods>