Documentation
¶
Overview ¶
An animation library stores a set of animations accessible through string keys, for use with AnimationPlayer nodes.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AddAnimation(name string, animation Animation.Instance) error
- func (self Instance) AsAnimationLibrary() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) GetAnimation(name string) Animation.Instance
- func (self Instance) GetAnimationList() []string
- func (self Instance) GetAnimationListSize() int
- func (self Instance) HasAnimation(name string) bool
- func (self Instance) ID() ID
- func (self Instance) OnAnimationAdded(cb func(name string), flags ...Signal.Flags)
- func (self Instance) OnAnimationChanged(cb func(name string), flags ...Signal.Flags)
- func (self Instance) OnAnimationRemoved(cb func(name string), flags ...Signal.Flags)
- func (self Instance) OnAnimationRenamed(cb func(name string, to_name string), flags ...Signal.Flags)
- func (self Instance) RemoveAnimation(name string)
- func (self Instance) RenameAnimation(name string, newname string)
- 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 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]) AsAnimationLibrary ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
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.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 (Instance) AddAnimation ¶
Adds the 'animation' to the library, accessible by the key 'name'.
func (Instance) AsAnimationLibrary ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) GetAnimation ¶
Returns the Animation with the key 'name'. If the animation does not exist, null is returned and an error is logged.
func (Instance) GetAnimationList ¶
Returns the keys for the Animations stored in the library.
func (Instance) GetAnimationListSize ¶
Returns the key count for the Animations stored in the library.
func (Instance) HasAnimation ¶
Returns true if the library stores an Animation with 'name' as the key.
func (Instance) OnAnimationAdded ¶
Emitted when an Animation is added, under the key 'name'.
func (Instance) OnAnimationChanged ¶
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 ¶
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 ¶
Removes the Animation with the key 'name'.
func (Instance) RenameAnimation ¶
Changes the key of the Animation associated with the key 'name' to 'newname'.