Interface Leaderboard

Base class for objects representing Script data.

Example

Unassigned
interface Leaderboard {
    name: string;
    orderingType: OrderingType;
    ttlSeconds: number;
    getLeaderboardInfo(options: RetrievalOptions, successCallback: ((othersInfo: UserRecord[], currentUserInfo?: UserRecord) => void), failureCallback: ((status: number) => void)): void;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    submitScore(score: number, successCallback: ((currentUserInfo: UserRecord) => void), failureCallback: ((status: number) => void)): void;
}

Hierarchy (view full)

Properties

name orderingType ttlSeconds

Methods

getLeaderboardInfo getTypeName isOfType isSame submitScore

Properties

Readonlyname

name: string

ReadonlyorderingType

orderingType: OrderingType

ReadonlyttlSeconds

ttlSeconds: number

Methods

getLeaderboardInfo

  • getLeaderboardInfo(options, successCallback, failureCallback): void

  • Parameters

    • options: RetrievalOptions
    • successCallback: ((othersInfo: UserRecord[], currentUserInfo?: UserRecord) => void)
        • (othersInfo, currentUserInfo?): void

        • Parameters

          Returns void

    • failureCallback: ((status: number) => void)
        • (status): void

        • Parameters

          • status: number

          Returns void

    Returns void

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

submitScore

  • submitScore(score, successCallback, failureCallback): void

  • Parameters

    • score: number
    • successCallback: ((currentUserInfo: UserRecord) => void)
        • (currentUserInfo): void

        • Parameters

          Returns void

    • failureCallback: ((status: number) => void)
        • (status): void

        • Parameters

          • status: number

          Returns void

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods