CreatureState Class

Summary

Base class for the various states a Animancer.Examples.StateMachines.Brains.Creature can be in and actions they can perform.
graph BT Type-->Base0["StateBehaviour<CreatureState>"] Base0-->Base1["MonoBehaviour"] Type-.->Interface0["IOwnedState<CreatureState>"] Type-.->Interface1["IState<CreatureState>"] Type["CreatureState"] class Type type-node Derived0["LocomotionState"]-->Type click Derived0 "/animancer/api/Animancer.Examples.StateMachines.Brains/LocomotionState" Derived1["LocomotionState"]-->Type click Derived1 "/animancer/api/Animancer.Examples.AnimatorControllers/LocomotionState" Derived2["AttackState"]-->Type click Derived2 "/animancer/api/Animancer.Examples.StateMachines.Weapons/AttackState" Derived3["EquipState"]-->Type click Derived3 "/animancer/api/Animancer.Examples.StateMachines.Weapons/EquipState" Derived4["IdleState"]-->Type click Derived4 "/animancer/api/Animancer.Examples.StateMachines.Brains/IdleState"

Syntax

[AddComponentMenu(Strings.ExamplesMenuPrefix + "Brains - Creature State")]
[HelpURL(Strings.DocsURLs.ExampleAPIDocumentation + nameof(StateMachines) + "." + nameof(Brains) + "/" + nameof(CreatureState))]
public abstract class CreatureState : StateBehaviour<CreatureState>, IOwnedState<CreatureState>, 
    IState<CreatureState>

Examples

Brains

Attributes

Type Description
AddComponentMenu
HelpURLAttribute

Properties

Name Value Summary
Creature Creature
The Animancer.Examples.StateMachines.Brains.Creature that owns this state.
OwnerStateMachine StateMachine<CreatureState>
The Animancer.FSM.StateMachine`1 that this state is used in.

Methods

Name Value Summary
Reset() void