Function getScores

  • getScores(
        this: API,
        item: Multiplayer.Room.PlaylistItem | { id: number; room_id: number },
        limit?: number,
        sort?: "score_asc" | "score_desc",
        cursor_string?: string,
    ): Promise<
        {
            cursor_string: null
            | string;
            params: { limit: number; sort: string };
            scores: Multiplayer.Room.PlaylistItem.Score[];
            total: number;
            user_score: null | Multiplayer.Room.PlaylistItem.Score;
        },
    >

    Get the scores on a specific item of a room!

    Parameters

    • this: API
    • item: Multiplayer.Room.PlaylistItem | { id: number; room_id: number }

      An object with the id of the item in question, as well as the id of the room

    • limit: number = 50

      How many scores maximum? Defaults to 50, the maximum the API will return

    • sort: "score_asc" | "score_desc" = "score_desc"

      Sort by scores, ascending or descending? Defaults to descending

    • Optionalcursor_string: string

      Use a Multiplayer.Scores' params and cursor_string to get the next page (scores 51 to 100 for example)

    Returns Promise<
        {
            cursor_string: null
            | string;
            params: { limit: number; sort: string };
            scores: Multiplayer.Room.PlaylistItem.Score[];
            total: number;
            user_score: null | Multiplayer.Room.PlaylistItem.Score;
        },
    >

    Remarks

    This will not work for rooms created before ~March 5th 2024 https://github.com/ppy/osu-web/issues/10725

Settings

Member Visibility