Class SucceedingBehavior

Behavior that always succeeds

Hierarchy (view full)

Constructors

constructor

Properties

context delayTicks isBehavior onFinalized onInitialized typeName INSTANCE

Methods

finalize initialize tick

Constructors

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: SucceedingBehavior = ...

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

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): Running | Succeeded

  • 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 Running | Succeeded

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

Settings

Member Visibility

Theme

On This Page