DirectionalAnimationSet Class

Summary

A set of up/down/left/right animations.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
Base Types
  • ScriptableObject
Derived Types
graph BT Type-->Base0["ScriptableObject"] Type-.->Interface0["IAnimationClipSource"] click Interface0 "/animancer/api/Animancer/IAnimationClipSource" Type-.->Interface1["IAnimationClipSource"] Type["DirectionalAnimationSet"] class Type type-node Derived0["DirectionalAnimationSet8"]-->Type click Derived0 "/animancer/api/Animancer/DirectionalAnimationSet8"

Syntax

[CreateAssetMenu(menuName = Strings.MenuPrefix + "Directional Animation Set/4 Directions", order = Strings.AssetMenuOrder + 10)]
public class DirectionalAnimationSet : ScriptableObject, IAnimationClipSource, IAnimationClipSource

Attributes

Type Description
CreateAssetMenuAttribute

Properties

Name Value Summary
ClipCount int
The number of animations in this set.
Down AnimationClip
[UnityEngine.SerializeField] The animation facing down.
Left AnimationClip
[UnityEngine.SerializeField] The animation facing left.
Right AnimationClip
[UnityEngine.SerializeField] The animation facing right.
Up AnimationClip
[UnityEngine.SerializeField] The animation facing up.

Methods

Name Value Summary
AddClips(AnimationClip[], int) void
Adds all animations from this set to the `clips`, starting from the specified `index`.
AddClipsAndDirections(AnimationClip[], Vector2[], int) void
Calls Animancer.DirectionalAnimationSet.AddClips(UnityEngine.AnimationClip[],System.Int32) and Animancer.DirectionalAnimationSet.AddDirections(UnityEngine.Vector2[],System.Int32).
AddDirections(Vector2[], int) void
Adds unit vectors corresponding to each of the animations in this set to the `directions`, starting from the specified `index`.
DirectionToVector(DirectionalAnimationSet.Direction) Vector2
Returns a vector representing the specified `direction`.
static
GetAnimationClips(List<AnimationClip>) void
[Animancer.IAnimationClipSource] Adds all animations from this set to the `clips`.
GetClip(DirectionalAnimationSet.Direction) AnimationClip
Returns the animation associated with the specified `direction`.
GetClip(int) AnimationClip
Returns the animation associated with the specified `direction`.
GetClip(Vector2) AnimationClip
Returns the animation closest to the specified `direction`.
GetDirection(int) Vector2
Returns a vector representing the specified `direction`.
GetDirectionName(int) string
Returns the name of the specified `direction`.
SetClip(DirectionalAnimationSet.Direction, AnimationClip) void
Sets the animation associated with the specified `direction`.
SetClip(int, AnimationClip) void
Sets the animation associated with the specified `direction`.
SetClipByName(AnimationClip) int
Attempts to assign the `clip` to one of this set's fields based on its name and returns the direction index of that field (or -1 if it was unable to determine the direction).
SetDown(AnimationClip) void
Sets the Animancer.DirectionalAnimationSet.Down animation.
SetLeft(AnimationClip) void
Sets the Animancer.DirectionalAnimationSet.Left animation.
SetRight(AnimationClip) void
Sets the Animancer.DirectionalAnimationSet.Right animation.
SetUp(AnimationClip) void
Sets the Animancer.DirectionalAnimationSet.Up animation.
Snap(Vector2) Vector2
Returns a copy of the `vector` pointing in the closest direction this set has an animation for.
SnapVectorToDirection(Vector2) Vector2
Returns a copy of the `vector` pointing in the closest direction this set type has an animation for.
static
VectorToDirection(Vector2) DirectionalAnimationSet.Direction
Returns the direction closest to the specified `vector`.
static