Documentation
¶
Overview ¶
A node used for advanced animation transitions in an AnimationPlayer.
Note: When linked with an AnimationPlayer, several properties and methods of the corresponding AnimationPlayer will not function as expected. Playback and transitions should be handled using only the AnimationTree and its constituent AnimationNode(s). The AnimationPlayer node should be used solely for adding, deleting, and editing animations.
Index ¶
- type Advanced
- type AnimationProcessCallback
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AdvanceExpressionBaseNode() string
- func (self Instance) AnimPlayer() string
- func (self Instance) AsAnimationMixer() AnimationMixer.Instance
- func (self Instance) AsAnimationTree() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) GetProcessCallback() AnimationProcessCallback
- func (self Instance) ID() ID
- func (self Instance) OnAnimationPlayerChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) SetAdvanceExpressionBaseNode(value string)
- func (self Instance) SetAnimPlayer(value string)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetProcessCallback(mode AnimationProcessCallback)
- func (self Instance) SetTreeRoot(value AnimationRootNode.Instance)
- func (self Instance) TreeRoot() AnimationRootNode.Instance
- 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 AnimationProcessCallback ¶
type AnimationProcessCallback int //gd:AnimationTree.AnimationProcessCallback
const ( AnimationProcessPhysics AnimationProcessCallback = 0 AnimationProcessIdle AnimationProcessCallback = 1 AnimationProcessManual AnimationProcessCallback = 2 )
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]) AsAnimationMixer ¶
func (self *Extension[T]) AsAnimationMixer() AnimationMixer.Instance
func (*Extension[T]) AsAnimationTree ¶
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.AnimationTree
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) AdvanceExpressionBaseNode ¶
The path to the Node used to evaluate the AnimationNode Expression if one is not explicitly specified internally.
func (Instance) AnimPlayer ¶
The path to the AnimationPlayer used for animating.
func (Instance) AsAnimationMixer ¶
func (self Instance) AsAnimationMixer() AnimationMixer.Instance
func (Instance) AsAnimationTree ¶
func (Instance) GetProcessCallback ¶
func (self Instance) GetProcessCallback() AnimationProcessCallback
Returns the process notification in which to update animations.
func (Instance) OnAnimationPlayerChanged ¶
Emitted when the AnimPlayer is changed.
func (Instance) SetAdvanceExpressionBaseNode ¶
SetAdvanceExpressionBaseNode sets the property returned by [GetAdvanceExpressionBaseNode].
func (Instance) SetAnimPlayer ¶
SetAnimPlayer sets the property returned by [GetAnimationPlayer].
func (Instance) SetProcessCallback ¶
func (self Instance) SetProcessCallback(mode AnimationProcessCallback)
Sets the process notification in which to update animations.
func (Instance) SetTreeRoot ¶
func (self Instance) SetTreeRoot(value AnimationRootNode.Instance)
SetTreeRoot sets the property returned by [GetTreeRoot].
func (Instance) TreeRoot ¶
func (self Instance) TreeRoot() AnimationRootNode.Instance
The root animation node of this AnimationTree. See AnimationRootNode.