Class BeastClipStateBehaviour

Animator state behaviour that plays a Beast clip when a Unity Animator state is entered.

Inheritance

object

BeastClipStateBehaviour

Namespace: CreatureKit.Beasts.Animation

Assembly: CreatureKit.Beasts.Animation.Runtime.dll

Syntax

public sealed class BeastClipStateBehaviour : StateMachineBehaviour

Remarks

Add this behaviour to an Animator Controller state when building no-code clip logic. The Unity Animator still owns state transitions, while BeastAnimator owns the generated Beast rig animation.

Constructors

BeastClipStateBehaviour()

Declaration

public BeastClipStateBehaviour()

Properties

Clip

Gets or sets the Beast clip played when the Animator state is entered.

Declaration

public BeastAnimationClip Clip { get; set; }

Property Value

Type	Description
BeastAnimationClip

StopOnStateExit

Gets or sets whether the Beast clip is stopped when the Animator state exits.

Declaration

public bool StopOnStateExit { get; set; }

Property Value

Type	Description
bool

Methods

OnStateEnter(Animator, AnimatorStateInfo, int)

Plays the selected Beast clip when Unity enters the Animator state that owns this behaviour.

Declaration

public override void OnStateEnter(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)

Parameters

Type	Name	Description
Animator	animator	Animator that entered the state.
AnimatorStateInfo	stateInfo	Unity state information for the entered state.
int	layerIndex	Animator layer index.

OnStateExit(Animator, AnimatorStateInfo, int)

Optionally stops the current Beast clip when Unity exits the Animator state that owns this behaviour.

Declaration

public override void OnStateExit(Animator animator, AnimatorStateInfo stateInfo, int layerIndex)

Parameters

Type	Name	Description
Animator	animator	Animator that exited the state.
AnimatorStateInfo	stateInfo	Unity state information for the exited state.
int	layerIndex	Animator layer index.