screeps-api
    Preparing search index...

    Interface AuthMeResponse

    GET /api/auth/me response

    ScreepsHttpClient.authMe

    interface AuthMeResponse {
        _id: string;
        badge?: UserBadge;
        cpu?: number;
        cpuShard?: CpuShardLimits;
        cpuShardUpdatedTime?: number;
        credits: string;
        email: string;
        gcl?: number;
        github?: { id: string; username: string };
        lastRespawnDate?: number;
        lastTweetTime?: number;
        money: number;
        notifyPrefs: UserNotifyPrefsRequest;
        ok: 1;
        password?: boolean;
        power?: number;
        powerExperimentations: number;
        powerExperimentationTime?: number;
        resources: {
            accessKey: number | undefined;
            cpuUnlock: number | undefined;
            pixel: number | undefined;
        };
        restrictedAccessUntil: unknown;
        steam?: { displayName: string; id: string; steamProfileLinkHidden?: 0
        | 1 };
        twitter?: { followers_count: number; username: string };
        username: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id badge? cpu? cpuShard? cpuShardUpdatedTime? credits email gcl? github? lastRespawnDate? lastTweetTime? money notifyPrefs ok password? power? powerExperimentations powerExperimentationTime? resources restrictedAccessUntil steam? twitter? username

    Properties

    _id

    _id: string
    badge?: UserBadge
    cpu?: number

    Total available CPU per tick

    cpuShard?: CpuShardLimits

    Result of Game.cpu.shardLimits

    cpuShardUpdatedTime?: number

    UNIX timestamp of last successful call to Game.cpu.setShardLimits()

    credits: string

    this appears to always be 0; use money instead

    email: string
    gcl?: number

    Lifetime control points earned by this player

    github?: { id: string; username: string }

    Github SSO account data

    lastRespawnDate?: number

    UNIX timestamp of the player's last (re)spawn

    lastTweetTime?: number
    money: number

    Player's current credit balance; use this instead of credits

    notifyPrefs: UserNotifyPrefsRequest
    ok: 1

    An API success response always contains { ok: 1 }

    password?: boolean

    True if password authentication is configured

    power?: number

    Lifetime power processed by this player

    powerExperimentations: number

    Number of remaining power creep experimentation periods: https://docs.screeps.com/power.html#Power-Creeps

    powerExperimentationTime?: number

    UNIX timestamp of the start of player's most recently used power creep experimentation period: https://docs.screeps.com/power.html#Power-Creeps

    resources: {
        accessKey: number | undefined;
        cpuUnlock: number | undefined;
        pixel: number | undefined;
    }

    Intrashard / account-bound resource types and amounts owned

    restrictedAccessUntil: unknown
    steam?: { displayName: string; id: string; steamProfileLinkHidden?: 0 | 1 }

    Steam SSO account data

    twitter?: { followers_count: number; username: string }

    Twitter SSO account data

    username: string

    Settings

    Member Visibility

    On This Page

    Properties