ControllerTransition<TState> Class

Summary

A serializable Animancer.ITransition which can create a particular type of Animancer.AnimancerState when passed into Animancer.AnimancerLayer.Play(Animancer.ITransition).
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["Transition<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<Transition<TState>>"] Type-.->Interface8["ICloneable<Transition<TState>>"] Type-.->Interface9["IAnimationClipCollection"] click Interface9 "/animancer/api/Animancer/IAnimationClipCollection" Type-.->Interface10["ICopyable<ControllerTransition<TState>>"] Type["ControllerTransition<TState>"] class Type type-node Derived0["ControllerTransition"]-->Type click Derived0 "/animancer/api/Animancer/ControllerTransition"

Syntax

[Serializable]
public abstract class ControllerTransition<TState> : Transition<TState>, ITransition<TState>, 
    ITransitionDetailed, ITransitionWithEvents, ITransition, IHasKey, IPolymorphic, IHasEvents, 
    ICopyable<Transition<TState>>, ICloneable<Transition<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 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).
ParameterBindings ControllerState.SerializableParameterBindings
[UnityEngine.SerializeField] Parameter names which make parameters in the UnityEngine.RuntimeAnimatorController follow the values of parameters in the Animancer.AnimancerGraph.Parameters.

Methods

Name Value Summary
Apply(AnimancerState) void
Applies the details of this transition to the `state`.
CopyFrom(ControllerTransition<TState>, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
CopyFrom(Transition<TState>, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.

Operators

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