Class CreateOptions

The options for the leaderboard to be made.

Hierarchy (View Summary, Expand)

ScriptObject
- CreateOptions

Index

Constructors

Properties

name orderingType ttlSeconds

Methods

create getTypeName isOfType isSame

Constructors

`Protected`constructor

new CreateOptions(): CreateOptions
Returns CreateOptions
Overrides ScriptObject.constructor

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

`Static`create

create(): CreateOptions
Create the option.

Returns CreateOptions

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame