Class planner_action

GOAP action class implementing both action base and action planner. Captures execution as action and plans its internal logic with separate logics graph.

Examples: combat planner, anomaly planner, items looting planner, alife planner, state planner

Source

C++ class planner_action : action_planner,action_base

Custom Constructor

planner_action

Hierarchy (View Summary)

action_planner
- planner_action

Constructors

constructor

new planner_action(): planner_action
Default constructor.

Returns planner_action
Overrides action_planner.constructor
- Defined in xr_ai/xr_goap.d.ts:585
new planner_action(object?: game_object): planner_action
Parameters
- Optionalobject: game_object
  target game object to work with, null is OK since correct object will be injected on setup
Returns planner_action
Overrides action_planner.constructor
- Defined in xr_ai/xr_goap.d.ts:590
new planner_action(object: game_object, name: string): planner_action
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 planner_action
Overrides action_planner.constructor
- Defined in xr_ai/xr_goap.d.ts:596

Properties

`Static` `Readonly`__name

__name: string

Name of luabind class constructor.

`Readonly`__name

__name: string

Name of luabind class instance constructor.

`Readonly`object

object: game_object

Game object that is handled by current planner instance.

`Readonly`storage

storage: property_storage

Container reference with state of planner preconditions.

Methods

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
Inherited from action_planner.action
- Defined in xr_ai/xr_goap.d.ts:513

actual

actual(): boolean
Returns boolean
whether state of current planner is actual
Inherited from action_planner.actual
- Defined in xr_ai/xr_goap.d.ts:474

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
Inherited from action_planner.add_action
- Defined in xr_ai/xr_goap.d.ts:499

add_effect

add_effect(property: world_property): unknown
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 unknown
- Defined in xr_ai/xr_goap.d.ts:622

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
Inherited from action_planner.add_evaluator
- Defined in xr_ai/xr_goap.d.ts:543

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
- Defined in xr_ai/xr_goap.d.ts:638

clear

clear(): void
Clear state of current action planner.

Returns void
Inherited from action_planner.clear
- Defined in xr_ai/xr_goap.d.ts:486

current_action

current_action(): action_base
Get currently active action being executed.

Returns action_base
current action instance reference
Inherited from action_planner.current_action
- Defined in xr_ai/xr_goap.d.ts:520

current_action_id

current_action_id(): number
Get currently active action identifier.

Returns number
unique identifier of current action
Inherited from action_planner.current_action_id
- Defined in xr_ai/xr_goap.d.ts:527

evaluator

evaluator(id: number): property_evaluator
Get evaluator instance by id.
Parameters
- id: number
  unique identifier of the evaluator to get
Returns property_evaluator
Inherited from action_planner.evaluator
- Defined in xr_ai/xr_goap.d.ts:557

execute

execute(): void
Lifecycle method. Execution tick of the action, called from object logics update cycle when current action is active.

Returns void
- Defined in xr_ai/xr_goap.d.ts:614

finalize

finalize(): void
Lifecycle method called once on action execution stop. Means that action is finished / preconditions are not met anymore.

Returns void
- Defined in xr_ai/xr_goap.d.ts:608

initialize

initialize(): void
Lifecycle method called once on action execution start. Means that lifecycle of the action begun.

Returns void
- Defined in xr_ai/xr_goap.d.ts:602

initialized

initialized(): boolean
Returns boolean
whether object action planner is already initialized
Inherited from action_planner.initialized
- Defined in xr_ai/xr_goap.d.ts:469

remove_action

remove_action(id: number): void
Remove action by unique id.
Parameters
- id: number
  unique identifier of the action to remove
Returns void
Inherited from action_planner.remove_action
- Defined in xr_ai/xr_goap.d.ts:506

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
- Defined in xr_ai/xr_goap.d.ts:630

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
Inherited from action_planner.remove_evaluator
- Defined in xr_ai/xr_goap.d.ts:550

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
- Defined in xr_ai/xr_goap.d.ts:646

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
Inherited from action_planner.set_goal_world_state
- Defined in xr_ai/xr_goap.d.ts:535

set_weight

set_weight(weight: number): void
Set weight of planner action switch.
Parameters
- weight: number
  weight value to express how prioritized action is
Returns void
- Defined in xr_ai/xr_goap.d.ts:653

setup

setup(object: game_object): void
Setup planner for game object.
Parameters
- object: game_object
  client game object to setup planner for
Returns void
Inherited from action_planner.setup
- Defined in xr_ai/xr_goap.d.ts:481

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
Inherited from action_planner.show
- Defined in xr_ai/xr_goap.d.ts:568

update

update(): void
Lifecycle method to handle generic game loop updates.

Returns void
Inherited from action_planner.update
- Defined in xr_ai/xr_goap.d.ts:491

weight

weight(first: world_state, second: world_state): number
Comparator to check weight of switching one state to another.
Parameters
- first: world_state
  first state
- second: world_state
  second state
Returns number
- Defined in xr_ai/xr_goap.d.ts:661

Class planner_action

Source

Custom Constructor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns planner_action

Parameters

Returns planner_action

Parameters

Returns planner_action

Properties

Static Readonly__name

Readonly__name

Readonlyobject

Readonlystorage

Methods

action

Parameters

Returns action_base

actual

Returns boolean

add_action

Parameters

Returns void

add_effect

Parameters

Returns unknown

add_evaluator

Parameters

Returns void

add_precondition

Parameters

Returns void

clear

Returns void

current_action

Returns action_base

current_action_id

Returns number

evaluator

Parameters

Returns property_evaluator

execute

Returns void

finalize

Returns void

initialize

Returns void

initialized

Returns boolean

remove_action

Parameters

Returns void

remove_effect

Parameters

Returns void

remove_evaluator

Parameters

Returns void

remove_precondition

Parameters

Returns void

set_goal_world_state

Parameters

Returns void

set_weight

Parameters

Returns void

setup

Parameters

Returns void

show

Parameters

Returns void

update

`Static` `Readonly`__name

`Readonly`__name

`Readonly`object

`Readonly`storage