EOS_Leaderboards_QueryLeaderboardUserScoresOptions

EOS API reference page for EOS_Leaderboards_QueryLeaderboardUserScoresOptions

Choose your implementation method:

C

C#

This data structure is part of the [Leaderboards Interface](Interfaces/Leaderboards).

Remarks

Input parameters for the EOS_Leaderboards_QueryLeaderboardUserScores function.

Properties

EOS_Leaderboards_QueryLeaderboardUserScoresOptions

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST.

const EOS_ProductUserId* UserIds

An array of Product User IDs indicating the users whose scores you want to retrieve

uint32_t UserIdsCount

The number of users included in query

const EOS_Leaderboards_UserScoresQueryStatInfo* StatInfo

The stats to be collected, along with the sorting method to use when determining rank order for each stat

uint32_t StatInfoCount

The number of stats to query

int64_t StartTime

An optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made after this time

int64_t EndTime

An optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made before this time

EOS_ProductUserId LocalUserId

Product 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.

Related API Members

This data structure is part of the [Leaderboards Interface](Interfaces/Leaderboards).

Remarks

Input parameters for the EOS_Leaderboards_QueryLeaderboardUserScores function.

Properties

Leaderboards.QueryLeaderboardUserScoresOptions

Property

Value

int ApiVersion

API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST.

ProductUserId[] UserIds

An array of Product User IDs indicating the users whose scores you want to retrieve

UserScoresQueryStatInfo[] StatInfo

The stats to be collected, along with the sorting method to use when determining rank order for each stat

System.DateTimeOffset? StartTime

An optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made after this time

System.DateTimeOffset? EndTime

An optional POSIX timestamp, or EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made before this time

ProductUserId LocalUserId

Product 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.

Related API Members