leaderboard - TogetherGames/Public-Unity-CSharp 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.

Finds the LeaderboardUser with the specified UserID if it exists, otherwise returns null.

Leaderboard.FindLeaderboardUserByUserID( userID )

long userID

The ID of the User to find.

Finds the LeaderboardUser with the specified LeaderboardUserID if it exists, otherwise returns null.

Leaderboard.FindLeaderboardUserByLeaderboardUserID( leaderboardUserID )

long leaderboardUserID

The ID of the LeaderboardUser to find

Gets the number of LeaderboardUsers currently managed internally.

Leaderboard.GetLeaderboardUserCount(  )

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

Leaderboard.GetLeaderboardUser( index )

int index

The index of the LeaderboardUser to find

Returns the index of the specified LeaderboardUser if it exists, otherwise returns -1.

Leaderboard.IndexOfLeaderboardUser( leaderboardUser )

LeaderboardUser leaderboardUser

Instance of the LeaderboardUser to find the index of

Returns the index of the LeaderboardUser with the specified UserID if it exists, otherwise returns -1.

Leaderboard.IndexOfLeaderboardUserByUserID( userID )

long userID

The ID of the User to find the index of

Returns the index of the Leaderboard with the specified LeaderboardID if it exists, otherwise returns -1.

Leaderboard.IndexOfLeaderboardUserByLeaderboardUserID( leaderboardUserID )

long leaderboardUserID

The ID of the LeaderboardUser to find the index of

Removes a LeaderboardUser from the internally managed list. This does not remove the user from the Leaderboard persistently.

Note
This method is deprecated

Leaderboard.RemoveLeaderboardUser( index )

int index

The index of the LeaderboardUser to remove

Gets the Leaderboard's details.

Leaderboard.GetDetails( friendsOnly, callbackFunc )

bool friendsOnly

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

The function to call upon completion.