Class action_planner

constructor

• new action_planner(): action_planner

• Default constructor.

  Returns action_planner

Readonlyobject

Readonlystorage

action

• action(id: number): action_base

• Get action instance by unique id.

  Parameters

  • id: number

    unique identifier of the action to get

  Returns action_base

actual

• actual(): boolean

• Returns boolean

  whether state of current planner is actual

add_action

• add_action(id: number, action: action_base): void

• Add generic action by id for planner execution.

  Parameters

  • id: number

    unique identifier of new action
  • action: action_base

    action implementation containing preconditions, logics, effects and other meta infos

  Returns void

add_evaluator

• add_evaluator(id: number, evaluator: property_evaluator): void

• Add evaluator instance for current action planner.

  Parameters

  • id: number

    unique identifier of the evaluator
  • evaluator: property_evaluator

    instance of evaluator linked to the id

  Returns void

clear

• clear(): void

• Clear state of current action planner.

  Returns void

current_action

• current_action(): action_base

• Get currently active action being executed.

  Returns action_base

  current action instance reference

current_action_id

• current_action_id(): number

• Get currently active action identifier.

  Returns number

  unique identifier of current action

evaluator

• evaluator(id: number): property_evaluator

• Get evaluator instance by id.

  Parameters

  • id: number

    unique identifier of the evaluator to get

  Returns property_evaluator

initialized

• initialized(): boolean

• Returns boolean

  whether object action planner is already initialized

remove_action

• remove_action(id: number): void

• Remove action by unique id.

  Parameters

  • id: number

    unique identifier of the action to remove

  Returns void

remove_evaluator

• remove_evaluator(id: number): void

• Return evaluator instance for current action planner.

  Parameters

  • id: number

    unique identifier of the evaluator for removal

  Returns void

set_goal_world_state

• set_goal_world_state(state: world_state): void

• Set target world state to try to reach with all the graph logics. All graphs will be built from current state to goal world state with the shortest possible path.

  Parameters

  • state: world_state

    target world state to reach with planner

  Returns void

setup

• setup(object: game_object): void

• Setup planner for game object.

  Parameters

  • object: game_object

    client game object to setup planner for

  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

  • prefix: string

    string prefix to display current action state in logs

  Returns void

update

• update(): void

• Lifecycle method to handle generic game loop updates.

  Returns void