host.anzo.eossdk.eos.sdk.leaderboards

Class EOS_Leaderboards_LeaderboardRecord

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.leaderboards.EOS_Leaderboards_LeaderboardRecord

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Leaderboards_LeaderboardRecord.ByReference, EOS_Leaderboards_LeaderboardRecord.ByValue

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

Contains information about a single leaderboard record

Since:

8/21/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Leaderboards_LeaderboardRecord.ByReference
static class	EOS_Leaderboards_LeaderboardRecord.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_LEADERBOARDRECORD_API_LATEST.
static int	EOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST The most recent version of the EOS_Leaderboards_LeaderboardRecord struct.
int	Rank Sorted position on leaderboard
int	Score Leaderboard score
java.lang.String	UserDisplayName The latest display name seen for the user since they last time logged in.
EOS_ProductUserId	UserId The Product User ID associated with this record

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

Method Summary

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

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_LEADERBOARDRECORD_API_LATEST

public static final int EOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST

The most recent version of the EOS_Leaderboards_LeaderboardRecord struct.

See Also:

Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_LEADERBOARDS_LEADERBOARDRECORD_API_LATEST.

UserId

public EOS_ProductUserId UserId

The Product User ID associated with this record

Rank

public int Rank

Sorted position on leaderboard

Score

public int Score

Leaderboard score

UserDisplayName

public java.lang.String 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 Detail

EOS_Leaderboards_LeaderboardRecord

public EOS_Leaderboards_LeaderboardRecord()

EOS_Leaderboards_LeaderboardRecord

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

Method Detail

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.

See Also:

EOS_Leaderboards_LeaderboardRecord, EOS_Leaderboards_Interface.copyLeaderboardRecordByIndex(EOS_Leaderboards_CopyLeaderboardRecordByIndexOptions), EOS_Leaderboards_Interface.copyLeaderboardRecordByUserId(EOS_Leaderboards_CopyLeaderboardRecordByUserIdOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception