Class StateMachineBehavior<TState, TContext, TEvent>

Base class for all behaviors attached to an Object3D.

Type Parameters

TState extends string
TContext
TEvent extends string = string

Hierarchy (View Summary)

Behavior
- StateMachineBehavior

Index

Constructors

Properties

isActive stateMachine target uuid inspector?

Methods

clone onAttach onDetach update

Constructors

constructor

new StateMachineBehavior<
    TState extends string,
    TContext,
    TEvent extends string = string,
>(
    stateMachine: StateMachine<TState, TContext, TEvent>,
): StateMachineBehavior<TState, TContext, TEvent>
Type Parameters
- TState extends string
- TContext
- TEvent extends string = string
Parameters
- stateMachine: StateMachine<TState, TContext, TEvent>
Returns StateMachineBehavior<TState, TContext, TEvent>
Overrides Behavior.constructor
- Defined in core/behaviors/StateMachineBehavior.ts:11

Properties

isActive

isActive: boolean = true

`Readonly`stateMachine

stateMachine: StateMachine<TState, TContext, TEvent>

target

target: CameraInterfaceData | Object3D | undefined = undefined

The object this behavior is attached to. Set automatically.

`Readonly`uuid

uuid: string = ...

`Static` `Optional` `Readonly`inspector

inspector?: Record<string, InspectorField>

Methods

clone

clone(): Behavior
Returns an independent copy of this behavior (own uuid, target cleared -- the caller is expected to attachBehavior() it onto the new host, which sets target correctly via onAttach()). Used by Object3D.clone() (Maker's Duplicate command).

Returns Behavior
Inherited from Behavior.clone
- Defined in core/behaviors/Behavior.ts:43

onAttach

onAttach(target: CameraInterfaceData | Object3D): void
Called when the behavior is attached to an object.
Parameters
- target: CameraInterfaceData | Object3D
Returns void
Inherited from Behavior.onAttach
- Defined in core/behaviors/Behavior.ts:27

onDetach

onDetach(): void
Called when the behavior is detached from an object.

Returns void
Inherited from Behavior.onDetach
- Defined in core/behaviors/Behavior.ts:34

update

update(deltaTime: number): void
Called every frame to update the behavior logic.
Parameters
- deltaTime: number
  The time elapsed since the last frame in seconds.
Returns void
Overrides Behavior.update
- Defined in core/behaviors/StateMachineBehavior.ts:16