CharacterState Class

Summary

A state for a Animancer.Samples.StateMachines.CharacterState.Character.
Assembly
Animancer.dll
Namespace
Animancer.Samples.StateMachines
Interfaces
Base Types
Derived Types
graph BT Type-->Base0["StateBehaviour"] click Base0 "/animancer/api/Animancer.FSM/StateBehaviour" Base0-->Base1["MonoBehaviour"] Type-.->Interface0["IState"] click Interface0 "/animancer/api/Animancer.FSM/IState" Type["CharacterState"] class Type type-node Derived0["IdleState"]-->Type click Derived0 "/animancer/api/Animancer.Samples.StateMachines/IdleState" Derived1["FlinchState"]-->Type click Derived1 "/animancer/api/Animancer.Samples.StateMachines/FlinchState" Derived2["MoveState"]-->Type click Derived2 "/animancer/api/Animancer.Samples.StateMachines/MoveState" Derived3["ActionState"]-->Type click Derived3 "/animancer/api/Animancer.Samples.StateMachines/ActionState" Derived4["EquipState"]-->Type click Derived4 "/animancer/api/Animancer.Samples.StateMachines/EquipState" Derived5["AttackState"]-->Type click Derived5 "/animancer/api/Animancer.Samples.StateMachines/AttackState"

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.