five-on-it / apps/api/src/lobbies / LobbyDeps

Interface: LobbyDeps

Defined in: apps/api/src/lobbies.ts:182

What a lobby is built with.

Properties

coalesceMs?

optional coalesceMs?: number

Defined in: apps/api/src/lobbies.ts:229

How long changes are gathered into one push (ms; LOBBY_TIMING.coalesceMs by default).

now?

optional now?: () => number

Defined in: apps/api/src/lobbies.ts:186

The clock (ms).

Returns

number

openTimeoutMs?

optional openTimeoutMs?: number

Defined in: apps/api/src/lobbies.ts:231

How long a run's opening may take (ms; LOBBY_TIMING.openTimeoutMs by default).

social: SocialHub

Defined in: apps/api/src/lobbies.ts:184

The feed, the parties, the names, the presence.

Methods

abandonRun()

abandonRun(run): Promise<unknown>

Defined in: apps/api/src/lobbies.ts:195

Abandons a run nobody will play (RunRoutes.abandon: counting for nothing, its room closed).

Parameters

run

string

Returns

Promise<unknown>

admit()?

optional admit(account, mission, game): string | undefined

Defined in: apps/api/src/lobbies.ts:217

Whether an account may join a lobby's mission or play its run, and why not (the Respect gate, answered at once from the accounts warm looked at). Everyone, by default.

Parameters

account

string

mission

actors

({ at: string; class: string | string[]; id: string; key?: string; locked: boolean; owner: "nobody" | "npc" | "mission"; tags: string[]; type: "vehicle"; } | { armed: boolean; at: string; class?: string; count: number; crew: number; id: string; max?: number; mode: "car" | "foot"; profile: "guard" | "pursuit" | "tail" | "aggressive"; tags: string[]; targets?: { team: string; }; type: "chasers"; } | { at: string; count: number; id: string; item: string; type: "item"; } | { at: string; id: string; items: object[]; kind: "crate" | "locker"; lock?: string; type: "container"; } | { at: string; code?: string; id: string; lock?: string; locked?: boolean; type: "door"; } | { at: string; id: string; loop: boolean; path?: string; patrol?: string[]; pockets: object[]; role: "guard" | "civilian"; schedule?: object[]; tags: string[]; turn?: number; type: "npc"; weapon: "none" | "pistol" | "shotgun" | "rifle" | "fists"; } | { at: string; follow?: string; id: string; loop: boolean; path?: string; role: "driver"; route?: string[]; speed?: number; tags: string[]; type: "npc"; vehicle: string; } | { at: string; id: string; loop: boolean; path?: string; patrol?: string[]; pockets: object[]; refuge?: string; role: "target"; schedule?: object[]; tags: string[]; type: "npc"; } | { at: string; id: string; role: "vip"; tags: string[]; type: "npc"; } | { at: string; contact: string; dialogue: string; id: string; role: "contact"; type: "npc"; } | { at: string; id: string; on?: boolean; type: "camera"; } | { app: string; at: string; id: string; kind: "atm" | "terminal" | "keypad" | "vending" | "counter"; prompt: "use" | "hack"; screen?: string; type: "terminal"; } | { at: string; id: string; type: "garage"; } | { at: string; id: string; kind: "terminal" | "vending" | "counter"; sells: object[]; type: "shop"; } | { at: string; id: string; type: "prop"; })[] = ...

apps

object[] = ...

blurb?

string = ...

contacts

object[] = ...

counters

Record<string, number> = ...

dialogues

object[] = ...

helpline?

string = ...

id

string = Id

items

object[] = ...

objectives

({ checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; verb: "goto"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; target: string; team?: string; text?: string; timeLimit?: number; verb: "steal_vehicle"; } | { checkpoint?: boolean; count?: number; failText?: string; hint?: string; id: string; item?: string; marker?: string; maxDamage?: number; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; vehicle?: string; verb: "deliver"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; item: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "pickup"; } | { checkpoint?: boolean; count: number; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; tag: string; team?: string; text?: string; timeLimit?: number; verb: "collect"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; interactable: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "use"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "survive"; } | { checkpoint?: boolean; failIf?: Condition; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "defend"; zone: string; } | { checkpoint?: boolean; distance: number; failText?: string; group: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "lose"; } | { checkpoint?: boolean; failText?: string; group?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; nonLethal: boolean; targets?: { team: string; }; team?: string; text?: string; timeLimit?: number; verb: "eliminate"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; nonLethal: boolean; targets: string[]; team?: string; text?: string; timeLimit?: number; verb: "incapacitate"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; maxPhase: "search" | "normal" | "alert" | "caution" | "suspicious"; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "sneak"; zone: string; } | { actor?: string; checkpoint?: boolean; choice?: string; contact?: string; dialogue: string; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "talk"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; target: string; team?: string; text?: string; timeLimit?: number; verb: "unlock"; } | { checkpoint?: boolean; countdown: number; failText?: string; hint?: string; id: string; laps?: number; marker?: string; next?: { done?: string; failed?: string; }; path: string; rivals: string[]; team?: string; text?: string; timeLimit?: number; verb: "race"; } | { checkpoint?: boolean; count: number; failText?: string; hint?: string; id: string; item: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; verb: "give"; } | { actor: string; checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; maxDamage?: number; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; verb: "escort"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; radius: number; target: string; team?: string; text?: string; timeLimit?: number; to?: string; verb: "chase"; } | { actor?: string; checkpoint?: boolean; failText?: string; from: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; place?: string; team?: string; text?: string; timeLimit?: number; verb: "photograph"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "wait"; zone?: string; } | { checkpoint?: boolean; distance?: number; failText?: string; from: string[] | "police"; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds?: number; team?: string; text?: string; timeLimit?: number; verb: "escape"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; targets: string[]; team?: string; text?: string; timeLimit?: number; verb: "destroy"; } | { checkpoint?: boolean; count?: number; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; radius: number; seconds: number; targets: { team: string; }; team?: string; text?: string; timeLimit?: number; verb: "catch"; } | { checkpoint?: boolean; failIf?: Condition; failText?: string; hint?: string; id: string; marker?: string; need?: number; next?: { done?: string; failed?: string; }; objectives: ({ checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; verb: "goto"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; target: string; team?: string; text?: string; timeLimit?: number; verb: "steal_vehicle"; } | { checkpoint?: boolean; count?: number; failText?: string; hint?: string; id: string; item?: string; marker?: string; maxDamage?: number; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; vehicle?: string; verb: "deliver"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; item: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "pickup"; } | { checkpoint?: boolean; count: number; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; tag: string; team?: string; text?: string; timeLimit?: number; verb: "collect"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; interactable: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "use"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "survive"; } | { checkpoint?: boolean; failIf?: Condition; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "defend"; zone: string; } | { checkpoint?: boolean; distance: number; failText?: string; group: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "lose"; } | { checkpoint?: boolean; failText?: string; group?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; nonLethal: boolean; targets?: { team: string; }; team?: string; text?: string; timeLimit?: number; verb: "eliminate"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; nonLethal: boolean; targets: string[]; team?: string; text?: string; timeLimit?: number; verb: "incapacitate"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; maxPhase: "search" | "normal" | "alert" | "caution" | "suspicious"; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "sneak"; zone: string; } | { actor?: string; checkpoint?: boolean; choice?: string; contact?: string; dialogue: string; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; verb: "talk"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; target: string; team?: string; text?: string; timeLimit?: number; verb: "unlock"; } | { checkpoint?: boolean; countdown: number; failText?: string; hint?: string; id: string; laps?: number; marker?: string; next?: { done?: string; failed?: string; }; path: string; rivals: string[]; team?: string; text?: string; timeLimit?: number; verb: "race"; } | { checkpoint?: boolean; count: number; failText?: string; hint?: string; id: string; item: string; marker?: string; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; verb: "give"; } | { actor: string; checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; maxDamage?: number; next?: { done?: string; failed?: string; }; team?: string; text?: string; timeLimit?: number; to: string; verb: "escort"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; radius: number; target: string; team?: string; text?: string; timeLimit?: number; to?: string; verb: "chase"; } | { actor?: string; checkpoint?: boolean; failText?: string; from: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; place?: string; team?: string; text?: string; timeLimit?: number; verb: "photograph"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds: number; team?: string; text?: string; timeLimit?: number; verb: "wait"; zone?: string; } | { checkpoint?: boolean; distance?: number; failText?: string; from: string[] | "police"; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; seconds?: number; team?: string; text?: string; timeLimit?: number; verb: "escape"; } | { checkpoint?: boolean; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; targets: string[]; team?: string; text?: string; timeLimit?: number; verb: "destroy"; } | { checkpoint?: boolean; count?: number; failText?: string; hint?: string; id: string; marker?: string; next?: { done?: string; failed?: string; }; radius: number; seconds: number; targets: { team: string; }; team?: string; text?: string; timeLimit?: number; verb: "catch"; })[]; team?: string; text?: string; timeLimit?: number; verb: "group"; })[] = ...

play?

{ ambient?: { pedestrians?: number; traffic?: number; }; friendlyFire: boolean; joinInProgress: "never" | "untilCheckpoint" | "always"; lives?: { count: number; per: "player" | "team"; }; mode: "solo" | "coop" | "versus"; onDeath?: "checkpoint" | "spectate" | "teamSpawn"; players?: { max: number; min: number; }; respect?: { min: number; }; retries?: number; teams?: "each" | object[]; } = ...

play.ambient?

{ pedestrians?: number; traffic?: number; } = ...

play.ambient.pedestrians?

number = ...

play.ambient.traffic?

number = ...

play.friendlyFire

boolean = ...

play.joinInProgress

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

play.lives?

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

play.lives.count

number = ...

play.lives.per

"player" | "team" = ...

play.mode

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

play.onDeath?

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

play.players?

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

play.players.max

number = ...

play.players.min

number = ...

play.respect?

{ min: number; } = ...

play.respect.min

number = ...

play.retries?

number = ...

play.teams?

"each" | object[] = ...

reward?

{ cash: number; rep: number; } = ...

reward.cash

number = ...

reward.rep

number = ...

rules

({ do: ({ showText: string; } | { sendMessage: { from: string; id?: string; text: string; }; } | { setFlag: string; } | { clearFlag: string; } | { startTimer: { id: string; seconds: number; }; } | { stopTimer: string; } | { add: { counter: string; value: number | { counter: string; } | { timeLeft: true; } | { elapsed: true; } | { count: ... | ... | ... | ...; } | { distance: [..., ...]; } | { health: ... | ... | ... | ...; } | { wanted: true; } | { phaseOf: string; } | { phase: ... | ... | ... | ... | ...; } | { kills: true; } | { alerts: true; } | { seen: true; } | { form: string; } | { time: true; }; }; } | { set: { counter: string; value: number | { counter: string; } | { timeLeft: true; } | { elapsed: true; } | { count: ... | ... | ... | ...; } | { distance: [..., ...]; } | { health: ... | ... | ... | ...; } | { wanted: true; } | { phaseOf: string; } | { phase: ... | ... | ... | ... | ...; } | { kills: true; } | { alerts: true; } | { seen: true; } | { form: string; } | { time: true; }; }; } | { spawn: { at?: string; count?: number; group: string; }; } | { setWanted: number; } | { give: { count: number; item: string; }; } | { take: { count?: number; tag: string; }; } | { lock: { door: string; }; } | { unlock: { door: string; }; } | { lockVehicle: string; } | { unlockVehicle: string; } | { giveKey: string; } | { spawnItem: { at: string; count: number; item: string; }; } | { alert: { npc?: string; }; } | { calm: { npc?: string; }; } | { cameraOff: { camera: string; }; } | { cameraOn: { camera: string; }; } | { reward: { cash: number; rep: number; }; } | { complete: true; } | { fail: true | { text: string; }; } | { win: string; } | { message: { choices?: Reply[]; from: string; id?: string; text: string; }; } | { call: { dialogue: string; from: string; }; } | { addContact: { contact: string; dialogue?: string; }; } | { removeContact: string; } | { installApp: string; } | { removeApp: string; } | { waypoint: string; } | { clearWaypoint: true; } | { setClock: string; } | { setPace: number; } | { setWeather: { intensity: number; kind: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; minutes?: number; over: number; }; } | { skipTime: { hours: number; text?: string; }; } | { setSignal: { group?: "north-south" | "east-west"; junction: string; seconds?: number; state: "green" | "red" | "flashing" | "auto"; }; })[]; if?: Condition; repeat: boolean; when: string; } | { enter?: ({ showText: string; } | { sendMessage: { from: string; id?: string; text: string; }; } | { setFlag: string; } | { clearFlag: string; } | { startTimer: { id: string; seconds: number; }; } | { stopTimer: string; } | { add: { counter: string; value: number | { counter: ...; } | { timeLeft: ...; } | { elapsed: ...; } | { count: ...; } | { distance: ...; } | { health: ...; } | { wanted: ...; } | { phaseOf: ...; } | { phase: ...; } | { kills: ...; } | { alerts: ...; } | { seen: ...; } | { form: ...; } | { time: ...; }; }; } | { set: { counter: string; value: number | { counter: ...; } | { timeLeft: ...; } | { elapsed: ...; } | { count: ...; } | { distance: ...; } | { health: ...; } | { wanted: ...; } | { phaseOf: ...; } | { phase: ...; } | { kills: ...; } | { alerts: ...; } | { seen: ...; } | { form: ...; } | { time: ...; }; }; } | { spawn: { at?: string; count?: number; group: string; }; } | { setWanted: number; } | { give: { count: number; item: string; }; } | { take: { count?: number; tag: string; }; } | { lock: { door: string; }; } | { unlock: { door: string; }; } | { lockVehicle: string; } | { unlockVehicle: string; } | { giveKey: string; } | { spawnItem: { at: string; count: number; item: string; }; } | { alert: { npc?: string; }; } | { calm: { npc?: string; }; } | { cameraOff: { camera: string; }; } | { cameraOn: { camera: string; }; } | { reward: { cash: number; rep: number; }; } | { complete: true; } | { fail: true | { text: string; }; } | { win: string; } | { message: { choices?: ...[]; from: string; id?: string; text: string; }; } | { call: { dialogue: string; from: string; }; } | { addContact: { contact: string; dialogue?: string; }; } | { removeContact: string; } | { installApp: string; } | { removeApp: string; } | { waypoint: string; } | { clearWaypoint: true; } | { setClock: string; } | { setPace: number; } | { setWeather: { intensity: number; kind: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; minutes?: number; over: number; }; } | { skipTime: { hours: number; text?: string; }; } | { setSignal: { group?: "north-south" | "east-west"; junction: string; seconds?: number; state: "green" | "red" | "flashing" | "auto"; }; })[]; every?: { do: ({ showText: string; } | { sendMessage: { from: string; id?: ... | ...; text: string; }; } | { setFlag: string; } | { clearFlag: string; } | { startTimer: { id: string; seconds: number; }; } | { stopTimer: string; } | { add: { counter: string; value: ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ...; }; } | { set: { counter: string; value: ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ... | ...; }; } | { spawn: { at?: ... | ...; count?: ... | ...; group: string; }; } | { setWanted: number; } | { give: { count: number; item: string; }; } | { take: { count?: ... | ...; tag: string; }; } | { lock: { door: string; }; } | { unlock: { door: string; }; } | { lockVehicle: string; } | { unlockVehicle: string; } | { giveKey: string; } | { spawnItem: { at: string; count: number; item: string; }; } | { alert: { npc?: ... | ...; }; } | { calm: { npc?: ... | ...; }; } | { cameraOff: { camera: string; }; } | { cameraOn: { camera: string; }; } | { reward: { cash: number; rep: number; }; } | { complete: true; } | { fail: true | { text: ...; }; } | { win: string; } | { message: { choices?: ... | ...; from: string; id?: ... | ...; text: string; }; } | { call: { dialogue: string; from: string; }; } | { addContact: { contact: string; dialogue?: ... | ...; }; } | { removeContact: string; } | { installApp: string; } | { removeApp: string; } | { waypoint: string; } | { clearWaypoint: true; } | { setClock: string; } | { setPace: number; } | { setWeather: { intensity: number; kind: ... | ... | ... | ... | ... | ...; minutes?: ... | ...; over: number; }; } | { skipTime: { hours: number; text?: ... | ...; }; } | { setSignal: { group?: ... | ... | ...; junction: string; seconds?: ... | ...; state: ... | ... | ... | ...; }; })[]; if?: Condition; seconds: number; }; exit?: ({ showText: string; } | { sendMessage: { from: string; id?: string; text: string; }; } | { setFlag: string; } | { clearFlag: string; } | { startTimer: { id: string; seconds: number; }; } | { stopTimer: string; } | { add: { counter: string; value: number | { counter: ...; } | { timeLeft: ...; } | { elapsed: ...; } | { count: ...; } | { distance: ...; } | { health: ...; } | { wanted: ...; } | { phaseOf: ...; } | { phase: ...; } | { kills: ...; } | { alerts: ...; } | { seen: ...; } | { form: ...; } | { time: ...; }; }; } | { set: { counter: string; value: number | { counter: ...; } | { timeLeft: ...; } | { elapsed: ...; } | { count: ...; } | { distance: ...; } | { health: ...; } | { wanted: ...; } | { phaseOf: ...; } | { phase: ...; } | { kills: ...; } | { alerts: ...; } | { seen: ...; } | { form: ...; } | { time: ...; }; }; } | { spawn: { at?: string; count?: number; group: string; }; } | { setWanted: number; } | { give: { count: number; item: string; }; } | { take: { count?: number; tag: string; }; } | { lock: { door: string; }; } | { unlock: { door: string; }; } | { lockVehicle: string; } | { unlockVehicle: string; } | { giveKey: string; } | { spawnItem: { at: string; count: number; item: string; }; } | { alert: { npc?: string; }; } | { calm: { npc?: string; }; } | { cameraOff: { camera: string; }; } | { cameraOn: { camera: string; }; } | { reward: { cash: number; rep: number; }; } | { complete: true; } | { fail: true | { text: string; }; } | { win: string; } | { message: { choices?: ...[]; from: string; id?: string; text: string; }; } | { call: { dialogue: string; from: string; }; } | { addContact: { contact: string; dialogue?: string; }; } | { removeContact: string; } | { installApp: string; } | { removeApp: string; } | { waypoint: string; } | { clearWaypoint: true; } | { setClock: string; } | { setPace: number; } | { setWeather: { intensity: number; kind: "clear" | "overcast" | "rain" | "storm" | "fog" | "snow"; minutes?: number; over: number; }; } | { skipTime: { hours: number; text?: string; }; } | { setSignal: { group?: "north-south" | "east-west"; junction: string; seconds?: number; state: "green" | "red" | "flashing" | "auto"; }; })[]; while: Condition; })[] = ...

start

{ on: "join"; } | { on: "enter"; zone: string; } = ...

stealth?

{ bonus?: { cash: number; rep: number; }; unseen?: "fail" | "bonus"; withoutAlerts?: "fail" | "bonus"; withoutKills?: "fail" | "bonus"; } = ...

stealth.bonus?

{ cash: number; rep: number; } = ...

stealth.bonus.cash

number = ...

stealth.bonus.rep

number = ...

stealth.unseen?

"fail" | "bonus" = ...

stealth.withoutAlerts?

"fail" | "bonus" = ...

stealth.withoutKills?

"fail" | "bonus" = ...

title

string = ...

game

CatalogGame

Returns

string | undefined

fillSeat()?

optional fillSeat(account, run, team, party?): Promise<FilledSeat | RunRefusal>

Defined in: apps/api/src/lobbies.ts:205

Seats an account in a run under way on a team (RunRoutes.fill): its join URL, or why not.

Parameters

account

Account

run

string

team

string

party?

string

Returns

Promise<FilledSeat | RunRefusal>

game()

game(id): Promise<CatalogGame | { error: string; status: number; }>

Defined in: apps/api/src/lobbies.ts:199

A game read again by its id (the catalogue's): its latest version, or why it is gone (taken down, deleted).

Parameters

id

string

Returns

Promise<CatalogGame | { error: string; status: number; }>

gateOf()?

optional gateOf(game, mission): number | undefined

Defined in: apps/api/src/lobbies.ts:225

The Respect tier a mission's gate asks for now (a creator's held to tier 2 until it qualifies), for its card.

Parameters

game

CatalogGame

mission

actors

apps

object[] = ...

blurb?

string = ...

contacts

object[] = ...

counters

Record<string, number> = ...

dialogues

object[] = ...

helpline?

string = ...

id

string = Id

items

object[] = ...

objectives

play?

play.ambient?

{ pedestrians?: number; traffic?: number; } = ...

play.ambient.pedestrians?

number = ...

play.ambient.traffic?

number = ...

play.friendlyFire

boolean = ...

play.joinInProgress

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

play.lives?

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

play.lives.count

number = ...

play.lives.per

"player" | "team" = ...

play.mode

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

play.onDeath?

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

play.players?

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

play.players.max

number = ...

play.players.min

number = ...

play.respect?

{ min: number; } = ...

play.respect.min

number = ...

play.retries?

number = ...

play.teams?

"each" | object[] = ...

reward?

{ cash: number; rep: number; } = ...

reward.cash

number = ...

reward.rep

number = ...

rules

start

{ on: "join"; } | { on: "enter"; zone: string; } = ...

stealth?

{ bonus?: { cash: number; rep: number; }; unseen?: "fail" | "bonus"; withoutAlerts?: "fail" | "bonus"; withoutKills?: "fail" | "bonus"; } = ...

stealth.bonus?

{ cash: number; rep: number; } = ...

stealth.bonus.cash

number = ...

stealth.bonus.rep

number = ...

stealth.unseen?

"fail" | "bonus" = ...

stealth.withoutAlerts?

"fail" | "bonus" = ...

stealth.withoutKills?

"fail" | "bonus" = ...

title

string = ...

Returns

number | undefined

liveSeats()?

optional liveSeats(run): Promise<{ gone: string[]; open: OpenTeam[]; } | undefined>

Defined in: apps/api/src/lobbies.ts:203

A run's open seats as its room says them now, and its seats gone for good (accounts); none when its room is out of sight.

Parameters

run

string

Returns

Promise<{ gone: string[]; open: OpenTeam[]; } | undefined>

log()?

optional log(message): void

Defined in: apps/api/src/lobbies.ts:227

Where what went wrong is told (the API's log); nowhere by default.

Parameters

message

string

Returns

void

openRun()

openRun(owner, game, mission, roster): Promise<OpenedRun | RunRefusal>

Defined in: apps/api/src/lobbies.ts:188

Opens a run of a mission for a roster (RunRoutes.openRoster), spending a room of owner's.

Parameters

owner

Account

game

CatalogGame

mission

actors

apps

object[] = ...

blurb?

string = ...

contacts

object[] = ...

counters

Record<string, number> = ...

dialogues

object[] = ...

helpline?

string = ...

id

string = Id

items

object[] = ...

objectives

play?

play.ambient?

{ pedestrians?: number; traffic?: number; } = ...

play.ambient.pedestrians?

number = ...

play.ambient.traffic?

number = ...

play.friendlyFire

boolean = ...

play.joinInProgress

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

play.lives?

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

play.lives.count

number = ...

play.lives.per

"player" | "team" = ...

play.mode

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

play.onDeath?

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

play.players?

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

play.players.max

number = ...

play.players.min

number = ...

play.respect?

{ min: number; } = ...

play.respect.min

number = ...

play.retries?

number = ...

play.teams?

"each" | object[] = ...

reward?

{ cash: number; rep: number; } = ...

reward.cash

number = ...

reward.rep

number = ...

rules

start

{ on: "join"; } | { on: "enter"; zone: string; } = ...

stealth?

{ bonus?: { cash: number; rep: number; }; unseen?: "fail" | "bonus"; withoutAlerts?: "fail" | "bonus"; withoutKills?: "fail" | "bonus"; } = ...

stealth.bonus?

{ cash: number; rep: number; } = ...

stealth.bonus.cash

number = ...

stealth.bonus.rep

number = ...

stealth.unseen?

"fail" | "bonus" = ...

stealth.withoutAlerts?

"fail" | "bonus" = ...

stealth.withoutKills?

"fail" | "bonus" = ...

title

string = ...

roster

readonly RosterSeat[]

Returns

Promise<OpenedRun | RunRefusal>

paid()?

optional paid(run, players): Promise<void>

Defined in: apps/api/src/lobbies.ts:212

Pays a run that ended (Respect), before its lobby shows the results; whether or not a lobby opened it.

Parameters

run

Run

players

readonly RunPlayer[]

Returns

Promise<void>

playlist()

playlist(playlist?): Promise<CatalogMission[]>

Defined in: apps/api/src/lobbies.ts:201

A playlist's missions in its rotation (Any by default): what the vote offers a mission on another level from.

Parameters

playlist?

"any" | "coop" | "versus" | "races"

Returns

Promise<CatalogMission[]>

seatedIn()

seatedIn(account): Promise<string | undefined>

Defined in: apps/api/src/lobbies.ts:197

The open run an account holds a seat in, if any (one open run per account: RunRoutes.seatOf).

Parameters

account

string

Returns

Promise<string | undefined>

skillOf()?

optional skillOf(account): number

Defined in: apps/api/src/lobbies.ts:223

An account's hidden skill (a rating): the teams balanced by it; none, by their numbers alone.

Parameters

account

string

Returns

number

tierOf()?

optional tierOf(account): number | undefined

Defined in: apps/api/src/lobbies.ts:221

An account's Respect tier, shown beside their name (none: a guest, or Respect not shown).

Parameters

account

string

Returns

number | undefined

warm()?

optional warm(accounts, game, mission): Promise<void>

Defined in: apps/api/src/lobbies.ts:219

Looks at accounts before their admission is asked (a run's start): their standings read.

Parameters

accounts

readonly string[]

game

CatalogGame

mission

actors

apps

object[] = ...

blurb?

string = ...

contacts

object[] = ...

counters

Record<string, number> = ...

dialogues

object[] = ...

helpline?

string = ...

id

string = Id

items

object[] = ...

objectives

play?

play.ambient?

{ pedestrians?: number; traffic?: number; } = ...

play.ambient.pedestrians?

number = ...

play.ambient.traffic?

number = ...

play.friendlyFire

boolean = ...

play.joinInProgress

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

play.lives?

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

play.lives.count

number = ...

play.lives.per

"player" | "team" = ...

play.mode

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

play.onDeath?

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

play.players?

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

play.players.max

number = ...

play.players.min

number = ...

play.respect?

{ min: number; } = ...

play.respect.min

number = ...

play.retries?

number = ...

play.teams?

"each" | object[] = ...

reward?

{ cash: number; rep: number; } = ...

reward.cash

number = ...

reward.rep

number = ...

rules

start

{ on: "join"; } | { on: "enter"; zone: string; } = ...

stealth?

{ bonus?: { cash: number; rep: number; }; unseen?: "fail" | "bonus"; withoutAlerts?: "fail" | "bonus"; withoutKills?: "fail" | "bonus"; } = ...

stealth.bonus?

{ cash: number; rep: number; } = ...

stealth.bonus.cash

number = ...

stealth.bonus.rep

number = ...

stealth.unseen?

"fail" | "bonus" = ...

stealth.withoutAlerts?

"fail" | "bonus" = ...

stealth.withoutKills?

"fail" | "bonus" = ...

title

string = ...

Returns

Promise<void>

audio

fonts

gui

renderer

ui

studio

scripts

blocks

Interface: LobbyDeps ​

Properties ​

coalesceMs? ​

now? ​

Returns ​

openTimeoutMs? ​

social ​

Methods ​

abandonRun() ​

Parameters ​

run ​

Returns ​

admit()? ​

Parameters ​

account ​

mission ​

actors ​

apps ​

blurb? ​

contacts ​

counters ​

dialogues ​

helpline? ​

id ​

items ​

objectives ​

play? ​

play.ambient? ​

play.ambient.pedestrians? ​

play.ambient.traffic? ​

play.friendlyFire ​

play.joinInProgress ​

play.lives? ​

play.lives.count ​

play.lives.per ​

play.mode ​

play.onDeath? ​

play.players? ​

play.players.max ​

play.players.min ​

play.respect? ​

play.respect.min ​

play.retries? ​

play.teams? ​

reward? ​

reward.cash ​

reward.rep ​

rules ​

start ​

stealth? ​

stealth.bonus? ​

stealth.bonus.cash ​

stealth.bonus.rep ​

stealth.unseen? ​

stealth.withoutAlerts? ​

stealth.withoutKills? ​

title ​

game ​

Returns ​

fillSeat()? ​

Parameters ​

account ​

run ​

team ​

party? ​

Returns ​

game() ​

Parameters ​

id ​

Returns ​

gateOf()? ​

Parameters ​

Interface: LobbyDeps

Properties

coalesceMs?

now?

Returns

openTimeoutMs?

social

Methods

abandonRun()

Parameters

run

Returns

admit()?

Parameters

account

mission

actors

apps

blurb?

contacts

counters

dialogues

helpline?

id

items

objectives

play?

play.ambient?

play.ambient.pedestrians?

play.ambient.traffic?

play.friendlyFire

play.joinInProgress

play.lives?

play.lives.count

play.lives.per

play.mode

play.onDeath?

play.players?

play.players.max

play.players.min

play.respect?

play.respect.min

play.retries?

play.teams?

reward?

reward.cash

reward.rep

rules

start

stealth?

stealth.bonus?

stealth.bonus.cash

stealth.bonus.rep

stealth.unseen?

stealth.withoutAlerts?

stealth.withoutKills?

title

game

Returns

fillSeat()?

Parameters

account

run

team

party?

Returns

game()

Parameters

id

Returns

gateOf()?

Parameters

game

mission

actors

apps

blurb?

contacts

counters

dialogues