Documentation
¶
Overview ¶
Sprite frame library for an graphics.gd/classdb/AnimatedSprite2D or graphics.gd/classdb/AnimatedSprite3D node. Contains frames and animation data for playback.
Index ¶
- type Advanced
- type Any
- type Expanded
- type Extension
- type ID
- type Instance
- func (self Instance) AddAnimation(anim string)
- func (self Instance) AddFrame(anim string, texture Texture2D.Instance)
- 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) DuplicateAnimation(anim_from string, anim_to string)
- 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) Texture2D.Instance
- func (self Instance) HasAnimation(anim string) bool
- func (self Instance) ID() ID
- 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 Texture2D.Instance)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- 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.SpriteFrames
func (Expanded) AddFrame ¶
func (self Expanded) AddFrame(anim string, texture Texture2D.Instance, duration Float.X, at_position int)
Adds a frame to the 'anim' animation. If 'at_position' is -1, the frame will be added to the end of the animation. 'duration' specifies the relative duration, see Instance.GetFrameDuration for details.
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]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsSpriteFrames ¶
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.SpriteFrames
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AddAnimation ¶
Adds a new 'anim' animation to the library.
func (Instance) AddFrame ¶
Adds a frame to the 'anim' animation. If 'at_position' is -1, the frame will be added to the end of the animation. 'duration' specifies the relative duration, see Instance.GetFrameDuration for details.
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsSpriteFrames ¶
func (Instance) ClearAll ¶
func (self Instance) ClearAll()
Removes all animations. An empty default animation will be created.
func (Instance) DuplicateAnimation ¶
Duplicates the animation 'anim_from' to a new animation named 'anim_to'. Fails if 'anim_to' already exists, or if 'anim_from' does not exist.
func (Instance) GetAnimationLoop ¶
Returns true if the given animation is configured to loop when it finishes playing. Otherwise, returns false.
func (Instance) GetAnimationNames ¶
Returns an array containing the names associated to each animation. Values are placed in alphabetical order.
func (Instance) GetAnimationSpeed ¶
Returns the speed in frames per second for the 'anim' animation.
func (Instance) GetFrameCount ¶
Returns the number of frames for the 'anim' animation.
func (Instance) GetFrameDuration ¶
Returns a relative duration of the frame 'idx' in the 'anim' animation (defaults to 1.0). For example, a frame with a duration of 2.0 is displayed twice as long as a frame with a duration of 1.0. You can calculate the absolute duration (in seconds) of a frame using the following formula:
In this example, playing_speed refers to either graphics.gd/classdb/AnimatedSprite2D.Instance.GetPlayingSpeed or graphics.gd/classdb/AnimatedSprite3D.Instance.GetPlayingSpeed.
func (Instance) GetFrameTexture ¶
Returns the texture of the frame 'idx' in the 'anim' animation.
func (Instance) HasAnimation ¶
Returns true if the 'anim' animation exists.
func (Instance) RemoveAnimation ¶
Removes the 'anim' animation.
func (Instance) RemoveFrame ¶
Removes the 'anim' animation's frame 'idx'.
func (Instance) RenameAnimation ¶
Changes the 'anim' animation's name to 'newname'.
func (Instance) SetAnimationLoop ¶
If 'loop' is true, the 'anim' animation will loop when it reaches the end, or the start if it is played in reverse.
func (Instance) SetAnimationSpeed ¶
Sets the speed for the 'anim' animation in frames per second.
func (Instance) SetFrame ¶
Sets the 'texture' and the 'duration' of the frame 'idx' in the 'anim' animation. 'duration' specifies the relative duration, see Instance.GetFrameDuration for details.
Source Files