From fab4cf40405750e00f9ed615b0052945f0d7fca1 Mon Sep 17 00:00:00 2001 From: Garry Newman Date: Wed, 2 Nov 2016 20:46:00 +0000 Subject: [PATCH] Documentation --- Facepunch.Steamworks.Config.ForcePlatform.md | 4 +++- Facepunch.Steamworks.Inventory.CreateDefinition.md | 3 ++- Facepunch.Steamworks.Inventory.FindDefinition.md | 3 ++- Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md | 2 +- Facepunch.Steamworks.Server.SetKey.md | 2 +- Facepunch.Steamworks.ServerAuth.EndSession.md | 2 +- Facepunch.Steamworks.ServerAuth.StartSession.md | 2 +- Facepunch.Steamworks.ServerQuery.Handle.md | 2 +- Facepunch.Steamworks.ServerStats.GetFloat.md | 2 +- Facepunch.Steamworks.ServerStats.GetInt.md | 2 +- Facepunch.Steamworks.ServerStats.Refresh.md | 2 +- Facepunch.Steamworks.ServerStats.Set.md | 2 +- Facepunch.Steamworks.Workshop.EditItem.md | 4 +++- Facepunch.Steamworks.Workshop.GetItem.md | 5 ++++- 14 files changed, 23 insertions(+), 14 deletions(-) diff --git a/Facepunch.Steamworks.Config.ForcePlatform.md b/Facepunch.Steamworks.Config.ForcePlatform.md index abc3568..eed7a1a 100644 --- a/Facepunch.Steamworks.Config.ForcePlatform.md +++ b/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 ``` diff --git a/Facepunch.Steamworks.Inventory.CreateDefinition.md b/Facepunch.Steamworks.Inventory.CreateDefinition.md index 01d08f7..89b93fc 100644 --- a/Facepunch.Steamworks.Inventory.CreateDefinition.md +++ b/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. ``` diff --git a/Facepunch.Steamworks.Inventory.FindDefinition.md b/Facepunch.Steamworks.Inventory.FindDefinition.md index 209ae7b..d9e0b12 100644 --- a/Facepunch.Steamworks.Inventory.FindDefinition.md +++ b/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. ``` diff --git a/Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md b/Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md index 7bcb9b5..18b0c60 100644 --- a/Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md +++ b/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 ``` diff --git a/Facepunch.Steamworks.Server.SetKey.md b/Facepunch.Steamworks.Server.SetKey.md index 1d31cf8..6fdda74 100644 --- a/Facepunch.Steamworks.Server.SetKey.md +++ b/Facepunch.Steamworks.Server.SetKey.md @@ -5,5 +5,5 @@ void SetKey( string Key, string Value ) ``` ## Summary ``` -No documentation available +Sets a Key Value ``` diff --git a/Facepunch.Steamworks.ServerAuth.EndSession.md b/Facepunch.Steamworks.ServerAuth.EndSession.md index 10cb56a..224487e 100644 --- a/Facepunch.Steamworks.ServerAuth.EndSession.md +++ b/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. ``` diff --git a/Facepunch.Steamworks.ServerAuth.StartSession.md b/Facepunch.Steamworks.ServerAuth.StartSession.md index 1346242..21ed2e3 100644 --- a/Facepunch.Steamworks.ServerAuth.StartSession.md +++ b/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. ``` diff --git a/Facepunch.Steamworks.ServerQuery.Handle.md b/Facepunch.Steamworks.ServerQuery.Handle.md index 7cf2063..115c58c 100644 --- a/Facepunch.Steamworks.ServerQuery.Handle.md +++ b/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. ``` diff --git a/Facepunch.Steamworks.ServerStats.GetFloat.md b/Facepunch.Steamworks.ServerStats.GetFloat.md index 3a32e42..ac91010 100644 --- a/Facepunch.Steamworks.ServerStats.GetFloat.md +++ b/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 ``` diff --git a/Facepunch.Steamworks.ServerStats.GetInt.md b/Facepunch.Steamworks.ServerStats.GetInt.md index 9c9148b..40c5ff4 100644 --- a/Facepunch.Steamworks.ServerStats.GetInt.md +++ b/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 ``` diff --git a/Facepunch.Steamworks.ServerStats.Refresh.md b/Facepunch.Steamworks.ServerStats.Refresh.md index 04f9937..c81e9e5 100644 --- a/Facepunch.Steamworks.ServerStats.Refresh.md +++ b/Facepunch.Steamworks.ServerStats.Refresh.md @@ -5,5 +5,5 @@ void Refresh( ulong steamid ) ``` ## Summary ``` -No documentation available +Retrieve the stats for this user ``` diff --git a/Facepunch.Steamworks.ServerStats.Set.md b/Facepunch.Steamworks.ServerStats.Set.md index 479cd57..3fe834c 100644 --- a/Facepunch.Steamworks.ServerStats.Set.md +++ b/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 ``` diff --git a/Facepunch.Steamworks.Workshop.EditItem.md b/Facepunch.Steamworks.Workshop.EditItem.md index 4a69d1f..f7322e4 100644 --- a/Facepunch.Steamworks.Workshop.EditItem.md +++ b/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. ``` diff --git a/Facepunch.Steamworks.Workshop.GetItem.md b/Facepunch.Steamworks.Workshop.GetItem.md index a3648a5..cb26235 100644 --- a/Facepunch.Steamworks.Workshop.GetItem.md +++ b/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. ```