host.anzo.eossdk.eos.sdk.leaderboards.options

Class EOS_Leaderboards_QueryLeaderboardUserScoresOptions

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.leaderboards.options.EOS_Leaderboards_QueryLeaderboardUserScoresOptions

Direct Known Subclasses:

EOS_Leaderboards_QueryLeaderboardUserScoresOptions.ByReference, EOS_Leaderboards_QueryLeaderboardUserScoresOptions.ByValue

@Structure.FieldOrder(value={"ApiVersion","UserIds","UserIdsCount","StatInfo","StatInfoCount","StartTime","EndTime","LocalUserId"})
public class EOS_Leaderboards_QueryLeaderboardUserScoresOptions
extends com.sun.jna.Structure

Input parameters for the EOS_Leaderboards_QueryLeaderboardUserScores function.

Since:

8/21/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Leaderboards_QueryLeaderboardUserScoresOptions.ByReference
static class	EOS_Leaderboards_QueryLeaderboardUserScoresOptions.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
int	ApiVersion API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST.
long	EndTime An optional POSIX timestamp, or EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made before this time
static int	EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST The most recent version of the EOS_Leaderboards_QueryLeaderboardUserScores struct.
EOS_ProductUserId	LocalUserId Product User ID for user who is querying user scores.
long	StartTime An optional POSIX timestamp, or EOS_Leaderboards_QueryLeaderboardDefinitionsOptions.EOS_LEADERBOARDS_TIME_UNDEFINED; results will only include scores made after this time
EOS_Leaderboards_UserScoresQueryStatInfo.ByReference	StatInfo The stats to be collected, along with the sorting method to use when determining rank order for each stat
int	StatInfoCount The number of stats to query
EOS_ProductUserId	UserIds An array of Product User IDs indicating the users whose scores you want to retrieve
int	UserIdsCount The number of users included in query

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
EOS_Leaderboards_QueryLeaderboardUserScoresOptions()
EOS_Leaderboards_QueryLeaderboardUserScoresOptions(com.sun.jna.Pointer peer)

Method Summary

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST

public static final int EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST

The most recent version of the EOS_Leaderboards_QueryLeaderboardUserScores struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LEADERBOARDS_QUERYLEADERBOARDUSERSCORES_API_LATEST.

UserIds

public EOS_ProductUserId UserIds

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

UserIdsCount

public int UserIdsCount

The number of users included in query

StatInfo

public EOS_Leaderboards_UserScoresQueryStatInfo.ByReference StatInfo

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

StatInfoCount

public int StatInfoCount

The number of stats to query

StartTime

public long StartTime

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

EndTime

public long EndTime

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

LocalUserId

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

Constructor Detail

EOS_Leaderboards_QueryLeaderboardUserScoresOptions

public EOS_Leaderboards_QueryLeaderboardUserScoresOptions()

EOS_Leaderboards_QueryLeaderboardUserScoresOptions

public EOS_Leaderboards_QueryLeaderboardUserScoresOptions(com.sun.jna.Pointer peer)