Class SendEventBehavior

Base class of behavior tree implementation

Hierarchy (view full)

Behavior
- SendEventBehavior

Index

Constructors

Properties

context data event isBehavior onFinalized onInitialized target typeName

Methods

finalize fromJSON initialize tick fromJSON

Constructors

constructor

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

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
Inherited from Behavior.finalize

fromJSON

fromJSON(__namedParameters): void
Parameters
- __namedParameters: {
      data: {};
      event: any;
      target: any;
  }
  - data: {}
  - event: any
  - 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
Inherited from Behavior.initialize

tick

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

Overrides Behavior.tick

`Static` fromJSON

fromJSON(j): SendEventBehavior
Parameters
- j: {
      data: any;
      event: string;
      target?: any;
  }
  - data: any
  - event: string
  - Optional target?: any
Returns SendEventBehavior