From 5a2f068e93995dac636ad30e4e83310bb2ece728 Mon Sep 17 00:00:00 2001 From: Garry Newman Date: Fri, 4 Nov 2016 20:57:34 +0000 Subject: [PATCH] Format descriptions --- Facepunch.Steamworks.App.BuildId.md | 6 +++--- ...unch.Steamworks.Auth.GetAuthSessionTicket.md | 4 ++-- Facepunch.Steamworks.BaseSteamworks.IsValid.md | 2 +- Facepunch.Steamworks.Client.IsValid.md | 2 +- Facepunch.Steamworks.Config.ForcePlatform.md | 4 ++-- Facepunch.Steamworks.Config.UseThisCall.md | 9 ++++----- ...nch.Steamworks.Inventory.CreateDefinition.md | 2 +- Facepunch.Steamworks.Inventory.Definitions.md | 4 ++-- ...punch.Steamworks.Inventory.FindDefinition.md | 2 +- Facepunch.Steamworks.Inventory.Items.md | 4 ++-- Facepunch.Steamworks.Inventory.OnUpdate.md | 2 +- ...ch.Steamworks.Inventory.PlaytimeHeartbeat.md | 6 +++--- Facepunch.Steamworks.Inventory.Refresh.md | 4 ++-- ...unch.Steamworks.Inventory.SerializedItems.md | 2 +- ...ch.Steamworks.Networking.SetListenChannel.md | 4 ++-- Facepunch.Steamworks.Server.BotCount.md | 4 ++-- Facepunch.Steamworks.Server.GameTags.md | 2 +- Facepunch.Steamworks.Server.IsValid.md | 2 +- Facepunch.Steamworks.Server.LoggedOn.md | 2 +- Facepunch.Steamworks.Server.MaxPlayers.md | 4 ++-- Facepunch.Steamworks.Server.PublicIp.md | 4 ++-- Facepunch.Steamworks.Server.Server.2.md | 2 +- Facepunch.Steamworks.Server.SetKey.md | 5 ++--- Facepunch.Steamworks.Server.UpdatePlayer.md | 4 ++-- Facepunch.Steamworks.Server.md | 11 ++++------- Facepunch.Steamworks.ServerList.Favourites.md | 2 +- Facepunch.Steamworks.ServerList.History.md | 2 +- ....Steamworks.ServerQuery.GetOutgoingPacket.md | 2 +- Facepunch.Steamworks.ServerStats.GetFloat.md | 4 ++-- Facepunch.Steamworks.ServerStats.GetInt.md | 4 ++-- Facepunch.Steamworks.ServerStats.Set.md | 2 +- Facepunch.Steamworks.ServerStats.md | 2 +- Facepunch.Steamworks.Voice.WantsRecording.md | 4 ++-- Facepunch.Steamworks.Voice.md | 3 --- Facepunch.Steamworks.Workshop.CreateItem.md | 2 +- Facepunch.Steamworks.Workshop.CreateQuery.md | 5 ++--- Facepunch.Steamworks.Workshop.EditItem.md | 4 ++-- Facepunch.Steamworks.Workshop.GetItem.md | 6 +++--- Facepunch.Steamworks.Workshop.md | 17 +++++++---------- 39 files changed, 72 insertions(+), 84 deletions(-) diff --git a/Facepunch.Steamworks.App.BuildId.md b/Facepunch.Steamworks.App.BuildId.md index 55a83b7..9096ed8 100644 --- a/Facepunch.Steamworks.App.BuildId.md +++ b/Facepunch.Steamworks.App.BuildId.md @@ -5,7 +5,7 @@ int BuildId ``` ## Summary ``` -Returns the current BuildId of the game. - This is pretty useless, as it isn't guarenteed to return - the build id you're playing, or the latest build id. +Returns the current BuildId of the game. +This is pretty useless, as it isn't guarenteed to return +the build id you're playing, or the latest build id. ``` diff --git a/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md b/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md index ccdd079..aa15189 100644 --- a/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md +++ b/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md @@ -5,6 +5,6 @@ Ticket GetAuthSessionTicket( ) ``` ## Summary ``` -Creates an auth ticket. - Which you can send to a server to authenticate that you are who you say you are. +Creates an auth ticket. +Which you can send to a server to authenticate that you are who you say you are. ``` diff --git a/Facepunch.Steamworks.BaseSteamworks.IsValid.md b/Facepunch.Steamworks.BaseSteamworks.IsValid.md index a2a0af7..f159296 100644 --- a/Facepunch.Steamworks.BaseSteamworks.IsValid.md +++ b/Facepunch.Steamworks.BaseSteamworks.IsValid.md @@ -6,5 +6,5 @@ bool IsValid ## Summary ``` Returns true if this instance has initialized properly. - If this returns false you should Dispose and throw an error. +If this returns false you should Dispose and throw an error. ``` diff --git a/Facepunch.Steamworks.Client.IsValid.md b/Facepunch.Steamworks.Client.IsValid.md index a2a0af7..f159296 100644 --- a/Facepunch.Steamworks.Client.IsValid.md +++ b/Facepunch.Steamworks.Client.IsValid.md @@ -6,5 +6,5 @@ bool IsValid ## Summary ``` Returns true if this instance has initialized properly. - If this returns false you should Dispose and throw an error. +If this returns false you should Dispose and throw an error. ``` diff --git a/Facepunch.Steamworks.Config.ForcePlatform.md b/Facepunch.Steamworks.Config.ForcePlatform.md index eed7a1a..2ec3e78 100644 --- a/Facepunch.Steamworks.Config.ForcePlatform.md +++ b/Facepunch.Steamworks.Config.ForcePlatform.md @@ -6,6 +6,6 @@ void ForcePlatform( OperatingSystem os, Architecture arch ) ## Summary ``` 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 +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.Config.UseThisCall.md b/Facepunch.Steamworks.Config.UseThisCall.md index b0cb105..bf48bf1 100644 --- a/Facepunch.Steamworks.Config.UseThisCall.md +++ b/Facepunch.Steamworks.Config.UseThisCall.md @@ -6,9 +6,8 @@ bool UseThisCall ## Summary ``` Some platforms allow/need CallingConvention.ThisCall. If you're crashing with argument null - errors on certain platforms, try flipping this to true. - - I owe this logic to Riley Labrecque's hard work on Steamworks.net - I don't have the knowledge - or patience to find this shit on my own, so massive thanks to him. And also massive thanks to him - for releasing his shit open source under the MIT license so we can all learn and iterate. +errors on certain platforms, try flipping this to true. +I owe this logic to Riley Labrecque's hard work on Steamworks.net - I don't have the knowledge +or patience to find this shit on my own, so massive thanks to him. And also massive thanks to him +for releasing his shit open source under the MIT license so we can all learn and iterate. ``` diff --git a/Facepunch.Steamworks.Inventory.CreateDefinition.md b/Facepunch.Steamworks.Inventory.CreateDefinition.md index 89b93fc..418140f 100644 --- a/Facepunch.Steamworks.Inventory.CreateDefinition.md +++ b/Facepunch.Steamworks.Inventory.CreateDefinition.md @@ -6,5 +6,5 @@ Definition CreateDefinition( int id ) ## Summary ``` 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. +Manually getting a Definition here lets you call functions on those definitions. ``` diff --git a/Facepunch.Steamworks.Inventory.Definitions.md b/Facepunch.Steamworks.Inventory.Definitions.md index 97fd687..d69f67a 100644 --- a/Facepunch.Steamworks.Inventory.Definitions.md +++ b/Facepunch.Steamworks.Inventory.Definitions.md @@ -5,6 +5,6 @@ Definition[] Definitions ``` ## Summary ``` -A list of items defined for this app. - This should be immediately populated and available. +A list of items defined for this app. +This should be immediately populated and available. ``` diff --git a/Facepunch.Steamworks.Inventory.FindDefinition.md b/Facepunch.Steamworks.Inventory.FindDefinition.md index d9e0b12..457b7d3 100644 --- a/Facepunch.Steamworks.Inventory.FindDefinition.md +++ b/Facepunch.Steamworks.Inventory.FindDefinition.md @@ -6,5 +6,5 @@ Definition FindDefinition( int DefinitionId ) ## Summary ``` You really need me to explain what this does? - Use your brains. +Use your brains. ``` diff --git a/Facepunch.Steamworks.Inventory.Items.md b/Facepunch.Steamworks.Inventory.Items.md index e0dbae2..a0b972d 100644 --- a/Facepunch.Steamworks.Inventory.Items.md +++ b/Facepunch.Steamworks.Inventory.Items.md @@ -5,6 +5,6 @@ Item[] Items ``` ## Summary ``` -A list of items owned by this user. You should call Refresh() before trying to access this, - and then wait until it's non null or listen to OnUpdate to find out immediately when it's populated. +A list of items owned by this user. You should call Refresh() before trying to access this, +and then wait until it's non null or listen to OnUpdate to find out immediately when it's populated. ``` diff --git a/Facepunch.Steamworks.Inventory.OnUpdate.md b/Facepunch.Steamworks.Inventory.OnUpdate.md index 7837998..4c6804c 100644 --- a/Facepunch.Steamworks.Inventory.OnUpdate.md +++ b/Facepunch.Steamworks.Inventory.OnUpdate.md @@ -6,5 +6,5 @@ Action OnUpdate ## Summary ``` Called when the local client's items are first retrieved, and when they change. - Obviously not called on the server. +Obviously not called on the server. ``` diff --git a/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md b/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md index fef7c6a..f7f5261 100644 --- a/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md +++ b/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md @@ -6,7 +6,7 @@ void PlaytimeHeartbeat( ) ## Summary ``` Call this at least every two minutes, every frame doesn't hurt. - You should call it when you consider it active play time. - IE - your player is alive, and playing. - Don't stress on it too much tho cuz it's super hijackable anyway. +You should call it when you consider it active play time. +IE - your player is alive, and playing. +Don't stress on it too much tho cuz it's super hijackable anyway. ``` diff --git a/Facepunch.Steamworks.Inventory.Refresh.md b/Facepunch.Steamworks.Inventory.Refresh.md index 8834652..36cc3e3 100644 --- a/Facepunch.Steamworks.Inventory.Refresh.md +++ b/Facepunch.Steamworks.Inventory.Refresh.md @@ -6,6 +6,6 @@ void Refresh( ) ## Summary ``` Call this to retrieve the items. - Note that if this has already been called it won't - trigger a call to OnUpdate unless the items have changed +Note that if this has already been called it won't +trigger a call to OnUpdate unless the items have changed ``` diff --git a/Facepunch.Steamworks.Inventory.SerializedItems.md b/Facepunch.Steamworks.Inventory.SerializedItems.md index d9235fd..8348492 100644 --- a/Facepunch.Steamworks.Inventory.SerializedItems.md +++ b/Facepunch.Steamworks.Inventory.SerializedItems.md @@ -6,5 +6,5 @@ byte[] SerializedItems ## Summary ``` You can send this data to a server, or another player who can then deserialize it - and get a verified list of items. +and get a verified list of items. ``` diff --git a/Facepunch.Steamworks.Networking.SetListenChannel.md b/Facepunch.Steamworks.Networking.SetListenChannel.md index c92682b..f3e7fd0 100644 --- a/Facepunch.Steamworks.Networking.SetListenChannel.md +++ b/Facepunch.Steamworks.Networking.SetListenChannel.md @@ -6,6 +6,6 @@ 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. +If you donp't enable the channel we won't listen to it, +so you won't be able to receive messages on it. ``` diff --git a/Facepunch.Steamworks.Server.BotCount.md b/Facepunch.Steamworks.Server.BotCount.md index 45d9151..b7045cc 100644 --- a/Facepunch.Steamworks.Server.BotCount.md +++ b/Facepunch.Steamworks.Server.BotCount.md @@ -5,6 +5,6 @@ int BotCount ``` ## Summary ``` -Gets or sets the current BotCount. - This doesn't enforce any kind of limit, it just updates the master server. +Gets or sets the current BotCount. +This doesn't enforce any kind of limit, it just updates the master server. ``` diff --git a/Facepunch.Steamworks.Server.GameTags.md b/Facepunch.Steamworks.Server.GameTags.md index 1f84be5..67d5800 100644 --- a/Facepunch.Steamworks.Server.GameTags.md +++ b/Facepunch.Steamworks.Server.GameTags.md @@ -6,5 +6,5 @@ string GameTags ## Summary ``` 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. +When querying the server list you can filter by these tags. ``` diff --git a/Facepunch.Steamworks.Server.IsValid.md b/Facepunch.Steamworks.Server.IsValid.md index a2a0af7..f159296 100644 --- a/Facepunch.Steamworks.Server.IsValid.md +++ b/Facepunch.Steamworks.Server.IsValid.md @@ -6,5 +6,5 @@ bool IsValid ## Summary ``` Returns true if this instance has initialized properly. - If this returns false you should Dispose and throw an error. +If this returns false you should Dispose and throw an error. ``` diff --git a/Facepunch.Steamworks.Server.LoggedOn.md b/Facepunch.Steamworks.Server.LoggedOn.md index 0c94fe5..caed7b2 100644 --- a/Facepunch.Steamworks.Server.LoggedOn.md +++ b/Facepunch.Steamworks.Server.LoggedOn.md @@ -6,5 +6,5 @@ bool LoggedOn ## Summary ``` Returns true if the server is connected and registered with the Steam master server - You should have called LogOnAnonymous etc on startup. +You should have called LogOnAnonymous etc on startup. ``` diff --git a/Facepunch.Steamworks.Server.MaxPlayers.md b/Facepunch.Steamworks.Server.MaxPlayers.md index f4c09af..1e180c0 100644 --- a/Facepunch.Steamworks.Server.MaxPlayers.md +++ b/Facepunch.Steamworks.Server.MaxPlayers.md @@ -5,6 +5,6 @@ int MaxPlayers ``` ## Summary ``` -Gets or sets the current MaxPlayers. - This doesn't enforce any kind of limit, it just updates the master server. +Gets or sets the current MaxPlayers. +This doesn't enforce any kind of limit, it just updates the master server. ``` diff --git a/Facepunch.Steamworks.Server.PublicIp.md b/Facepunch.Steamworks.Server.PublicIp.md index d101d9b..b272d35 100644 --- a/Facepunch.Steamworks.Server.PublicIp.md +++ b/Facepunch.Steamworks.Server.PublicIp.md @@ -6,6 +6,6 @@ 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. +current public ip address. Be aware that this is likely to return +null for the first few seconds after initialization. ``` diff --git a/Facepunch.Steamworks.Server.Server.2.md b/Facepunch.Steamworks.Server.Server.2.md index 4830ade..10f0c64 100644 --- a/Facepunch.Steamworks.Server.Server.2.md +++ b/Facepunch.Steamworks.Server.Server.2.md @@ -6,5 +6,5 @@ Server( uint appId, uint IpAddress, UInt16 GamePort, bool Secure, string Version ## Summary ``` Initialize a server - query port will use the same as GamePort (MASTERSERVERUPDATERPORT_USEGAMESOCKETSHARE) - This means you'll need to detect and manually process and reply to server queries. +This means you'll need to detect and manually process and reply to server queries. ``` diff --git a/Facepunch.Steamworks.Server.SetKey.md b/Facepunch.Steamworks.Server.SetKey.md index 3bbb603..53a4942 100644 --- a/Facepunch.Steamworks.Server.SetKey.md +++ b/Facepunch.Steamworks.Server.SetKey.md @@ -6,7 +6,6 @@ void SetKey( string Key, string Value ) ## Summary ``` 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. +when querying servers from the server list. +Information describing gamemodes are common here. ``` diff --git a/Facepunch.Steamworks.Server.UpdatePlayer.md b/Facepunch.Steamworks.Server.UpdatePlayer.md index 04b6a80..1176114 100644 --- a/Facepunch.Steamworks.Server.UpdatePlayer.md +++ b/Facepunch.Steamworks.Server.UpdatePlayer.md @@ -6,6 +6,6 @@ void UpdatePlayer( ulong steamid, string name, int score ) ## Summary ``` 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. +any time a player's name or score changes. This keeps the information shown +to server queries up to date. ``` diff --git a/Facepunch.Steamworks.Server.md b/Facepunch.Steamworks.Server.md index 7971ae2..c4db0f6 100644 --- a/Facepunch.Steamworks.Server.md +++ b/Facepunch.Steamworks.Server.md @@ -3,8 +3,7 @@ ### Summary ``` Initialize this class for Game Servers. - - Game servers offer a limited amount of Steam functionality - and don't require the Steam client. +Game servers offer a limited amount of Steam functionality - and don't require the Steam client. ``` ### Constructors @@ -20,6 +19,7 @@ Initialize this class for Game Servers. ### Properties * **uint** [[AppId|Facepunch.Steamworks.Server.AppId]] +* **ServerAuth** [[Auth|Facepunch.Steamworks.Server.Auth]] * **int** [[BotCount|Facepunch.Steamworks.Server.BotCount]] * **string** [[GameDescription|Facepunch.Steamworks.Server.GameDescription]] * **string** [[GameTags|Facepunch.Steamworks.Server.GameTags]] @@ -33,12 +33,9 @@ Initialize this class for Game Servers. * **bool** [[Passworded|Facepunch.Steamworks.Server.Passworded]] * **string** [[Product|Facepunch.Steamworks.Server.Product]] * **IPAddress** [[PublicIp|Facepunch.Steamworks.Server.PublicIp]] +* **ServerQuery** [[Query|Facepunch.Steamworks.Server.Query]] * **string** [[ServerName|Facepunch.Steamworks.Server.ServerName]] -* **ulong** [[SteamId|Facepunch.Steamworks.Server.SteamId]] -* **string** [[Username|Facepunch.Steamworks.Server.Username]] +* **ServerStats** [[Stats|Facepunch.Steamworks.Server.Stats]] * **Workshop** [[Workshop|Facepunch.Steamworks.Server.Workshop]] ### Fields -* **ServerQuery** [[Query|Facepunch.Steamworks.Server.Query]] -* **ServerStats** [[Stats|Facepunch.Steamworks.Server.Stats]] -* **ServerAuth** [[Auth|Facepunch.Steamworks.Server.Auth]] diff --git a/Facepunch.Steamworks.ServerList.Favourites.md b/Facepunch.Steamworks.ServerList.Favourites.md index 8a4ae03..9d03fd1 100644 --- a/Facepunch.Steamworks.ServerList.Favourites.md +++ b/Facepunch.Steamworks.ServerList.Favourites.md @@ -6,5 +6,5 @@ Request Favourites( ) ## Summary ``` Favourite filters don't seem to work, so we don't bother. - You should apply them post process'dly +You should apply them post process'dly ``` diff --git a/Facepunch.Steamworks.ServerList.History.md b/Facepunch.Steamworks.ServerList.History.md index ca72ed9..4d9796d 100644 --- a/Facepunch.Steamworks.ServerList.History.md +++ b/Facepunch.Steamworks.ServerList.History.md @@ -6,5 +6,5 @@ Request History( ) ## Summary ``` History filters don't seem to work, so we don't bother. - You should apply them post process'dly +You should apply them post process'dly ``` diff --git a/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md b/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md index 1fcb78b..fbba114 100644 --- a/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md +++ b/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md @@ -6,5 +6,5 @@ bool GetOutgoingPacket( Packet& packet ) ## Summary ``` If true, Steam wants to send a packet. You should respond by sending - this packet in an unconnected way to the returned Address and Port. +this packet in an unconnected way to the returned Address and Port. ``` diff --git a/Facepunch.Steamworks.ServerStats.GetFloat.md b/Facepunch.Steamworks.ServerStats.GetFloat.md index 3d81eea..bfaaf68 100644 --- a/Facepunch.Steamworks.ServerStats.GetFloat.md +++ b/Facepunch.Steamworks.ServerStats.GetFloat.md @@ -6,6 +6,6 @@ float GetFloat( ulong steamid, string name, float defaultValue ) ## Summary ``` 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. +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. ``` diff --git a/Facepunch.Steamworks.ServerStats.GetInt.md b/Facepunch.Steamworks.ServerStats.GetInt.md index 35b1d98..8621144 100644 --- a/Facepunch.Steamworks.ServerStats.GetInt.md +++ b/Facepunch.Steamworks.ServerStats.GetInt.md @@ -6,6 +6,6 @@ int GetInt( ulong steamid, string name, int defaultValue ) ## Summary ``` 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. +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. ``` diff --git a/Facepunch.Steamworks.ServerStats.Set.md b/Facepunch.Steamworks.ServerStats.Set.md index 14ad891..0f7f20d 100644 --- a/Facepunch.Steamworks.ServerStats.Set.md +++ b/Facepunch.Steamworks.ServerStats.Set.md @@ -6,5 +6,5 @@ bool Set( ulong steamid, string name, float stat ) ## Summary ``` Set the named stat for this user. Setting stats should follow the rules - you defined in Steamworks. +you defined in Steamworks. ``` diff --git a/Facepunch.Steamworks.ServerStats.md b/Facepunch.Steamworks.ServerStats.md index c1652e3..2d078cb 100644 --- a/Facepunch.Steamworks.ServerStats.md +++ b/Facepunch.Steamworks.ServerStats.md @@ -3,7 +3,7 @@ ### Summary ``` Allows getting and setting stats on users from the gameserver. These stats - should have been set up on the Steamworks website for your app. +should have been set up on the Steamworks website for your app. ``` ### Methods diff --git a/Facepunch.Steamworks.Voice.WantsRecording.md b/Facepunch.Steamworks.Voice.WantsRecording.md index c02c679..8551763 100644 --- a/Facepunch.Steamworks.Voice.WantsRecording.md +++ b/Facepunch.Steamworks.Voice.WantsRecording.md @@ -5,6 +5,6 @@ bool WantsRecording ``` ## Summary ``` -If set to true we are listening to the mic. - You should usually toggle this with the press of a key for push to talk. +If set to true we are listening to the mic. +You should usually toggle this with the press of a key for push to talk. ``` diff --git a/Facepunch.Steamworks.Voice.md b/Facepunch.Steamworks.Voice.md index 683dca2..ca8f667 100644 --- a/Facepunch.Steamworks.Voice.md +++ b/Facepunch.Steamworks.Voice.md @@ -5,9 +5,6 @@ No documentation available ``` -### Constructors -* [[Voice|Facepunch.Steamworks.Voice.Voice.1]]( **Client** client ) - ### Methods * **bool** [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( **byte[]** input, **MemoryStream** output, **uint** samepleRate ) * **bool** [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( **IntPtr** input, **int** inputoffset, **int** inputsize, **MemoryStream** output, **uint** samepleRate ) diff --git a/Facepunch.Steamworks.Workshop.CreateItem.md b/Facepunch.Steamworks.Workshop.CreateItem.md index 394e578..bf39758 100644 --- a/Facepunch.Steamworks.Workshop.CreateItem.md +++ b/Facepunch.Steamworks.Workshop.CreateItem.md @@ -6,5 +6,5 @@ Editor CreateItem( ItemType type ) ## Summary ``` Create a new Editor object with the intention of creating a new item. - Your item won't actually be created until you call Publish() on the object. +Your item won't actually be created until you call Publish() on the object. ``` diff --git a/Facepunch.Steamworks.Workshop.CreateQuery.md b/Facepunch.Steamworks.Workshop.CreateQuery.md index 06f1860..67325c4 100644 --- a/Facepunch.Steamworks.Workshop.CreateQuery.md +++ b/Facepunch.Steamworks.Workshop.CreateQuery.md @@ -6,7 +6,6 @@ Query CreateQuery( ) ## Summary ``` Creates a query object, which is used to get a list of items. - - This could be a list of the most popular items, or a search, - or just getting a list of the items you've uploaded. +This could be a list of the most popular items, or a search, +or just getting a list of the items you've uploaded. ``` diff --git a/Facepunch.Steamworks.Workshop.EditItem.md b/Facepunch.Steamworks.Workshop.EditItem.md index f7322e4..3d7e97b 100644 --- a/Facepunch.Steamworks.Workshop.EditItem.md +++ b/Facepunch.Steamworks.Workshop.EditItem.md @@ -6,6 +6,6 @@ Editor EditItem( ulong itemId ) ## Summary ``` 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. +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 cb26235..0efe761 100644 --- a/Facepunch.Steamworks.Workshop.GetItem.md +++ b/Facepunch.Steamworks.Workshop.GetItem.md @@ -6,7 +6,7 @@ Item GetItem( ulong itemid ) ## Summary ``` 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. +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. ``` diff --git a/Facepunch.Steamworks.Workshop.md b/Facepunch.Steamworks.Workshop.md index e85dfe9..fe7ab71 100644 --- a/Facepunch.Steamworks.Workshop.md +++ b/Facepunch.Steamworks.Workshop.md @@ -3,16 +3,13 @@ ### Summary ``` Allows you to interact with Steam's UGC stuff (User Generated Content). - To put simply, this allows you to upload a folder of files to Steam. - - To upload a new file use CreateItem. This returns an Editor object. - This object is also used to edit existing items. - - To get a list of items you can call CreateQuery. From there you can download - an item and retrieve the folder that it's downloaded to. - - Generally there's no need to compress and decompress your uploads, so you should - usually be able to use the content straight from the destination folder. +To put simply, this allows you to upload a folder of files to Steam. +To upload a new file use CreateItem. This returns an Editor object. +This object is also used to edit existing items. +To get a list of items you can call CreateQuery. From there you can download +an item and retrieve the folder that it's downloaded to. +Generally there's no need to compress and decompress your uploads, so you should +usually be able to use the content straight from the destination folder. ``` ### Methods