Open Classmigueldeicaza.swiftgodot 0.46.0SwiftGodot

AnimatedSprite2D

Sprite node that contains multiple textures as frames to play for animation.

class AnimatedSprite2D

Mangled symbol

s10SwiftGodot16AnimatedSprite2DCWhat are these?

FNV24: [7BCJ6]

AnimatedSprite2D is similar to the Sprite2D node, except it carries multiple textures as animation frames. Animations are created using a SpriteFrames resource, which allows you to import image files (or a folder containing said files) to provide the animation frames for the sprite. The SpriteFrames resource can be configured in the editor via the SpriteFrames bottom panel.

This object emits the following signals:

Superclasses

class Node2D
A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index.

Citizens in SwiftGodot

Conformances

protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Type members

class var godotClassName: StringName

Instance members

var animation: StringName
The current animation from the spriteFrames resource. If this value is changed, the frame counter and the frameProgress are reset.
var animationChanged: SimpleSignal
Emitted when animation changes.
var animationFinished: SimpleSignal
Emitted when the animation reaches the end, or the start if it is played in reverse. When the animation finishes, it pauses the playback.
var animationLooped: SimpleSignal
Emitted when the animation loops.
var autoplay: String
The key of the animation to play when the scene loads.
var centered: Bool
If true, texture will be centered.
var flipH: Bool
If true, texture is flipped horizontally.
var flipV: Bool
If true, texture is flipped vertically.
var frame: Int32
The displayed animation frame’s index. Setting this property also resets frameProgress. If this is not desired, use setFrameAndProgress(frame:progress:).
var frameChanged: SimpleSignal
Emitted when frame changes.
var frameProgress: Double
The progress value between 0.0 and 1.0 until the current frame transitions to the next frame. If the animation is playing backwards, the value transitions from 1.0 to 0.0.
var offset: Vector2
The texture’s drawing offset.
var speedScale: Double
The speed scaling ratio. For example, 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.
var spriteFrames: SpriteFrames?
The SpriteFrames resource containing the animation(s). Allows you the option to load, edit, clear, make unique and save the states of the SpriteFrames resource.
var spriteFramesChanged: SimpleSignal
Emitted when spriteFrames changes.
func getPlayingSpeed() -> Double
Returns the actual playing speed of current animation or 0 if not playing. This speed is the speedScale property multiplied by custom_speed argument specified when calling the play(name:customSpeed:fromEnd:) method.
func isPlaying() -> Bool
Returns true if an animation is currently playing (even if speedScale and/or custom_speed are 0).
func pause()
Pauses the currently playing animation. The frame and frameProgress will be kept and calling play(name:customSpeed:fromEnd:) or playBackwards(name:) without arguments will resume the animation from the current playback position.
func play(name: StringName, customSpeed: Double, fromEnd: Bool)
Plays the animation with key name. If customSpeed is negative and fromEnd is true, the animation will play backwards (which is equivalent to calling playBackwards(name:)).
func playBackwards(name: StringName)
Plays the animation with key name in reverse.
func setFrameAndProgress(frame: Int32, progress: Double)
The setter of frame resets the frameProgress to 0.0 implicitly, but this method avoids that.
func stop()
Stops the currently playing animation. The animation position is reset to 0 and the custom_speed is reset to 1.0. See also pause.