host.anzo.eossdk.eos.sdk.leaderboards

Class EOS_Leaderboards_LeaderboardUserScore

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.leaderboards.EOS_Leaderboards_LeaderboardUserScore

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Leaderboards_LeaderboardUserScore.ByReference, EOS_Leaderboards_LeaderboardUserScore.ByValue

@Structure.FieldOrder(value={"ApiVersion","UserId","Score"})
public class EOS_Leaderboards_LeaderboardUserScore
extends com.sun.jna.Structure
implements java.lang.AutoCloseable

Contains information about a single leaderboard user score

Since:

8/21/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Leaderboards_LeaderboardUserScore.ByReference
static class	EOS_Leaderboards_LeaderboardUserScore.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_LEADERBOARDUSERSCORE_API_LATEST.
static int	EOS_LEADERBOARDS_LEADERBOARDUSERSCORE_API_LATEST The most recent version of the EOS_Leaderboards_LeaderboardUserScore struct.
int	Score Leaderboard score
EOS_ProductUserId	UserId The Product User ID of the user who got this score

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_LeaderboardUserScore()
EOS_Leaderboards_LeaderboardUserScore(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
void	close()
void	release() Release the memory associated with leaderboard user score.

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_LEADERBOARDUSERSCORE_API_LATEST

public static final int EOS_LEADERBOARDS_LEADERBOARDUSERSCORE_API_LATEST

The most recent version of the EOS_Leaderboards_LeaderboardUserScore struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LEADERBOARDS_LEADERBOARDUSERSCORE_API_LATEST.

UserId

public EOS_ProductUserId UserId

The Product User ID of the user who got this score

Score

public int Score

Leaderboard score

Constructor Detail

EOS_Leaderboards_LeaderboardUserScore

public EOS_Leaderboards_LeaderboardUserScore()

EOS_Leaderboards_LeaderboardUserScore

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

Method Detail

release

public void release()

Release the memory associated with leaderboard user score. This must be called on data retrieved from EOS_Leaderboards_CopyLeaderboardUserScoreByIndex or EOS_Leaderboards_CopyLeaderboardUserScoreByUserId.

See Also:

EOS_Leaderboards_LeaderboardUserScore, EOS_Leaderboards_Interface.copyLeaderboardUserScoreByIndex(EOS_Leaderboards_CopyLeaderboardUserScoreByIndexOptions), EOS_Leaderboards_Interface.copyLeaderboardUserScoreByUserId(EOS_Leaderboards_CopyLeaderboardUserScoreByUserIdOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception