DirectionalAnimationSet Class

Summary

A set of up/right/down/left animations.
Assembly
Animancer.dll
Namespace
Animancer
Interfaces
  • IAnimationClipSource
Base Types
  • ScriptableObject
Derived Types
graph BT Type-->Base0["ScriptableObject"] Type-.->Interface0["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 + 3)]
[AnimancerHelpUrl(typeof(DirectionalAnimationSet))]
public class DirectionalAnimationSet : ScriptableObject, 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).
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).

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`.