ControllerTransition<TState> Class

Summary

A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerPlayable.Play(Animancer.ITransition).
graph BT Type-->Base0["AnimancerTransition<TState>"] Base0-->Base1["Object"] Type-.->Interface0["ITransition<TState>"] Type-.->Interface1["ITransitionDetailed"] click Interface1 "/animancer/api/Animancer/ITransitionDetailed" Type-.->Interface2["ITransitionWithEvents"] click Interface2 "/animancer/api/Animancer/ITransitionWithEvents" Type-.->Interface3["ITransition"] click Interface3 "/animancer/api/Animancer/ITransition" Type-.->Interface4["IHasKey"] click Interface4 "/animancer/api/Animancer/IHasKey" Type-.->Interface5["IPolymorphic"] click Interface5 "/animancer/api/Animancer/IPolymorphic" Type-.->Interface6["IHasEvents"] click Interface6 "/animancer/api/Animancer/IHasEvents" Type-.->Interface7["ICopyable<AnimancerTransition<TState>>"] Type-.->Interface8["IAnimationClipCollection"] click Interface8 "/animancer/api/Animancer/IAnimationClipCollection" Type-.->Interface9["ICopyable<ControllerTransition<TState>>"] Type["ControllerTransition<TState>"] class Type type-node Derived0["Float2ControllerTransition"]-->Type click Derived0 "/animancer/api/Animancer/Float2ControllerTransition" Derived1["ControllerTransition"]-->Type click Derived1 "/animancer/api/Animancer/ControllerTransition" Derived2["Float1ControllerTransition"]-->Type click Derived2 "/animancer/api/Animancer/Float1ControllerTransition" Derived3["Float3ControllerTransition"]-->Type click Derived3 "/animancer/api/Animancer/Float3ControllerTransition"

Syntax

[Serializable]
public abstract class ControllerTransition<TState> : AnimancerTransition<TState>, 
    ITransition<TState>, ITransitionDetailed, ITransitionWithEvents, ITransition, IHasKey, 
    IPolymorphic, IHasEvents, ICopyable<AnimancerTransition<TState>>, IAnimationClipCollection, 
    ICopyable<ControllerTransition<TState>>
    where TState : ControllerState

Remarks

Documentation: Transitions

Attributes

Type Description
SerializableAttribute

Type Parameters

Name Description
TState

Fields

Name Constant Value Summary
ControllerFieldName _Controller
[Editor-Only] The name of the serialized backing field of Animancer.ControllerTransition`1.Controller.
static

Properties

Name Value Summary
ActionsOnStop ControllerState.ActionOnStop[]
[UnityEngine.SerializeField] Determines what each layer does when Animancer.ControllerState.Stop is called.
Controller RuntimeAnimatorController
[UnityEngine.SerializeField] The Animancer.ControllerState.Controller that will be used for the created state.
IsValid bool
Can this transition create a valid Animancer.AnimancerState?
MainObject Object
The Animancer.AnimancerState.MainObject that the created state will have.
MaximumDuration float
The maximum amount of time the animation is expected to take (in seconds).

Methods

Name Value Summary
Apply(AnimancerState) void
Called by Animancer.AnimancerPlayable.Play(Animancer.ITransition) to apply any modifications to the `state`.
CopyFrom(ControllerTransition<TState>) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.

Operators

Name Value Summary
implicit operator RuntimeAnimatorController(ControllerTransition<TState>) RuntimeAnimatorController