InterfaceRetrievalOptions

Describes the context for the leaderboard to be requested.

interface RetrievalOptions {
    usersLimit: number;
    usersType: UsersType;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

usersLimit usersType

Methods

getTypeName isOfType isSame

Properties

usersLimit

usersLimit: number

The number of users to be retrieved.

usersType

usersType: UsersType

The type of users to be retrieved.

Methods

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

Settings

Member Visibility

On This Page

Properties
Methods