diff --git a/Generated/Facepunch.Steamworks.Client.GetLeaderboard.md b/Generated/Facepunch.Steamworks.Client.GetLeaderboard.md new file mode 100644 index 0000000..4c08fb7 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Client.GetLeaderboard.md @@ -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 ); + diff --git a/Generated/Facepunch.Steamworks.Client.md b/Generated/Facepunch.Steamworks.Client.md index cfcecfc..bd55abd 100644 --- a/Generated/Facepunch.Steamworks.Client.md +++ b/Generated/Facepunch.Steamworks.Client.md @@ -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]]**( ); diff --git a/Generated/Facepunch.Steamworks.Leaderboard.AddScore.md b/Generated/Facepunch.Steamworks.Leaderboard.AddScore.md new file mode 100644 index 0000000..bc9f389 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.AddScore.md @@ -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. + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Dispose.md b/Generated/Facepunch.Steamworks.Leaderboard.Dispose.md new file mode 100644 index 0000000..660d52f --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Dispose.md @@ -0,0 +1,4 @@ +# Dispose +## Method +public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Leaderboard.Dispose]]**( ); + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Entry.GlobalRank.md b/Generated/Facepunch.Steamworks.Leaderboard.Entry.GlobalRank.md new file mode 100644 index 0000000..e15f88c --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Entry.GlobalRank.md @@ -0,0 +1,4 @@ +# GlobalRank +## Property +public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GlobalRank|Facepunch.Steamworks.Leaderboard.Entry.GlobalRank]]**; + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Entry.Name.md b/Generated/Facepunch.Steamworks.Leaderboard.Entry.Name.md new file mode 100644 index 0000000..40e2143 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Entry.Name.md @@ -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 + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Entry.Score.md b/Generated/Facepunch.Steamworks.Leaderboard.Entry.Score.md new file mode 100644 index 0000000..c304081 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Entry.Score.md @@ -0,0 +1,4 @@ +# Score +## Property +public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Score|Facepunch.Steamworks.Leaderboard.Entry.Score]]**; + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Entry.SteamId.md b/Generated/Facepunch.Steamworks.Leaderboard.Entry.SteamId.md new file mode 100644 index 0000000..df6d845 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Entry.SteamId.md @@ -0,0 +1,4 @@ +# SteamId +## Property +public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SteamId|Facepunch.Steamworks.Leaderboard.Entry.SteamId]]**; + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Entry.SubScores.md b/Generated/Facepunch.Steamworks.Leaderboard.Entry.SubScores.md new file mode 100644 index 0000000..cd7d73a --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Entry.SubScores.md @@ -0,0 +1,4 @@ +# SubScores +## Property +public [[Int32[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SubScores|Facepunch.Steamworks.Leaderboard.Entry.SubScores]]**; + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Entry.md b/Generated/Facepunch.Steamworks.Leaderboard.Entry.md new file mode 100644 index 0000000..ac24dbf --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Entry.md @@ -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]]**; diff --git a/Generated/Facepunch.Steamworks.Leaderboard.FetchScores.md b/Generated/Facepunch.Steamworks.Leaderboard.FetchScores.md new file mode 100644 index 0000000..4be22a8 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.FetchScores.md @@ -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. + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.IsError.md b/Generated/Facepunch.Steamworks.Leaderboard.IsError.md new file mode 100644 index 0000000..03b4c5c --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.IsError.md @@ -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. + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.IsQuerying.md b/Generated/Facepunch.Steamworks.Leaderboard.IsQuerying.md new file mode 100644 index 0000000..69c42e0 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.IsQuerying.md @@ -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 + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.IsValid.md b/Generated/Facepunch.Steamworks.Leaderboard.IsValid.md new file mode 100644 index 0000000..9942fab --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.IsValid.md @@ -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. + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Name.md b/Generated/Facepunch.Steamworks.Leaderboard.Name.md new file mode 100644 index 0000000..4d80c4c --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Name.md @@ -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 + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.Results.md b/Generated/Facepunch.Steamworks.Leaderboard.Results.md new file mode 100644 index 0000000..09e77d7 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.Results.md @@ -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. + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.TotalEntries.md b/Generated/Facepunch.Steamworks.Leaderboard.TotalEntries.md new file mode 100644 index 0000000..fda6bc4 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.TotalEntries.md @@ -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 + + diff --git a/Generated/Facepunch.Steamworks.Leaderboard.md b/Generated/Facepunch.Steamworks.Leaderboard.md new file mode 100644 index 0000000..3927800 --- /dev/null +++ b/Generated/Facepunch.Steamworks.Leaderboard.md @@ -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]]**; diff --git a/Generated/Facepunch.Steamworks.md b/Generated/Facepunch.Steamworks.md index af899d0..bfdb756 100644 --- a/Generated/Facepunch.Steamworks.md +++ b/Generated/Facepunch.Steamworks.md @@ -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]]