@lands.io/mod-sdk / PlayerEliminatedEvent

Interface: PlayerEliminatedEvent¶

Emitted when a player loses their last tile and is eliminated.

Table of contents¶

Properties¶

eliminatedPlayerId¶

• eliminatedPlayerId: string

The player who was eliminated

eliminatorPlayerId¶

• eliminatorPlayerId: null | string

The player who conquered the last tile (null for relinquish / non-combat loss)

tick¶

• tick: number

Engine tick when the elimination occurred

Source Code¶

View full implementation

/**
 * Emitted when a player loses their last tile and is eliminated.
 */
export interface PlayerEliminatedEvent {
  /** Engine tick when the elimination occurred */
  tick: Tick;
  /** The player who was eliminated */
  eliminatedPlayerId: PlayerID;
  /** The player who conquered the last tile (null for relinquish / non-combat loss) */
  eliminatorPlayerId: PlayerID | null;
}