Class FailingBehavior

Base class of behavior tree implementation

Hierarchy (view full)

Behavior
- FailingBehavior

Index

Constructors

Properties

context delayTicks isBehavior onFinalized onInitialized typeName INSTANCE typeName

Methods

finalize initialize tick

Constructors

constructor

new FailingBehavior(delayTicks?): FailingBehavior
Parameters
- delayTicks: number = 0
Returns FailingBehavior
Overrides Behavior.constructor

Properties

context

context: BehaviorContext = null

Any internal state used by the behavior This provides a way to interact with the outside as well as to pass data between themselves

delayTicks

delayTicks: number

isBehavior

isBehavior: boolean

`Readonly` onFinalized

onFinalized: Signal = ...

Dispatched after finalization is complete

`Readonly` onInitialized

onInitialized: Signal = ...

Dispatched after initialization is complete

typeName

typeName: string

`Static` INSTANCE

INSTANCE: FailingBehavior = ...

`Static` typeName

typeName: string

Methods

finalize

finalize(): void
Called when behavior is finished, or interrupted Used to clean up any resources You can think of it as "stop"

Returns void
Inherited from Behavior.finalize

initialize

initialize(context): void
Called before behavior gets executed via tick for the first time Used to prepare the behavior for execution You can think of it as "start"
Parameters
- context: BehaviorContext
Returns void
Inherited from Behavior.initialize

tick

tick(td): Running | Failed
Main update function. Every behavior executes some logic, some behaviors are long-running and some are instantaneous
Parameters
- td: any
  time step in seconds
Returns Running | Failed
signals status of the behavior, "success" or "failure" are used to signal completion of the behavior

Overrides Behavior.tick