Class WaitForEventBehavior

Base class of behavior tree implementation

Hierarchy (view full)

Behavior
- WaitForEventBehavior

Index

Constructors

Properties

context data detected event isBehavior onFinalized onInitialized target typeName

Methods

finalize fromJSON initialize tick fromJSON

Constructors

constructor

new WaitForEventBehavior(): WaitForEventBehavior
Returns WaitForEventBehavior
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

data

data: any

detected

detected: boolean

event

event: string

isBehavior

isBehavior: boolean

`Readonly` onFinalized

onFinalized: Signal = ...

Dispatched after finalization is complete

`Readonly` onInitialized

onInitialized: Signal = ...

Dispatched after initialization is complete

target

target: any

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
Overrides Behavior.finalize

fromJSON

fromJSON(json): void
Parameters
- json: {
  event: string;
  target?: any;
  }
  - event: string
  - Optional target?: any
Returns void

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
Overrides Behavior.initialize

tick

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

Overrides Behavior.tick

`Static` fromJSON

fromJSON(json): WaitForEventBehavior
Parameters
- json: {
  event: string;
  target?: any;
  }
  - event: string
  - Optional target?: any
Returns WaitForEventBehavior