Documentation
¶
Overview ¶
Package SpriteFrames provides methods for working with SpriteFrames object instances.
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 [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.
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
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 (Instance) AddAnimation ¶
Adds a new [param anim] animation to the library.
func (Instance) AddFrame ¶
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) 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 [code]default[/code] animation will be created.
func (Instance) DuplicateAnimation ¶
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.
func (Instance) GetAnimationLoop ¶
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code].
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 [param anim] animation.
func (Instance) GetFrameCount ¶
Returns the number of frames for the [param anim] animation.
func (Instance) GetFrameDuration ¶
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 ¶
Returns the texture of the frame [param idx] in the [param anim] animation.
func (Instance) HasAnimation ¶
Returns [code]true[/code] if the [param anim] animation exists.
func (Instance) RemoveAnimation ¶
Removes the [param anim] animation.
func (Instance) RemoveFrame ¶
Removes the [param anim] animation's frame [param idx].
func (Instance) RenameAnimation ¶
Changes the [param anim] animation's name to [param newname].
func (Instance) SetAnimationLoop ¶
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 ¶
Sets the speed for the [param anim] animation in frames per second.
Source Files