Class EOS_Leaderboards_LeaderboardRecord
java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.leaderboards.EOS_Leaderboards_LeaderboardRecord
- All Implemented Interfaces:
AutoCloseable
- Direct Known Subclasses:
EOS_Leaderboards_LeaderboardRecord.ByReference,EOS_Leaderboards_LeaderboardRecord.ByValue
@FieldOrder({"ApiVersion","UserId","Rank","Score","UserDisplayName"})
public class EOS_Leaderboards_LeaderboardRecord
extends com.sun.jna.Structure
implements AutoCloseable
Contains information about a single leaderboard record
- Since:
- 8/21/2023
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classNested classes/interfaces inherited from class com.sun.jna.Structure
com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField -
Field Summary
FieldsModifier and TypeFieldDescriptionintAPI Version: Set this toEOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST.static final intThe most recent version of the EOS_Leaderboards_LeaderboardRecord struct.intSorted position on leaderboardintLeaderboard scoreThe latest display name seen for the user since they last time logged in.The Product User ID associated with this recordFields inherited from class com.sun.jna.Structure
ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE -
Constructor Summary
Constructors -
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
-
Field Details
-
EOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST
public static final int EOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATESTThe most recent version of the EOS_Leaderboards_LeaderboardRecord struct.- See Also:
-
ApiVersion
public int ApiVersionAPI Version: Set this toEOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST. -
UserId
The Product User ID associated with this record -
Rank
public int RankSorted position on leaderboard -
Score
public int ScoreLeaderboard score -
UserDisplayName
The latest display name seen for the user since they last time logged in. This is empty if the user does not have a display name set.
-
-
Constructor Details
-
EOS_Leaderboards_LeaderboardRecord
public EOS_Leaderboards_LeaderboardRecord() -
EOS_Leaderboards_LeaderboardRecord
public EOS_Leaderboards_LeaderboardRecord(com.sun.jna.Pointer peer)
-
-
Method Details
-
release
public void release()Release the memory associated with leaderboard record. This must be called on data retrieved from EOS_Leaderboards_CopyLeaderboardRecordByIndex or EOS_Leaderboards_CopyLeaderboardRecordByUserId. -
close
- Specified by:
closein interfaceAutoCloseable- Throws:
Exception
-