Class LeaderboardModule

Enables usage of Leaderboard API within a Lens.

See

Leaderboard guide.

Hierarchy (View Summary)

Asset
- LeaderboardModule

Index

Properties

name uniqueIdentifier

Methods

getLeaderboard getTypeName isOfType isSame

Properties

name

name: string

The name of the Asset in Lens Studio.

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

getLeaderboard

getLeaderboard(
    options: CreateOptions,
    successCallback: (leaderboard: Leaderboard) => void,
    failureCallback: (message: string) => void,
): void
Gets a handle for a leaderboard.
Parameters
- options: CreateOptions
- successCallback: (leaderboard: Leaderboard) => void
- failureCallback: (message: string) => void
Returns void

getTypeName

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

Returns string
Inherited from Asset.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 Asset.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 Asset.isSame