Documentation
¶
Overview ¶
Package AnimatedSprite2D provides methods for working with AnimatedSprite2D object instances.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- type ID
- type Instance
- func (self Instance) Animation() string
- func (self Instance) AsAnimatedSprite2D() Instance
- func (self Instance) AsCanvasItem() CanvasItem.Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode2D() Node2D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) Autoplay() string
- func (self Instance) Centered() bool
- func (self Instance) FlipH() bool
- func (self Instance) FlipV() bool
- func (self Instance) Frame() int
- func (self Instance) FrameProgress() Float.X
- func (self Instance) GetPlayingSpeed() Float.X
- func (self Instance) ID() ID
- func (self Instance) IsPlaying() bool
- func (self Instance) Offset() Vector2.XY
- func (self Instance) OnAnimationChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) OnAnimationFinished(cb func(), flags ...Signal.Flags)
- func (self Instance) OnAnimationLooped(cb func(), flags ...Signal.Flags)
- func (self Instance) OnFrameChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) OnSpriteFramesChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) Pause()
- func (self Instance) Play()
- func (self Instance) PlayBackwards()
- func (self Instance) SetAnimation(value string)
- func (self Instance) SetAutoplay(value string)
- func (self Instance) SetCentered(value bool)
- func (self Instance) SetFlipH(value bool)
- func (self Instance) SetFlipV(value bool)
- func (self Instance) SetFrame(value int)
- func (self Instance) SetFrameAndProgress(frame_ int, progress Float.X)
- func (self Instance) SetFrameProgress(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetOffset(value Vector2.XY)
- func (self Instance) SetSpeedScale(value Float.X)
- func (self Instance) SetSpriteFrames(value SpriteFrames.Instance)
- func (self Instance) SpeedScale() Float.X
- func (self Instance) SpriteFrames() SpriteFrames.Instance
- func (self Instance) Stop()
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Expanded ¶
type Expanded [1]gdclass.AnimatedSprite2D
func (Expanded) Play ¶
Plays the animation with key [param name]. If [param custom_speed] is negative and [param from_end] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). If this method is called with that same animation [param name], or with no [param name] parameter, the assigned animation will resume playing if it was paused.
func (Expanded) PlayBackwards ¶
Plays the animation with key [param name] 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.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsAnimatedSprite2D ¶
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.AnimatedSprite2D
[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.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsAnimatedSprite2D ¶
func (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) FrameProgress ¶
func (Instance) GetPlayingSpeed ¶
Returns the actual playing speed of current animation or [code]0[/code] if not playing. This speed is the [member speed_scale] property multiplied by [code]custom_speed[/code] argument specified when calling the [method play] method. Returns a negative value if the current animation is playing backwards.
func (Instance) IsPlaying ¶
Returns [code]true[/code] if an animation is currently playing (even if [member speed_scale] and/or [code]custom_speed[/code] are [code]0[/code]).
func (Instance) OnAnimationChanged ¶
func (Instance) OnAnimationFinished ¶
func (Instance) OnAnimationLooped ¶
func (Instance) OnFrameChanged ¶
func (Instance) OnSpriteFramesChanged ¶
func (Instance) Pause ¶
func (self Instance) Pause()
Pauses the currently playing animation. The [member frame] and [member frame_progress] will be kept and calling [method play] or [method play_backwards] without arguments will resume the animation from the current playback position. See also [method stop].
func (Instance) Play ¶
func (self Instance) Play()
Plays the animation with key [param name]. If [param custom_speed] is negative and [param from_end] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). If this method is called with that same animation [param name], or with no [param name] parameter, the assigned animation will resume playing if it was paused.
func (Instance) PlayBackwards ¶
func (self Instance) PlayBackwards()
Plays the animation with key [param name] 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.
func (Instance) SetAnimation ¶
func (Instance) SetAutoplay ¶
func (Instance) SetCentered ¶
func (Instance) SetFrameAndProgress ¶
Sets [member frame] the [member frame_progress] to the given values. Unlike setting [member frame], this method does not reset the [member frame_progress] to [code]0.0[/code] implicitly. [b]Example:[/b] Change the animation while keeping the same [member frame] and [member frame_progress]: [codeblocks] [gdscript] var current_frame = animated_sprite.get_frame() var current_progress = animated_sprite.get_frame_progress() animated_sprite.play("walk_another_skin") animated_sprite.set_frame_and_progress(current_frame, current_progress) [/gdscript] [/codeblocks]
func (Instance) SetFrameProgress ¶
func (Instance) SetSpeedScale ¶
func (Instance) SetSpriteFrames ¶
func (self Instance) SetSpriteFrames(value SpriteFrames.Instance)
func (Instance) SpeedScale ¶
func (Instance) SpriteFrames ¶
func (self Instance) SpriteFrames() SpriteFrames.Instance
Source Files