Documentation

Facepunch.Steamworks.Config.ForcePlatform.md

@@ -5,5 +5,7 @@ void ForcePlatform( OperatingSystem os, Architecture arch )
 ```
 ## Summary
 ```
-No documentation available
+You can force the platform to a particular one here.
+            This is useful if you're on OSX because some versions of mono don't have a way
+            to tell which platform we're running
 ```

Facepunch.Steamworks.Inventory.CreateDefinition.md

@@ -5,5 +5,6 @@ Definition CreateDefinition( int id )
 ```
 ## Summary
 ```
-No documentation available
+Some definitions aren't sent to the client, and all aren't available on the server.
+            Manually getting a Definition here lets you call functions on those definitions.
 ```

Facepunch.Steamworks.Inventory.FindDefinition.md

@@ -5,5 +5,6 @@ Definition FindDefinition( int DefinitionId )
 ```
 ## Summary
 ```
-No documentation available
+You really need me to explain what this does?
+            Use your brains.
 ```

Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md

@@ -5,5 +5,5 @@ Single PriceCategoryToFloat( string price )
 ```
 ## Summary
 ```
-No documentation available
+Utility, given a "1;VLV250" string, convert it to a 2.5
 ```

Facepunch.Steamworks.Server.SetKey.md

@@ -5,5 +5,5 @@ void SetKey( string Key, string Value )
 ```
 ## Summary
 ```
-No documentation available
+Sets a Key Value
 ```

Facepunch.Steamworks.ServerAuth.EndSession.md

@@ -5,5 +5,5 @@ void EndSession( ulong steamid )
 ```
 ## Summary
 ```
-No documentation available
+Forget this guy. They're no longer in the game.
 ```

Facepunch.Steamworks.ServerAuth.StartSession.md

@@ -5,5 +5,5 @@ bool StartSession( byte[] data, ulong steamid )
 ```
 ## Summary
 ```
-No documentation available
+Start authorizing a ticket. This user isn't authorized yet. Wait for a call to OnAuthChange.
 ```

Facepunch.Steamworks.ServerQuery.Handle.md

@@ -5,5 +5,5 @@ void Handle( byte[] data, int size, uint address, UInt16 port )
 ```
 ## Summary
 ```
-No documentation available
+We have received a server query on our game port. Pass it to Steam to handle.
 ```

Facepunch.Steamworks.ServerStats.GetFloat.md

@@ -5,5 +5,5 @@ Single GetFloat( ulong steamid, string name, Single defaultValue )
 ```
 ## Summary
 ```
-No documentation available
+Set the named stat for this user
 ```

Facepunch.Steamworks.ServerStats.GetInt.md

@@ -5,5 +5,5 @@ int GetInt( ulong steamid, string name, int defaultValue )
 ```
 ## Summary
 ```
-No documentation available
+Set the named stat for this user
 ```

Facepunch.Steamworks.ServerStats.Refresh.md

@@ -5,5 +5,5 @@ void Refresh( ulong steamid )
 ```
 ## Summary
 ```
-No documentation available
+Retrieve the stats for this user
 ```

Facepunch.Steamworks.ServerStats.Set.md

@@ -5,5 +5,5 @@ bool Set( ulong steamid, string name, Single stat )
 ```
 ## Summary
 ```
-No documentation available
+Set the named statistic for this user
 ```

Facepunch.Steamworks.Workshop.EditItem.md

@@ -5,5 +5,7 @@ Editor EditItem( ulong itemId )
 ```
 ## Summary
 ```
-No documentation available
+Returns a class representing this ItemId. We don't query
+            item name, description etc. We don't verify that item exists.
+            We don't verify that this item belongs to your app.
 ```

Facepunch.Steamworks.Workshop.GetItem.md

@@ -5,5 +5,8 @@ Item GetItem( ulong itemid )
 ```
 ## Summary
 ```
-No documentation available
+Gets an Item object for a specific item. This doesn't currently
+            query the item's name and description. It's only really useful
+            if you know an item's ID and want to download it, or check its
+            current download status.
 ```