Class Rule<Power>

Standard rule of Diplomacy

Type parameters

Power

Hierarchy

Rule<Power, MilitaryBranch, State, Dislodged<Power>, ProvinceStatus<Power>, Result, Error>
- Rule

Index

Constructors

constructor

Properties

phaseRules

Methods

Constructors

constructor

new Rule(): Rule

- Defined in standardRule/rule.ts:38
Returns Rule

Properties

Private phaseRules

phaseRules: Map<Phase, PhaseRule<Power>>

Methods

Protected defaultOrderOf

defaultOrderOf(board: Board<Power>, unit: Unit<Power>): Order<Power>

Overrides Rule.defaultOrderOf
- Defined in standardRule/rule.ts:143
Parameters
- board: Board<Power>
- unit: Unit<Power>
Returns Order<Power>

Protected errorOfOrder

errorOfOrder(board: Board<Power>, order: Order<Power>): Error

Overrides Rule.errorOfOrder
- Defined in standardRule/rule.ts:127
Parameters
- board: Board<Power>
- order: Order<Power>
Returns Error

Protected errorOfOrders

errorOfOrders(board: Board<Power>, orders: Set<Order<Power>>): Error

Overrides Rule.errorOfOrders
- Defined in standardRule/rule.ts:135
Parameters
- board: Board<Power>
- orders: Set<Order<Power>>
Returns Error

resolve

resolve(board: Board<Power, MilitaryBranch, State, Dislodged<Power>, ProvinceStatus<Power>>, orders: Set<Order<Power, MilitaryBranch>>): ResultOrFail

Inherited from Rule.resolve
- Defined in rule.ts:84
Resolves orders and creates a result.

Parameters
- board: Board<Power, MilitaryBranch, State, Dislodged<Power>, ProvinceStatus<Power>>
- orders: Set<Order<Power, MilitaryBranch>>
  
  The set of orders to be resolved.
Returns ResultOrFail

The result of the orders

Protected resolveProcedure

resolveProcedure(board: Board<Power>, orders: Set<Order<Power>>): ResultOrFail

Overrides Rule.resolveProcedure
- Defined in standardRule/rule.ts:69
Parameters
- board: Board<Power>
- orders: Set<Order<Power>>
Returns ResultOrFail

Protected unitsRequiringOrder

unitsRequiringOrder(board: Board<Power>): Set<Unit<Power>>

Overrides Rule.unitsRequiringOrder
- Defined in standardRule/rule.ts:119
Parameters
- board: Board<Power>
Returns Set<Unit<Power>>

Generated using TypeDoc