TransitionLibraryDefinition Class

Summary

[System.SerializableAttribute] A library of transitions and other details which can create a Animancer.TransitionLibraries.TransitionLibrary.
Assembly
Animancer.dll
Namespace
Animancer.TransitionLibraries
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IAnimationClipSource"] Type-.->Interface1["ICopyable<TransitionLibraryDefinition>"] Type-.->Interface2["IEquatable<TransitionLibraryDefinition>"] Type-.->Interface3["IHasDescription"] click Interface3 "/animancer/api/Animancer/IHasDescription" Type["TransitionLibraryDefinition"] class Type type-node

Syntax

[Serializable]
public class TransitionLibraryDefinition : IAnimationClipSource, 
    ICopyable<TransitionLibraryDefinition>, IEquatable<TransitionLibraryDefinition>, IHasDescription

Remarks

Documentation: Transition Libraries

Attributes

Type Description
SerializableAttribute

Fields

Name Constant Value Summary
AliasAllTransitionsTooltip Should all Transitions automatically be registered using their name as an Alias?
Tooltip for the Animancer.TransitionLibraries.TransitionLibraryDefinition.AliasAllTransitions field.
static

Properties

Name Value Summary
AliasAllTransitions bool
[UnityEngine.SerializeField] Should all Transitions automatically be registered using their name as an Alias?
Aliases NamedIndex[]
[UnityEngine.SerializeField] Alternate names that can be used to look up transitions.
Modifiers TransitionModifierDefinition[]
[UnityEngine.SerializeField] Modified fade durations for specific transition combinations.
Transitions TransitionAssetBase[]
[UnityEngine.SerializeField] The transitions in this library.

Methods

Name Value Summary
AddAlias(NamedIndex) int
Adds an item to the Animancer.TransitionLibraries.TransitionLibraryDefinition.Aliases, sorted by its values.
AddTransition(TransitionAssetBase) void
Adds an item to the end of the Animancer.TransitionLibraries.TransitionLibraryDefinition.Transitions.
AppendDescription(StringBuilder, string) void
Appends a detailed descrption of the current details of this object.
CopyFrom(TransitionLibraryDefinition, CloneContext) void
Copies the contents of `copyFrom` into this object, replacing its previous contents.
Equals(Object) bool
Are all fields in this object equal to the equivalent in `obj`?
Equals(TransitionLibraryDefinition) bool
Are all fields in this object equal to the equivalent fields in `other`?
GetAnimationClips(List<AnimationClip>) void
Gathers all the animations in this definition.
GetHashCode() int
Returns a hash code based on the values of this object's fields.
IndexOfModifier(int, int) int
Returns the index in the Animancer.TransitionLibraries.TransitionLibraryDefinition.Modifiers which matches the given Animancer.TransitionLibraries.TransitionModifierDefinition.FromIndex and Animancer.TransitionLibraries.TransitionModifierDefinition.ToIndex or -1 if no such item exists.
RemoveAlias(int) void
Removes an item from the Animancer.TransitionLibraries.TransitionLibraryDefinition.Aliases.
RemoveAlias(NamedIndex) bool
Removes an item from the Animancer.TransitionLibraries.TransitionLibraryDefinition.Aliases.
RemoveModifier(int, int) bool
Removes an item from the Animancer.TransitionLibraries.TransitionLibraryDefinition.Modifiers.
RemoveModifier(TransitionModifierDefinition) bool
Removes an item from the Animancer.TransitionLibraries.TransitionLibraryDefinition.Modifiers.
RemoveTransition(int) void
Removes an item from the Animancer.TransitionLibraries.TransitionLibraryDefinition.Transitions and adjusts the other fields to account for the moved indices.
SetModifier(TransitionModifierDefinition) void
Adds or replaces an item in the Animancer.TransitionLibraries.TransitionLibraryDefinition.Modifiers.
SortAliases() void
Ensures that the Animancer.TransitionLibraries.TransitionLibraryDefinition.Aliases are sorted.
TryGetModifier(int, int, TransitionModifierDefinition) bool
Tries to find an item in the Animancer.TransitionLibraries.TransitionLibraryDefinition.Modifiers with the specified indices.
TryGetTransition(int, TransitionAssetBase) bool
Animancer.AnimancerUtilities.TryGet``1(System.Collections.Generic.IList{``0},System.Int32,``0@) for the Animancer.TransitionLibraries.TransitionLibraryDefinition.Transitions.

Operators

Name Value Summary
operator !=(TransitionLibraryDefinition, TransitionLibraryDefinition) bool
operator ==(TransitionLibraryDefinition, TransitionLibraryDefinition) bool