Class action_baseAbstract

constructor

• new action_base(): action_base

• Default constructor.

  Returns action_base
• new action_base(object?: game_object): action_base

• Parameters

  • Optionalobject: game_object

    target game object to work with, null is OK since correct object will be injected on setup

  Returns action_base
• new action_base(object: game_object, name: string): action_base

• Parameters

  • object: game_object

    target game object to work with, null is OK since correct object will be injected on setup
  • name: string

    name of the action, used for debug purposes mainly

  Returns action_base

Readonlyobject

Readonlystorage

add_effect

• add_effect(property: world_property): void

• Add action effect. Describes what target world state is expected to be if action is completed.

  Parameters

  • property: world_property

    world state property describing a pair of evaluator ID and value

  Returns void

add_precondition

• add_precondition(property: world_property): void

• Add action execution precondition. When building logics graph, action will be considered blocked by some preconditions.

  Parameters

  • property: world_property

    world state property describing a pair of evaluator ID and value

  Returns void

execute

• execute(): void

• Lifecycle method. Execution tick of the action, called from object logics update cycle when current action is active.

  Returns void

finalize

• finalize(): void

• Lifecycle method called once on action execution stop. Means that action is finished / preconditions are not met anymore.

  Returns void

initialize

• initialize(): void

• Lifecycle method called once on action execution start. Means that lifecycle of the action begun.

  Returns void

remove_effect

• remove_effect(id: number): void

• Remove action effect. Action will be not considered as property changing for id anymore

  Parameters

  • id: number

    world state property id

  Returns void

remove_precondition

• remove_precondition(id: number): void

• Remove precondition for action. When building logics graph, action will not be considered blocked by evaluator id states.

  Parameters

  • id: number

    world state property id

  Returns void

set_weight

• set_weight(weight: number): void

• Set weight of current action execution.

  Parameters

  • weight: number

    weight value to express how prioritized action is

  Returns void

setup

• setup(object: game_object, storage: property_storage): void

• Handle setup of the action and binding to a specific object.

  Parameters

  • object: game_object

    target client object to work with
  • storage: property_storage

    action instance storage with preconditions and state

  Returns void

show

• show(prefix?: string): void

• Debug method. With mixed / debug build allows investigation of evaluators and actions matches. Helps to debug custom actions and actions pre-conditions with state printing in log files.

  Note: Available only in mixed / debug engine builds, not for direct usage from lua.

  Parameters

  • Optionalprefix: string

    string prefix to display current action state in logs

  Returns void