@ue-too/board-game-engine / ValueComparisonPrecondition

Class: ValueComparisonPrecondition<T>

Defined in: action-system/precondition.ts:26

Unified value comparison precondition that works with both custom schema components and typed components. Automatically detects which approach to use based on whether the component has a registered schema.

Example

// With custom schema component
const precondition1 = new ValueComparisonPrecondition(
    100, '>', coordinator, HEALTH_COMPONENT, entity, 'health'
);

// With typed component (type-safe)
type HealthComponent = { health: number; maxHealth: number };
const precondition2 = new ValueComparisonPrecondition<HealthComponent>(
    coordinator, HEALTH_COMPONENT, entity, 'health', 100, '>'
);

Type Parameters

T

T = Record<string, unknown>

Implements

• Precondition

Constructors

Constructor

new ValueComparisonPrecondition<T>(coordinator, componentName, entity, valuePath, value, operator): ValueComparisonPrecondition<T>

Defined in: action-system/precondition.ts:37

Parameters

coordinator

Coordinator

componentName

symbol

entity

number

valuePath

keyof T

value

number

operator

">" | "<" | ">=" | "<=" | "==" | "!="

Returns

ValueComparisonPrecondition<T>

Constructor

new ValueComparisonPrecondition<T>(value, operator, coordinator, componentName, entity, valuePath): ValueComparisonPrecondition<T>

Defined in: action-system/precondition.ts:46

Parameters

value

number

operator

">" | "<" | ">=" | "<=" | "==" | "!="

coordinator

Coordinator

componentName

symbol

entity

number

valuePath

string

Returns

ValueComparisonPrecondition<T>

Methods

check()

check(): boolean

Defined in: action-system/precondition.ts:102

Returns

boolean

Implementation of

Precondition.check