com.codedisaster.steamworks

Class SteamUserStats

java.lang.Object

com.codedisaster.steamworks.SteamUserStats

public class SteamUserStats
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SteamUserStats.LeaderboardDataRequest
static class	SteamUserStats.LeaderboardDisplayType
static class	SteamUserStats.LeaderboardSortMethod
static class	SteamUserStats.LeaderboardUploadScoreMethod

Field Summary

Fields

Modifier and Type	Field and Description
protected long	callback
protected long	pointer

Constructor Summary

Constructors

Constructor and Description
SteamUserStats(SteamUserStatsCallback callback)

Method Summary

Modifier and Type	Method and Description
boolean	clearAchievement(String name)
protected static void	deleteCallback(long callback)
void	dispose()
SteamAPICall	downloadLeaderboardEntries(SteamLeaderboardHandle leaderboard, SteamUserStats.LeaderboardDataRequest leaderboardDataRequest, int rangeStart, int rangeEnd)
SteamAPICall	downloadLeaderboardEntriesForUsers(SteamLeaderboardHandle leaderboard, SteamID[] users)
SteamAPICall	findLeaderboard(String leaderboardName)
SteamAPICall	findOrCreateLeaderboard(String leaderboardName, SteamUserStats.LeaderboardSortMethod leaderboardSortMethod, SteamUserStats.LeaderboardDisplayType leaderboardDisplayType)
String	getAchievementName(int index)
boolean	getDownloadedLeaderboardEntry(SteamLeaderboardEntriesHandle leaderboardEntries, int index, SteamLeaderboardEntry entry, int[] details)
double	getGlobalStat(String name, double defaultValue)
long	getGlobalStat(String name, long defaultValue)
int	getGlobalStatHistory(String name, double[] data)
int	getGlobalStatHistory(String name, long[] data)
SteamUserStats.LeaderboardDisplayType	getLeaderboardDisplayType(SteamLeaderboardHandle leaderboard)
int	getLeaderboardEntryCount(SteamLeaderboardHandle leaderboard)
String	getLeaderboardName(SteamLeaderboardHandle leaderboard)
SteamUserStats.LeaderboardSortMethod	getLeaderboardSortMethod(SteamLeaderboardHandle leaderboard)
int	getNumAchievements()
float	getStatF(String name, float defaultValue)
int	getStatI(String name, int defaultValue)
boolean	indicateAchievementProgress(String name, int curProgress, int maxProgress)
boolean	isAchieved(String name, boolean defaultValue)
boolean	requestCurrentStats()
SteamAPICall	requestGlobalStats(int historyDays)
boolean	resetAllStats(boolean achievementsToo)
boolean	setAchievement(String name)
boolean	setStatF(String name, float value)
boolean	setStatI(String name, int value)
boolean	storeStats()
SteamAPICall	uploadLeaderboardScore(SteamLeaderboardHandle leaderboard, SteamUserStats.LeaderboardUploadScoreMethod method, int score, int[] scoreDetails)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pointer

protected final long pointer

callback

protected long callback

Constructor Detail

SteamUserStats

public SteamUserStats(SteamUserStatsCallback callback)

Method Detail

requestCurrentStats

public boolean requestCurrentStats()

getStatI

public int getStatI(String name,
                    int defaultValue)

setStatI

public boolean setStatI(String name,
                        int value)

getStatF

public float getStatF(String name,
                      float defaultValue)

setStatF

public boolean setStatF(String name,
                        float value)

isAchieved

public boolean isAchieved(String name,
                          boolean defaultValue)

setAchievement

public boolean setAchievement(String name)

clearAchievement

public boolean clearAchievement(String name)

storeStats

public boolean storeStats()

indicateAchievementProgress

public boolean indicateAchievementProgress(String name,
                                           int curProgress,
                                           int maxProgress)

getNumAchievements

public int getNumAchievements()

getAchievementName

public String getAchievementName(int index)

resetAllStats

public boolean resetAllStats(boolean achievementsToo)

findOrCreateLeaderboard

public SteamAPICall findOrCreateLeaderboard(String leaderboardName,
                                            SteamUserStats.LeaderboardSortMethod leaderboardSortMethod,
                                            SteamUserStats.LeaderboardDisplayType leaderboardDisplayType)

findLeaderboard

public SteamAPICall findLeaderboard(String leaderboardName)

getLeaderboardName

public String getLeaderboardName(SteamLeaderboardHandle leaderboard)

getLeaderboardEntryCount

public int getLeaderboardEntryCount(SteamLeaderboardHandle leaderboard)

getLeaderboardSortMethod

public SteamUserStats.LeaderboardSortMethod getLeaderboardSortMethod(SteamLeaderboardHandle leaderboard)

getLeaderboardDisplayType

public SteamUserStats.LeaderboardDisplayType getLeaderboardDisplayType(SteamLeaderboardHandle leaderboard)

downloadLeaderboardEntries

public SteamAPICall downloadLeaderboardEntries(SteamLeaderboardHandle leaderboard,
                                               SteamUserStats.LeaderboardDataRequest leaderboardDataRequest,
                                               int rangeStart,
                                               int rangeEnd)

downloadLeaderboardEntriesForUsers

public SteamAPICall downloadLeaderboardEntriesForUsers(SteamLeaderboardHandle leaderboard,
                                                       SteamID[] users)

getDownloadedLeaderboardEntry

public boolean getDownloadedLeaderboardEntry(SteamLeaderboardEntriesHandle leaderboardEntries,
                                             int index,
                                             SteamLeaderboardEntry entry,
                                             int[] details)

Parameters:

details - The array size denotes the maximum number of details returned. Check SteamLeaderboardEntry.getNumDetails() for the actual count. Can be null.

uploadLeaderboardScore

public SteamAPICall uploadLeaderboardScore(SteamLeaderboardHandle leaderboard,
                                           SteamUserStats.LeaderboardUploadScoreMethod method,
                                           int score,
                                           int[] scoreDetails)

Parameters:

scoreDetails - Can be null.

requestGlobalStats

public SteamAPICall requestGlobalStats(int historyDays)

getGlobalStat

public long getGlobalStat(String name,
                          long defaultValue)

getGlobalStat

public double getGlobalStat(String name,
                            double defaultValue)

getGlobalStatHistory

public int getGlobalStatHistory(String name,
                                long[] data)

getGlobalStatHistory

public int getGlobalStatHistory(String name,
                                double[] data)

dispose

public void dispose()

deleteCallback

protected static void deleteCallback(long callback)