This is the old Animancer v7.4 documentation. Click here for the latest version.

FlinchState Class

Summary

A Animancer.Examples.StateMachines.CharacterState which activates itself when the character takes damage.
Assembly
Animancer.dll
Namespace
Animancer.Examples.StateMachines
Interfaces
Base Types
graph BT Type-->Base0["CharacterState"] click Base0 "/animancer-v7-4/api/Animancer.Examples.StateMachines/CharacterState" Base0-->Base1["StateBehaviour"] click Base1 "/animancer-v7-4/api/Animancer.FSM/StateBehaviour" Base1-->Base2["MonoBehaviour"] Type-.->Interface0["IState"] click Interface0 "/animancer-v7-4/api/Animancer.FSM/IState" Type["FlinchState"] class Type type-node

Syntax

[AddComponentMenu(Strings.ExamplesMenuPrefix + "Interruptions - Flinch State")]
[HelpURL(Strings.DocsURLs.ExampleAPIDocumentation + nameof(StateMachines) + "/" + nameof(FlinchState))]
public sealed class FlinchState : CharacterState, IState

Examples

Interruptions

Attributes

Type Description
AddComponentMenu
HelpURLAttribute

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.
Inherited from CharacterState
CanInterruptSelf bool
Character Character
Inherited from CharacterState
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.
Inherited from CharacterState