Summary

[Pro-Only] A Animancer.NamedAnimancerComponent which plays a main UnityEngine.RuntimeAnimatorController with the ability to play other individual UnityEngine.AnimationClips separately.

Assembly

Animancer.dll

Namespace

Animancer

Interfaces

IAnimancerComponent
IEnumerable<AnimancerState>
IEnumerator
IAnimationClipSource
IAnimationClipSource
IAnimationClipCollection

Base Types

graph BT Type-->Base0["NamedAnimancerComponent"] click Base0 "/animancer/api/Animancer/NamedAnimancerComponent" Base0-->Base1["AnimancerComponent"] click Base1 "/animancer/api/Animancer/AnimancerComponent" Base1-->Base2["MonoBehaviour"] Type-.->Interface0["IAnimancerComponent"] click Interface0 "/animancer/api/Animancer/IAnimancerComponent" Type-.->Interface1["IEnumerable<AnimancerState>"] Type-.->Interface2["IEnumerator"] Type-.->Interface3["IAnimationClipSource"] click Interface3 "/animancer/api/Animancer/IAnimationClipSource" Type-.->Interface4["IAnimationClipSource"] Type-.->Interface5["IAnimationClipCollection"] click Interface5 "/animancer/api/Animancer/IAnimationClipCollection" Type["HybridAnimancerComponent"] class Type type-node

Syntax

[AddComponentMenu(Strings.MenuPrefix + "Hybrid Animancer Component")]
[HelpURL(Strings.APIDocumentationURL + "/HybridAnimancerComponent")]
public class HybridAnimancerComponent : NamedAnimancerComponent, IAnimancerComponent, 
    IEnumerable<AnimancerState>, IEnumerator, IAnimationClipSource, IAnimationClipSource, 
    IAnimationClipCollection

Attributes

Type	Description
AddComponentMenu
HelpURLAttribute

Properties

Name	Value	Summary
ActionOnDisable	AnimancerComponent.DisableAction	[`UnityEngine.SerializeField`] Determines what happens when this component is disabled or its `UnityEngine.GameObject` becomes inactive (i.e. in `Animancer.AnimancerComponent.OnDisable`). The default value is `Animancer.AnimancerComponent.DisableAction.Stop`. Inherited from AnimancerComponent
Animations	AnimationClip[]	[`UnityEngine.SerializeField`] Animations in this array will be automatically registered by `Animancer.NamedAnimancerComponent.Awake` as states that can be retrieved using their name and the first element will be played by `Animancer.NamedAnimancerComponent.OnEnable` if `Animancer.NamedAnimancerComponent.PlayAutomatically` is true. Inherited from NamedAnimancerComponent
Animator	Animator	[`UnityEngine.SerializeField`] The `UnityEngine.Animator` component which this script controls. Inherited from AnimancerComponent
Controller	ControllerState.Transition	[`UnityEngine.SerializeField`] The main `UnityEngine.RuntimeAnimatorController` that this object plays.
DefaultAnimation	AnimationClip	The first element in the `Animancer.NamedAnimancerComponent.Animations` array. It will be automatically played by `Animancer.NamedAnimancerComponent.OnEnable` if `Animancer.NamedAnimancerComponent.PlayAutomatically` is true. Inherited from NamedAnimancerComponent
InitialUpdateMode	Nullable<AnimatorUpdateMode>	[Editor-Only] The `Animancer.AnimancerComponent.UpdateMode` what was first used when this script initialised. This is used to give a warning when changing to or from `UnityEngine.AnimatorUpdateMode.AnimatePhysics` at runtime since it won't work correctly. Inherited from AnimancerComponent
IsPlayableInitialised	bool	Indicates whether the `Animancer.AnimancerComponent.Playable` has been initialised. Inherited from AnimancerComponent
Layers	AnimancerPlayable.LayerList	The layers which each manage their own set of animations. Inherited from AnimancerComponent
Playable	AnimancerPlayable	The internal system which manages the playing animations. Accessing this property will automatically initialise it. Inherited from AnimancerComponent
PlayAutomatically	bool	[`UnityEngine.SerializeField`] If true, the first clip in the `Animancer.NamedAnimancerComponent.Animations` array will be automatically played by `Animancer.NamedAnimancerComponent.OnEnable`. Inherited from NamedAnimancerComponent
States	AnimancerPlayable.StateDictionary	The states managed by this component. Inherited from AnimancerComponent
UpdateMode	AnimatorUpdateMode	Determines when animations are updated and which time source is used. This property is mainly a wrapper around the `UnityEngine.Animator.updateMode`. Note that changing to or from `UnityEngine.AnimatorUpdateMode.AnimatePhysics` at runtime has no effect. Inherited from AnimancerComponent

Methods

Name	Value	Summary
~AnimancerComponent()	void	[Editor-Only] Ensures that the `UnityEngine.Playables.PlayableGraph` is destroyed. Inherited from AnimancerComponent
Awake()	void	Called by Unity when this component is being loaded. Creates a state for each clip in the `Animancer.NamedAnimancerComponent.Animations` array. Inherited from NamedAnimancerComponent
CrossFade(int, float, int, float)	void	Starts a transition from the current state to the specified state using normalized times.
CrossFade(string, float, int, float)	AnimancerState	Starts a transition from the current state to the specified state using normalized times.
CrossFadeAnimationsInSequence(float)	IEnumerator	[Pro-Only] [Coroutine] Cross fades between each clip in the `Animancer.NamedAnimancerComponent.Animations` array one after the other. Mainly useful for testing and showcasing purposes. Inherited from NamedAnimancerComponent
CrossFadeInFixedTime(int, float, int, float)	void	Starts a transition from the current state to the specified state using times in seconds.
CrossFadeInFixedTime(string, float, int, float)	AnimancerState	Starts a transition from the current state to the specified state using times in seconds.
Evaluate()	void	Evaluates all of the currently playing animations to apply their states to the animated objects. Inherited from AnimancerComponent
Evaluate(float)	void	Advances all currently playing animations by the specified amount of time (in seconds) and evaluates the graph to apply their states to the animated objects. Inherited from AnimancerComponent
GatherAnimationClips(ICollection<AnimationClip>)	void	[`Animancer.IAnimationClipSource`] Gathers all the animations in the `UnityEngine.Playables.Playable` and the `Animations` array.
GetAnimationClips(List<AnimationClip>)	void	[`Animancer.IAnimationClipSource`] Calls `Animancer.AnimancerComponent.GatherAnimationClips(System.Collections.Generic.ICollection{UnityEngine.AnimationClip})`. Inherited from AnimancerComponent
GetAnimatorTransitionInfo(int)	AnimatorTransitionInfo	Gets information about the current transition.
GetBool(int)	bool	Gets the value of the specified boolean parameter.
GetBool(string)	bool	Gets the value of the specified boolean parameter.
GetCurrentAnimatorClipInfo(int)	AnimatorClipInfo[]	Gets information about the `UnityEngine.AnimationClip`s currently being played.
GetCurrentAnimatorClipInfo(int, List<AnimatorClipInfo>)	void	Gets information about the `UnityEngine.AnimationClip`s currently being played.
GetCurrentAnimatorClipInfoCount(int)	int	Gets the number of `UnityEngine.AnimationClip`s currently being played.
GetCurrentAnimatorStateInfo(int)	AnimatorStateInfo	Returns information about the current state.
GetEnumerator()	IEnumerator<AnimancerState>	Returns an enumerator that will iterate through all states in each layer (not states inside mixers). Inherited from AnimancerComponent
GetFloat(int)	float	Gets the value of the specified float parameter.
GetFloat(string)	float	Gets the value of the specified float parameter.
GetInteger(int)	int	Gets the value of the specified integer parameter.
GetInteger(string)	int	Gets the value of the specified integer parameter.
GetKey(AnimationClip)	Object	Returns the clip's name. This method is used to determine the dictionary key to use for an animation when none is specified by the user, such as in `Animancer.AnimancerComponent.Play(UnityEngine.AnimationClip)`. Inherited from NamedAnimancerComponent
GetLayerCount()	int	Gets the number of layers in the `Animancer.HybridAnimancerComponent.Controller`.
GetLayerIndex(string)	int	Gets the index of the layer with the specified name.
GetLayerName(int)	string	Gets the name of the layer with the specified index.
GetLayerWeight(int)	float	Gets the weight of the layer at the specified index.
GetNextAnimatorClipInfo(int)	AnimatorClipInfo[]	Gets information about the `UnityEngine.AnimationClip`s currently being transitioned towards.
GetNextAnimatorClipInfo(int, List<AnimatorClipInfo>)	void	Gets information about the `UnityEngine.AnimationClip`s currently being transitioned towards.
GetNextAnimatorClipInfoCount(int)	int	Gets the number of `UnityEngine.AnimationClip`s currently being transitioned towards.
GetNextAnimatorStateInfo(int)	AnimatorStateInfo	Returns information about the next state being transitioned towards.
GetParameter(int)	AnimatorControllerParameter	Gets the details of one of the `Animancer.HybridAnimancerComponent.Controller`'s parameters.
GetParameterCount()	int	Gets the number of parameters in the `Animancer.HybridAnimancerComponent.Controller`.
HasState(int, int)	bool	Indicates whether the specified layer contains the specified state.
InitialisePlayable()	void	Creates a new `Animancer.AnimancerPlayable` if it doesn't already exist. Inherited from AnimancerComponent
IsInTransition(int)	bool	Indicates whether the specified layer is currently executing a transition.
IsParameterControlledByCurve(int)	bool	Indicates whether the specified parameter is controlled by an `UnityEngine.AnimationClip`.
IsParameterControlledByCurve(string)	bool	Indicates whether the specified parameter is controlled by an `UnityEngine.AnimationClip`.
IsPlaying()	bool	Returns true if at least one animation is being played. Inherited from AnimancerComponent
IsPlaying(AnimancerState)	bool	[Warning] You should not use an `Animancer.AnimancerState` as a key. Just check `Animancer.AnimancerState.IsPlaying`. Inherited from AnimancerComponent
IsPlaying(AnimationClip)	bool	Returns true if a state is registered for the `clip` and it is currently playing. The actual dictionary key is determined using `Animancer.AnimancerComponent.GetKey(UnityEngine.AnimationClip)`. Inherited from AnimancerComponent
IsPlaying(IHasKey)	bool	Returns true if a state is registered with the `Animancer.IHasKey.Key` and it is currently playing. Inherited from AnimancerComponent
IsPlaying(Object)	bool	Returns true if a state is registered with the `key` and it is currently playing. Inherited from AnimancerComponent
IsPlayingClip(AnimationClip)	bool	Returns true if the `clip` is currently being played by at least one state. This method is inefficient because it searches through every state to find any that are playing the `clip`, unlike `Animancer.AnimancerComponent.IsPlaying(UnityEngine.AnimationClip)` which only checks the state registered using the `clip`s key. Inherited from AnimancerComponent
OnDestroy()	void	Called by Unity when this component is destroyed. Ensures that the `Animancer.AnimancerComponent.Playable` is properly cleaned up. Inherited from AnimancerComponent
OnDisable()	void	Called by Unity when this component becomes disabled or inactive. Acts according to the `Animancer.AnimancerComponent.ActionOnDisable`. Inherited from AnimancerComponent
OnEnable()	void	Called by Unity when this component becomes enabled and active. Plays the `Animancer.HybridAnimancerComponent.Controller` if `PlayAutomatically` is false (otherwise it plays the first animation in the `Animancer.NamedAnimancerComponent.Animations` array).
OnValidate()	void	[Editor-Only] Called by the Unity Editor in Edit Mode whenever an instance of this script is loaded or a value is changed in the Inspector. Uses `ClipState.ValidateClip` to ensure that all of the clips in the `Animancer.NamedAnimancerComponent.Animations` array are supported by the `Animancer` system and removes any others. Inherited from NamedAnimancerComponent
Play(AnimancerState)	AnimancerState	Stops all other animations, plays the `state`, and returns it. The animation will continue playing from its current `Animancer.AnimancerState.Time`. To restart it from the beginning you can use `...Play(state).Time = 0;`. Inherited from AnimancerComponent
Play(AnimancerState, float, FadeMode)	AnimancerState	Starts fading in the `state` over the course of the `fadeDuration` while fading out all others in the same layer. Returns the `state`. If the `state` was already playing and fading in with less time remaining than the `fadeDuration`, this method will allow it to complete the existing fade rather than starting a slower one. If the layer currently has 0 `Animancer.AnimancerNode.Weight`, this method will fade in the layer itself and simply `AnimancerState.Play(AnimancerState)` the `state`. Animancer Lite only allows the default `fadeDuration` (0.25 seconds) in a runtime build. Inherited from AnimancerComponent
Play(AnimationClip)	AnimancerState	Stops all other animations, plays the `clip`, and returns its state. The animation will continue playing from its current `Animancer.AnimancerState.Time`. To restart it from the beginning you can use `...Play(clip, layerIndex).Time = 0;`. Inherited from AnimancerComponent
Play(AnimationClip, float, FadeMode)	AnimancerState	Starts fading in the `clip` over the course of the `fadeDuration` while fading out all others in the same layer. Returns its state. If the `state` was already playing and fading in with less time remaining than the `fadeDuration`, this method will allow it to complete the existing fade rather than starting a slower one. If the layer currently has 0 `Animancer.AnimancerNode.Weight`, this method will fade in the layer itself and simply `AnimancerState.Play(AnimationClip)` the `clip`. Animancer Lite only allows the default `fadeDuration` (0.25 seconds) in a runtime build. Inherited from AnimancerComponent
Play(int, int, float)	void	Plays the specified state immediately, starting from a particular normalized time.
Play(ITransition)	AnimancerState	Creates a state for the `transition` if it didn't already exist, then calls `Animancer.AnimancerComponent.Play(Animancer.AnimancerState)` or `Animancer.AnimancerComponent.Play(Animancer.AnimancerState,System.Single,Animancer.FadeMode)` depending on `ITransition.CrossFadeFromStart`. Inherited from AnimancerComponent
Play(ITransition, float, FadeMode)	AnimancerState	Creates a state for the `transition` if it didn't already exist, then calls `Animancer.AnimancerComponent.Play(Animancer.AnimancerState)` or `Animancer.AnimancerComponent.Play(Animancer.AnimancerState,System.Single,Animancer.FadeMode)` depending on `ITransition.CrossFadeFromStart`. Inherited from AnimancerComponent
Play(Object)	AnimancerState	Stops all other animations, plays the animation registered with the `key`, and returns that state. If no state is registered with the `key`, this method does nothing and returns null. The animation will continue playing from its current `Animancer.AnimancerState.Time`. To restart it from the beginning you can use `...Play(key).Time = 0;`. Inherited from AnimancerComponent
Play(Object, float, FadeMode)	AnimancerState	Starts fading in the animation registered with the `key` over the course of the `fadeDuration` while fading out all others in the same layer. Returns the animation's state (or null if none was registered). If the state was already playing and fading in with less time remaining than the `fadeDuration`, this method will allow it to complete the existing fade rather than starting a slower one. If the layer currently has 0 `Animancer.AnimancerNode.Weight`, this method will fade in the layer itself and simply `AnimancerState.Play(AnimancerState)` the state. Animancer Lite only allows the default `fadeDuration` (0.25 seconds) in a runtime build. Inherited from AnimancerComponent
Play(string, int, float)	AnimancerState	Plays the specified state immediately, starting from a particular normalized time.
PlayAnimationsInSequence()	IEnumerator	[Coroutine] Plays each clip in the `Animancer.NamedAnimancerComponent.Animations` array one after the other. Mainly useful for testing and showcasing purposes. Inherited from NamedAnimancerComponent
PlayController()	ControllerState	Transitions to the `Animancer.HybridAnimancerComponent.Controller` over its specified Animancer.AnimancerState.Transition`1.FadeDuration. Returns the Animancer.AnimancerState.Transition`1.State.
PlayInFixedTime(int, int, float)	void	Plays the specified state immediately, starting from a particular time (in seconds).
PlayInFixedTime(string, int, float)	AnimancerState	Plays the specified state immediately, starting from a particular time (in seconds).
Reset()	void	[Editor-Only] Called by the Unity Editor when this component is first added (in Edit Mode) and whenever the Reset command is executed from its context menu. Sets `PlayAutomatically` = false by default so that `Animancer.HybridAnimancerComponent.OnEnable` will play the `Animancer.HybridAnimancerComponent.Controller` instead of the first animation in the `Animancer.NamedAnimancerComponent.Animations` array.
ResetTrigger(int)	void	Resets the specified trigger parameter to false.
ResetTrigger(string)	void	Resets the specified trigger parameter to false.
SetBool(int, bool)	void	Sets the value of the specified boolean parameter.
SetBool(string, bool)	void	Sets the value of the specified boolean parameter.
SetFloat(int, float)	void	Sets the value of the specified float parameter.
SetFloat(string, float)	void	Sets the value of the specified float parameter.
SetInteger(int, int)	void	Sets the value of the specified integer parameter.
SetInteger(string, int)	void	Sets the value of the specified integer parameter.
SetLayerWeight(int, float)	void	Sets the weight of the layer at the specified index.
SetTrigger(int)	void	Sets the specified trigger parameter to true.
SetTrigger(string)	void	Sets the specified trigger parameter to true.
Stop()	void	Stops all animations and rewinds them to the start. Inherited from AnimancerComponent
Stop(AnimancerState)	AnimancerState	[Warning] You should not use an `Animancer.AnimancerState` as a key. Just call `Animancer.AnimancerState.Stop`. Inherited from AnimancerComponent
Stop(AnimationClip)	AnimancerState	Gets the state associated with the `clip`, stops and rewinds it to the start, then returns it. Inherited from AnimancerComponent
Stop(IHasKey)	AnimancerState	Gets the state registered with the `Animancer.IHasKey.Key`, stops and rewinds it to the start, then returns it. Inherited from AnimancerComponent
Stop(Object)	AnimancerState	Gets the state associated with the `key`, stops and rewinds it to the start, then returns it. Inherited from AnimancerComponent

Operators