Interface: Unit¶

A game unit (ship, building, etc.)

Table of contents¶

Methods¶

delete¶

▸ delete(displayMessage?): void

Parameters¶

Name	Type
`displayMessage?`	`boolean`

Returns¶

void

hasHealth¶

▸ hasHealth(): boolean

Health (for units that have it)

Returns¶

boolean

health¶

▸ health(): number

Returns¶

number

id¶

▸ id(): number

Returns¶

number

isActive¶

▸ isActive(): boolean

Returns¶

boolean

modifyHealth¶

▸ modifyHealth(delta): void

Parameters¶

Name	Type
`delta`	`number`

Returns¶

void

move¶

▸ move(tile): void

Movement

Parameters¶

Name	Type
`tile`	`number`

Returns¶

void

moveTarget¶

▸ moveTarget(): null | number

Returns¶

null | number

owner¶

▸ owner(): Player

Returns¶

Player

setMoveTarget¶

▸ setMoveTarget(cell): void

Parameters¶

Name	Type
`cell`	`number`

Returns¶

void

setTroops¶

▸ setTroops(troops): void

Mutations

Parameters¶

Name	Type
`troops`	`number`

Returns¶

void

tile¶

▸ tile(): number

Returns¶

number

troops¶

▸ troops(): number

Returns¶

number

type¶

▸ type(): UnitType

Returns¶

UnitType

Source Code¶

View full implementation

/**
 * A game unit (ship, building, etc.)
 */
export interface Unit {
  id(): number;
  type(): UnitType;
  troops(): number;
  owner(): Player;
  tile(): TileRef;
  isActive(): boolean;

  /** Health (for units that have it) */
  hasHealth(): boolean;
  health(): number;
  modifyHealth(delta: number): void;

  /** Movement */
  move(tile: TileRef): void;
  moveTarget(): TileRef | null;
  setMoveTarget(cell: TileRef): void;

  /** Mutations */
  setTroops(troops: number): void;
  delete(displayMessage?: boolean): void;
}