EOS_Leaderboards_QueryLeaderboardUserScoresOptions

EOS API reference page for EOS_Leaderboards_QueryLeaderboardUserScoresOptions

2 mins to read

This data structure is part of the Leaderboards Interface.

Remarks

Input parameters for the EOS_Leaderboards_QueryLeaderboardUserScores function.

Properties

EOS_Leaderboards_QueryLeaderboardUserScoresOptions

PropertyValue
int32_t ApiVersionAPI Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST.
const EOS_ProductUserId* UserIdsAn array of Product User IDs indicating the users whose scores you want to retrieve
uint32_t UserIdsCountThe number of users included in query
const EOS_Leaderboards_UserScoresQueryStatInfo* StatInfoThe stats to be collected, along with the sorting method to use when determining rank order for each stat
uint32_t StatInfoCountThe number of stats to query
int64_t StartTimeAn optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made after this time
int64_t EndTimeAn optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made before this time
EOS_ProductUserId LocalUserIdProduct User ID for user who is querying user scores. Must be set when using a client policy that requires a valid logged in user. Not used for Dedicated Server where no user is available.