Class RotationBehavior

Base class of behavior tree implementation

Hierarchy (view full)

Constructors

constructor

Properties

__offset angle axis context isBehavior onFinalized onInitialized resetWhenFinalize speed typeName

Methods

finalize fromJSON initialize tick fromJSON

Constructors

constructor

Properties

__offset

__offset: Quaternion

angle

angle: number

axis

axis: Vector3

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

resetWhenFinalize

resetWhenFinalize: boolean

speed

speed: number

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

fromJSON

  • fromJSON(param): void

  • Parameters

    • param: {
          angle?: number;
          axis?: Vector3;
          resetWhenFinalize?: boolean;
          speed?: number;
      }
      • Optional angle?: number
      • Optional axis?: Vector3
      • Optional resetWhenFinalize?: boolean
      • Optional speed?: number

    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

    Returns void

tick

  • tick(timeDelta): BehaviorStatus

  • Main update function. Every behavior executes some logic, some behaviors are long-running and some are instantaneous

    Parameters

    • timeDelta: any

      time step in seconds

    Returns BehaviorStatus

    signals status of the behavior, "success" or "failure" are used to signal completion of the behavior

Static fromJSON

  • fromJSON(param): RotationBehavior

  • Parameters

    • param: {
          angle?: number;
          axis?: Vector3;
          resetWhenFinalize?: boolean;
          speed?: number;
      }
      • Optional angle?: number
      • Optional axis?: Vector3
      • Optional resetWhenFinalize?: boolean
      • Optional speed?: number

    Returns RotationBehavior

Settings

Member Visibility

Theme

On This Page