Instance Methodmigueldeicaza.swiftgodot 0.45.0SwiftGodot
getRootMotionRotationAccumulator
Retrieve the blended value of the rotation tracks with the rootMotionTrack as a Quaternion that can be used elsewhere.
final func getRootMotionRotationAccumulator() -> Quaternion This is necessary to apply the root motion position correctly, taking rotation into account. See also getRootMotionPosition.
Also, this is useful in cases where you want to respect the initial key values of the animation.
For example, if an animation with only one key Quaternion(0, 0, 0, 1) is played in the previous frame and then an animation with only one key Quaternion(0, 0.707, 0, 0.707) is played in the next frame, the difference can be calculated as follows:
However, if the animation loops, an unintended discrete change may occur, so this is only useful for some simple use cases.
Other members in extension
Types
enum AnimationCallbackModeMethodenum AnimationCallbackModeProcessclass Signal1Signal support.
class Signal2Signal support.
Type members
Instance members
var active: BoolIf
true, theAnimationMixerwill be processing.var animationFinished: Signal1Notifies when an animation finished playing.
var animationLibrariesUpdated: SimpleSignalNotifies when the animation libraries have changed.
var animationListChanged: SimpleSignalNotifies when an animation list is changed.
var animationStarted: Signal2Notifies when an animation starts playing.
var audioMaxPolyphony: Int32The number of possible simultaneous sounds for each of the assigned AudioStreamPlayers.
var cachesCleared: SimpleSignalNotifies when the caches have been cleared, either automatically, or manually via
clearCaches.var callbackModeMethod: AnimationMixer.AnimationCallbackModeMethodThe call mode to use for Call Method tracks.
var callbackModeProcess: AnimationMixer.AnimationCallbackModeProcessThe process notification in which to update animations.
var deterministic: BoolIf
true, the blending uses the deterministic algorithm. The total weight is not normalized and the result is accumulated with an initial value (0or a"RESET"animation if present).var mixerUpdated: SimpleSignalEditor only. Notifies when the property have been updated to update dummy
AnimationPlayerin animation player editor.var resetOnSave: BoolThis is used by the editor. If set to
true, the scene will be saved with the effects of the reset animation (the animation with the key"RESET") applied as if it had been seeked to time 0, with the editor keeping the values that the scene had before saving.var rootMotionTrack: NodePathThe path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by
":". For example,"character/skeleton:ankle"or"character/mesh:transform/local".var rootNode: NodePathThe node from which node path references will travel.
func addAnimationLibrary(name: StringName, library: AnimationLibrary?) -> GodotError Adds
libraryto the animation player, under the keyname.func advance(delta: Double) Manually advance the animations by the specified time (in seconds).
func clearCaches() AnimationMixercaches animated nodes. It may not notice if a node disappears;clearCachesforces it to update the cache again.func findAnimation(Animation?) -> StringName Returns the key of
animationor an emptyStringNameif not found.func findAnimationLibrary(animation: Animation?) -> StringName Returns the key for the
AnimationLibrarythat containsanimationor an emptyStringNameif not found.func getAnimation(name: StringName) -> Animation? Returns the
Animationwith the keyname. If the animation does not exist,nullis returned and an error is logged.func getAnimationLibrary(name: StringName) -> AnimationLibrary? Returns the first
AnimationLibrarywith keynameornullif not found.func getAnimationLibraryList() -> VariantCollection<StringName> Returns the list of stored library keys.
func getAnimationList() -> PackedStringArray Returns the list of stored animation keys.
func getRootMotionPosition() -> Vector3 Retrieve the motion delta of position with the
rootMotionTrackas aVector3that can be used elsewhere.func getRootMotionPositionAccumulator() -> Vector3 Retrieve the blended value of the position tracks with the
rootMotionTrackas aVector3that can be used elsewhere.func getRootMotionRotation() -> Quaternion Retrieve the motion delta of rotation with the
rootMotionTrackas aQuaternionthat can be used elsewhere.func getRootMotionScale() -> Vector3 Retrieve the motion delta of scale with the
rootMotionTrackas aVector3that can be used elsewhere.func getRootMotionScaleAccumulator() -> Vector3 Retrieve the blended value of the scale tracks with the
rootMotionTrackas aVector3that can be used elsewhere.func hasAnimation(name: StringName) -> Bool Returns
trueif theAnimationPlayerstores anAnimationwith keyname.func hasAnimationLibrary(name: StringName) -> Bool Returns
trueif theAnimationPlayerstores anAnimationLibrarywith keyname.func removeAnimationLibrary(name: StringName) Removes the
AnimationLibraryassociated with the keyname.func renameAnimationLibrary(name: StringName, newname: StringName) Moves the
AnimationLibraryassociated with the keynameto the keynewname.
Show implementation details (1)
Hide implementation details
func _postProcessKeyValue(animation: Animation?, track: Int32, value: Variant, object: Object?, objectIdx: Int32) -> Variant A virtual function for processing after key getting during playback.