Interface Room

Obtainable From

API.getRoom / API.getRooms

interface Room {
    active: boolean;
    auto_skip: boolean;
    category: "normal" | "spotlight" | "daily_challenge";
    channel_id: number;
    current_playlist_item?: null | Multiplayer.Room.PlaylistItem.WithBeatmap;
    current_user_score?: {
        accuracy: number;
        attempts: number;
        completed: number;
        playlist_item_attempts: {
            attempts: number;
            id: number;
        }[];
        pp: number;
        room_id: number;
        total_score: number;
        user_id: number;
    };
    difficulty_range?: {
        max: number;
        min: number;
    };
    ends_at: null | Date;
    has_password: boolean;
    host: WithCountry;
    id: number;
    max_attempts: null | number;
    name: string;
    participant_count: number;
    playlist?: WithComplexBeatmap[];
    playlist_item_stats?: {
        count_active: number;
        count_total: number;
        ruleset_ids: Ruleset[];
    };
    queue_mode: "all_players" | "all_players_round_robin" | "host_only";
    recent_participants: User[];
    starts_at: Date;
    type: "head_to_head" | "team_versus" | "playlists";
    user_id: number;
}

Properties

active auto_skip category channel_id current_playlist_item? current_user_score? difficulty_range? ends_at has_password host id max_attempts name participant_count playlist? playlist_item_stats? queue_mode recent_participants starts_at type user_id

Properties

active

active: boolean

auto_skip

auto_skip: boolean

category

category: "normal" | "spotlight" | "daily_challenge"

channel_id

channel_id: number

Optionalcurrent_playlist_item

current_playlist_item?: null | Multiplayer.Room.PlaylistItem.WithBeatmap

Optionalcurrent_user_score

current_user_score?: {
    accuracy: number;
    attempts: number;
    completed: number;
    playlist_item_attempts: {
        attempts: number;
        id: number;
    }[];
    pp: number;
    room_id: number;
    total_score: number;
    user_id: number;
}

Only exists if the authorized user has played

Type declaration

  • accuracy: number

    In a format where 96.40% would be 0.9640 (with some numbers after the zero)

  • attempts: number
  • completed: number
  • playlist_item_attempts: {
        attempts: number;
        id: number;
    }[]

    How many (completed (I think)) attempts on each item? Empty array if the multiplayer room is the realtime kind

  • pp: number
  • room_id: number
  • total_score: number
  • user_id: number

Optionaldifficulty_range

difficulty_range?: {
    max: number;
    min: number;
}

ends_at

ends_at: null | Date

has_password

has_password: boolean

host

host: WithCountry

id

id: number

max_attempts

max_attempts: null | number

name

name: string

participant_count

participant_count: number

Optionalplaylist

playlist?: WithComplexBeatmap[]

Optionalplaylist_item_stats

playlist_item_stats?: {
    count_active: number;
    count_total: number;
    ruleset_ids: Ruleset[];
}

queue_mode

queue_mode: "all_players" | "all_players_round_robin" | "host_only"

recent_participants

recent_participants: User[]

starts_at

starts_at: Date

type

type: "head_to_head" | "team_versus" | "playlists"

user_id

user_id: number

Settings

Member Visibility

On This Page

Properties