rooms_status

Behavior#

How the project's multiplayer rooms are doing right now: the stored rooms policy (enabled, mode, signed_in_only, max_players, messages_per_second, tick_rate, teams, lobby, late_join, rejoin, and the named kinds with the same fields, when and by whom it was set), live rooms and players in total and per kind, the matchmaking queues (per kind and size: players waiting and the longest wait in ms, preview builds' queues apart), usage per day from the rooms worker (player-seconds by mode, sandbox time, joins, messages in and out, bytes sent, storage rows written, estimated awake seconds, and results_lost: signed results a room had to abandon; null when the worker cannot be reached, with metered_at, when usage was last read, and unreachable_since while it cannot be), open reports (signed-in players' reports on players not yet banned; guest reports count separately) and how many players are banned, and hosting: the game's multiplayer credits (balance, reserved and available cents, runway, matches open and in their grace, the preview allowance against its caps, the published rates, the cost estimate of its online play, buy_url) with warnings and must_act to pass on to the creator.

New guest ids are bounded per project per hour (a flood raises an alert). Read it before rooms_configure or player_ban, and whenever the deployer asks about online play, matchmaking, cost, or a complaint.

Input parameters#

This tool takes no arguments. Send an empty object: {}.

The descriptions above include conditional requirements. The full schema below shows structural validation; runtime checks also apply.

JSON Schema#

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}