SpriteFrames

Documentation

Overview

Package SpriteFrames provides methods for working with SpriteFrames object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AddAnimation(anim string)
  • func (self Instance) AddFrame(anim string, texture [1]gdclass.Texture2D)
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) AsSpriteFrames() Instance
  • func (self Instance) Clear(anim string)
  • func (self Instance) ClearAll()
  • func (self Instance) GetAnimationLoop(anim string) bool
  • func (self Instance) GetAnimationNames() []string
  • func (self Instance) GetAnimationSpeed(anim string) Float.X
  • func (self Instance) GetFrameCount(anim string) int
  • func (self Instance) GetFrameDuration(anim string, idx int) Float.X
  • func (self Instance) GetFrameTexture(anim string, idx int) [1]gdclass.Texture2D
  • func (self Instance) HasAnimation(anim string) bool
  • func (self Instance) RemoveAnimation(anim string)
  • func (self Instance) RemoveFrame(anim string, idx int)
  • func (self Instance) RenameAnimation(anim string, newname string)
  • func (self Instance) SetAnimationLoop(anim string, loop bool)
  • func (self Instance) SetAnimationSpeed(anim string, fps Float.X)
  • func (self Instance) SetFrame(anim string, idx int, texture [1]gdclass.Texture2D)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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 Any

type Any interface {
	gd.IsClass
	AsSpriteFrames() Instance
}

type Instance

type Instance [1]gdclass.SpriteFrames

Sprite frame library for an [AnimatedSprite2D] or [AnimatedSprite3D] node. Contains frames and animation data for playback.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AddAnimation

func (self Instance) AddAnimation(anim string)

Adds a new [param anim] animation to the library.

func (Instance) AddFrame

func (self Instance) AddFrame(anim string, texture [1]gdclass.Texture2D)

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.

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) AsSpriteFrames

func (self Instance) AsSpriteFrames() Instance

func (Instance) Clear

func (self Instance) Clear(anim string)

Removes all frames from the [param anim] animation.

func (Instance) ClearAll

func (self Instance) ClearAll()

Removes all animations. An empty [code]default[/code] animation will be created.

func (Instance) GetAnimationLoop

func (self Instance) GetAnimationLoop(anim string) bool

Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].

func (Instance) GetAnimationNames

func (self Instance) GetAnimationNames() []string

Returns an array containing the names associated to each animation. Values are placed in alphabetical order.

func (Instance) GetAnimationSpeed

func (self Instance) GetAnimationSpeed(anim string) Float.X

Returns the speed in frames per second for the [param anim] animation.

func (Instance) GetFrameCount

func (self Instance) GetFrameCount(anim string) int

Returns the number of frames for the [param anim] animation.

func (Instance) GetFrameDuration

func (self Instance) GetFrameDuration(anim string, idx int) Float.X

Returns a relative duration of the frame [param idx] in the [param anim] animation (defaults to [code]1.0[/code]). For example, a frame with a duration of [code]2.0[/code] is displayed twice as long as a frame with a duration of [code]1.0[/code]. You can calculate the absolute duration (in seconds) of a frame using the following formula: [codeblock] absolute_duration = relative_duration / (animation_fps * abs(playing_speed)) [/codeblock] In this example, [code]playing_speed[/code] refers to either [method AnimatedSprite2D.get_playing_speed] or [method AnimatedSprite3D.get_playing_speed].

func (Instance) GetFrameTexture

func (self Instance) GetFrameTexture(anim string, idx int) [1]gdclass.Texture2D

Returns the texture of the frame [param idx] in the [param anim] animation.

func (Instance) HasAnimation

func (self Instance) HasAnimation(anim string) bool

Returns [code]true[/code] if the [param anim] animation exists.

func (Instance) RemoveAnimation

func (self Instance) RemoveAnimation(anim string)

Removes the [param anim] animation.

func (Instance) RemoveFrame

func (self Instance) RemoveFrame(anim string, idx int)

Removes the [param anim] animation's frame [param idx].

func (Instance) RenameAnimation

func (self Instance) RenameAnimation(anim string, newname string)

Changes the [param anim] animation's name to [param newname].

func (Instance) SetAnimationLoop

func (self Instance) SetAnimationLoop(anim string, loop bool)

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.

func (Instance) SetAnimationSpeed

func (self Instance) SetAnimationSpeed(anim string, fps Float.X)

Sets the speed for the [param anim] animation in frames per second.

func (Instance) SetFrame

func (self Instance) SetFrame(anim string, idx int, texture [1]gdclass.Texture2D)

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.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value