Interface ScoreboardListResponse

GET /api/scoreboard/list response

See

ScreepsHttpClient.scoreboardList

interface ScoreboardListResponse {
    meta: { length: number };
    ok: 1;
    users: ScoreboardUser[];
}

Hierarchy (View Summary)

ScreepsResponse
- ScoreboardListResponse

Index

Properties

Properties

meta

meta: { length: number }

Type Declaration

length: number
The total number of players in the result set

ok

ok: 1

An API success response always contains { ok: 1 }

users

users: ScoreboardUser[]

A page of player scoreboard results ordered by ScoreboardUser.rank (ascending)