five-on-it / packages/missions/src/validate / validateGame

Function: validateGame()

validateGame(game, context?): Issue[]

Defined in: packages/missions/src/validate.ts:558

Checks a game document (already valid against its schema); returns every issue, errors first.

Parameters

game

blurb?

string = ...

id

string = ...

level

string = ...

missions

object[] = ...

paths

Record<string, { gates: string[]; laps: number; } | { loop: boolean; patrol: string[]; }> = ...

places

Record<string, { name?: string; role?: "players" | "police" | "traffic" | "guards" | "hospital"; tags?: string[]; x: number; y?: number; yaw?: number; z: number; }> = ...

rules

{ clock?: { pace: number; start: string; }; dropMissionItems: boolean; fallDamage: boolean; garages?: { respray?: number; store?: number; }; ghostSeconds: number; loadout?: object[]; maxPlayers: number; partyRewards: "split" | "shared"; phone: boolean; playerDamage: "on" | "off" | "rivals"; police: boolean; prices?: Record<string, number>; respawn: "hospital" | "mission"; safeZones: string[]; traffic: number; vehicleFire: boolean; weather?: { changes: boolean; climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; intensity: number; start?: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; }; } = ...

rules.clock?

{ pace: number; start: string; } = ...

The room clock (GAME_DESIGN §5.7): the time the room starts at and its pace, game minutes per real second (1 is an hour a minute, a day in 24 minutes; 0 stops it; up to 60 for a day in 24 seconds).

rules.clock.pace

number = ...

rules.clock.start

string = ...

rules.dropMissionItems

boolean = ...

Whether a character that dies drops the items a mission defined that it carried, where it fell (GAME_DESIGN §7.4).

rules.fallDamage

boolean = ...

Whether a long fall hurts (from about 4 m) and a very long one kills (from about 12 m).

rules.garages?

{ respray?: number; store?: number; } = ...

What every garage of the level charges ($), over the level's own prices (GAME_DESIGN §5.5).

rules.garages.respray?

number = ...

rules.garages.store?

number = ...

rules.ghostSeconds

number = ...

Seconds a player is a ghost after coming back (passing through cars and people, taking no harm).

rules.loadout?

object[] = ...

What every player starts with (GAME_DESIGN §7.4): stacks of items by id (weapons and their ammunition are items), each in the slot of the strip it names (1 to 16; the number keys select the first nine, and the slot a key selects is the weapon held) or the first free one. Absent: free roam's arsenal, the fists' slot 1 left empty, the pistol, shotgun, rifle, rocket launcher, grenades and tranquilizer on 2 to 7 and the guns' ammunition from 9 on; an empty list: nothing but the phone.

rules.maxPlayers

number = ...

How many players a room of this game takes.

rules.partyRewards

"split" | "shared" = ...

How a party's mission reward is paid: each member the whole of it (shared), or the reward divided among them (split).

rules.phone

boolean = ...

Whether every character starts with a phone (GAME_DESIGN §7.5); a mission may give one.

rules.playerDamage

"on" | "off" | "rivals" = ...

Whether players hurt each other: never, only rivals (players outside one's party), or always.

rules.police

boolean = ...

Whether the room has police: crimes raise a Wanted level and police cars come (GAME_DESIGN §12).

rules.prices?

Record<string, number> = ...

What the shops charge ($), by item id, over the items' own prices (GAME_DESIGN §14).

rules.respawn

"hospital" | "mission" = ...

Where a player who went down comes back: the nearest spawn point (hospital), or where their mission started (mission).

rules.safeZones

string[] = ...

The game's zones where players cannot hurt each other and no car is carjacked.

rules.traffic

number = ...

Ambient cars driving the level's roads around the players: none unless the game asks (at most 64).

rules.vehicleFire

boolean = ...

Whether a car brought low catches fire, burns and blows up, its blast lighting the cars beside it.

rules.weather?

{ changes: boolean; climate?: "none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast"; intensity: number; start?: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; } = ...

The room's weather (GAME_DESIGN §5.7): its climate (the level's by default: a region's biome, temperate for a town; none is always clear), the weather it opens with (start, at an intensity), and whether it changes on its own from there (a front every half an hour, by the climate's odds) or holds. Missions change it (setWeather).

rules.weather.changes

boolean = ...

rules.weather.climate?

"none" | "temperate" | "meadow" | "forest" | "alpine" | "farmland" | "steppe" | "desert" | "autumn" | "coast" = ...

rules.weather.intensity

number = ...

rules.weather.start?

"clear" | "overcast" | "rain" | "storm" | "fog" | "snow" = ...

schemaVersion?

number = ...

The document's format (migrate.ts): 1 when absent; a newer one is migrated away before this reads it.

title

string = ...

zones

Record<string, { kind?: "pickup" | "spawn" | "restricted" | "race_gate" | "safe" | "checkpoint" | "dropoff"; place: string; radius: number; raises?: "alert" | "heat"; role?: "players" | "police" | "traffic" | "guards" | "hospital"; }> = ...

context?

ValidateContext = {}

Returns

Issue[]