Latest docs

Facepunch.Steamworks.BaseSteamworks.IsValid.md

@@ -5,5 +5,6 @@ bool IsValid
 ```
 ## Summary
 ```
-No documentation available
+Returns true if this instance has initialized properly.
+            If this returns false you should Dispose and throw an error.
 ```

Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md

@@ -0,0 +1,9 @@
+# UpdateWhile
+## Method
+```
+void UpdateWhile( Func\<bool\> func )
+```
+## Summary
+```
+No documentation available
+```

Facepunch.Steamworks.BaseSteamworks.md

@@ -2,12 +2,12 @@
 
 ### Summary
 ```
-No documentation available
+Implements shared functionality between Steamworks.Client and Steamworks.Server
 ```
 ### Methods
 * **void** [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]](  )
-* **void** [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]](  )
 * **void** [[Update|Facepunch.Steamworks.BaseSteamworks.Update]](  )
+* **void** [[UpdateWhile|Facepunch.Steamworks.BaseSteamworks.UpdateWhile]]( **Func\<bool\>** func )
 
 ### Properties
 * **uint** [[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]]
@@ -17,5 +17,3 @@ No documentation available
 * **Workshop** [[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]]
 
 ### Fields
-* **Action\<MessageType, string\>** [[OnMessage|Facepunch.Steamworks.BaseSteamworks.OnMessage]]
-* **Action** [[OnUpdate|Facepunch.Steamworks.BaseSteamworks.OnUpdate]]

Facepunch.Steamworks.Client.BetaName.md

@@ -5,5 +5,5 @@ string BetaName
 ```
 ## Summary
 ```
-Current Beta name, if ser
+Current Beta name, if we're using a beta branch.
 ```

Facepunch.Steamworks.Client.Dispose.md

@@ -5,5 +5,5 @@ void Dispose(  )
 ```
 ## Summary
 ```
-No documentation available
+Call when finished to shut down the Steam client.
 ```

Facepunch.Steamworks.Client.IsValid.md

@@ -5,5 +5,6 @@ bool IsValid
 ```
 ## Summary
 ```
-No documentation available
+Returns true if this instance has initialized properly.
+            If this returns false you should Dispose and throw an error.
 ```

Facepunch.Steamworks.Client.md

@@ -27,5 +27,3 @@ No documentation available
 * **Workshop** [[Workshop|Facepunch.Steamworks.Client.Workshop]]
 
 ### Fields
-* **Action\<MessageType, string\>** [[OnMessage|Facepunch.Steamworks.Client.OnMessage]]
-* **Action** [[OnUpdate|Facepunch.Steamworks.Client.OnUpdate]]

Facepunch.Steamworks.Editor.Progress.md

@@ -1,7 +1,7 @@
 # Progress
 ## Property
 ```
-Double Progress
+double Progress
 ```
 ## Summary
 ```

Facepunch.Steamworks.Editor.md

@@ -18,7 +18,7 @@ No documentation available
 * **ulong** [[Id|Facepunch.Steamworks.Editor.Id]]
 * **bool** [[NeedToAgreeToWorkshopLegal|Facepunch.Steamworks.Editor.NeedToAgreeToWorkshopLegal]]
 * **string** [[PreviewImage|Facepunch.Steamworks.Editor.PreviewImage]]
-* **Double** [[Progress|Facepunch.Steamworks.Editor.Progress]]
+* **double** [[Progress|Facepunch.Steamworks.Editor.Progress]]
 * **bool** [[Publishing|Facepunch.Steamworks.Editor.Publishing]]
 * **List\<string\>** [[Tags|Facepunch.Steamworks.Editor.Tags]]
 * **string** [[Title|Facepunch.Steamworks.Editor.Title]]

Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md

@@ -1,7 +1,7 @@
 # PriceCategoryToFloat
 ## Method
 ```
-Single PriceCategoryToFloat( string price )
+float PriceCategoryToFloat( string price )
 ```
 ## Summary
 ```

Facepunch.Steamworks.Inventory.md

@@ -10,7 +10,7 @@ No documentation available
 * **void** [[Dispose|Facepunch.Steamworks.Inventory.Dispose]](  )
 * **Definition** [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( **int** DefinitionId )
 * **void** [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]](  )
-* **Single** [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( **string** price )
+* **float** [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( **string** price )
 * **void** [[Refresh|Facepunch.Steamworks.Inventory.Refresh]](  )
 
 ### Properties

Facepunch.Steamworks.Item.DownloadProgress.md

@@ -1,7 +1,7 @@
 # DownloadProgress
 ## Property
 ```
-Double DownloadProgress
+double DownloadProgress
 ```
 ## Summary
 ```

Facepunch.Steamworks.Item.Score.md

@@ -1,7 +1,7 @@
 # Score
 ## Property
 ```
-Single Score
+float Score
 ```
 ## Summary
 ```

Facepunch.Steamworks.Item.md

@@ -21,7 +21,7 @@ No documentation available
 * **string** [[DiscussUrl|Facepunch.Steamworks.Item.DiscussUrl]]
 * **bool** [[Downloading|Facepunch.Steamworks.Item.Downloading]]
 * **bool** [[DownloadPending|Facepunch.Steamworks.Item.DownloadPending]]
-* **Double** [[DownloadProgress|Facepunch.Steamworks.Item.DownloadProgress]]
+* **double** [[DownloadProgress|Facepunch.Steamworks.Item.DownloadProgress]]
 * **int** [[FavouriteCount|Facepunch.Steamworks.Item.FavouriteCount]]
 * **int** [[FollowerCount|Facepunch.Steamworks.Item.FollowerCount]]
 * **ulong** [[Id|Facepunch.Steamworks.Item.Id]]
@@ -32,7 +32,7 @@ No documentation available
 * **string** [[OwnerName|Facepunch.Steamworks.Item.OwnerName]]
 * **string** [[PreviewImageUrl|Facepunch.Steamworks.Item.PreviewImageUrl]]
 * **int** [[ReportScore|Facepunch.Steamworks.Item.ReportScore]]
-* **Single** [[Score|Facepunch.Steamworks.Item.Score]]
+* **float** [[Score|Facepunch.Steamworks.Item.Score]]
 * **ulong** [[Size|Facepunch.Steamworks.Item.Size]]
 * **string** [[StartsUrl|Facepunch.Steamworks.Item.StartsUrl]]
 * **bool** [[Subscribed|Facepunch.Steamworks.Item.Subscribed]]

Facepunch.Steamworks.Networking.SetListenChannel.md

@@ -0,0 +1,11 @@
+# SetListenChannel
+## Method
+```
+void SetListenChannel( int ChannelId, bool Listen )
+```
+## Summary
+```
+Enable or disable listening on a specific channel.
+            If you donp't enable the channel we won't listen to it,
+            so you won't be able to receive messages on it.
+```

Facepunch.Steamworks.Networking.md

@@ -7,6 +7,7 @@ No documentation available
 ### Methods
 * **void** [[Dispose|Facepunch.Steamworks.Networking.Dispose]](  )
 * **bool** [[SendP2PPacket|Facepunch.Steamworks.Networking.SendP2PPacket]]( **ulong** steamid, **byte[]** data, **int** length, **SendType** eP2PSendType, **int** nChannel )
+* **void** [[SetListenChannel|Facepunch.Steamworks.Networking.SetListenChannel]]( **int** ChannelId, **bool** Listen )
 
 ### Properties
 

Facepunch.Steamworks.Result.Block.md

@@ -1,7 +1,7 @@
 # Block
 ## Method
 ```
-bool Block( Single maxWait )
+bool Block( float maxWait )
 ```
 ## Summary
 ```

Facepunch.Steamworks.Result.md

@@ -5,7 +5,7 @@
 No documentation available
 ```
 ### Methods
-* **bool** [[Block|Facepunch.Steamworks.Result.Block]]( **Single** maxWait )
+* **bool** [[Block|Facepunch.Steamworks.Result.Block]]( **float** maxWait )
 * **void** [[Dispose|Facepunch.Steamworks.Result.Dispose]](  )
 
 ### Properties

Facepunch.Steamworks.Server.Dispose.md

@@ -0,0 +1,9 @@
+# Dispose
+## Method
+```
+void Dispose(  )
+```
+## Summary
+```
+Shutdown interface, disconnect from Steam
+```

Facepunch.Steamworks.Server.GameTags.md

@@ -5,5 +5,6 @@ string GameTags
 ```
 ## Summary
 ```
-Gets or sets the current GameTags
+Gets or sets the current GameTags. This is a comma seperated list of tags for this server.
+            When querying the server list you can filter by these tags.
 ```

Facepunch.Steamworks.Server.IsValid.md

@@ -5,5 +5,6 @@ bool IsValid
 ```
 ## Summary
 ```
-No documentation available
+Returns true if this instance has initialized properly.
+            If this returns false you should Dispose and throw an error.
 ```

Facepunch.Steamworks.Server.LogOnAnonymous.md

@@ -5,5 +5,5 @@ void LogOnAnonymous(  )
 ```
 ## Summary
 ```
-Log onto Steam anonymously
+Log onto Steam anonymously.
 ```

Facepunch.Steamworks.Server.LoggedOn.md

@@ -5,5 +5,6 @@ bool LoggedOn
 ```
 ## Summary
 ```
-No documentation available
+Returns true if the server is connected and registered with the Steam master server
+            You should have called LogOnAnonymous etc on startup.
 ```

Facepunch.Steamworks.Server.Product.md

@@ -5,5 +5,5 @@ string Product
 ```
 ## Summary
 ```
-Gets or sets the current Product
+Gets or sets the current product. This isn't really used.
 ```

Facepunch.Steamworks.Server.PublicIp.md

@@ -0,0 +1,11 @@
+# PublicIp
+## Property
+```
+IPAddress PublicIp
+```
+## Summary
+```
+To the best of its ability this tries to get the server's
+            current public ip address. Be aware that this is likely to return
+            null for the first few seconds after initialization.
+```

Facepunch.Steamworks.Server.SetKey.md

@@ -5,5 +5,8 @@ void SetKey( string Key, string Value )
 ```
 ## Summary
 ```
-Sets a Key Value
+Sets a Key Value. These can be anything you like, and are accessible
+            when querying servers from the server list.
+            
+            Information describing gamemodes are common here.
 ```

Facepunch.Steamworks.Server.UpdatePlayer.md

@@ -5,5 +5,7 @@ void UpdatePlayer( ulong steamid, string name, int score )
 ```
 ## Summary
 ```
-No documentation available
+Update this connected player's information. You should really call this
+            any time a player's name or score changes. This keeps the information shown
+            to server queries up to date.
 ```

Facepunch.Steamworks.Server.md

@@ -2,7 +2,9 @@
 
 ### Summary
 ```
-No documentation available
+Initialize this class for Game Servers.
+            
+            Game servers offer a limited amount of Steam functionality - and don't require the Steam client.
 ```
 ### Methods
 * **void** [[FetchRules|Facepunch.Steamworks.Server.FetchRules]](  )

Facepunch.Steamworks.ServerQuery.md

@@ -2,7 +2,7 @@
 
 ### Summary
 ```
-No documentation available
+If you're manually processing the server queries, you should use this class.
 ```
 ### Methods
 * **bool** [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( **Packet&** packet )

Facepunch.Steamworks.ServerStats.Commit.md

@@ -1,7 +1,7 @@
 # Commit
 ## Method
 ```
-void Commit( ulong steamid )
+void Commit( ulong steamid, Action\<bool\> Callback )
 ```
 ## Summary
 ```

Facepunch.Steamworks.ServerStats.GetFloat.md

@@ -1,9 +1,11 @@
 # GetFloat
 ## Method
 ```
-Single GetFloat( ulong steamid, string name, Single defaultValue )
+float GetFloat( ulong steamid, string name, float defaultValue )
 ```
 ## Summary
 ```
-Set the named stat for this user
+Get the named stat for this user. If getting the stat failed, will return
+            defaultValue. You should have called Refresh for this userid - which downloads
+            the stats from the backend. If you didn't call it this will always return defaultValue.
 ```

Facepunch.Steamworks.ServerStats.GetInt.md

@@ -5,5 +5,7 @@ int GetInt( ulong steamid, string name, int defaultValue )
 ```
 ## Summary
 ```
-Set the named stat for this user
+Get the named stat for this user. If getting the stat failed, will return
+            defaultValue. You should have called Refresh for this userid - which downloads
+            the stats from the backend. If you didn't call it this will always return defaultValue.
 ```

Facepunch.Steamworks.ServerStats.Refresh.md

@@ -1,9 +1,9 @@
 # Refresh
 ## Method
 ```
-void Refresh( ulong steamid )
+void Refresh( ulong steamid, Action\<bool\> Callback )
 ```
 ## Summary
 ```
-Retrieve the stats for this user
+No documentation available
 ```

Facepunch.Steamworks.ServerStats.Set.md

@@ -1,9 +1,10 @@
 # Set
 ## Method
 ```
-bool Set( ulong steamid, string name, Single stat )
+bool Set( ulong steamid, string name, float stat )
 ```
 ## Summary
 ```
-Set the named statistic for this user
+Set the named stat for this user. Setting stats should follow the rules
+            you defined in Steamworks.
 ```

Facepunch.Steamworks.ServerStats.md

@@ -2,15 +2,16 @@
 
 ### Summary
 ```
-No documentation available
+Allows getting and setting stats on users from the gameserver. These stats
+            should have been set up on the Steamworks website for your app.
 ```
 ### Methods
-* **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid )
-* **Single** [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( **ulong** steamid, **string** name, **Single** defaultValue )
+* **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid, **Action\<bool\>** Callback )
+* **float** [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( **ulong** steamid, **string** name, **float** defaultValue )
 * **int** [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( **ulong** steamid, **string** name, **int** defaultValue )
-* **void** [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( **ulong** steamid )
+* **void** [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( **ulong** steamid, **Action\<bool\>** Callback )
 * **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **int** stat )
-* **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **Single** stat )
+* **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **float** stat )
 
 ### Properties
 

Facepunch.Steamworks.Stats.GetFloat.md

@@ -1,7 +1,7 @@
 # GetFloat
 ## Method
 ```
-Single GetFloat( string name )
+float GetFloat( string name )
 ```
 ## Summary
 ```

Facepunch.Steamworks.Stats.GetGlobalFloat.md

@@ -1,7 +1,7 @@
 # GetGlobalFloat
 ## Method
 ```
-Double GetGlobalFloat( string name )
+double GetGlobalFloat( string name )
 ```
 ## Summary
 ```

Facepunch.Steamworks.Stats.md

@@ -5,8 +5,8 @@
 No documentation available
 ```
 ### Methods
-* **Single** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name )
-* **Double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name )
+* **float** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name )
+* **double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name )
 * **Int64** [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( **string** name )
 * **int** [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( **string** name )
 * **void** [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( **int** days )