Sara/this-city
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: updated engine

Browse source
This commit is contained in:
Sara Gerretsen 2026-07-10 17:04:34 +02:00
parent cbe99774ff
commit f4cf6b3999
6607 changed files with 910135 additions and 430025 deletions
Download patch file Download diff file Expand all files Collapse all files

38
engine/doc/classes/SpriteFrames.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SpriteFrames" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<class name="SpriteFrames" inherits="Resource" api_type="core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Sprite frame library for AnimatedSprite2D and AnimatedSprite3D.
</brief_description>
@ -47,11 +47,18 @@
Duplicates the animation [param anim_from] to a new animation named [param anim_to]. Fails if [param anim_to] already exists, or if [param anim_from] does not exist.
</description>
</method>
<method name="get_animation_loop" qualifiers="const">
<method name="get_animation_loop" qualifiers="const" deprecated="Use [method get_animation_loop_mode] instead.">
<return type="bool" />
<param index="0" name="anim" type="StringName" />
<description>
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].
Returns [code]true[/code] if [code]get_animation_loop_mode(anim) == LOOP_LINEAR[/code]. Otherwise, returns [code]false[/code].
</description>
</method>
<method name="get_animation_loop_mode" qualifiers="const">
<return type="int" enum="SpriteFrames.LoopMode" />
<param index="0" name="anim" type="StringName" />
<description>
Returns the loop mode for the [param anim] animation.
</description>
</method>
<method name="get_animation_names" qualifiers="const">
@ -124,12 +131,21 @@
Changes the [param anim] animation's name to [param newname].
</description>
</method>
<method name="set_animation_loop">
<method name="set_animation_loop" deprecated="Use [method set_animation_loop_mode] instead.">
<return type="void" />
<param index="0" name="anim" type="StringName" />
<param index="1" name="loop" type="bool" />
<description>
If [param loop] is [code]true[/code], the [param anim] animation will loop when it reaches the end, or the start if it is played in reverse.
If [param loop] is [code]false[/code] equivalent to [code]set_animation_loop_mode(LOOP_NONE)[/code].
If [param loop] is [code]true[/code] equivalent to [code]set_animation_loop_mode(LOOP_LINEAR)[/code].
</description>
</method>
<method name="set_animation_loop_mode">
<return type="void" />
<param index="0" name="anim" type="StringName" />
<param index="1" name="loop_mode" type="int" enum="SpriteFrames.LoopMode" />
<description>
Sets the [param loop_mode] for the [param anim] animation.
</description>
</method>
<method name="set_animation_speed">
@ -151,4 +167,16 @@
</description>
</method>
</methods>
<constants>
<constant name="LOOP_NONE" value="0" enum="LoopMode">
The animation plays once and stops when it reaches the end, or the start if played in reverse.
</constant>
<constant name="LOOP_LINEAR" value="1" enum="LoopMode">
The animation restarts from the beginning when it reaches the end, or from the end if played in reverse, repeating continuously.
</constant>
<constant name="LOOP_PINGPONG" value="2" enum="LoopMode">
The animation alternates direction each time it reaches the end or start, playing forward and then in reverse repeatedly.
[b]Note:[/b] Both [AnimatedSprite2D] and [AnimatedSprite3D] play the first/last frame for its duration only once at each end of the animation loop (instead of twice, once per forward/backward animation direction).
</constant>
</constants>
</class>