From 0a8d4778ed58a915b240102e99996fbe36d5b4c8 Mon Sep 17 00:00:00 2001 From: Garry Newman Date: Wed, 9 Nov 2016 12:05:30 +0000 Subject: [PATCH] Retain indents --- Generated/Facepunch.Steamworks.App.BuildId.md | 3 ++- .../Facepunch.Steamworks.Auth.GetAuthSessionTicket.md | 3 ++- Generated/Facepunch.Steamworks.Auth.Ticket.Cancel.md | 3 ++- Generated/Facepunch.Steamworks.BaseSteamworks.AppId.md | 1 + Generated/Facepunch.Steamworks.BaseSteamworks.IsValid.md | 1 + .../Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md | 1 + Generated/Facepunch.Steamworks.BaseSteamworks.md | 1 + Generated/Facepunch.Steamworks.Client.AppId.md | 1 + Generated/Facepunch.Steamworks.Client.BetaName.md | 1 + Generated/Facepunch.Steamworks.Client.Dispose.md | 1 + Generated/Facepunch.Steamworks.Client.IsValid.md | 1 + Generated/Facepunch.Steamworks.Client.SteamId.md | 1 + Generated/Facepunch.Steamworks.Client.Update.md | 1 + Generated/Facepunch.Steamworks.Client.Username.md | 1 + Generated/Facepunch.Steamworks.Config.ForcePlatform.md | 1 + Generated/Facepunch.Steamworks.Config.UseThisCall.md | 3 +++ Generated/Facepunch.Steamworks.Friends.All.md | 1 + Generated/Facepunch.Steamworks.Friends.AllBlocked.md | 1 + Generated/Facepunch.Steamworks.Friends.AllFriends.md | 1 + Generated/Facepunch.Steamworks.Friends.md | 4 +++- Generated/Facepunch.Steamworks.Image.IsError.md | 1 + Generated/Facepunch.Steamworks.Inventory.CraftItem.md | 1 + .../Facepunch.Steamworks.Inventory.CreateDefinition.md | 1 + ...punch.Steamworks.Inventory.Definition.ExchangeSchema.md | 3 ++- ...epunch.Steamworks.Inventory.Definition.IngredientFor.md | 1 + .../Facepunch.Steamworks.Inventory.Definition.Recipes.md | 1 + ...acepunch.Steamworks.Inventory.Definition.SetProperty.md | 3 ++- ...unch.Steamworks.Inventory.Definition.TriggerItemDrop.md | 1 + Generated/Facepunch.Steamworks.Inventory.Definition.md | 1 + Generated/Facepunch.Steamworks.Inventory.Definitions.md | 3 ++- Generated/Facepunch.Steamworks.Inventory.FindDefinition.md | 1 + .../Facepunch.Steamworks.Inventory.Item.Definition.md | 1 + Generated/Facepunch.Steamworks.Inventory.Item.md | 1 + Generated/Facepunch.Steamworks.Inventory.Items.md | 3 ++- Generated/Facepunch.Steamworks.Inventory.OnUpdate.md | 1 + .../Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md | 1 + .../Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md | 1 + ...cepunch.Steamworks.Inventory.Recipe.Ingredient.Count.md | 1 + ...ch.Steamworks.Inventory.Recipe.Ingredient.Definition.md | 1 + ....Steamworks.Inventory.Recipe.Ingredient.DefinitionId.md | 1 + .../Facepunch.Steamworks.Inventory.Recipe.Ingredients.md | 1 + Generated/Facepunch.Steamworks.Inventory.Recipe.Result.md | 1 + Generated/Facepunch.Steamworks.Inventory.Recipe.md | 1 + Generated/Facepunch.Steamworks.Inventory.Refresh.md | 1 + .../Facepunch.Steamworks.Inventory.SerializedExpireTime.md | 1 + .../Facepunch.Steamworks.Inventory.SerializedItems.md | 1 + .../Facepunch.Steamworks.Networking.SetListenChannel.md | 1 + Generated/Facepunch.Steamworks.Server.AppId.md | 1 + Generated/Facepunch.Steamworks.Server.BotCount.md | 3 ++- Generated/Facepunch.Steamworks.Server.Dispose.md | 1 + Generated/Facepunch.Steamworks.Server.GameDescription.md | 1 + Generated/Facepunch.Steamworks.Server.GameTags.md | 1 + Generated/Facepunch.Steamworks.Server.IsValid.md | 1 + Generated/Facepunch.Steamworks.Server.LogOnAnonymous.md | 1 + Generated/Facepunch.Steamworks.Server.LoggedOn.md | 1 + Generated/Facepunch.Steamworks.Server.MapName.md | 3 ++- Generated/Facepunch.Steamworks.Server.MaxPlayers.md | 3 ++- Generated/Facepunch.Steamworks.Server.ModDir.md | 1 + Generated/Facepunch.Steamworks.Server.Passworded.md | 1 + Generated/Facepunch.Steamworks.Server.Product.md | 1 + Generated/Facepunch.Steamworks.Server.PublicIp.md | 1 + Generated/Facepunch.Steamworks.Server.Server.1.md | 1 + Generated/Facepunch.Steamworks.Server.Server.2.md | 1 + Generated/Facepunch.Steamworks.Server.Server.3.md | 1 + Generated/Facepunch.Steamworks.Server.ServerName.md | 1 + Generated/Facepunch.Steamworks.Server.SetKey.md | 2 ++ Generated/Facepunch.Steamworks.Server.Update.md | 1 + Generated/Facepunch.Steamworks.Server.UpdatePlayer.md | 1 + Generated/Facepunch.Steamworks.Server.md | 2 ++ Generated/Facepunch.Steamworks.ServerAuth.EndSession.md | 1 + Generated/Facepunch.Steamworks.ServerAuth.OnAuthChange.md | 1 + Generated/Facepunch.Steamworks.ServerAuth.StartSession.md | 1 + Generated/Facepunch.Steamworks.ServerList.Favourites.md | 1 + Generated/Facepunch.Steamworks.ServerList.History.md | 1 + .../Facepunch.Steamworks.ServerList.Request.Dispose.md | 1 + .../Facepunch.Steamworks.ServerList.Request.Finished.md | 1 + .../Facepunch.Steamworks.ServerList.Request.Responded.md | 1 + ...Facepunch.Steamworks.ServerList.Request.Unresponsive.md | 3 ++- .../Facepunch.Steamworks.ServerList.Server.FetchRules.md | 1 + .../Facepunch.Steamworks.ServerList.Server.HasRules.md | 1 + ...cepunch.Steamworks.ServerList.Server.OnReceivedRules.md | 1 + Generated/Facepunch.Steamworks.ServerList.Server.Rules.md | 1 + .../Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md | 1 + Generated/Facepunch.Steamworks.ServerQuery.Handle.md | 1 + .../Facepunch.Steamworks.ServerQuery.Packet.Address.md | 1 + Generated/Facepunch.Steamworks.ServerQuery.Packet.Data.md | 1 + Generated/Facepunch.Steamworks.ServerQuery.Packet.Port.md | 1 + Generated/Facepunch.Steamworks.ServerQuery.Packet.Size.md | 1 + Generated/Facepunch.Steamworks.ServerQuery.Packet.md | 1 + Generated/Facepunch.Steamworks.ServerQuery.md | 1 + Generated/Facepunch.Steamworks.ServerStats.Commit.md | 1 + Generated/Facepunch.Steamworks.ServerStats.GetFloat.md | 1 + Generated/Facepunch.Steamworks.ServerStats.GetInt.md | 1 + Generated/Facepunch.Steamworks.ServerStats.Refresh.md | 1 + Generated/Facepunch.Steamworks.ServerStats.Set.md | 1 + Generated/Facepunch.Steamworks.ServerStats.md | 1 + Generated/Facepunch.Steamworks.SteamFriend.CurrentAppId.md | 1 + Generated/Facepunch.Steamworks.SteamFriend.Id.md | 1 + Generated/Facepunch.Steamworks.SteamFriend.IsBlocked.md | 3 ++- Generated/Facepunch.Steamworks.SteamFriend.IsFriend.md | 3 ++- Generated/Facepunch.Steamworks.SteamFriend.IsOnline.md | 1 + Generated/Facepunch.Steamworks.SteamFriend.IsPlaying.md | 1 + .../Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md | 1 + Generated/Facepunch.Steamworks.SteamFriend.Name.md | 1 + Generated/Facepunch.Steamworks.Voice.DesiredSampleRate.md | 1 + .../Facepunch.Steamworks.Voice.LastVoiceRecordTime.md | 1 + Generated/Facepunch.Steamworks.Voice.OptimalSampleRate.md | 1 + Generated/Facepunch.Steamworks.Voice.WantsRecording.md | 3 ++- Generated/Facepunch.Steamworks.Workshop.CreateItem.md | 1 + Generated/Facepunch.Steamworks.Workshop.CreateQuery.md | 4 +++- Generated/Facepunch.Steamworks.Workshop.Dispose.md | 1 + Generated/Facepunch.Steamworks.Workshop.EditItem.md | 1 + Generated/Facepunch.Steamworks.Workshop.GetItem.md | 1 + Generated/Facepunch.Steamworks.Workshop.Item.Url.md | 1 + Generated/Facepunch.Steamworks.Workshop.Query.AppId.md | 1 + Generated/Facepunch.Steamworks.Workshop.Query.Block.md | 1 + .../Facepunch.Steamworks.Workshop.Query.ExcludeTags.md | 1 + Generated/Facepunch.Steamworks.Workshop.Query.FileId.md | 1 + Generated/Facepunch.Steamworks.Workshop.Query.Page.md | 1 + .../Facepunch.Steamworks.Workshop.Query.RequireAllTags.md | 1 + .../Facepunch.Steamworks.Workshop.Query.RequireTags.md | 1 + .../Facepunch.Steamworks.Workshop.Query.UploaderAppId.md | 3 ++- Generated/Facepunch.Steamworks.Workshop.md | 7 ++++++- 123 files changed, 151 insertions(+), 18 deletions(-) diff --git a/Generated/Facepunch.Steamworks.App.BuildId.md b/Generated/Facepunch.Steamworks.App.BuildId.md index e0114e4..715ecc9 100644 --- a/Generated/Facepunch.Steamworks.App.BuildId.md +++ b/Generated/Facepunch.Steamworks.App.BuildId.md @@ -3,7 +3,8 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BuildId|Facepunch.Steamworks.App.BuildId]]** { get; set; } ### Summary -Returns the current BuildId of the game. +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/Generated/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md b/Generated/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md index e34e9e3..c271fd7 100644 --- a/Generated/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md +++ b/Generated/Facepunch.Steamworks.Auth.GetAuthSessionTicket.md @@ -3,6 +3,7 @@ public [[Ticket|Facepunch.Steamworks.Auth.Ticket]] **[[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]**( ); ### Summary -Creates an auth ticket. +Creates an auth ticket. Which you can send to a server to authenticate that you are who you say you are. + diff --git a/Generated/Facepunch.Steamworks.Auth.Ticket.Cancel.md b/Generated/Facepunch.Steamworks.Auth.Ticket.Cancel.md index 2af188d..686c3ee 100644 --- a/Generated/Facepunch.Steamworks.Auth.Ticket.Cancel.md +++ b/Generated/Facepunch.Steamworks.Auth.Ticket.Cancel.md @@ -3,6 +3,7 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Cancel|Facepunch.Steamworks.Auth.Ticket.Cancel]]**( ); ### Summary -Cancels a ticket. +Cancels a ticket. You should cancel your ticket when you close the game or leave a server. + diff --git a/Generated/Facepunch.Steamworks.BaseSteamworks.AppId.md b/Generated/Facepunch.Steamworks.BaseSteamworks.AppId.md index 7e25b04..5de8719 100644 --- a/Generated/Facepunch.Steamworks.BaseSteamworks.AppId.md +++ b/Generated/Facepunch.Steamworks.BaseSteamworks.AppId.md @@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId ### Summary Current running program's AppId + diff --git a/Generated/Facepunch.Steamworks.BaseSteamworks.IsValid.md b/Generated/Facepunch.Steamworks.BaseSteamworks.IsValid.md index defaf7e..63f5e39 100644 --- a/Generated/Facepunch.Steamworks.BaseSteamworks.IsValid.md +++ b/Generated/Facepunch.Steamworks.BaseSteamworks.IsValid.md @@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsVal Returns true if this instance has initialized properly. If this returns false you should Dispose and throw an error. + diff --git a/Generated/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md b/Generated/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md index 110864f..cca1c03 100644 --- a/Generated/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md +++ b/Generated/Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md @@ -7,3 +7,4 @@ Run Update until func returns false. This will cause your program to lock up until it finishes. This is useful for things like tests or command line utilities etc. + diff --git a/Generated/Facepunch.Steamworks.BaseSteamworks.md b/Generated/Facepunch.Steamworks.BaseSteamworks.md index 167becd..fb1083f 100644 --- a/Generated/Facepunch.Steamworks.BaseSteamworks.md +++ b/Generated/Facepunch.Steamworks.BaseSteamworks.md @@ -4,6 +4,7 @@ Implements shared functionality between Steamworks.Client and Steamworks.Server + ### Constructors * public **[[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks.BaseSteamworks.1]]**( ); diff --git a/Generated/Facepunch.Steamworks.Client.AppId.md b/Generated/Facepunch.Steamworks.Client.AppId.md index a456120..508094b 100644 --- a/Generated/Facepunch.Steamworks.Client.AppId.md +++ b/Generated/Facepunch.Steamworks.Client.AppId.md @@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId ### Summary Current running program's AppId + diff --git a/Generated/Facepunch.Steamworks.Client.BetaName.md b/Generated/Facepunch.Steamworks.Client.BetaName.md index cc1787f..8fd82e8 100644 --- a/Generated/Facepunch.Steamworks.Client.BetaName.md +++ b/Generated/Facepunch.Steamworks.Client.BetaName.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Bet ### Summary Current Beta name, if we're using a beta branch. + diff --git a/Generated/Facepunch.Steamworks.Client.Dispose.md b/Generated/Facepunch.Steamworks.Client.Dispose.md index 9f945d2..2b883b8 100644 --- a/Generated/Facepunch.Steamworks.Client.Dispose.md +++ b/Generated/Facepunch.Steamworks.Client.Dispose.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispo ### Summary Call when finished to shut down the Steam client. + diff --git a/Generated/Facepunch.Steamworks.Client.IsValid.md b/Generated/Facepunch.Steamworks.Client.IsValid.md index 60f7a64..c269971 100644 --- a/Generated/Facepunch.Steamworks.Client.IsValid.md +++ b/Generated/Facepunch.Steamworks.Client.IsValid.md @@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsVal Returns true if this instance has initialized properly. If this returns false you should Dispose and throw an error. + diff --git a/Generated/Facepunch.Steamworks.Client.SteamId.md b/Generated/Facepunch.Steamworks.Client.SteamId.md index a314a46..2b3dee9 100644 --- a/Generated/Facepunch.Steamworks.Client.SteamId.md +++ b/Generated/Facepunch.Steamworks.Client.SteamId.md @@ -5,3 +5,4 @@ public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Stea ### Summary Current user's SteamId + diff --git a/Generated/Facepunch.Steamworks.Client.Update.md b/Generated/Facepunch.Steamworks.Client.Update.md index af3c78f..fe432dc 100644 --- a/Generated/Facepunch.Steamworks.Client.Update.md +++ b/Generated/Facepunch.Steamworks.Client.Update.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Updat ### Summary Should be called at least once every frame + diff --git a/Generated/Facepunch.Steamworks.Client.Username.md b/Generated/Facepunch.Steamworks.Client.Username.md index 74a342a..942a5f8 100644 --- a/Generated/Facepunch.Steamworks.Client.Username.md +++ b/Generated/Facepunch.Steamworks.Client.Username.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Use ### Summary Current user's Username + diff --git a/Generated/Facepunch.Steamworks.Config.ForcePlatform.md b/Generated/Facepunch.Steamworks.Config.ForcePlatform.md index 1add6bf..460be0e 100644 --- a/Generated/Facepunch.Steamworks.Config.ForcePlatform.md +++ b/Generated/Facepunch.Steamworks.Config.ForcePlatform.md @@ -7,3 +7,4 @@ 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/Generated/Facepunch.Steamworks.Config.UseThisCall.md b/Generated/Facepunch.Steamworks.Config.UseThisCall.md index dafa151..56ab276 100644 --- a/Generated/Facepunch.Steamworks.Config.UseThisCall.md +++ b/Generated/Facepunch.Steamworks.Config.UseThisCall.md @@ -5,7 +5,10 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UseTh ### 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. + + diff --git a/Generated/Facepunch.Steamworks.Friends.All.md b/Generated/Facepunch.Steamworks.Friends.All.md index 73fa4d6..34da483 100644 --- a/Generated/Facepunch.Steamworks.Friends.All.md +++ b/Generated/Facepunch.Steamworks.Friends.All.md @@ -5,3 +5,4 @@ public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library ### Summary Returns all friends, even blocked, ignored, friend requests etc + diff --git a/Generated/Facepunch.Steamworks.Friends.AllBlocked.md b/Generated/Facepunch.Steamworks.Friends.AllBlocked.md index 3ba4278..9d54532 100644 --- a/Generated/Facepunch.Steamworks.Friends.AllBlocked.md +++ b/Generated/Facepunch.Steamworks.Friends.AllBlocked.md @@ -5,3 +5,4 @@ public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library ### Summary Returns all blocked users + diff --git a/Generated/Facepunch.Steamworks.Friends.AllFriends.md b/Generated/Facepunch.Steamworks.Friends.AllFriends.md index 5951d99..f01348f 100644 --- a/Generated/Facepunch.Steamworks.Friends.AllFriends.md +++ b/Generated/Facepunch.Steamworks.Friends.AllFriends.md @@ -5,3 +5,4 @@ public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library ### Summary Returns only friends + diff --git a/Generated/Facepunch.Steamworks.Friends.md b/Generated/Facepunch.Steamworks.Friends.md index 51e22f8..9190e68 100644 --- a/Generated/Facepunch.Steamworks.Friends.md +++ b/Generated/Facepunch.Steamworks.Friends.md @@ -3,12 +3,14 @@ ### Summary Handles most interactions with people in Steam, not just friends as the name would suggest. + ### Example ``` foreach ( var friend in client.Friends.AllFriends ) { -Console.WriteLine( $"{friend.Id}: {friend.Name}" ); + Console.WriteLine( $"{friend.Id}: {friend.Name}" ); } + ``` diff --git a/Generated/Facepunch.Steamworks.Image.IsError.md b/Generated/Facepunch.Steamworks.Image.IsError.md index 06c79bd..a7720da 100644 --- a/Generated/Facepunch.Steamworks.Image.IsError.md +++ b/Generated/Facepunch.Steamworks.Image.IsError.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsErr ### Summary Return true if this image couldn't be loaded for some reason + diff --git a/Generated/Facepunch.Steamworks.Inventory.CraftItem.md b/Generated/Facepunch.Steamworks.Inventory.CraftItem.md index 1813644..813a750 100644 --- a/Generated/Facepunch.Steamworks.Inventory.CraftItem.md +++ b/Generated/Facepunch.Steamworks.Inventory.CraftItem.md @@ -7,3 +7,4 @@ Crafting! Uses the passed items to buy the target item. You need to have set up the appropriate exchange rules in your item definitions. + diff --git a/Generated/Facepunch.Steamworks.Inventory.CreateDefinition.md b/Generated/Facepunch.Steamworks.Inventory.CreateDefinition.md index 1457f77..49e61ba 100644 --- a/Generated/Facepunch.Steamworks.Inventory.CreateDefinition.md +++ b/Generated/Facepunch.Steamworks.Inventory.CreateDefinition.md @@ -6,3 +6,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[CreateDefini 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/Generated/Facepunch.Steamworks.Inventory.Definition.ExchangeSchema.md b/Generated/Facepunch.Steamworks.Inventory.Definition.ExchangeSchema.md index d7c0239..2f130be 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Definition.ExchangeSchema.md +++ b/Generated/Facepunch.Steamworks.Inventory.Definition.ExchangeSchema.md @@ -3,6 +3,7 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ExchangeSchema|Facepunch.Steamworks.Inventory.Definition.ExchangeSchema]]** { get; set; } ### Summary -If this item can be created using other items this string will contain a comma seperated +If this item can be created using other items this string will contain a comma seperated list of definition ids that can be used, ie "100,101;102x5;103x3,104x3" + diff --git a/Generated/Facepunch.Steamworks.Inventory.Definition.IngredientFor.md b/Generated/Facepunch.Steamworks.Inventory.Definition.IngredientFor.md index 659a7b5..b0eadd2 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Definition.IngredientFor.md +++ b/Generated/Facepunch.Steamworks.Inventory.Definition.IngredientFor.md @@ -5,3 +5,4 @@ public [[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[IngredientFor|Face ### Summary A list of recepies we're included in + diff --git a/Generated/Facepunch.Steamworks.Inventory.Definition.Recipes.md b/Generated/Facepunch.Steamworks.Inventory.Definition.Recipes.md index d57338a..a2e8fad 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Definition.Recipes.md +++ b/Generated/Facepunch.Steamworks.Inventory.Definition.Recipes.md @@ -5,3 +5,4 @@ public [[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[Recipes|Facepunch. ### Summary A list of recepies for creating this item. Can be null if none. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Definition.SetProperty.md b/Generated/Facepunch.Steamworks.Inventory.Definition.SetProperty.md index 44d288d..0f1cfd6 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Definition.SetProperty.md +++ b/Generated/Facepunch.Steamworks.Inventory.Definition.SetProperty.md @@ -4,6 +4,7 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SetPr ### Summary If you're manually occupying the Definition (because maybe you're on a server -and want to hack around the fact that definitions aren't presented to you), +and want to hack around the fact that definitions aren't presented to you), you can use this to set propertis. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Definition.TriggerItemDrop.md b/Generated/Facepunch.Steamworks.Inventory.Definition.TriggerItemDrop.md index 025f466..66d4f45 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Definition.TriggerItemDrop.md +++ b/Generated/Facepunch.Steamworks.Inventory.Definition.TriggerItemDrop.md @@ -8,3 +8,4 @@ an item drop to a player. This won't automatically result in giving an item to a player. Just call it every minute or so, or on launch. ItemDefinition is usually a generator + diff --git a/Generated/Facepunch.Steamworks.Inventory.Definition.md b/Generated/Facepunch.Steamworks.Inventory.Definition.md index 26a5a94..ee8dec5 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Definition.md +++ b/Generated/Facepunch.Steamworks.Inventory.Definition.md @@ -6,6 +6,7 @@ not unique to that item. For example, this might be a tshirt, but you might be a multiple tshirts. + ### Methods * public [[T|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetProperty|Facepunch.Steamworks.Inventory.Definition.GetProperty]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name ); * public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetStringProperty|Facepunch.Steamworks.Inventory.Definition.GetStringProperty]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name ); diff --git a/Generated/Facepunch.Steamworks.Inventory.Definitions.md b/Generated/Facepunch.Steamworks.Inventory.Definitions.md index effd926..009c54c 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Definitions.md +++ b/Generated/Facepunch.Steamworks.Inventory.Definitions.md @@ -3,6 +3,7 @@ public [[Definition[]|Facepunch.Steamworks.Inventory.Definition]] **[[Definitions|Facepunch.Steamworks.Inventory.Definitions]]**; ### Summary -A list of items defined for this app. +A list of items defined for this app. This should be immediately populated and available. + diff --git a/Generated/Facepunch.Steamworks.Inventory.FindDefinition.md b/Generated/Facepunch.Steamworks.Inventory.FindDefinition.md index e1d1bcc..a606744 100644 --- a/Generated/Facepunch.Steamworks.Inventory.FindDefinition.md +++ b/Generated/Facepunch.Steamworks.Inventory.FindDefinition.md @@ -6,3 +6,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[FindDefiniti You really need me to explain what this does? Use your brains. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Item.Definition.md b/Generated/Facepunch.Steamworks.Inventory.Item.Definition.md index 38bfa87..822c147 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Item.Definition.md +++ b/Generated/Facepunch.Steamworks.Inventory.Item.Definition.md @@ -5,3 +5,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|F ### Summary Careful, this might not be available. Especially on a game server. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Item.md b/Generated/Facepunch.Steamworks.Inventory.Item.md index ca19d79..70f0813 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Item.md +++ b/Generated/Facepunch.Steamworks.Inventory.Item.md @@ -4,6 +4,7 @@ An item in your inventory. + ### Constructors * public **[[Item|Facepunch.Steamworks.Inventory.Item.Item.1]]**( ); diff --git a/Generated/Facepunch.Steamworks.Inventory.Items.md b/Generated/Facepunch.Steamworks.Inventory.Items.md index f913b3e..2dbc8d1 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Items.md +++ b/Generated/Facepunch.Steamworks.Inventory.Items.md @@ -3,6 +3,7 @@ public [[Item[]|Facepunch.Steamworks.Inventory.Item]] **[[Items|Facepunch.Steamworks.Inventory.Items]]**; ### Summary -A list of items owned by this user. You should call Refresh() before trying to access this, +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/Generated/Facepunch.Steamworks.Inventory.OnUpdate.md b/Generated/Facepunch.Steamworks.Inventory.OnUpdate.md index 23d8e4d..9364bf2 100644 --- a/Generated/Facepunch.Steamworks.Inventory.OnUpdate.md +++ b/Generated/Facepunch.Steamworks.Inventory.OnUpdate.md @@ -6,3 +6,4 @@ public [[Action|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OnU Called when the local client's items are first retrieved, and when they change. Obviously not called on the server. + diff --git a/Generated/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md b/Generated/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md index ae5e788..f7c2c88 100644 --- a/Generated/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md +++ b/Generated/Facepunch.Steamworks.Inventory.PlaytimeHeartbeat.md @@ -8,3 +8,4 @@ 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/Generated/Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md b/Generated/Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md index 525a705..b0551d5 100644 --- a/Generated/Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md +++ b/Generated/Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md @@ -5,3 +5,4 @@ public [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Pric ### Summary Utility, given a "1;VLV250" string, convert it to a 2.5 + diff --git a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Count.md b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Count.md index 83aad89..cb5e08c 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Count.md +++ b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Count.md @@ -5,3 +5,4 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Count| ### Summary The amount of this item needed. Generally this will be 1. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Definition.md b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Definition.md index 548125f..2464bdc 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Definition.md +++ b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.Definition.md @@ -6,3 +6,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|F If we don't know about this item definition this might be null. In which case, DefinitionId should still hold the correct id. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.DefinitionId.md b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.DefinitionId.md index 17f4247..9aed925 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.DefinitionId.md +++ b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredient.DefinitionId.md @@ -5,3 +5,4 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Defini ### Summary The definition ID of the ingredient. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredients.md b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredients.md index 3a4578f..6e73573 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredients.md +++ b/Generated/Facepunch.Steamworks.Inventory.Recipe.Ingredients.md @@ -5,3 +5,4 @@ public [[Ingredient[]|Facepunch.Steamworks.Inventory.Recipe.Ingredient]] **[[Ing ### Summary The items, with quantity required to create this item. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Recipe.Result.md b/Generated/Facepunch.Steamworks.Inventory.Recipe.Result.md index fed2c90..bf1b4b7 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Recipe.Result.md +++ b/Generated/Facepunch.Steamworks.Inventory.Recipe.Result.md @@ -5,3 +5,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Result|Facep ### Summary The item that this will create. + diff --git a/Generated/Facepunch.Steamworks.Inventory.Recipe.md b/Generated/Facepunch.Steamworks.Inventory.Recipe.md index 0f874e5..74b76fb 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Recipe.md +++ b/Generated/Facepunch.Steamworks.Inventory.Recipe.md @@ -5,6 +5,7 @@ Represents a crafting recepie which was defined using the exchange section in the item schema. + ### Fields * public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Result|Facepunch.Steamworks.Inventory.Recipe.Result]]**; * public [[Ingredient[]|Facepunch.Steamworks.Inventory.Recipe.Ingredient]] **[[Ingredients|Facepunch.Steamworks.Inventory.Recipe.Ingredients]]**; diff --git a/Generated/Facepunch.Steamworks.Inventory.Refresh.md b/Generated/Facepunch.Steamworks.Inventory.Refresh.md index 9f61ae5..cfee6be 100644 --- a/Generated/Facepunch.Steamworks.Inventory.Refresh.md +++ b/Generated/Facepunch.Steamworks.Inventory.Refresh.md @@ -7,3 +7,4 @@ 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 + diff --git a/Generated/Facepunch.Steamworks.Inventory.SerializedExpireTime.md b/Generated/Facepunch.Steamworks.Inventory.SerializedExpireTime.md index cfed11d..4639ef5 100644 --- a/Generated/Facepunch.Steamworks.Inventory.SerializedExpireTime.md +++ b/Generated/Facepunch.Steamworks.Inventory.SerializedExpireTime.md @@ -5,3 +5,4 @@ public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[S ### Summary Serialized data exprires after an hour. This is the time the value in SerializedItems will expire. + diff --git a/Generated/Facepunch.Steamworks.Inventory.SerializedItems.md b/Generated/Facepunch.Steamworks.Inventory.SerializedItems.md index 7cb330a..2285ebd 100644 --- a/Generated/Facepunch.Steamworks.Inventory.SerializedItems.md +++ b/Generated/Facepunch.Steamworks.Inventory.SerializedItems.md @@ -6,3 +6,4 @@ public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Ser You can send this data to a server, or another player who can then deserialize it and get a verified list of items. + diff --git a/Generated/Facepunch.Steamworks.Networking.SetListenChannel.md b/Generated/Facepunch.Steamworks.Networking.SetListenChannel.md index 1cbde26..3e46c3b 100644 --- a/Generated/Facepunch.Steamworks.Networking.SetListenChannel.md +++ b/Generated/Facepunch.Steamworks.Networking.SetListenChannel.md @@ -7,3 +7,4 @@ 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. + diff --git a/Generated/Facepunch.Steamworks.Server.AppId.md b/Generated/Facepunch.Steamworks.Server.AppId.md index 9d2bf17..719899a 100644 --- a/Generated/Facepunch.Steamworks.Server.AppId.md +++ b/Generated/Facepunch.Steamworks.Server.AppId.md @@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId ### Summary Current running program's AppId + diff --git a/Generated/Facepunch.Steamworks.Server.BotCount.md b/Generated/Facepunch.Steamworks.Server.BotCount.md index b3545b2..a793290 100644 --- a/Generated/Facepunch.Steamworks.Server.BotCount.md +++ b/Generated/Facepunch.Steamworks.Server.BotCount.md @@ -3,6 +3,7 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BotCount|Facepunch.Steamworks.Server.BotCount]]** { get; set; } ### Summary -Gets or sets the current BotCount. +Gets or sets the current BotCount. This doesn't enforce any kind of limit, it just updates the master server. + diff --git a/Generated/Facepunch.Steamworks.Server.Dispose.md b/Generated/Facepunch.Steamworks.Server.Dispose.md index 4eee17d..c256059 100644 --- a/Generated/Facepunch.Steamworks.Server.Dispose.md +++ b/Generated/Facepunch.Steamworks.Server.Dispose.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispo ### Summary Shutdown interface, disconnect from Steam + diff --git a/Generated/Facepunch.Steamworks.Server.GameDescription.md b/Generated/Facepunch.Steamworks.Server.GameDescription.md index fab59ed..fb01e1a 100644 --- a/Generated/Facepunch.Steamworks.Server.GameDescription.md +++ b/Generated/Facepunch.Steamworks.Server.GameDescription.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Gam ### Summary Gets or sets the current Product + diff --git a/Generated/Facepunch.Steamworks.Server.GameTags.md b/Generated/Facepunch.Steamworks.Server.GameTags.md index fc511ea..b7e7a6b 100644 --- a/Generated/Facepunch.Steamworks.Server.GameTags.md +++ b/Generated/Facepunch.Steamworks.Server.GameTags.md @@ -6,3 +6,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Gam 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. + diff --git a/Generated/Facepunch.Steamworks.Server.IsValid.md b/Generated/Facepunch.Steamworks.Server.IsValid.md index d5beabb..f6ed050 100644 --- a/Generated/Facepunch.Steamworks.Server.IsValid.md +++ b/Generated/Facepunch.Steamworks.Server.IsValid.md @@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsVal Returns true if this instance has initialized properly. If this returns false you should Dispose and throw an error. + diff --git a/Generated/Facepunch.Steamworks.Server.LogOnAnonymous.md b/Generated/Facepunch.Steamworks.Server.LogOnAnonymous.md index bd766d8..92ed8a0 100644 --- a/Generated/Facepunch.Steamworks.Server.LogOnAnonymous.md +++ b/Generated/Facepunch.Steamworks.Server.LogOnAnonymous.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[LogOn ### Summary Log onto Steam anonymously. + diff --git a/Generated/Facepunch.Steamworks.Server.LoggedOn.md b/Generated/Facepunch.Steamworks.Server.LoggedOn.md index f86b577..3c12582 100644 --- a/Generated/Facepunch.Steamworks.Server.LoggedOn.md +++ b/Generated/Facepunch.Steamworks.Server.LoggedOn.md @@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Logge Returns true if the server is connected and registered with the Steam master server You should have called LogOnAnonymous etc on startup. + diff --git a/Generated/Facepunch.Steamworks.Server.MapName.md b/Generated/Facepunch.Steamworks.Server.MapName.md index f4fefc9..b575ab0 100644 --- a/Generated/Facepunch.Steamworks.Server.MapName.md +++ b/Generated/Facepunch.Steamworks.Server.MapName.md @@ -3,5 +3,6 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[MapName|Facepunch.Steamworks.Server.MapName]]** { get; set; } ### Summary -Gets or sets the current Map Name. +Gets or sets the current Map Name. + diff --git a/Generated/Facepunch.Steamworks.Server.MaxPlayers.md b/Generated/Facepunch.Steamworks.Server.MaxPlayers.md index 814377e..4e3631a 100644 --- a/Generated/Facepunch.Steamworks.Server.MaxPlayers.md +++ b/Generated/Facepunch.Steamworks.Server.MaxPlayers.md @@ -3,6 +3,7 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[MaxPlayers|Facepunch.Steamworks.Server.MaxPlayers]]** { get; set; } ### Summary -Gets or sets the current MaxPlayers. +Gets or sets the current MaxPlayers. This doesn't enforce any kind of limit, it just updates the master server. + diff --git a/Generated/Facepunch.Steamworks.Server.ModDir.md b/Generated/Facepunch.Steamworks.Server.ModDir.md index 3492f75..5c09074 100644 --- a/Generated/Facepunch.Steamworks.Server.ModDir.md +++ b/Generated/Facepunch.Steamworks.Server.ModDir.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Mod ### Summary Gets or sets the current ModDir + diff --git a/Generated/Facepunch.Steamworks.Server.Passworded.md b/Generated/Facepunch.Steamworks.Server.Passworded.md index 2523340..6d678e7 100644 --- a/Generated/Facepunch.Steamworks.Server.Passworded.md +++ b/Generated/Facepunch.Steamworks.Server.Passworded.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Passw ### Summary Set whether the server should report itself as passworded + diff --git a/Generated/Facepunch.Steamworks.Server.Product.md b/Generated/Facepunch.Steamworks.Server.Product.md index 7f3d65b..75b571c 100644 --- a/Generated/Facepunch.Steamworks.Server.Product.md +++ b/Generated/Facepunch.Steamworks.Server.Product.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Pro ### Summary Gets or sets the current product. This isn't really used. + diff --git a/Generated/Facepunch.Steamworks.Server.PublicIp.md b/Generated/Facepunch.Steamworks.Server.PublicIp.md index cf169a5..fe88cc4 100644 --- a/Generated/Facepunch.Steamworks.Server.PublicIp.md +++ b/Generated/Facepunch.Steamworks.Server.PublicIp.md @@ -7,3 +7,4 @@ 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. + diff --git a/Generated/Facepunch.Steamworks.Server.Server.1.md b/Generated/Facepunch.Steamworks.Server.Server.1.md index 2ffb2cf..6bbd450 100644 --- a/Generated/Facepunch.Steamworks.Server.Server.1.md +++ b/Generated/Facepunch.Steamworks.Server.Server.1.md @@ -5,3 +5,4 @@ public **[[Server|Facepunch.Steamworks.Server.Server.1]]**( [[uint|https://msdn. ### Summary Initialize a Steam Server instance + diff --git a/Generated/Facepunch.Steamworks.Server.Server.2.md b/Generated/Facepunch.Steamworks.Server.Server.2.md index f01cf4e..bcd862e 100644 --- a/Generated/Facepunch.Steamworks.Server.Server.2.md +++ b/Generated/Facepunch.Steamworks.Server.Server.2.md @@ -5,3 +5,4 @@ public **[[Server|Facepunch.Steamworks.Server.Server.2]]**( [[uint|https://msdn. ### Summary Initialize a Steam Server instance + diff --git a/Generated/Facepunch.Steamworks.Server.Server.3.md b/Generated/Facepunch.Steamworks.Server.Server.3.md index d74a9ed..ac1c303 100644 --- a/Generated/Facepunch.Steamworks.Server.Server.3.md +++ b/Generated/Facepunch.Steamworks.Server.Server.3.md @@ -6,3 +6,4 @@ public **[[Server|Facepunch.Steamworks.Server.Server.3]]**( [[uint|https://msdn. 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. + diff --git a/Generated/Facepunch.Steamworks.Server.ServerName.md b/Generated/Facepunch.Steamworks.Server.ServerName.md index 516fcdc..b49a33e 100644 --- a/Generated/Facepunch.Steamworks.Server.ServerName.md +++ b/Generated/Facepunch.Steamworks.Server.ServerName.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Ser ### Summary Gets or sets the current ServerName + diff --git a/Generated/Facepunch.Steamworks.Server.SetKey.md b/Generated/Facepunch.Steamworks.Server.SetKey.md index 4eca1c4..0e0cc60 100644 --- a/Generated/Facepunch.Steamworks.Server.SetKey.md +++ b/Generated/Facepunch.Steamworks.Server.SetKey.md @@ -5,5 +5,7 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SetKe ### 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. + diff --git a/Generated/Facepunch.Steamworks.Server.Update.md b/Generated/Facepunch.Steamworks.Server.Update.md index 8f2cb1b..3bba0ce 100644 --- a/Generated/Facepunch.Steamworks.Server.Update.md +++ b/Generated/Facepunch.Steamworks.Server.Update.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Updat ### Summary Should be called at least once every frame + diff --git a/Generated/Facepunch.Steamworks.Server.UpdatePlayer.md b/Generated/Facepunch.Steamworks.Server.UpdatePlayer.md index 1628682..36f4df0 100644 --- a/Generated/Facepunch.Steamworks.Server.UpdatePlayer.md +++ b/Generated/Facepunch.Steamworks.Server.UpdatePlayer.md @@ -7,3 +7,4 @@ 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. + diff --git a/Generated/Facepunch.Steamworks.Server.md b/Generated/Facepunch.Steamworks.Server.md index 2b43f55..6759245 100644 --- a/Generated/Facepunch.Steamworks.Server.md +++ b/Generated/Facepunch.Steamworks.Server.md @@ -2,9 +2,11 @@ ### Summary Initialize this class for Game Servers. + Game servers offer a limited amount of Steam functionality - and don't require the Steam client. + ### Constructors * public **[[Server|Facepunch.Steamworks.Server.Server.1]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] IpAddress, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] SteamPort, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] GamePort, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] QueryPort, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] Secure, [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] VersionString ); * public **[[Server|Facepunch.Steamworks.Server.Server.2]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] IpAddress, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] GamePort, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] QueryPort, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] Secure, [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] VersionString ); diff --git a/Generated/Facepunch.Steamworks.ServerAuth.EndSession.md b/Generated/Facepunch.Steamworks.ServerAuth.EndSession.md index 0dffe5c..4e74b57 100644 --- a/Generated/Facepunch.Steamworks.ServerAuth.EndSession.md +++ b/Generated/Facepunch.Steamworks.ServerAuth.EndSession.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[EndSe ### Summary Forget this guy. They're no longer in the game. + diff --git a/Generated/Facepunch.Steamworks.ServerAuth.OnAuthChange.md b/Generated/Facepunch.Steamworks.ServerAuth.OnAuthChange.md index 9be0d84..0eff4e6 100644 --- a/Generated/Facepunch.Steamworks.ServerAuth.OnAuthChange.md +++ b/Generated/Facepunch.Steamworks.ServerAuth.OnAuthChange.md @@ -5,3 +5,4 @@ public [[Action<ulong, ulong, Status>|https://msdn.microsoft.com/en-us/lib ### Summary Steamid, Ownerid, Status + diff --git a/Generated/Facepunch.Steamworks.ServerAuth.StartSession.md b/Generated/Facepunch.Steamworks.ServerAuth.StartSession.md index 5e51c36..7138523 100644 --- a/Generated/Facepunch.Steamworks.ServerAuth.StartSession.md +++ b/Generated/Facepunch.Steamworks.ServerAuth.StartSession.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Start ### Summary Start authorizing a ticket. This user isn't authorized yet. Wait for a call to OnAuthChange. + diff --git a/Generated/Facepunch.Steamworks.ServerList.Favourites.md b/Generated/Facepunch.Steamworks.ServerList.Favourites.md index fa3667c..84134e0 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Favourites.md +++ b/Generated/Facepunch.Steamworks.ServerList.Favourites.md @@ -6,3 +6,4 @@ public [[Request|Facepunch.Steamworks.ServerList.Request]] **[[Favourites|Facepu Favourite filters don't seem to work, so we don't bother. You should apply them post process'dly + diff --git a/Generated/Facepunch.Steamworks.ServerList.History.md b/Generated/Facepunch.Steamworks.ServerList.History.md index d68ad09..36c932c 100644 --- a/Generated/Facepunch.Steamworks.ServerList.History.md +++ b/Generated/Facepunch.Steamworks.ServerList.History.md @@ -6,3 +6,4 @@ public [[Request|Facepunch.Steamworks.ServerList.Request]] **[[History|Facepunch History filters don't seem to work, so we don't bother. You should apply them post process'dly + diff --git a/Generated/Facepunch.Steamworks.ServerList.Request.Dispose.md b/Generated/Facepunch.Steamworks.ServerList.Request.Dispose.md index 7ea882b..2209ad7 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Request.Dispose.md +++ b/Generated/Facepunch.Steamworks.ServerList.Request.Dispose.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispo ### Summary Disposing will end the query + diff --git a/Generated/Facepunch.Steamworks.ServerList.Request.Finished.md b/Generated/Facepunch.Steamworks.ServerList.Request.Finished.md index 8ddafa6..87ff5ff 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Request.Finished.md +++ b/Generated/Facepunch.Steamworks.ServerList.Request.Finished.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Finis ### Summary True when we have finished + diff --git a/Generated/Facepunch.Steamworks.ServerList.Request.Responded.md b/Generated/Facepunch.Steamworks.ServerList.Request.Responded.md index 1de9954..d5ed3ae 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Request.Responded.md +++ b/Generated/Facepunch.Steamworks.ServerList.Request.Responded.md @@ -6,3 +6,4 @@ public [[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.as A list of servers that responded. If you're only interested in servers that responded since you last updated, then simply clear this list. + diff --git a/Generated/Facepunch.Steamworks.ServerList.Request.Unresponsive.md b/Generated/Facepunch.Steamworks.ServerList.Request.Unresponsive.md index e7327fb..897108c 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Request.Unresponsive.md +++ b/Generated/Facepunch.Steamworks.ServerList.Request.Unresponsive.md @@ -3,5 +3,6 @@ public [[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Unresponsive|Facepunch.Steamworks.ServerList.Request.Unresponsive]]**; ### Summary -A list of servers that were in the master list but didn't respond. +A list of servers that were in the master list but didn't respond. + diff --git a/Generated/Facepunch.Steamworks.ServerList.Server.FetchRules.md b/Generated/Facepunch.Steamworks.ServerList.Server.FetchRules.md index 44b9b24..728dcfa 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Server.FetchRules.md +++ b/Generated/Facepunch.Steamworks.ServerList.Server.FetchRules.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Fetch ### Summary Populates Rules for this server + diff --git a/Generated/Facepunch.Steamworks.ServerList.Server.HasRules.md b/Generated/Facepunch.Steamworks.ServerList.Server.HasRules.md index a5fe4a9..2672ee7 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Server.HasRules.md +++ b/Generated/Facepunch.Steamworks.ServerList.Server.HasRules.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[HasRu ### Summary Returns true if this server has rules + diff --git a/Generated/Facepunch.Steamworks.ServerList.Server.OnReceivedRules.md b/Generated/Facepunch.Steamworks.ServerList.Server.OnReceivedRules.md index aa209c8..e705e44 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Server.OnReceivedRules.md +++ b/Generated/Facepunch.Steamworks.ServerList.Server.OnReceivedRules.md @@ -6,3 +6,4 @@ public [[Action<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.as Callback when rules are receieved. The bool is true if server responded properly. + diff --git a/Generated/Facepunch.Steamworks.ServerList.Server.Rules.md b/Generated/Facepunch.Steamworks.ServerList.Server.Rules.md index b215b29..4f579f4 100644 --- a/Generated/Facepunch.Steamworks.ServerList.Server.Rules.md +++ b/Generated/Facepunch.Steamworks.ServerList.Server.Rules.md @@ -5,3 +5,4 @@ public [[Dictionary<string, string>|https://msdn.microsoft.com/en-us/libra ### Summary List of server rules. Use HasRules to see if this is safe to access. + diff --git a/Generated/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md b/Generated/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md index 573a0fd..f021b8c 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.GetOutgoingPacket.md @@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetOu 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. + diff --git a/Generated/Facepunch.Steamworks.ServerQuery.Handle.md b/Generated/Facepunch.Steamworks.ServerQuery.Handle.md index f308fe9..0a03a74 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.Handle.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.Handle.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Handl ### Summary We have received a server query on our game port. Pass it to Steam to handle. + diff --git a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Address.md b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Address.md index 8eb578b..61e40ee 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Address.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Address.md @@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Addre ### Summary Target IP address + diff --git a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Data.md b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Data.md index 203305f..8636bf0 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Data.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Data.md @@ -6,3 +6,4 @@ public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dat This data is pooled. Make a copy if you don't use it immediately. This buffer is also quite large - so pay attention to Size. + diff --git a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Port.md b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Port.md index f730d04..4c9fe30 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Port.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Port.md @@ -5,3 +5,4 @@ public [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Por ### Summary Target port + diff --git a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Size.md b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Size.md index f615615..2ac64e0 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.Packet.Size.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.Packet.Size.md @@ -5,3 +5,4 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Size|F ### Summary Size of the data + diff --git a/Generated/Facepunch.Steamworks.ServerQuery.Packet.md b/Generated/Facepunch.Steamworks.ServerQuery.Packet.md index 30c8fe6..bcadcd8 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.Packet.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.Packet.md @@ -4,6 +4,7 @@ A server query packet. + ### Properties * public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Address|Facepunch.Steamworks.ServerQuery.Packet.Address]]** { get; set; } * public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Data|Facepunch.Steamworks.ServerQuery.Packet.Data]]** { get; set; } diff --git a/Generated/Facepunch.Steamworks.ServerQuery.md b/Generated/Facepunch.Steamworks.ServerQuery.md index 1f2bcc6..d4efd8e 100644 --- a/Generated/Facepunch.Steamworks.ServerQuery.md +++ b/Generated/Facepunch.Steamworks.ServerQuery.md @@ -4,6 +4,7 @@ If you're manually processing the server queries, you should use this class. + ### Methods * public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]**( [[Packet&|Facepunch.Steamworks.ServerQuery.Packet]] packet ); * public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Handle|Facepunch.Steamworks.ServerQuery.Handle]]**( [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] data, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] size, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] address, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] port ); diff --git a/Generated/Facepunch.Steamworks.ServerStats.Commit.md b/Generated/Facepunch.Steamworks.ServerStats.Commit.md index 9caabbb..91dd042 100644 --- a/Generated/Facepunch.Steamworks.ServerStats.Commit.md +++ b/Generated/Facepunch.Steamworks.ServerStats.Commit.md @@ -7,3 +7,4 @@ Once you've set a stat change on a user you need to commit your changes. You can do that using this function. The callback will let you know if your action succeeded, but most of the time you can fire and forget. + diff --git a/Generated/Facepunch.Steamworks.ServerStats.GetFloat.md b/Generated/Facepunch.Steamworks.ServerStats.GetFloat.md index aba35ac..c6169e9 100644 --- a/Generated/Facepunch.Steamworks.ServerStats.GetFloat.md +++ b/Generated/Facepunch.Steamworks.ServerStats.GetFloat.md @@ -7,3 +7,4 @@ 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. + diff --git a/Generated/Facepunch.Steamworks.ServerStats.GetInt.md b/Generated/Facepunch.Steamworks.ServerStats.GetInt.md index a4e8f07..fb9559f 100644 --- a/Generated/Facepunch.Steamworks.ServerStats.GetInt.md +++ b/Generated/Facepunch.Steamworks.ServerStats.GetInt.md @@ -7,3 +7,4 @@ 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. + diff --git a/Generated/Facepunch.Steamworks.ServerStats.Refresh.md b/Generated/Facepunch.Steamworks.ServerStats.Refresh.md index 1751c43..1079d80 100644 --- a/Generated/Facepunch.Steamworks.ServerStats.Refresh.md +++ b/Generated/Facepunch.Steamworks.ServerStats.Refresh.md @@ -7,3 +7,4 @@ Retrieve the stats for this user. If you pass a callback function in this will be called when the stats are recieved, the bool will signify whether it was successful or not. + diff --git a/Generated/Facepunch.Steamworks.ServerStats.Set.md b/Generated/Facepunch.Steamworks.ServerStats.Set.md index 8580798..5b0b6c7 100644 --- a/Generated/Facepunch.Steamworks.ServerStats.Set.md +++ b/Generated/Facepunch.Steamworks.ServerStats.Set.md @@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Set|F Set the named stat for this user. Setting stats should follow the rules you defined in Steamworks. + diff --git a/Generated/Facepunch.Steamworks.ServerStats.md b/Generated/Facepunch.Steamworks.ServerStats.md index e7ff7d7..1394f2c 100644 --- a/Generated/Facepunch.Steamworks.ServerStats.md +++ b/Generated/Facepunch.Steamworks.ServerStats.md @@ -5,6 +5,7 @@ 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 * public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Commit|Facepunch.Steamworks.ServerStats.Commit]]**( [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid, [[Action<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] Callback ); * public [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]**( [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid, [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name, [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] defaultValue ); diff --git a/Generated/Facepunch.Steamworks.SteamFriend.CurrentAppId.md b/Generated/Facepunch.Steamworks.SteamFriend.CurrentAppId.md index 9b7a825..2ba206a 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.CurrentAppId.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.CurrentAppId.md @@ -5,3 +5,4 @@ public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Curr ### Summary The AppId this guy is playing + diff --git a/Generated/Facepunch.Steamworks.SteamFriend.Id.md b/Generated/Facepunch.Steamworks.SteamFriend.Id.md index 958d189..7bf24a7 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.Id.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.Id.md @@ -5,3 +5,4 @@ public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Id|F ### Summary Steam Id + diff --git a/Generated/Facepunch.Steamworks.SteamFriend.IsBlocked.md b/Generated/Facepunch.Steamworks.SteamFriend.IsBlocked.md index 0ded1c6..2713a4f 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.IsBlocked.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.IsBlocked.md @@ -3,5 +3,6 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsBlocked|Facepunch.Steamworks.SteamFriend.IsBlocked]]** { get; set; } ### Summary -Return true if blocked + Return true if blocked + diff --git a/Generated/Facepunch.Steamworks.SteamFriend.IsFriend.md b/Generated/Facepunch.Steamworks.SteamFriend.IsFriend.md index 9fa6b89..1857470 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.IsFriend.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.IsFriend.md @@ -3,5 +3,6 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsFriend|Facepunch.Steamworks.SteamFriend.IsFriend]]** { get; set; } ### Summary -Return true if is a friend. Returns false if blocked, request etc. + Return true if is a friend. Returns false if blocked, request etc. + diff --git a/Generated/Facepunch.Steamworks.SteamFriend.IsOnline.md b/Generated/Facepunch.Steamworks.SteamFriend.IsOnline.md index 667398a..c2d8482 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.IsOnline.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.IsOnline.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsOnl ### Summary Returns true if this friend is online + diff --git a/Generated/Facepunch.Steamworks.SteamFriend.IsPlaying.md b/Generated/Facepunch.Steamworks.SteamFriend.IsPlaying.md index 8d30439..6e74c54 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.IsPlaying.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.IsPlaying.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsPla ### Summary Returns true if this friend is online and playing this game + diff --git a/Generated/Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md b/Generated/Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md index 3543600..ba5d9f9 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md @@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsPla ### Summary Returns true if this friend is online and playing this game + diff --git a/Generated/Facepunch.Steamworks.SteamFriend.Name.md b/Generated/Facepunch.Steamworks.SteamFriend.Name.md index 0768a9a..ced192e 100644 --- a/Generated/Facepunch.Steamworks.SteamFriend.Name.md +++ b/Generated/Facepunch.Steamworks.SteamFriend.Name.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Nam ### Summary Their current display name + diff --git a/Generated/Facepunch.Steamworks.Voice.DesiredSampleRate.md b/Generated/Facepunch.Steamworks.Voice.DesiredSampleRate.md index 1e2be71..7384924 100644 --- a/Generated/Facepunch.Steamworks.Voice.DesiredSampleRate.md +++ b/Generated/Facepunch.Steamworks.Voice.DesiredSampleRate.md @@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Desir ### Summary If set we will capture the audio at this rate. If unset (set to 0) will capture at OptimalSampleRate + diff --git a/Generated/Facepunch.Steamworks.Voice.LastVoiceRecordTime.md b/Generated/Facepunch.Steamworks.Voice.LastVoiceRecordTime.md index f188148..ca0ebe9 100644 --- a/Generated/Facepunch.Steamworks.Voice.LastVoiceRecordTime.md +++ b/Generated/Facepunch.Steamworks.Voice.LastVoiceRecordTime.md @@ -5,3 +5,4 @@ public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[L ### Summary The last time voice was detected, recorded + diff --git a/Generated/Facepunch.Steamworks.Voice.OptimalSampleRate.md b/Generated/Facepunch.Steamworks.Voice.OptimalSampleRate.md index b13bb4c..920f0c3 100644 --- a/Generated/Facepunch.Steamworks.Voice.OptimalSampleRate.md +++ b/Generated/Facepunch.Steamworks.Voice.OptimalSampleRate.md @@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Optim ### Summary Returns the optimal sample rate for voice - according to Steam + diff --git a/Generated/Facepunch.Steamworks.Voice.WantsRecording.md b/Generated/Facepunch.Steamworks.Voice.WantsRecording.md index c9614b4..10058b2 100644 --- a/Generated/Facepunch.Steamworks.Voice.WantsRecording.md +++ b/Generated/Facepunch.Steamworks.Voice.WantsRecording.md @@ -3,6 +3,7 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[WantsRecording|Facepunch.Steamworks.Voice.WantsRecording]]** { get; set; } ### Summary -If set to true we are listening to the mic. +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/Generated/Facepunch.Steamworks.Workshop.CreateItem.md b/Generated/Facepunch.Steamworks.Workshop.CreateItem.md index 1094566..ef269aa 100644 --- a/Generated/Facepunch.Steamworks.Workshop.CreateItem.md +++ b/Generated/Facepunch.Steamworks.Workshop.CreateItem.md @@ -6,3 +6,4 @@ public [[Editor|Facepunch.Steamworks.Workshop.Editor]] **[[CreateItem|Facepunch. 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. + diff --git a/Generated/Facepunch.Steamworks.Workshop.CreateQuery.md b/Generated/Facepunch.Steamworks.Workshop.CreateQuery.md index 7b2af89..7980005 100644 --- a/Generated/Facepunch.Steamworks.Workshop.CreateQuery.md +++ b/Generated/Facepunch.Steamworks.Workshop.CreateQuery.md @@ -4,6 +4,8 @@ public [[Query|Facepunch.Steamworks.Workshop.Query]] **[[CreateQuery|Facepunch.S ### 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, + +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/Generated/Facepunch.Steamworks.Workshop.Dispose.md b/Generated/Facepunch.Steamworks.Workshop.Dispose.md index 9bab9c0..7e4318c 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Dispose.md +++ b/Generated/Facepunch.Steamworks.Workshop.Dispose.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispo ### Summary You should never have to call this manually + diff --git a/Generated/Facepunch.Steamworks.Workshop.EditItem.md b/Generated/Facepunch.Steamworks.Workshop.EditItem.md index a88f4c5..8000cdf 100644 --- a/Generated/Facepunch.Steamworks.Workshop.EditItem.md +++ b/Generated/Facepunch.Steamworks.Workshop.EditItem.md @@ -7,3 +7,4 @@ 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/Generated/Facepunch.Steamworks.Workshop.GetItem.md b/Generated/Facepunch.Steamworks.Workshop.GetItem.md index 78c489e..7add571 100644 --- a/Generated/Facepunch.Steamworks.Workshop.GetItem.md +++ b/Generated/Facepunch.Steamworks.Workshop.GetItem.md @@ -8,3 +8,4 @@ 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/Generated/Facepunch.Steamworks.Workshop.Item.Url.md b/Generated/Facepunch.Steamworks.Workshop.Item.Url.md index 0ff98e5..de2cc55 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Item.Url.md +++ b/Generated/Facepunch.Steamworks.Workshop.Item.Url.md @@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Url ### Summary Return a URL to view this item online + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.AppId.md b/Generated/Facepunch.Steamworks.Workshop.Query.AppId.md index f89696c..9e1bf79 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.AppId.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.AppId.md @@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId ### Summary The AppId you're querying. This defaults to this appid. + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.Block.md b/Generated/Facepunch.Steamworks.Workshop.Query.Block.md index d0c0e2a..6deb136 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.Block.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.Block.md @@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Block ### Summary Don't call this in production! + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.ExcludeTags.md b/Generated/Facepunch.Steamworks.Workshop.Query.ExcludeTags.md index b604812..be4f1b9 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.ExcludeTags.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.ExcludeTags.md @@ -5,3 +5,4 @@ public [[List<string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.as ### Summary Don't return any items with this tag + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.FileId.md b/Generated/Facepunch.Steamworks.Workshop.Query.FileId.md index 749fa0c..667cb91 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.FileId.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.FileId.md @@ -5,3 +5,4 @@ public [[List<ulong>|https://msdn.microsoft.com/en-us/library/ya5y69ds.asp ### Summary If you're querying for a particular file or files, add them to this. + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.Page.md b/Generated/Facepunch.Steamworks.Workshop.Query.Page.md index bcb87fc..6334d48 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.Page.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.Page.md @@ -5,3 +5,4 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Page|F ### Summary Page starts at 1 !! + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.RequireAllTags.md b/Generated/Facepunch.Steamworks.Workshop.Query.RequireAllTags.md index 020caf3..0b400cc 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.RequireAllTags.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.RequireAllTags.md @@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Requi If true, return items that have all RequireTags If false, return items that have any tags in RequireTags + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.RequireTags.md b/Generated/Facepunch.Steamworks.Workshop.Query.RequireTags.md index f100c2b..0b4e9c4 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.RequireTags.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.RequireTags.md @@ -5,3 +5,4 @@ public [[List<string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.as ### Summary Only return items with these tags + diff --git a/Generated/Facepunch.Steamworks.Workshop.Query.UploaderAppId.md b/Generated/Facepunch.Steamworks.Workshop.Query.UploaderAppId.md index ae6b975..3317724 100644 --- a/Generated/Facepunch.Steamworks.Workshop.Query.UploaderAppId.md +++ b/Generated/Facepunch.Steamworks.Workshop.Query.UploaderAppId.md @@ -4,5 +4,6 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Uploa ### Summary The AppId of the app used to upload the item. This defaults to 0 -which means all/any. +which means all/any. + diff --git a/Generated/Facepunch.Steamworks.Workshop.md b/Generated/Facepunch.Steamworks.Workshop.md index f1b2c1c..b363584 100644 --- a/Generated/Facepunch.Steamworks.Workshop.md +++ b/Generated/Facepunch.Steamworks.Workshop.md @@ -3,14 +3,19 @@ ### 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. +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 * public [[Editor|Facepunch.Steamworks.Workshop.Editor]] **[[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]**( [[ItemType|Facepunch.Steamworks.Workshop.ItemType]] type ); * public [[Query|Facepunch.Steamworks.Workshop.Query]] **[[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]**( );