This is the old Animancer v7.4 documentation. Click here for the latest version.

AnimancerNodeBase Class

Summary

Base class for objects that manage a UnityEngine.Playables.Playable.
Assembly
Animancer.dll
Namespace
Animancer
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type["AnimancerNodeBase"] class Type type-node Derived0["AnimancerGraph"]-->Type click Derived0 "/animancer-v7-4/api/Animancer/AnimancerGraph" Derived1["AnimancerNode"]-->Type click Derived1 "/animancer-v7-4/api/Animancer/AnimancerNode"

Syntax

public abstract class AnimancerNodeBase

Remarks

This is the base class of Animancer.AnimancerGraph and Animancer.AnimancerNode.

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 as their Animancer.AnimancerNodeBase.Parent.
EffectiveSpeed float
The Animancer.AnimancerNodeBase.Speed of this node multiplied by the Animancer.AnimancerNodeBase.Speed of each of its parents to determine the actual speed it's playing at.
Graph AnimancerGraph
The Animancer.AnimancerGraph containing this node.
KeepChildrenConnected bool
Should child playables stay connected to the graph at all times?
Layer AnimancerLayer
The root Animancer.AnimancerLayer which this node is connected to (if any).
Parent AnimancerNodeBase
The object which receives the output of the Animancer.AnimancerNodeBase.Playable.
Playable Playable
The internal object this node manages in the UnityEngine.Playables.PlayableGraph.
Speed float
[Pro-Only] How fast the Animancer.AnimancerState.Time is advancing every frame (default 1).

Methods

Name Value Summary
AddContextMenuIK(GenericMenu, AnimancerNodeBase) void
[Editor-Only] Adds functions to show and set Animancer.AnimancerNodeBase.ApplyAnimatorIK and Animancer.AnimancerNodeBase.ApplyFootIK.
static
MarkAsUsed(AnimancerNodeBase) void
[Assert-Conditional] Prevents the `node` from causing Animancer.OptionalWarning.UnusedNode.
static
OnChildIsLoopingChanged(bool) void
Called when a child's Animancer.AnimancerState.IsLooping value changes.