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

TransitionAssetReference Class

Summary

A [System.SerializableAttribute] wrapper around an Animancer.TransitionAssetBase.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IAnimationClipSource"] Type-.->Interface1["ICopyable<TransitionAssetReference>"] Type-.->Interface2["IPolymorphic"] click Interface2 "/animancer-v7-4/api/Animancer/IPolymorphic" Type-.->Interface3["ITransition"] click Interface3 "/animancer-v7-4/api/Animancer/ITransition" Type-.->Interface4["IHasKey"] click Interface4 "/animancer-v7-4/api/Animancer/IHasKey" Type-.->Interface5["IWrapper"] click Interface5 "/animancer-v7-4/api/Animancer/IWrapper" Type["TransitionAssetReference"] class Type type-node

Syntax

[Serializable]
public class TransitionAssetReference : IAnimationClipSource, ICopyable<TransitionAssetReference>, 
    IPolymorphic, ITransition, IHasKey, IWrapper

Remarks

This allows Transition Assets to be referenced inside [UnityEngine.SerializeReference] fields which can't directly reference UnityEngine.Objects.

Documentation: Transition Assets

Attributes

Type Description
SerializableAttribute

Constructors

Name Summary
TransitionAssetReference() Creates a new Animancer.TransitionAssetReference.
TransitionAssetReference(TransitionAssetBase) Creates a new Animancer.TransitionAssetReference.

Properties

Name Value Summary
Asset TransitionAssetBase
[UnityEngine.SerializeField] The wrapped Transition Asset.
FadeDuration float
The amount of time this transition should take (in seconds).
FadeMode FadeMode
The Animancer.FadeMode which should be used when this transition is passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
IsValid bool
Can this transition create a valid Animancer.AnimancerState?
Key Object
A key which can be used in dictionaries and hash sets.

Methods

Name Value Summary
Apply(AnimancerState) void
Called by Animancer.AnimancerLayer.Play(Animancer.ITransition) to apply any modifications to the `state`.
CopyFrom(TransitionAssetReference, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
CreateState() AnimancerState
Creates and returns a new Animancer.AnimancerState.

Note that using methods like Animancer.AnimancerLayer.Play(Animancer.ITransition) will also call Animancer.ITransition.Apply(Animancer.AnimancerState), so if you call this method manually you may want to call that method as well. Or you can just use Animancer.AnimancerUtilities.CreateStateAndApply(Animancer.ITransition,Animancer.AnimancerGraph).
GetAnimationClips(List<AnimationClip>) void
[UnityEngine.IAnimationClipSource] Calls Animancer.AnimancerUtilities.GatherFromSource(System.Collections.Generic.ICollection{UnityEngine.AnimationClip},System.Object).
ToString() string
Describes the Animancer.TransitionAssetReference.Asset.