five-on-it / packages/protocol/src/platform / RoomOpenRequest

Variable: RoomOpenRequest

const RoomOpenRequest: ZodObject<{ artifactUrl: ZodOptional<ZodURL>; bundled: ZodOptional<ZodString>; id: ZodString; maxPlayers: ZodNumber; moderationUrl: ZodOptional<ZodURL>; run: ZodOptional<ZodObject<{ game: ZodString; id: ZodString; mission: ZodString; playtest: ZodOptional<ZodBoolean>; reportToken: ZodString; reportUrl: ZodURL; seats: ZodArray<ZodObject<{ account: ZodString; name: ZodString; party: ZodOptional<ZodString>; team: ZodString; tier: ZodOptional<ZodNumber>; }, $strip>>; teams: ZodArray<ZodString>; }, $strip>>; title: ZodString; }, $strip>

Defined in: packages/protocol/src/platform.ts:226

The API's request to a game server: open this room, fetching the game from this URL (or, bundled, playing a level that ships with its bundled game, which the server carries); for a public room, the URL its chat lines are checked at (the platform's moderation, asked with the room secret) before anyone else reads them (a room without one is private: its chat is not moderated); for a run's room, the run (RunSpec).