Leaderboard.RetrievalOptions
ClassDescribes the context for the leaderboard to be requested.
- Available on all platforms
Index
Properties
Methods
Extends
Properties
usersLimit
usersLimit:
number
The number of users to be retrieved. The number should be >= 0.
Default Value
64
usersType
usersType:
UsersType
The type of users to be retrieved.
Default Value
Leaderboard.UsersType.Friends
Methods
create()
staticcreate():RetrievalOptions
Creates the option.
Returns
RetrievalOptions
getTypeName()
staticgetTypeName():TypeName<RetrievalOptions>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<RetrievalOptions>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean