MetaPlatformSDK_LeaderboardEntry
Inherits: RefCounted
Represents an entry on a leaderboard.
Description
Represents an entry on a leaderboard.
Properties
String |
|
|
PackedByteArray |
|
|
int |
|
|
int |
|
|
int |
|
|
int |
|
|
int |
|
|
Property Descriptions
String display_score = ""
String get_display_score ( )
The formatted score that will be displayed in the leaderboard of this entry. You can select a score type to determine how scores are displayed on Leaderboard. See here for examples of different score type.
PackedByteArray extra_data = PackedByteArray()
PackedByteArray get_extra_data ( )
A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer. It will be used by two entry methods: MetaPlatformSDK.leaderboard_write_entry_async and MetaPlatformSDK.leaderboard_write_entry_with_supplementary_metric_async.
int extra_data_length = 0
int get_extra_data_length ( )
The length in bytes of extra_data.
int id = 0
int get_id ( )
This is a unique identifier for the leaderboard entry. It is of type id and is optional.
int rank = 0
int get_rank ( )
The rank of this leaderboard entry in the leaderboard. It can be used in MetaPlatformSDK.leaderboard_get_entries_after_rank_async to retrieve leaderboard entries starting from a specified rank.
int score = 0
int get_score ( )
The raw underlying value of the score achieved by the user in the leaderboard. It's of type long_as_string and it's used to determine the user's rank in the leaderboard.
MetaPlatformSDK_SupplementaryMetric supplementary_metric
MetaPlatformSDK_SupplementaryMetric get_supplementary_metric ( )
This may be null, which indicates that the value is not present or that the curent app or user is not permitted to access it.
int timestamp = 0
int get_timestamp ( )
The timestamp of this entry being created in the leaderboard.
MetaPlatformSDK_User user
MetaPlatformSDK_User get_user ( )
User of this leaderboard entry. You can request a block of leaderboard entries for the specified user ID(s) by MetaPlatformSDK.leaderboard_get_entries_by_ids_async.