TogetherLeaderboard - TogetherGames/Public-Corona-Lua GitHub Wiki

The Leaderboard class represents a together Leaderboard.

The ID of the Leaderboard.

The ID of the User that created the GameInstance the Leaderboard is based on.

The ID of the Room the original GameInstance.

The number of seconds since the original GameInstance was started.

The number of seconds since the original GameInstance was finished.

The max number of users in the original GameInstance.

The index of whose turn it last was.

The ID of the User that won the original GameInstance.

Contains all the LeaderboardUsers that were playing the original GameInstance.

Gets the number of LeaderboardUsers currently managed internally.

TogetherLeaderboard:GetLeaderboardUserCount(  )

Gets the LeaderboardUser at the specified index if it exists, otherwise returns nil.

TogetherLeaderboard:GetLeaderboardUser( index )

number index

The index of the LeaderboardUser to find

Sorts the list of LeaderboardUsers by the specified property.

TogetherLeaderboard:SortBy( propertyName )

string propertyName

The name of the property to sort the list of LeaderboardUsers by

Gets the LeaderboardUser that had won the original GameInstance if it exists, otherwise returns nil.

TogetherLeaderboard:GetWinningLeaderboardUser(  )

Gets the Leaderboard's details.

TogetherLeaderboard:GetDetails( friendsOnly, callbackFunc )

boolean friendsOnly

A boolean indicating whether only Together friend Users should be retrieve.

The function to call upon completion.