screeps-api
    Preparing search index...

    Interface ScreepsVersionResponse

    GET /api/version response

    ScreepsHttpClient.version

    interface ScreepsVersionResponse {
        currentSeason?: string;
        databaseVersion?: number;
        decorationConvertationCost?: number;
        decorationPixelizationCost?: number;
        ok: 1;
        package?: number;
        protocol: number;
        serverData: {
            customObjectTypes: object;
            features: {
                menuItems: {
                    after?: string;
                    item: object;
                    module?: string;
                    section: number;
                    start?: number;
                }[];
                name: string;
                version: number;
            }[];
            historyChunkSize: number;
            renderer: { metadata: object; resources: object };
            shards: string[];
            socketUpdateThrottle?: number;
            welcomeText?: string;
        };
        useNativeAuth?: boolean;
        users: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    currentSeason? databaseVersion? decorationConvertationCost? decorationPixelizationCost? ok package? protocol serverData useNativeAuth? users

    Properties

    currentSeason?: string

    Name of the current season (usually the season number as a string); undefined on unofficial servers

    databaseVersion?: number
    decorationConvertationCost?: number

    undefined on unofficial servers

    decorationPixelizationCost?: number

    undefined on unofficial servers

    ok: 1

    An API success response always contains { ok: 1 }

    package?: number

    Client version number; undefined on non-official servers

    protocol: number
    serverData: {
        customObjectTypes: object;
        features: {
            menuItems: {
                after?: string;
                item: object;
                module?: string;
                section: number;
                start?: number;
            }[];
            name: string;
            version: number;
        }[];
        historyChunkSize: number;
        renderer: { metadata: object; resources: object };
        shards: string[];
        socketUpdateThrottle?: number;
        welcomeText?: string;
    }

    Type Declaration

    • customObjectTypes: object
    • features: {
          menuItems: {
              after?: string;
              item: object;
              module?: string;
              section: number;
              start?: number;
          }[];
          name: string;
          version: number;
      }[]
    • historyChunkSize: number

      Number of ticks in each complete history file/chunk

    • renderer: { metadata: object; resources: object }
    • shards: string[]
    • OptionalsocketUpdateThrottle?: number

      socket update rate; undefined on official servers

    • OptionalwelcomeText?: string

      welcome message that will be displayed upon signin

    useNativeAuth?: boolean

    undefined on official servers

    users: number

    Sum of the number of active players on each shard

    Settings

    Member Visibility

    On This Page

    Properties