Class: property_evaluator

Class implementation of world properties evaluators. Generic handler to calculate current state of bound world property id.

Source

C++ class property_evaluator

Custom Constructor

property_evaluator

Extends

• EngineBinding

Extended by

• property_evaluator_const

Constructors

Constructor

new property_evaluator(): property_evaluator;

Default constructor.

Returns

property_evaluator

Overrides

EngineBinding.constructor

Constructor

new property_evaluator(object: Nillable<game_object>): property_evaluator;

Parameters

Parameter	Type	Description
object	Nillable<game_object>	Target game object to work with, null is OK since correct object will be injected on setup.

Returns

property_evaluator

Overrides

EngineBinding.constructor

Constructor

new property_evaluator(object: Nillable<game_object>, name: string): property_evaluator;

Parameters

Parameter	Type	Description
object	Nillable<game_object>	Target game object to work with, null is OK since correct object will be injected on setup.
name	string	Name of the evaluator, used for debug purposes mainly.

Returns

property_evaluator

Overrides

EngineBinding.constructor

Methods

evaluate()

evaluate(): boolean;

Main evaluator lifecycle method. Called every time to get world property up-to-date state.

Returns

boolean

Current evaluator value.

---

setup()

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

Handle setup of the evaluator and binding to a specific object.

Parameters

Parameter	Type	Description
object	game_object	Target client object to work with.
storage	property_storage	Action instance storage with preconditions and state.

Returns

void

Remarks

Called by the planner when the evaluator is registered. Call it manually only for standalone evaluator tests.

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

EngineBinding.__name

---

object

readonly object: game_object;

Linked game object to work with.

---

storage

readonly storage: property_storage;

Container reference with state of action preconditions.

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

EngineBinding.__name