CharacterState Class

Summary

A state for a Animancer.Samples.StateMachines.CharacterState.Character.
CharacterState
MonoBehaviour

Syntax

[AddComponentMenu(Strings.SamplesMenuPrefix + "Characters - Character State")]
[AnimancerHelpUrl(typeof(CharacterState))]
public abstract class CharacterState : StateBehaviour, IState

Remarks

Sample: Characters

Attributes

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

Properties

Name Value Summary
CanEnterState bool
[Animancer.FSM.IState.CanEnterState] Determines whether the Animancer.FSM.StateMachine`1 can enter this state. Always returns true unless overridden.
Inherited from StateBehaviour
CanExitState bool
[Animancer.FSM.IState.CanExitState] Determines whether the Animancer.FSM.StateMachine`1 can exit this state. Always returns true unless overridden.
CanInterruptSelf bool
Character Character
Priority CharacterStatePriority

Methods

Name Value Summary
OnEnterState() void
[Animancer.FSM.IState.OnEnterState] Asserts that this component isn't already enabled, then enables it.
Inherited from StateBehaviour
OnExitState() void
[Animancer.FSM.IState.OnExitState] Asserts that this component isn't already disabled, then disables it.
Inherited from StateBehaviour
OnValidate() void
[Editor-Only] States start disabled and only the current state gets enabled at runtime.