Updated to v0.3

Garry Newman 2017-02-13 10:10:40 +00:00
parent 887a81fa90
commit 7f0c57a76e
19 changed files with 133 additions and 0 deletions

@ -0,0 +1,4 @@
# GetLeaderboard
## Method
public [[Leaderboard|Facepunch.Steamworks.Leaderboard]] **[[GetLeaderboard|Facepunch.Steamworks.Client.GetLeaderboard]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name, [[LeaderboardSortMethod|Facepunch.Steamworks.Client.LeaderboardSortMethod]] sortMethod, [[LeaderboardDisplayType|Facepunch.Steamworks.Client.LeaderboardDisplayType]] displayType );

@ -6,6 +6,7 @@
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Client.Dispose]]**( );
* public [[Leaderboard|Facepunch.Steamworks.Leaderboard]] **[[GetLeaderboard|Facepunch.Steamworks.Client.GetLeaderboard]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name, [[LeaderboardSortMethod|Facepunch.Steamworks.Client.LeaderboardSortMethod]] sortMethod, [[LeaderboardDisplayType|Facepunch.Steamworks.Client.LeaderboardDisplayType]] displayType );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunCallbacks|Facepunch.Steamworks.Client.RunCallbacks]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Client.Update]]**( );

@ -0,0 +1,10 @@
# AddScore
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AddScore|Facepunch.Steamworks.Leaderboard.AddScore]]**( [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] replaceOldScore, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] onlyIfBeatsOldScore, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] score, [[Int32[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] subscores );
### Summary
Add a score to this leaderboard.
Subscores are totally optional, and can be used for other game defined data such as laps etc.. although
they have no bearing on sorting at all.

@ -0,0 +1,4 @@
# Dispose
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Leaderboard.Dispose]]**( );

@ -0,0 +1,4 @@
# GlobalRank
## Property
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GlobalRank|Facepunch.Steamworks.Leaderboard.Entry.GlobalRank]]**;

@ -0,0 +1,9 @@
# Name
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Name|Facepunch.Steamworks.Leaderboard.Entry.Name]]**;
### Summary
Note that the player's name might not be immediately available.
If that's the case you'll have to use Friends.GetName to find the name

@ -0,0 +1,4 @@
# Score
## Property
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Score|Facepunch.Steamworks.Leaderboard.Entry.Score]]**;

@ -0,0 +1,4 @@
# SteamId
## Property
public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SteamId|Facepunch.Steamworks.Leaderboard.Entry.SteamId]]**;

@ -0,0 +1,4 @@
# SubScores
## Property
public [[Int32[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SubScores|Facepunch.Steamworks.Leaderboard.Entry.SubScores]]**;

@ -0,0 +1,13 @@
# Entry
### Summary
A single entry in a leaderboard
### Fields
* public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SteamId|Facepunch.Steamworks.Leaderboard.Entry.SteamId]]**;
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Score|Facepunch.Steamworks.Leaderboard.Entry.Score]]**;
* public [[Int32[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SubScores|Facepunch.Steamworks.Leaderboard.Entry.SubScores]]**;
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GlobalRank|Facepunch.Steamworks.Leaderboard.Entry.GlobalRank]]**;
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Name|Facepunch.Steamworks.Leaderboard.Entry.Name]]**;

@ -0,0 +1,8 @@
# FetchScores
## Method
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[FetchScores|Facepunch.Steamworks.Leaderboard.FetchScores]]**( [[RequestType|Facepunch.Steamworks.Leaderboard.RequestType]] RequestType, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] start, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] end );
### Summary
Fetch a subset of scores. The scores end up in Results.

@ -0,0 +1,9 @@
# IsError
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsError|Facepunch.Steamworks.Leaderboard.IsError]]** { get; set; }
### Summary
Returns true if we asked steam about this board but it returned
an error.

@ -0,0 +1,8 @@
# IsQuerying
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsQuerying|Facepunch.Steamworks.Leaderboard.IsQuerying]]** { get; set; }
### Summary
Returns true if we're querying scores

@ -0,0 +1,9 @@
# IsValid
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.Leaderboard.IsValid]]** { get; set; }
### Summary
Returns true if this board is valid, ie, we've received
a positive response from Steam about it.

@ -0,0 +1,8 @@
# Name
## Property
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Name|Facepunch.Steamworks.Leaderboard.Name]]** { get; set; }
### Summary
The name of this board, as retrieved from Steam

@ -0,0 +1,8 @@
# Results
## Property
public [[Entry[]|Facepunch.Steamworks.Leaderboard.Entry]] **[[Results|Facepunch.Steamworks.Leaderboard.Results]]**;
### Summary
The results from the last query. Can be null.

@ -0,0 +1,8 @@
# TotalEntries
## Property
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[TotalEntries|Facepunch.Steamworks.Leaderboard.TotalEntries]]** { get; set; }
### Summary
The total number of entries on this board

@ -0,0 +1,17 @@
# Leaderboard
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AddScore|Facepunch.Steamworks.Leaderboard.AddScore]]**( [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] replaceOldScore, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] onlyIfBeatsOldScore, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] score, [[Int32[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] subscores );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Leaderboard.Dispose]]**( );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[FetchScores|Facepunch.Steamworks.Leaderboard.FetchScores]]**( [[RequestType|Facepunch.Steamworks.Leaderboard.RequestType]] RequestType, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] start, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] end );
### Properties
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsError|Facepunch.Steamworks.Leaderboard.IsError]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsQuerying|Facepunch.Steamworks.Leaderboard.IsQuerying]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.Leaderboard.IsValid]]** { get; set; }
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Name|Facepunch.Steamworks.Leaderboard.Name]]** { get; set; }
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[TotalEntries|Facepunch.Steamworks.Leaderboard.TotalEntries]]** { get; set; }
### Fields
* public [[Entry[]|Facepunch.Steamworks.Leaderboard.Entry]] **[[Results|Facepunch.Steamworks.Leaderboard.Results]]**;

@ -3,6 +3,7 @@
## Facepunch.Steamworks
* [[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks]]
* [[Leaderboard|Facepunch.Steamworks.Leaderboard]]
* [[Inventory|Facepunch.Steamworks.Inventory]]
* [[Networking|Facepunch.Steamworks.Networking]]
* [[Client|Facepunch.Steamworks.Client]]