five-on-it / apps/client/src/ui/lobby / rulesText

Function: rulesText()

rulesText(t, rules): string[]

Defined in: apps/client/src/ui/lobby.ts:96

A mission's rules in plain words, a line each: the players, the teams (or everyone on their own), the Respect tier it asks for, the lives, friendly fire, joining late, the time limit, what a death does and the retries.

Parameters

t

TFunction

rules

each

boolean = ...

friendlyFire

boolean = ...

joinInProgress

"never" | "untilCheckpoint" | "always" = ...

lives

{ count: number; per: "player" | "team"; } | null = ...

So many lives per player or for the team; null: unlimited.

mode

"solo" | "coop" | "versus" = ...

onDeath

"checkpoint" | "spectate" | "teamSpawn" = ...

players

{ max: number; min: number; } = Range

players.max

number = ...

players.min

number = ...

respect

number | null = ...

The Respect tier it asks for now (a creator's mission held to tier 2 until it qualifies); null for none.

retries

number = ...

teams

object[] = ...

Its teams (co-op's one); a free-for-all's none: every player on their own (each).

timeLimit

number | null = ...

The longest an attempt may take (s); null when nothing bounds it.

Returns

string[]