@lands.io/mod-sdk / Attack

Interface: Attack¶

An ongoing attack between players

Table of contents¶

Methods¶

attackType¶

▸ attackType(): AttackType

Attack properties

Returns¶

AttackType

attacker¶

▸ attacker(): Player

Returns¶

Player

id¶

▸ id(): string

Returns¶

string

isActive¶

▸ isActive(): boolean

Returns¶

boolean

orderRetreat¶

▸ orderRetreat(): void

Returns¶

void

retreated¶

▸ retreated(): boolean

Returns¶

boolean

retreating¶

▸ retreating(): boolean

Retreat handling

Returns¶

boolean

setTroops¶

▸ setTroops(troops): void

Parameters¶

Name	Type
`troops`	`number`

Returns¶

void

sourceTile¶

▸ sourceTile(): null | number

Returns¶

null | number

target¶

▸ target(): Player | TerraNullius

Returns¶

Player | TerraNullius

targetTile¶

▸ targetTile(): null | number

Returns¶

null | number

troops¶

▸ troops(): number

Returns¶

number

Source Code¶

View full implementation

/**
 * An ongoing attack between players
 */
export interface Attack {
  id(): string;
  attacker(): Player;
  target(): Player | TerraNullius;
  troops(): number;
  setTroops(troops: number): void;
  isActive(): boolean;

  /** Retreat handling */
  retreating(): boolean;
  retreated(): boolean;
  orderRetreat(): void;

  /** Attack properties */
  attackType(): AttackType;
  sourceTile(): TileRef | null;
  targetTile(): TileRef | null;
}