IPlayableWrapper Interface

Summary

Interface for objects that manage a UnityEngine.Playables.Playable.
graph BT Type["IPlayableWrapper"] class Type type-node Implementing0["AnimancerState"]-.->Type click Implementing0 "/animancer/api/Animancer/AnimancerState" Implementing1["ManualMixerState"]-.->Type click Implementing1 "/animancer/api/Animancer/ManualMixerState" Implementing2["ClipState"]-.->Type click Implementing2 "/animancer/api/Animancer/ClipState" Implementing3["DirectionalMixerState"]-.->Type click Implementing3 "/animancer/api/Animancer/DirectionalMixerState" Implementing4["AnimancerPlayable"]-.->Type click Implementing4 "/animancer/api/Animancer/AnimancerPlayable" Implementing5["CartesianMixerState"]-.->Type click Implementing5 "/animancer/api/Animancer/CartesianMixerState" Implementing6["MixerState<TParameter>"]-.->Type click Implementing6 "/animancer/api/Animancer/MixerState_1" Implementing7["LinearMixerState"]-.->Type click Implementing7 "/animancer/api/Animancer/LinearMixerState" Implementing8["ControllerState"]-.->Type click Implementing8 "/animancer/api/Animancer/ControllerState" Implementing9["AnimancerNode"]-.->Type click Implementing9 "/animancer/api/Animancer/AnimancerNode" Implementing10["Float2ControllerState"]-.->Type click Implementing10 "/animancer/api/Animancer/Float2ControllerState" Implementing11["Float1ControllerState"]-.->Type click Implementing11 "/animancer/api/Animancer/Float1ControllerState" Implementing12["AnimancerLayer"]-.->Type click Implementing12 "/animancer/api/Animancer/AnimancerLayer" Implementing13["PlayableAssetState"]-.->Type click Implementing13 "/animancer/api/Animancer/PlayableAssetState" Implementing14["Float3ControllerState"]-.->Type click Implementing14 "/animancer/api/Animancer/Float3ControllerState"

Syntax

public interface IPlayableWrapper

Properties

Name Value Summary
ApplyAnimatorIK bool
Should Unity call OnAnimatorIK on the animated object while this object and its children have any Animancer.AnimancerNode.Weight?
ApplyFootIK bool
Should this object and its children apply IK to the character's feet?
ChildCount int
The number of nodes using this object as their Animancer.IPlayableWrapper.Parent.
KeepChildrenConnected bool
Indicates whether child playables should stay connected to the graph at all times.

If false, playables will be disconnected from the graph while they are at 0 weight to stop it from evaluating them every frame.
Parent IPlayableWrapper
The object which receives the output of the Animancer.IPlayableWrapper.Playable.
Playable Playable
The UnityEngine.Playables.Playable managed by this object.
Speed float
How fast the Animancer.AnimancerState.Time is advancing every frame.
Weight float
The current blend weight of this node which determines how much it affects the final output.

Methods

Name Value Summary
GetChild(int) AnimancerNode
Returns the state connected to the specified `index` as a child of this object.

Extension Methods

Name Value Summary
NormalizeChildWeights() void
Re-scales the Animancer.AnimancerNode.Weight of all children to add up to 1.