InterfaceCreateOptions

The options for the leaderboard to be made.

interface CreateOptions {
    name: string;
    orderingType: OrderingType;
    ttlSeconds: number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

name orderingType ttlSeconds

Methods

getTypeName isOfType isSame

Properties

name

name: string

The name of the leaderboard.

orderingType

orderingType: OrderingType

How the leaderboard should be ordered.

ttlSeconds

ttlSeconds: number

How long the leaderboard should last.

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