Animancer Namespace

Summary

Everything in the Animancer plugin is located in this namespace.

Class Types

Class Summary
AnimancerComponent The main component through which other scripts can interact with Animancer. It allows you to play animations on an UnityEngine.Animator without using a UnityEngine.RuntimeAnimatorController.
AnimancerGraph The root node which manages Animancer's UnityEngine.Playables.PlayableGraph.
AnimancerHelpUrlAttribute [Assert-Conditional] A UnityEngine.HelpURLAttribute which points to Animancer's documentation.
AnimancerJob<T> [Pro-Only] A base class that allows Animation Jobs to be easily inserted into an Animancer graph.
AnimancerLayer A layer on which animations can play with their states managed independantly of other layers while blending the output with those layers.
AnimancerLayerList A list of Animancer.AnimancerLayers with methods to control their mixing and masking.
AnimancerLayerMixerList An Animancer.AnimancerLayerList which uses an UnityEngine.Animations.AnimationLayerMixerPlayable.
AnimancerNode Base class for UnityEngine.Playables.Playable wrapper objects in an Animancer.AnimancerGraph.
AnimancerNodeBase Base class for objects that manage a UnityEngine.Playables.Playable.
AnimancerReflection Reflection utilities used throughout Animancer.
AnimancerState Base class for all states in an Animancer.AnimancerGraph graph which manages one or more UnityEngine.Playables.Playables.
AnimancerStateDictionary A dictionary of Animancer.AnimancerStates mapped to their Animancer.AnimancerState.Key.
AnimancerUtilities Various extension methods and utilities.
AnimatedBool [Pro-Only] A wrapper which allows access to the value of bool properties that are controlled by animations.
AnimatedFloat [Pro-Only] A wrapper which allows access to the value of float properties that are controlled by animations.
AnimatedInt [Pro-Only] A wrapper which allows access to the value of int properties that are controlled by animations.
AnimatedProperty<TJob, TValue> [Pro-Only] A base wrapper which allows access to the value of properties that are controlled by animations.
CartesianMixerState [Pro-Only] An Animancer.AnimancerState which blends an array of other states together based on a two dimensional parameter and thresholds using Gradient Band Interpolation.
ClipState An Animancer.AnimancerState which plays an UnityEngine.AnimationClip.
ClipTransition A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
ClipTransitionSequence A group of Animancer.ClipTransitions which play one after the other.
CloneableExtensions Extension methods for Animancer.ICloneable`1.
CloneContext A dictionary which maps objects to their copies.
CollectionPool<TItem, TCollection> An Animancer.ObjectPool`1 for System.Collections.Generic.ICollection`1.
ControllerState [Pro-Only] An Animancer.AnimancerState which plays a UnityEngine.RuntimeAnimatorController.
ControllerTransition A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
ControllerTransition<TState> A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
ConvertableUtilities Utility methods for Animancer.IConvertable`1.
CopyableExtensions Extension methods for Animancer.ICopyable`1.
DefaultFadeValueAttribute [Editor-Conditional] A Animancer.DefaultValueAttribute which uses the Animancer.AnimancerGraph.DefaultFadeDuration and 0.
DefaultValueAttribute [Editor-Conditional] Specifies the default value of a field and a secondary fallback.
Diagonals Constants for each of the diagonal directions.
DirectionalAnimations3D A Animancer.DirectionalAnimations3D`1 using int as the group type.
DirectionalAnimations3D<TGroup> A component which manages a screen-facing billboard and plays animations from a Animancer.DirectionalAnimationSet to make it look like a UnityEngine.Sprite based character is facing a particular direction in 3D space.
DirectionalAnimationSet A set of up/right/down/left animations.
DirectionalAnimationSet8 A set of up/right/down/left animations with diagonals as well.
DirectionalClipTransition A Animancer.ClipTransition which gets its clip from a Animancer.DirectionalAnimationSet.
DirectionalMixerState [Pro-Only] An Animancer.AnimancerState which blends an array of other states together based on a two dimensional parameter and thresholds using Polar Gradient Band Interpolation.
DontAllowFade An Animancer.IUpdatable that cancels any fades and logs warnings when they occur.
DrawAfterEventsAttribute [Editor-Conditional] Causes an Inspector field in an Animancer.ITransition to be drawn after its events where the events would normally be drawn last.
Easing A set of common easing functions.
EventNamesAttribute [Editor-Conditional] Specifies a set of acceptable names for Animancer.AnimancerEvents so they can display a warning in the Inspector if an unexpected name is used.
ExitEvent [Pro-Only] A callback to be triggered after an Animancer.AnimancerNode either starts or finishes fading out to 0 Animancer.AnimancerNode.EffectiveWeight.
ExposedPropertyTable Sets a UnityEngine.Playables.PlayableDirector as Animancer's UnityEngine.IExposedPropertyTable.
FadeGroup A group of Animancer.AnimancerNodes which are cross-fading.
FadeGroupExtensions Extension methods for Animancer.FadeGroup.
HybridAnimancerComponent [Pro-Only] A Animancer.NamedAnimancerComponent which plays a main UnityEngine.RuntimeAnimatorController with the ability to play other individual UnityEngine.AnimationClips separately.
HybridAnimancerComponentExtensions Extension methods for Animancer.HybridAnimancerComponent.
IndexedList<TItem, TIndexer> A System.Collections.Generic.List`1 which can remove items in O(1) time without searching and an inbuilt enumerator which supports modifications at any time (including during enumeration).
LinearMixerState [Pro-Only] An Animancer.AnimancerState which blends an array of other states together using linear interpolation between the specified thresholds.
LinearMixerTransition A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
ListPool Convenience methods for accessing Animancer.ListPool`1.
ListPool<T> An Animancer.ObjectPool`1 for System.Collections.Generic.List`1.
ManualMixerState [Pro-Only] An Animancer.AnimancerState which blends multiple child states by allowing you to control their Animancer.AnimancerNode.Weight manually.
ManualMixerTransition A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
ManualMixerTransition<TMixer> A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
MixerChildFade Fades the child weights of a Animancer.MixerState`1 to a new parameter value instead of fading the actual parameter.
MixerState<TParameter> [Pro-Only] Base class for mixers which blend an array of child states together based on a Animancer.MixerState`1.Parameter.
MixerTransition<TMixer, TParameter> A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
MixerTransition2D A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
NameCache [Assert-Only] A simple system for caching UnityEngine.Object.name since it allocates garbage every time it's accessed.
NamedAnimancerComponent An Animancer.AnimancerComponent which uses the UnityEngine.Object.names of UnityEngine.AnimationClips so they can be referenced using strings as well as the clips themselves.
NamedEventDictionary A dictionary which maps event names to callbacks.
ObjectPool<T> A simple object pooling system.
Parameter<T> A generic value with an event for when it gets changed.
ParameterDictionary A dictionary of Animancer.IParameters registered using Animancer.StringReferences.
PlayableAssetState [Pro-Only] An Animancer.AnimancerState which plays a UnityEngine.Playables.PlayableAsset.
PlayableAssetTransition A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
PolymorphicAttribute The attributed field will be drawn by a Animancer.Editor.PolymorphicDrawer which allows the user to select its type in the Inspector.
RedirectRootMotion A component which takes the root motion from an UnityEngine.Animator and applies it to a different object.
RedirectRootMotion<T>
RedirectRootMotionToCharacterController A component which takes the root motion from an UnityEngine.Animator and applies it to a UnityEngine.CharacterController.
RedirectRootMotionToRigidbody A component which takes the root motion from an UnityEngine.Animator and applies it to a UnityEngine.Rigidbody.
RedirectRootMotionToTransform A component which takes the root motion from an UnityEngine.Animator and applies it to a UnityEngine.Transform.
SetPool Convenience methods for accessing Animancer.SetPool`1.
SetPool<T> An Animancer.ObjectPool`1 for System.Collections.Generic.HashSet`1.
SmoothedFloatParameter A wrapper around a Animancer.Parameter`1 containing a float which uses UnityEngine.Mathf.SmoothDamp(System.Single,System.Single,System.Single@,System.Single,System.Single,System.Single) to smoothly update its value.
SmoothedVector2Parameter Manages two Animancer.SmoothedFloatParameters as a UnityEngine.Vector2.
SoloAnimation Plays a single UnityEngine.AnimationClip.
SpriteRendererTextureSwap Replaces the UnityEngine.SpriteRenderer.sprite with a copy of it that uses a different Animancer.SpriteRendererTextureSwap.Texture during every Animancer.SpriteRendererTextureSwap.LateUpdate.
Static<T> Holds an instance of T which is automatically created using its parameterless constructor when first accessed.
StringAsset A UnityEngine.ScriptableObject which holds a Animancer.StringReference based on its UnityEngine.Object.name.
StringBuilderPool An Animancer.ObjectPool`1 for System.Text.StringBuilder.
StringReference A string wrapper which allows fast reference equality checks and dictionary usage by ensuring that users of identical strings are given the same Animancer.StringReference instead of needing to compare each character in the strings.
StringReferenceExtensions Extension methods for Animancer.StringReference.
Strings Various string constants used throughout Animancer.
ThresholdLabelAttribute [Editor-Conditional] Specifies a custom display label for the Thresholds column of a mixer transition.
TimeSynchronizer<T> A system for synchronizing the Animancer.AnimancerState.NormalizedTime of animations within the same "group".
Transition<TState> A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
TransitionAsset A UnityEngine.ScriptableObject based Animancer.ITransition.
TransitionAsset<TTransition> A UnityEngine.ScriptableObject based Animancer.ITransition.
TransitionAssetBase A UnityEngine.ScriptableObject based Animancer.ITransition.
TransitionAssetReference A [System.SerializableAttribute] wrapper around an Animancer.TransitionAssetBase.
TryCreateTransitionAttribute Attribute for static methods which try to create a transition from an object.
UltEvent An UltEvents.UltEvent which implements Animancer.IInvokable.
UnityEvent A UnityEngine.Events.UnityEvent which implements Animancer.IInvokable.
Updatable [Pro-Only] An object that can be updated during Animancer's animation updates.
UpdatableListPlayable A UnityEngine.Playables.PlayableBehaviour which executes Animancer.IUpdatable.Update on each item in an Animancer.IUpdatable.List every frame.
Validate Enforces various rules throughout the system, most of which are compiled out if UNITY_ASSERTIONS is not defined (by default, it is only defined in the Unity Editor and in Development Builds).
Vector2MixerState [Pro-Only] An Animancer.AnimancerState which blends an array of other states together based on a two dimensional parameter and thresholds.
WeightedMaskLayerList A replacement for the default UnityEngine.Animations.AnimationLayerMixerPlayable which uses custom Animancer.WeightedMaskLayerList.BoneWeights for each individual bone instead of just using an UnityEngine.AvatarMask to include or exclude them entirely.
WeightedMaskLayers Replaces the default Animancer.AnimancerLayerMixerList with a Animancer.WeightedMaskLayerList.
WeightedMaskLayersDefinition Serializable data which defines how to control a Animancer.WeightedMaskLayerList.

Struct Types

Struct Summary
AnimancerEvent A Animancer.AnimancerEvent.callback delegate paired with a Animancer.AnimancerEvent.normalizedTime to determine when to invoke it.
FastEnumerator<T> An System.Collections.Generic.IEnumerator`1 for any System.Collections.Generic.IList`1 which doesn't bother checking if the target has been modified. This gives it good performance but also makes it slightly less safe to use.
NodeParameter<T> A wrapper for managing a Animancer.Parameter`1 in an Animancer.AnimancerNode.
NodeWeight An Animancer.AnimancerNode and its Animancer.NodeWeight.StartingWeight.
PlayableOutputRefresher A utility for re-assigning Animancer's UnityEngine.Playables.PlayableOutput.
SimpleTimer A very simple timer system based on a System.Diagnostics.Stopwatch.
StateParameterDetails Details of a parameter in an Animancer.IParametizedState.
WeightedMaskMixerJob An UnityEngine.Animations.IAnimationJob which mixes its inputs based on individual Animancer.WeightedMaskMixerJob.boneWeights.

Enum Types

Enum Summary
Direction Up, Right, Down, Left, or their diagonals.
FadeMode Determines how Animancer.AnimancerLayer.Play(Animancer.AnimancerState,System.Single,Animancer.FadeMode) works.
OptionalWarning Bitwise flags used to determine which warnings Animancer should give.

These warnings are all optional. Feel free to disable any of them if you understand the potential issues they're referring to.

Interface Types

Interface Summary
IAnimancerComponent Interface for components that manage an Animancer.AnimancerGraph.
IAnimationClipCollection A variant of UnityEngine.IAnimationClipSource which uses a System.Collections.Generic.ICollection`1 instead of a System.Collections.Generic.List`1 so that it can take a System.Collections.Generic.HashSet`1 to efficiently avoid adding duplicates. Animancer.AnimancerUtilities contains various extension methods for this purpose.
ICharacterRoot Interface for components to indicate which UnityEngine.GameObject is the root of a character when Animancer.AnimancerUtilities.FindRoot(UnityEngine.GameObject) is called.
ICloneable<T> An object that can be cloned.
IConvertable<T> An object which can be converted to another type.
ICopyable<T> An object that can be copied.
IHasDescription An object which can give a detailed description of itself.
IHasEvents An object which has an Animancer.AnimancerEvent.Sequence.Serializable.
IHasKey An object with a Animancer.IHasKey.Key which can be used in dictionaries and hash sets.
IIndexer<T> An object which accesses the index of the items in an Animancer.IndexedList`2.
IInitializable<T> An object with an Animancer.IInitializable`1.Initialize(`0) method.
IInvokable An object with an Animancer.IInvokable.Invoke method.
IMotion An object with an Animancer.IMotion.AverageAngularSpeed and Animancer.IMotion.AverageVelocity.
IParameter A value wrapper with utilities for being drawn in the Inspector.
IParametizedState An object with various parameters.
IPolymorphic An object that will be drawn by a Animancer.Editor.PolymorphicDrawer which allows the user to select its type in the Inspector.
IPolymorphicReset An Animancer.IPolymorphic with a Animancer.IPolymorphicReset.Reset(System.Object) method.
IReadOnlyIndexedList<T> An System.Collections.Generic.IReadOnlyList`1 which can remove items in O(1) time without searching and an inbuilt enumerator which supports modifications at any time (including during enumeration).
ITransition An object which can create an Animancer.AnimancerState and set its details.
ITransition<TState> An Animancer.ITransition which creates a specific type of Animancer.AnimancerState.
ITransitionDetailed An Animancer.ITransition with some additional details (mainly for the Unity Editor GUI).
ITransitionWithEvents A combination of Animancer.ITransition and Animancer.IHasEvents.
IUpdatable [Pro-Only] An object that can be updated during Animancer's animation updates.
IWrapper An object which wraps a Animancer.IWrapper.WrappedObject object.

Namespaces

Namespace Summary
Animancer.Editor [Editor-Only] Types used in the Unity Editor which doesn't exist at runtime.
Animancer.FSM A flexible Finite State Machine system.
Animancer.Samples Samples which demonstrate how to use Animancer.
Animancer.TransitionLibraries Transition Libraries.
Animancer.Units Various attributes for displaying units of measurement on float fields.