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/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 + 4)]
[AnimancerHelpUrl(typeof(DirectionalAnimationSet8))]
public class DirectionalAnimationSet8 : DirectionalAnimationSet, IAnimationClipSource

Remarks

Documentation: Directional Animation Sets

Attributes

Type Description
CreateAssetMenuAttribute
AnimancerHelpUrlAttribute [Assert-Conditional] A UnityEngine.HelpURLAttribute which points to Animancer's documentation.

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
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) wasn't called.
GetClip(DirectionalAnimationSet.Direction) AnimationClip
Returns the animation associated with the specified `direction`.
GetClip(Vector2) AnimationClip
Returns the animation closest to the specified `direction`.
GetDirectionName(int) string
Returns the name of the specified `direction`.