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

DirectionalAnimationSet8 Class

Summary

A set of up/right/down/left animations with diagonals as well.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
  • IAnimationClipSource
Base Types
graph BT Type-->Base0["DirectionalAnimationSet"] click Base0 "/animancer-v7-4/api/Animancer/DirectionalAnimationSet" Base0-->Base1["ScriptableObject"] Type-.->Interface0["IAnimationClipSource"] Type["DirectionalAnimationSet8"] class Type type-node

Syntax

[CreateAssetMenu(menuName = Strings.MenuPrefix + "Directional Animation Set/8 Directions", order = Strings.AssetMenuOrder + 11)]
[HelpURL(Strings.DocsURLs.APIDocumentation + "/" + nameof(DirectionalAnimationSet8))]
public class DirectionalAnimationSet8 : DirectionalAnimationSet, IAnimationClipSource

Remarks

Documentation: Directional Animation Sets

Attributes

Type Description
CreateAssetMenuAttribute
HelpURLAttribute

Properties

Name Value Summary
ClipCount int
The number of animations in this set.
Down AnimationClip
[UnityEngine.SerializeField] The animation facing down (0, -1).
DownLeft AnimationClip
[UnityEngine.SerializeField] The animation facing diagonally down-left ~(-0.7, -0.7).
DownRight AnimationClip
[UnityEngine.SerializeField] The animation facing diagonally down-right ~(0.7, -0.7).
Left AnimationClip
[UnityEngine.SerializeField] The animation facing left (-1, 0).
Right AnimationClip
[UnityEngine.SerializeField] The animation facing right (1, 0).
Up AnimationClip
[UnityEngine.SerializeField] The animation facing up (0, 1).
UpLeft AnimationClip
[UnityEngine.SerializeField] The animation facing diagonally up-left ~(-0.7, 0.7).
UpRight AnimationClip
[UnityEngine.SerializeField] The animation facing diagonally up-right ~(0.7, 0.7).

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`.
AllowSetClips(bool) void
[Assert-Only] Determines whether the UnityEngine.AnimationClip properties are allowed to be set.
AssertCanSetClips() void
[Assert-Only] Throws an System.ArgumentException if Animancer.DirectionalAnimationSet.AllowSetClips(System.Boolean) was not called.
DirectionToVector(DirectionalAnimationSet.Direction) Vector2
Returns a vector representing the specified `direction`.
static
DirectionToVector(DirectionalAnimationSet8.Direction) Vector2
Returns a vector representing the specified `direction`.
static
GetAnimationClips(List<AnimationClip>) void
[UnityEngine.IAnimationClipSource] Adds all animations from this set to the `clips`.
GetClip(DirectionalAnimationSet.Direction) AnimationClip
Returns the animation associated with the specified `direction`.
GetClip(DirectionalAnimationSet8.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(DirectionalAnimationSet8.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
[Editor-Only] 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).
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
SnapVectorToDirection(Vector2) Vector2
Returns a copy of the `vector` pointing in the closest direction this set type has an animation for.
static
VectorToDirection(Vector2) DirectionalAnimationSet8.Direction
Returns the direction closest to the specified `vector`.
static
VectorToDirection(Vector2) DirectionalAnimationSet.Direction
Returns the direction closest to the specified `vector`.
static