Class ActionBehavior

Base class of behavior tree implementation

Hierarchy (view full)

Behavior
- ActionBehavior

Index

Constructors

Properties

__action __context context isBehavior onFinalized onInitialized typeName

Methods

finalize initialize tick

Constructors

constructor

new ActionBehavior(func, options?): ActionBehavior
Parameters
- func: ((context) => void | BehaviorStatus)
  - - (context): void | BehaviorStatus
    - Parameters
      context: {
          elapsed: number;
          entity: Entity;
          timeDelta: number;
          [key: string]: any;
      }
      [key: string]: any
      elapsed: number
      entity: Entity
      timeDelta: number
      Returns void | BehaviorStatus
- Optional options: {
  context?: any;
  isRepeat?: boolean;
  }
  - Optional context?: any
  - Optional isRepeat?: boolean
Returns ActionBehavior
Overrides Behavior.constructor

Properties

__action

__action: ((context) => void | BehaviorStatus)

Type declaration

- (context): void | BehaviorStatus
- Parameters
  - context: {
        elapsed: number;
        entity: Entity;
        timeDelta: number;
        [key: string]: any;
    }
    - [key: string]: any
    - elapsed: number
    - entity: Entity
    - timeDelta: number
  Returns void | BehaviorStatus

__context

__context: any

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

isBehavior

isBehavior: boolean

`Readonly` onFinalized

onFinalized: Signal = ...

Dispatched after finalization is complete

`Readonly` onInitialized

onInitialized: Signal = ...

Dispatched after initialization is complete

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(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