AnimationLibrary

package
v0.0.0-...-357ca8a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

An animation library stores a set of animations accessible through string keys, for use with AnimationPlayer nodes.

Index

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 Any

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

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsAnimationLibrary

func (self *Extension[T]) AsAnimationLibrary() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

func (*Extension[T]) AsResource

func (self *Extension[T]) AsResource() Resource.Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.AnimationLibrary

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 New

func New() Instance

func (Instance) AddAnimation

func (self Instance) AddAnimation(name string, animation Animation.Instance) error

Adds the 'animation' to the library, accessible by the key 'name'.

func (Instance) AsAnimationLibrary

func (self Instance) AsAnimationLibrary() Instance

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) GetAnimation

func (self Instance) GetAnimation(name string) Animation.Instance

Returns the Animation with the key 'name'. If the animation does not exist, null is returned and an error is logged.

func (Instance) GetAnimationList

func (self Instance) GetAnimationList() []string

Returns the keys for the Animations stored in the library.

func (Instance) GetAnimationListSize

func (self Instance) GetAnimationListSize() int

Returns the key count for the Animations stored in the library.

func (Instance) HasAnimation

func (self Instance) HasAnimation(name string) bool

Returns true if the library stores an Animation with 'name' as the key.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) OnAnimationAdded

func (self Instance) OnAnimationAdded(cb func(name string), flags ...Signal.Flags)

Emitted when an Animation is added, under the key 'name'.

func (Instance) OnAnimationChanged

func (self Instance) OnAnimationChanged(cb func(name string), flags ...Signal.Flags)

Emitted when there's a change in one of the animations, e.g. tracks are added, moved or have changed paths. 'name' is the key of the animation that was changed.

See also OnResource.Changed, which this acts as a relay for.

func (Instance) OnAnimationRemoved

func (self Instance) OnAnimationRemoved(cb func(name string), flags ...Signal.Flags)

Emitted when an Animation stored with the key 'name' is removed.

func (Instance) OnAnimationRenamed

func (self Instance) OnAnimationRenamed(cb func(name string, to_name string), flags ...Signal.Flags)

Emitted when the key for an Animation is changed, from 'name' to 'to_name'.

func (Instance) RemoveAnimation

func (self Instance) RemoveAnimation(name string)

Removes the Animation with the key 'name'.

func (Instance) RenameAnimation

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

Changes the key of the Animation associated with the key 'name' to 'newname'.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) Virtual

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL