From b6722bbee937b36d7e9d0100747abdf7f9bcfbf5 Mon Sep 17 00:00:00 2001 From: Garry Newman Date: Wed, 2 Nov 2016 19:38:01 +0000 Subject: [PATCH] More docs --- Facepunch.Steamworks.App.md | 17 +-- Facepunch.Steamworks.Auth.md | 11 +- Facepunch.Steamworks.BaseSteamworks.md | 43 +++---- Facepunch.Steamworks.CallbackHandle.md | 10 +- Facepunch.Steamworks.CallbackIdentifiers.md | 100 ++++++++-------- Facepunch.Steamworks.Client.md | 96 ++++++--------- Facepunch.Steamworks.Config.md | 20 +--- Facepunch.Steamworks.Defines.md | 54 ++++----- Facepunch.Steamworks.Friends.md | 31 ++--- Facepunch.Steamworks.Image.md | 20 ++++ Facepunch.Steamworks.Inventory.md | 49 +++----- Facepunch.Steamworks.Networking.md | 20 ++-- Facepunch.Steamworks.Overlay.md | 50 +++----- Facepunch.Steamworks.Screenshots.md | 10 +- Facepunch.Steamworks.Server.md | 122 ++++++++------------ Facepunch.Steamworks.ServerAuth.md | 16 +-- Facepunch.Steamworks.ServerList.md | 44 ++----- Facepunch.Steamworks.ServerQuery.md | 14 +-- Facepunch.Steamworks.ServerStats.md | 30 ++--- Facepunch.Steamworks.Stats.md | 30 ++--- Facepunch.Steamworks.SteamFriend.md | 67 +++++------ Facepunch.Steamworks.Voice.md | 43 +++---- Facepunch.Steamworks.Workshop.md | 26 ++--- 23 files changed, 360 insertions(+), 563 deletions(-) create mode 100644 Facepunch.Steamworks.Image.md diff --git a/Facepunch.Steamworks.App.md b/Facepunch.Steamworks.App.md index a615d8e..7a2c911 100644 --- a/Facepunch.Steamworks.App.md +++ b/Facepunch.Steamworks.App.md @@ -1,15 +1,10 @@ # App -## Methods -##### `void` [[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]( `bool` **missingFilesOnly** ) -*No documentation available* +### Methods +* `void` [[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]( `bool` **missingFilesOnly** ) + +### Properties +* `int` [[BuildId|Facepunch.Steamworks.App.BuildId]] -##### Properties -### `int` [[BuildId|Facepunch.Steamworks.App.BuildId]] -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. - - -## Fields +### Fields diff --git a/Facepunch.Steamworks.Auth.md b/Facepunch.Steamworks.Auth.md index 950109e..ab2f064 100644 --- a/Facepunch.Steamworks.Auth.md +++ b/Facepunch.Steamworks.Auth.md @@ -1,11 +1,8 @@ # Auth -## Methods -##### `Ticket` [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( ) -Creates an auth ticket. - Which you can send to a server to authenticate that you are who you say you are. +### Methods +* `Ticket` [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( ) +### Properties -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.BaseSteamworks.md b/Facepunch.Steamworks.BaseSteamworks.md index 48ce88b..4fb39d1 100644 --- a/Facepunch.Steamworks.BaseSteamworks.md +++ b/Facepunch.Steamworks.BaseSteamworks.md @@ -1,33 +1,22 @@ # BaseSteamworks -## Methods -##### `void` [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( ) -*No documentation available* +### Methods +* `void` [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( ) +* `void` [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( ) +* `void` [[Update|Facepunch.Steamworks.BaseSteamworks.Update]]( ) -##### `void` [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( ) -*No documentation available* +### Properties +* `UInt32` [[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]] -##### `void` [[Update|Facepunch.Steamworks.BaseSteamworks.Update]]( ) -*No documentation available* +* `Inventory` [[Inventory|Facepunch.Steamworks.BaseSteamworks.Inventory]] + +* `bool` [[IsValid|Facepunch.Steamworks.BaseSteamworks.IsValid]] + +* `Networking` [[Networking|Facepunch.Steamworks.BaseSteamworks.Networking]] + +* `Workshop` [[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]] -##### Properties -### `UInt32` [[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]] -Current running program's AppId - -### `Inventory` [[Inventory|Facepunch.Steamworks.BaseSteamworks.Inventory]] -*No documentation available* - -### `bool` [[IsValid|Facepunch.Steamworks.BaseSteamworks.IsValid]] -*No documentation available* - -### `Networking` [[Networking|Facepunch.Steamworks.BaseSteamworks.Networking]] -*No documentation available* - -### `Workshop` [[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]] -*No documentation available* - - -## Fields -### OnMessage -### OnUpdate +### Fields +* `Action\` [[OnMessage|Facepunch.Steamworks.BaseSteamworks.OnMessage]] +* `Action` [[OnUpdate|Facepunch.Steamworks.BaseSteamworks.OnUpdate]] diff --git a/Facepunch.Steamworks.CallbackHandle.md b/Facepunch.Steamworks.CallbackHandle.md index 7dac731..dd35dea 100644 --- a/Facepunch.Steamworks.CallbackHandle.md +++ b/Facepunch.Steamworks.CallbackHandle.md @@ -1,10 +1,8 @@ # CallbackHandle -## Methods -##### `void` [[Dispose|Facepunch.Steamworks.CallbackHandle.Dispose]]( ) -*No documentation available* +### Methods +* `void` [[Dispose|Facepunch.Steamworks.CallbackHandle.Dispose]]( ) +### Properties -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.CallbackIdentifiers.md b/Facepunch.Steamworks.CallbackIdentifiers.md index 3843e24..fc2cbb9 100644 --- a/Facepunch.Steamworks.CallbackIdentifiers.md +++ b/Facepunch.Steamworks.CallbackIdentifiers.md @@ -1,54 +1,54 @@ # CallbackIdentifiers -## Methods +### Methods -##### Properties +### Properties -## Fields -### SteamUser -### SteamGameServer -### SteamFriends -### SteamBilling -### SteamMatchmaking -### SteamContentServer -### SteamUtils -### ClientFriends -### ClientUser -### SteamApps -### SteamUserStats -### SteamNetworking -### ClientRemoteStorage -### ClientDepotBuilder -### SteamGameServerItems -### ClientUtils -### SteamGameCoordinator -### SteamGameServerStats -### Steam2Async -### SteamGameStats -### ClientHTTP -### ClientScreenshots -### SteamScreenshots -### ClientAudio -### ClientUnifiedMessages -### SteamStreamLauncher -### ClientController -### SteamController -### ClientParentalSettings -### ClientDeviceAuth -### ClientNetworkDeviceManager -### ClientMusic -### ClientRemoteClientManager -### ClientUGC -### SteamStreamClient -### ClientShortcuts -### ClientRemoteControlManager -### SteamAppList -### SteamMusic -### SteamMusicRemote -### ClientVR -### ClientGameNotification -### SteamGameNotification -### SteamHTMLSurface -### ClientVideo -### ClientInventory -### ClientBluetoothManager +### Fields +* `int` [[SteamUser|Facepunch.Steamworks.CallbackIdentifiers.SteamUser]] +* `int` [[SteamGameServer|Facepunch.Steamworks.CallbackIdentifiers.SteamGameServer]] +* `int` [[SteamFriends|Facepunch.Steamworks.CallbackIdentifiers.SteamFriends]] +* `int` [[SteamBilling|Facepunch.Steamworks.CallbackIdentifiers.SteamBilling]] +* `int` [[SteamMatchmaking|Facepunch.Steamworks.CallbackIdentifiers.SteamMatchmaking]] +* `int` [[SteamContentServer|Facepunch.Steamworks.CallbackIdentifiers.SteamContentServer]] +* `int` [[SteamUtils|Facepunch.Steamworks.CallbackIdentifiers.SteamUtils]] +* `int` [[ClientFriends|Facepunch.Steamworks.CallbackIdentifiers.ClientFriends]] +* `int` [[ClientUser|Facepunch.Steamworks.CallbackIdentifiers.ClientUser]] +* `int` [[SteamApps|Facepunch.Steamworks.CallbackIdentifiers.SteamApps]] +* `int` [[SteamUserStats|Facepunch.Steamworks.CallbackIdentifiers.SteamUserStats]] +* `int` [[SteamNetworking|Facepunch.Steamworks.CallbackIdentifiers.SteamNetworking]] +* `int` [[ClientRemoteStorage|Facepunch.Steamworks.CallbackIdentifiers.ClientRemoteStorage]] +* `int` [[ClientDepotBuilder|Facepunch.Steamworks.CallbackIdentifiers.ClientDepotBuilder]] +* `int` [[SteamGameServerItems|Facepunch.Steamworks.CallbackIdentifiers.SteamGameServerItems]] +* `int` [[ClientUtils|Facepunch.Steamworks.CallbackIdentifiers.ClientUtils]] +* `int` [[SteamGameCoordinator|Facepunch.Steamworks.CallbackIdentifiers.SteamGameCoordinator]] +* `int` [[SteamGameServerStats|Facepunch.Steamworks.CallbackIdentifiers.SteamGameServerStats]] +* `int` [[Steam2Async|Facepunch.Steamworks.CallbackIdentifiers.Steam2Async]] +* `int` [[SteamGameStats|Facepunch.Steamworks.CallbackIdentifiers.SteamGameStats]] +* `int` [[ClientHTTP|Facepunch.Steamworks.CallbackIdentifiers.ClientHTTP]] +* `int` [[ClientScreenshots|Facepunch.Steamworks.CallbackIdentifiers.ClientScreenshots]] +* `int` [[SteamScreenshots|Facepunch.Steamworks.CallbackIdentifiers.SteamScreenshots]] +* `int` [[ClientAudio|Facepunch.Steamworks.CallbackIdentifiers.ClientAudio]] +* `int` [[ClientUnifiedMessages|Facepunch.Steamworks.CallbackIdentifiers.ClientUnifiedMessages]] +* `int` [[SteamStreamLauncher|Facepunch.Steamworks.CallbackIdentifiers.SteamStreamLauncher]] +* `int` [[ClientController|Facepunch.Steamworks.CallbackIdentifiers.ClientController]] +* `int` [[SteamController|Facepunch.Steamworks.CallbackIdentifiers.SteamController]] +* `int` [[ClientParentalSettings|Facepunch.Steamworks.CallbackIdentifiers.ClientParentalSettings]] +* `int` [[ClientDeviceAuth|Facepunch.Steamworks.CallbackIdentifiers.ClientDeviceAuth]] +* `int` [[ClientNetworkDeviceManager|Facepunch.Steamworks.CallbackIdentifiers.ClientNetworkDeviceManager]] +* `int` [[ClientMusic|Facepunch.Steamworks.CallbackIdentifiers.ClientMusic]] +* `int` [[ClientRemoteClientManager|Facepunch.Steamworks.CallbackIdentifiers.ClientRemoteClientManager]] +* `int` [[ClientUGC|Facepunch.Steamworks.CallbackIdentifiers.ClientUGC]] +* `int` [[SteamStreamClient|Facepunch.Steamworks.CallbackIdentifiers.SteamStreamClient]] +* `int` [[ClientShortcuts|Facepunch.Steamworks.CallbackIdentifiers.ClientShortcuts]] +* `int` [[ClientRemoteControlManager|Facepunch.Steamworks.CallbackIdentifiers.ClientRemoteControlManager]] +* `int` [[SteamAppList|Facepunch.Steamworks.CallbackIdentifiers.SteamAppList]] +* `int` [[SteamMusic|Facepunch.Steamworks.CallbackIdentifiers.SteamMusic]] +* `int` [[SteamMusicRemote|Facepunch.Steamworks.CallbackIdentifiers.SteamMusicRemote]] +* `int` [[ClientVR|Facepunch.Steamworks.CallbackIdentifiers.ClientVR]] +* `int` [[ClientGameNotification|Facepunch.Steamworks.CallbackIdentifiers.ClientGameNotification]] +* `int` [[SteamGameNotification|Facepunch.Steamworks.CallbackIdentifiers.SteamGameNotification]] +* `int` [[SteamHTMLSurface|Facepunch.Steamworks.CallbackIdentifiers.SteamHTMLSurface]] +* `int` [[ClientVideo|Facepunch.Steamworks.CallbackIdentifiers.ClientVideo]] +* `int` [[ClientInventory|Facepunch.Steamworks.CallbackIdentifiers.ClientInventory]] +* `int` [[ClientBluetoothManager|Facepunch.Steamworks.CallbackIdentifiers.ClientBluetoothManager]] diff --git a/Facepunch.Steamworks.Client.md b/Facepunch.Steamworks.Client.md index 39935cb..e9a06ad 100644 --- a/Facepunch.Steamworks.Client.md +++ b/Facepunch.Steamworks.Client.md @@ -1,63 +1,43 @@ # Client -## Methods -##### `void` [[Dispose|Facepunch.Steamworks.Client.Dispose]]( ) -*No documentation available* +### Methods +* `void` [[Dispose|Facepunch.Steamworks.Client.Dispose]]( ) +* `void` [[Update|Facepunch.Steamworks.Client.Update]]( ) -##### `void` [[Update|Facepunch.Steamworks.Client.Update]]( ) -Should be called at least once every frame +### Properties +* `App` [[App|Facepunch.Steamworks.Client.App]] + +* `UInt32` [[AppId|Facepunch.Steamworks.Client.AppId]] + +* `Auth` [[Auth|Facepunch.Steamworks.Client.Auth]] + +* `string` [[BetaName|Facepunch.Steamworks.Client.BetaName]] + +* `Friends` [[Friends|Facepunch.Steamworks.Client.Friends]] + +* `Inventory` [[Inventory|Facepunch.Steamworks.Client.Inventory]] + +* `bool` [[IsValid|Facepunch.Steamworks.Client.IsValid]] + +* `Networking` [[Networking|Facepunch.Steamworks.Client.Networking]] + +* `Overlay` [[Overlay|Facepunch.Steamworks.Client.Overlay]] + +* `Screenshots` [[Screenshots|Facepunch.Steamworks.Client.Screenshots]] + +* `ServerList` [[ServerList|Facepunch.Steamworks.Client.ServerList]] + +* `Stats` [[Stats|Facepunch.Steamworks.Client.Stats]] + +* `ulong` [[SteamId|Facepunch.Steamworks.Client.SteamId]] + +* `string` [[Username|Facepunch.Steamworks.Client.Username]] + +* `Voice` [[Voice|Facepunch.Steamworks.Client.Voice]] + +* `Workshop` [[Workshop|Facepunch.Steamworks.Client.Workshop]] -##### Properties -### `App` [[App|Facepunch.Steamworks.Client.App]] -*No documentation available* - -### `UInt32` [[AppId|Facepunch.Steamworks.Client.AppId]] -Current running program's AppId - -### `Auth` [[Auth|Facepunch.Steamworks.Client.Auth]] -*No documentation available* - -### `string` [[BetaName|Facepunch.Steamworks.Client.BetaName]] -Current Beta name, if ser - -### `Friends` [[Friends|Facepunch.Steamworks.Client.Friends]] -*No documentation available* - -### `Inventory` [[Inventory|Facepunch.Steamworks.Client.Inventory]] -*No documentation available* - -### `bool` [[IsValid|Facepunch.Steamworks.Client.IsValid]] -*No documentation available* - -### `Networking` [[Networking|Facepunch.Steamworks.Client.Networking]] -*No documentation available* - -### `Overlay` [[Overlay|Facepunch.Steamworks.Client.Overlay]] -*No documentation available* - -### `Screenshots` [[Screenshots|Facepunch.Steamworks.Client.Screenshots]] -*No documentation available* - -### `ServerList` [[ServerList|Facepunch.Steamworks.Client.ServerList]] -*No documentation available* - -### `Stats` [[Stats|Facepunch.Steamworks.Client.Stats]] -*No documentation available* - -### `ulong` [[SteamId|Facepunch.Steamworks.Client.SteamId]] -Current user's SteamId - -### `string` [[Username|Facepunch.Steamworks.Client.Username]] -Current user's Username - -### `Voice` [[Voice|Facepunch.Steamworks.Client.Voice]] -*No documentation available* - -### `Workshop` [[Workshop|Facepunch.Steamworks.Client.Workshop]] -*No documentation available* - - -## Fields -### OnMessage -### OnUpdate +### Fields +* `Action\` [[OnMessage|Facepunch.Steamworks.Client.OnMessage]] +* `Action` [[OnUpdate|Facepunch.Steamworks.Client.OnUpdate]] diff --git a/Facepunch.Steamworks.Config.md b/Facepunch.Steamworks.Config.md index 3898ef4..7435933 100644 --- a/Facepunch.Steamworks.Config.md +++ b/Facepunch.Steamworks.Config.md @@ -1,18 +1,10 @@ # Config -## Methods -##### `void` [[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]( `OperatingSystem` **os**, `Architecture` **arch** ) -*No documentation available* +### Methods +* `void` [[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]( `OperatingSystem` **os**, `Architecture` **arch** ) + +### Properties +* `bool` [[UseThisCall|Facepunch.Steamworks.Config.UseThisCall]] -##### Properties -### `bool` [[UseThisCall|Facepunch.Steamworks.Config.UseThisCall]] -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. - - -## Fields +### Fields diff --git a/Facepunch.Steamworks.Defines.md b/Facepunch.Steamworks.Defines.md index c83ee2c..618a597 100644 --- a/Facepunch.Steamworks.Defines.md +++ b/Facepunch.Steamworks.Defines.md @@ -1,31 +1,31 @@ # Defines -## Methods +### Methods -##### Properties +### Properties -## Fields -### STEAMAPPLIST_INTERFACE_VERSION -### STEAMAPPS_INTERFACE_VERSION -### STEAMAPPTICKET_INTERFACE_VERSION -### STEAMCONTROLLER_INTERFACE_VERSION -### STEAMFRIENDS_INTERFACE_VERSION -### STEAMGAMECOORDINATOR_INTERFACE_VERSION -### STEAMGAMESERVER_INTERFACE_VERSION -### STEAMGAMESERVERSTATS_INTERFACE_VERSION -### STEAMHTMLSURFACE_INTERFACE_VERSION -### STEAMHTTP_INTERFACE_VERSION -### STEAMINVENTORY_INTERFACE_VERSION -### STEAMMATCHMAKING_INTERFACE_VERSION -### STEAMMATCHMAKINGSERVERS_INTERFACE_VERSION -### STEAMMUSIC_INTERFACE_VERSION -### STEAMMUSICREMOTE_INTERFACE_VERSION -### STEAMNETWORKING_INTERFACE_VERSION -### STEAMREMOTESTORAGE_INTERFACE_VERSION -### STEAMSCREENSHOTS_INTERFACE_VERSION -### STEAMUGC_INTERFACE_VERSION -### STEAMUNIFIEDMESSAGES_INTERFACE_VERSION -### STEAMUSER_INTERFACE_VERSION -### STEAMUSERSTATS_INTERFACE_VERSION -### STEAMUTILS_INTERFACE_VERSION -### STEAMVIDEO_INTERFACE_VERSION +### Fields +* `string` [[STEAMAPPLIST_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMAPPLIST_INTERFACE_VERSION]] +* `string` [[STEAMAPPS_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMAPPS_INTERFACE_VERSION]] +* `string` [[STEAMAPPTICKET_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMAPPTICKET_INTERFACE_VERSION]] +* `string` [[STEAMCONTROLLER_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMCONTROLLER_INTERFACE_VERSION]] +* `string` [[STEAMFRIENDS_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMFRIENDS_INTERFACE_VERSION]] +* `string` [[STEAMGAMECOORDINATOR_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMGAMECOORDINATOR_INTERFACE_VERSION]] +* `string` [[STEAMGAMESERVER_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMGAMESERVER_INTERFACE_VERSION]] +* `string` [[STEAMGAMESERVERSTATS_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMGAMESERVERSTATS_INTERFACE_VERSION]] +* `string` [[STEAMHTMLSURFACE_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMHTMLSURFACE_INTERFACE_VERSION]] +* `string` [[STEAMHTTP_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMHTTP_INTERFACE_VERSION]] +* `string` [[STEAMINVENTORY_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMINVENTORY_INTERFACE_VERSION]] +* `string` [[STEAMMATCHMAKING_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMMATCHMAKING_INTERFACE_VERSION]] +* `string` [[STEAMMATCHMAKINGSERVERS_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMMATCHMAKINGSERVERS_INTERFACE_VERSION]] +* `string` [[STEAMMUSIC_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMMUSIC_INTERFACE_VERSION]] +* `string` [[STEAMMUSICREMOTE_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMMUSICREMOTE_INTERFACE_VERSION]] +* `string` [[STEAMNETWORKING_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMNETWORKING_INTERFACE_VERSION]] +* `string` [[STEAMREMOTESTORAGE_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMREMOTESTORAGE_INTERFACE_VERSION]] +* `string` [[STEAMSCREENSHOTS_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMSCREENSHOTS_INTERFACE_VERSION]] +* `string` [[STEAMUGC_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMUGC_INTERFACE_VERSION]] +* `string` [[STEAMUNIFIEDMESSAGES_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMUNIFIEDMESSAGES_INTERFACE_VERSION]] +* `string` [[STEAMUSER_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMUSER_INTERFACE_VERSION]] +* `string` [[STEAMUSERSTATS_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMUSERSTATS_INTERFACE_VERSION]] +* `string` [[STEAMUTILS_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMUTILS_INTERFACE_VERSION]] +* `string` [[STEAMVIDEO_INTERFACE_VERSION|Facepunch.Steamworks.Defines.STEAMVIDEO_INTERFACE_VERSION]] diff --git a/Facepunch.Steamworks.Friends.md b/Facepunch.Steamworks.Friends.md index 2175e80..b6a261f 100644 --- a/Facepunch.Steamworks.Friends.md +++ b/Facepunch.Steamworks.Friends.md @@ -1,28 +1,17 @@ # Friends -## Methods -##### `SteamFriend` [[Get|Facepunch.Steamworks.Friends.Get]]( `ulong` **steamid** ) -*No documentation available* +### Methods +* `SteamFriend` [[Get|Facepunch.Steamworks.Friends.Get]]( `ulong` **steamid** ) +* `Image` [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( `AvatarSize` **size**, `ulong` **steamid** ) +* `string` [[GetName|Facepunch.Steamworks.Friends.GetName]]( `ulong` **steamid** ) +* `void` [[Refresh|Facepunch.Steamworks.Friends.Refresh]]( ) -##### `Image` [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( `AvatarSize` **size**, `ulong` **steamid** ) -*No documentation available* +### Properties +* `IEnumerable\` [[All|Facepunch.Steamworks.Friends.All]] -##### `string` [[GetName|Facepunch.Steamworks.Friends.GetName]]( `ulong` **steamid** ) -*No documentation available* +* `IEnumerable\` [[AllBlocked|Facepunch.Steamworks.Friends.AllBlocked]] -##### `void` [[Refresh|Facepunch.Steamworks.Friends.Refresh]]( ) -*No documentation available* +* `IEnumerable\` [[AllFriends|Facepunch.Steamworks.Friends.AllFriends]] -##### Properties -### `IEnumerable\` [[All|Facepunch.Steamworks.Friends.All]] -Returns all friends, even blocked, ignored, friend requests etc - -### `IEnumerable\` [[AllBlocked|Facepunch.Steamworks.Friends.AllBlocked]] -*No documentation available* - -### `IEnumerable\` [[AllFriends|Facepunch.Steamworks.Friends.AllFriends]] -*No documentation available* - - -## Fields +### Fields diff --git a/Facepunch.Steamworks.Image.md b/Facepunch.Steamworks.Image.md new file mode 100644 index 0000000..487e831 --- /dev/null +++ b/Facepunch.Steamworks.Image.md @@ -0,0 +1,20 @@ +# Image + +### Methods +* `Color` [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( `int` **x**, `int` **y** ) + +### Properties +* `Byte[]` [[Data|Facepunch.Steamworks.Image.Data]] + +* `int` [[Height|Facepunch.Steamworks.Image.Height]] + +* `int` [[Id|Facepunch.Steamworks.Image.Id]] + +* `bool` [[IsError|Facepunch.Steamworks.Image.IsError]] + +* `bool` [[IsLoaded|Facepunch.Steamworks.Image.IsLoaded]] + +* `int` [[Width|Facepunch.Steamworks.Image.Width]] + + +### Fields diff --git a/Facepunch.Steamworks.Inventory.md b/Facepunch.Steamworks.Inventory.md index 62e5410..9984dfa 100644 --- a/Facepunch.Steamworks.Inventory.md +++ b/Facepunch.Steamworks.Inventory.md @@ -1,38 +1,19 @@ # Inventory -## Methods -##### `Definition` [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( `int` **id** ) -*No documentation available* +### Methods +* `Definition` [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( `int` **id** ) +* `Result` [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( `Byte[]` **data**, `int` **dataLength** ) +* `void` [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( ) +* `Definition` [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( `int` **DefinitionId** ) +* `void` [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]( ) +* `Single` [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( `string` **price** ) +* `void` [[Refresh|Facepunch.Steamworks.Inventory.Refresh]]( ) -##### `Result` [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( `Byte[]` **data**, `int` **dataLength** ) -*No documentation available* +### Properties -##### `void` [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( ) -*No documentation available* - -##### `Definition` [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( `int` **DefinitionId** ) -*No documentation available* - -##### `void` [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]( ) -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. - -##### `Single` [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( `string` **price** ) -*No documentation available* - -##### `void` [[Refresh|Facepunch.Steamworks.Inventory.Refresh]]( ) -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 - - -##### Properties - -## Fields -### OnUpdate -### Items -### SerializedItems -### SerializedExpireTime -### Definitions +### Fields +* `Action` [[OnUpdate|Facepunch.Steamworks.Inventory.OnUpdate]] +* `Item[]` [[Items|Facepunch.Steamworks.Inventory.Items]] +* `Byte[]` [[SerializedItems|Facepunch.Steamworks.Inventory.SerializedItems]] +* `DateTime` [[SerializedExpireTime|Facepunch.Steamworks.Inventory.SerializedExpireTime]] +* `Definition[]` [[Definitions|Facepunch.Steamworks.Inventory.Definitions]] diff --git a/Facepunch.Steamworks.Networking.md b/Facepunch.Steamworks.Networking.md index 77b2ffa..4897362 100644 --- a/Facepunch.Steamworks.Networking.md +++ b/Facepunch.Steamworks.Networking.md @@ -1,16 +1,12 @@ # Networking -## Methods -##### `void` [[Dispose|Facepunch.Steamworks.Networking.Dispose]]( ) -*No documentation available* +### Methods +* `void` [[Dispose|Facepunch.Steamworks.Networking.Dispose]]( ) +* `bool` [[SendP2PPacket|Facepunch.Steamworks.Networking.SendP2PPacket]]( `ulong` **steamid**, `Byte[]` **data**, `int` **length**, `SendType` **eP2PSendType**, `int` **nChannel** ) -##### `bool` [[SendP2PPacket|Facepunch.Steamworks.Networking.SendP2PPacket]]( `ulong` **steamid**, `Byte[]` **data**, `int` **length**, `SendType` **eP2PSendType**, `int` **nChannel** ) -*No documentation available* +### Properties - -##### Properties - -## Fields -### OnP2PData -### OnIncomingConnection -### OnConnectionFailed +### Fields +* `Action\` [[OnP2PData|Facepunch.Steamworks.Networking.OnP2PData]] +* `Func\` [[OnIncomingConnection|Facepunch.Steamworks.Networking.OnIncomingConnection]] +* `Action\` [[OnConnectionFailed|Facepunch.Steamworks.Networking.OnConnectionFailed]] diff --git a/Facepunch.Steamworks.Overlay.md b/Facepunch.Steamworks.Overlay.md index c766f51..80c5fae 100644 --- a/Facepunch.Steamworks.Overlay.md +++ b/Facepunch.Steamworks.Overlay.md @@ -1,40 +1,18 @@ # Overlay -## Methods -##### `void` [[AcceptFriendRequest|Facepunch.Steamworks.Overlay.AcceptFriendRequest]]( `ulong` **steamid** ) -*No documentation available* +### Methods +* `void` [[AcceptFriendRequest|Facepunch.Steamworks.Overlay.AcceptFriendRequest]]( `ulong` **steamid** ) +* `void` [[AddFriend|Facepunch.Steamworks.Overlay.AddFriend]]( `ulong` **steamid** ) +* `void` [[IgnoreFriendRequest|Facepunch.Steamworks.Overlay.IgnoreFriendRequest]]( `ulong` **steamid** ) +* `void` [[OpenAchievements|Facepunch.Steamworks.Overlay.OpenAchievements]]( `ulong` **steamid** ) +* `void` [[OpenChat|Facepunch.Steamworks.Overlay.OpenChat]]( `ulong` **steamid** ) +* `void` [[OpenProfile|Facepunch.Steamworks.Overlay.OpenProfile]]( `ulong` **steamid** ) +* `void` [[OpenStats|Facepunch.Steamworks.Overlay.OpenStats]]( `ulong` **steamid** ) +* `void` [[OpenTrade|Facepunch.Steamworks.Overlay.OpenTrade]]( `ulong` **steamid** ) +* `void` [[OpenUrl|Facepunch.Steamworks.Overlay.OpenUrl]]( `string` **url** ) +* `void` [[OpenUserPage|Facepunch.Steamworks.Overlay.OpenUserPage]]( `string` **name**, `ulong` **steamid** ) +* `void` [[RemoveFriend|Facepunch.Steamworks.Overlay.RemoveFriend]]( `ulong` **steamid** ) -##### `void` [[AddFriend|Facepunch.Steamworks.Overlay.AddFriend]]( `ulong` **steamid** ) -*No documentation available* +### Properties -##### `void` [[IgnoreFriendRequest|Facepunch.Steamworks.Overlay.IgnoreFriendRequest]]( `ulong` **steamid** ) -*No documentation available* - -##### `void` [[OpenAchievements|Facepunch.Steamworks.Overlay.OpenAchievements]]( `ulong` **steamid** ) -*No documentation available* - -##### `void` [[OpenChat|Facepunch.Steamworks.Overlay.OpenChat]]( `ulong` **steamid** ) -*No documentation available* - -##### `void` [[OpenProfile|Facepunch.Steamworks.Overlay.OpenProfile]]( `ulong` **steamid** ) -*No documentation available* - -##### `void` [[OpenStats|Facepunch.Steamworks.Overlay.OpenStats]]( `ulong` **steamid** ) -*No documentation available* - -##### `void` [[OpenTrade|Facepunch.Steamworks.Overlay.OpenTrade]]( `ulong` **steamid** ) -*No documentation available* - -##### `void` [[OpenUrl|Facepunch.Steamworks.Overlay.OpenUrl]]( `string` **url** ) -*No documentation available* - -##### `void` [[OpenUserPage|Facepunch.Steamworks.Overlay.OpenUserPage]]( `string` **name**, `ulong` **steamid** ) -*No documentation available* - -##### `void` [[RemoveFriend|Facepunch.Steamworks.Overlay.RemoveFriend]]( `ulong` **steamid** ) -*No documentation available* - - -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.Screenshots.md b/Facepunch.Steamworks.Screenshots.md index 05e024f..997aca8 100644 --- a/Facepunch.Steamworks.Screenshots.md +++ b/Facepunch.Steamworks.Screenshots.md @@ -1,10 +1,8 @@ # Screenshots -## Methods -##### `void` [[Trigger|Facepunch.Steamworks.Screenshots.Trigger]]( ) -*No documentation available* +### Methods +* `void` [[Trigger|Facepunch.Steamworks.Screenshots.Trigger]]( ) +### Properties -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.Server.md b/Facepunch.Steamworks.Server.md index aec42d2..7aecab5 100644 --- a/Facepunch.Steamworks.Server.md +++ b/Facepunch.Steamworks.Server.md @@ -1,83 +1,53 @@ # Server -## Methods -##### `void` [[LogOnAnonymous|Facepunch.Steamworks.Server.LogOnAnonymous]]( ) -Log onto Steam anonymously +### Methods +* `void` [[LogOnAnonymous|Facepunch.Steamworks.Server.LogOnAnonymous]]( ) +* `void` [[SetKey|Facepunch.Steamworks.Server.SetKey]]( `string` **Key**, `string` **Value** ) +* `void` [[Update|Facepunch.Steamworks.Server.Update]]( ) +* `void` [[UpdatePlayer|Facepunch.Steamworks.Server.UpdatePlayer]]( `ulong` **steamid**, `string` **name**, `int` **score** ) -##### `void` [[SetKey|Facepunch.Steamworks.Server.SetKey]]( `string` **Key**, `string` **Value** ) -*No documentation available* +### Properties +* `UInt32` [[AppId|Facepunch.Steamworks.Server.AppId]] -##### `void` [[Update|Facepunch.Steamworks.Server.Update]]( ) -Should be called at least once every frame +* `ServerAuth` [[Auth|Facepunch.Steamworks.Server.Auth]] -##### `void` [[UpdatePlayer|Facepunch.Steamworks.Server.UpdatePlayer]]( `ulong` **steamid**, `string` **name**, `int` **score** ) -*No documentation available* +* `int` [[BotCount|Facepunch.Steamworks.Server.BotCount]] + +* `string` [[GameDescription|Facepunch.Steamworks.Server.GameDescription]] + +* `string` [[GameTags|Facepunch.Steamworks.Server.GameTags]] + +* `Inventory` [[Inventory|Facepunch.Steamworks.Server.Inventory]] + +* `bool` [[IsValid|Facepunch.Steamworks.Server.IsValid]] + +* `bool` [[LoggedOn|Facepunch.Steamworks.Server.LoggedOn]] + +* `string` [[MapName|Facepunch.Steamworks.Server.MapName]] + +* `int` [[MaxPlayers|Facepunch.Steamworks.Server.MaxPlayers]] + +* `string` [[ModDir|Facepunch.Steamworks.Server.ModDir]] + +* `Networking` [[Networking|Facepunch.Steamworks.Server.Networking]] + +* `bool` [[Passworded|Facepunch.Steamworks.Server.Passworded]] + +* `string` [[Product|Facepunch.Steamworks.Server.Product]] + +* `ServerQuery` [[Query|Facepunch.Steamworks.Server.Query]] + +* `string` [[ServerName|Facepunch.Steamworks.Server.ServerName]] + +* `ServerStats` [[Stats|Facepunch.Steamworks.Server.Stats]] + +* `ulong` [[SteamId|Facepunch.Steamworks.Server.SteamId]] + +* `string` [[Username|Facepunch.Steamworks.Server.Username]] + +* `Workshop` [[Workshop|Facepunch.Steamworks.Server.Workshop]] -##### Properties -### `UInt32` [[AppId|Facepunch.Steamworks.Server.AppId]] -Current running program's AppId - -### `ServerAuth` [[Auth|Facepunch.Steamworks.Server.Auth]] -*No documentation available* - -### `int` [[BotCount|Facepunch.Steamworks.Server.BotCount]] -Gets or sets the current BotCount. - This doesn't enforce any kind of limit, it just updates the master server. - -### `string` [[GameDescription|Facepunch.Steamworks.Server.GameDescription]] -Gets or sets the current Product - -### `string` [[GameTags|Facepunch.Steamworks.Server.GameTags]] -Gets or sets the current GameTags - -### `Inventory` [[Inventory|Facepunch.Steamworks.Server.Inventory]] -*No documentation available* - -### `bool` [[IsValid|Facepunch.Steamworks.Server.IsValid]] -*No documentation available* - -### `bool` [[LoggedOn|Facepunch.Steamworks.Server.LoggedOn]] -*No documentation available* - -### `string` [[MapName|Facepunch.Steamworks.Server.MapName]] -Gets or sets the current Map Name. - -### `int` [[MaxPlayers|Facepunch.Steamworks.Server.MaxPlayers]] -Gets or sets the current MaxPlayers. - This doesn't enforce any kind of limit, it just updates the master server. - -### `string` [[ModDir|Facepunch.Steamworks.Server.ModDir]] -Gets or sets the current ModDir - -### `Networking` [[Networking|Facepunch.Steamworks.Server.Networking]] -*No documentation available* - -### `bool` [[Passworded|Facepunch.Steamworks.Server.Passworded]] -Gets or sets the current Passworded - -### `string` [[Product|Facepunch.Steamworks.Server.Product]] -Gets or sets the current Product - -### `ServerQuery` [[Query|Facepunch.Steamworks.Server.Query]] -*No documentation available* - -### `string` [[ServerName|Facepunch.Steamworks.Server.ServerName]] -Gets or sets the current ServerName - -### `ServerStats` [[Stats|Facepunch.Steamworks.Server.Stats]] -*No documentation available* - -### `ulong` [[SteamId|Facepunch.Steamworks.Server.SteamId]] -Current user's SteamId - -### `string` [[Username|Facepunch.Steamworks.Server.Username]] -Current user's Username - -### `Workshop` [[Workshop|Facepunch.Steamworks.Server.Workshop]] -*No documentation available* - - -## Fields -### OnMessage -### OnUpdate +### Fields +* `Action\` [[OnMessage|Facepunch.Steamworks.Server.OnMessage]] +* `Action` [[OnUpdate|Facepunch.Steamworks.Server.OnUpdate]] diff --git a/Facepunch.Steamworks.ServerAuth.md b/Facepunch.Steamworks.ServerAuth.md index f7b746a..ce233e2 100644 --- a/Facepunch.Steamworks.ServerAuth.md +++ b/Facepunch.Steamworks.ServerAuth.md @@ -1,14 +1,10 @@ # ServerAuth -## Methods -##### `void` [[EndSession|Facepunch.Steamworks.ServerAuth.EndSession]]( `ulong` **steamid** ) -*No documentation available* +### Methods +* `void` [[EndSession|Facepunch.Steamworks.ServerAuth.EndSession]]( `ulong` **steamid** ) +* `bool` [[StartSession|Facepunch.Steamworks.ServerAuth.StartSession]]( `Byte[]` **data**, `ulong` **steamid** ) -##### `bool` [[StartSession|Facepunch.Steamworks.ServerAuth.StartSession]]( `Byte[]` **data**, `ulong` **steamid** ) -*No documentation available* +### Properties - -##### Properties - -## Fields -### OnAuthChange +### Fields +* `Action\` [[OnAuthChange|Facepunch.Steamworks.ServerAuth.OnAuthChange]] diff --git a/Facepunch.Steamworks.ServerList.md b/Facepunch.Steamworks.ServerList.md index 59daacc..e5530ce 100644 --- a/Facepunch.Steamworks.ServerList.md +++ b/Facepunch.Steamworks.ServerList.md @@ -1,36 +1,16 @@ # ServerList -## Methods -##### `void` [[AddToFavourite|Facepunch.Steamworks.ServerList.AddToFavourite]]( `Server` **server** ) -*No documentation available* +### Methods +* `void` [[AddToFavourite|Facepunch.Steamworks.ServerList.AddToFavourite]]( `Server` **server** ) +* `void` [[AddToHistory|Facepunch.Steamworks.ServerList.AddToHistory]]( `Server` **server** ) +* `Request` [[Custom|Facepunch.Steamworks.ServerList.Custom]]( `IEnumerable\` **serverList** ) +* `Request` [[Favourites|Facepunch.Steamworks.ServerList.Favourites]]( ) +* `Request` [[History|Facepunch.Steamworks.ServerList.History]]( ) +* `Request` [[Internet|Facepunch.Steamworks.ServerList.Internet]]( `Filter` **filter** ) +* `bool` [[IsFavourite|Facepunch.Steamworks.ServerList.IsFavourite]]( `Server` **server** ) +* `void` [[RemoveFromFavourite|Facepunch.Steamworks.ServerList.RemoveFromFavourite]]( `Server` **server** ) +* `void` [[RemoveFromHistory|Facepunch.Steamworks.ServerList.RemoveFromHistory]]( `Server` **server** ) -##### `void` [[AddToHistory|Facepunch.Steamworks.ServerList.AddToHistory]]( `Server` **server** ) -*No documentation available* +### Properties -##### `Request` [[Custom|Facepunch.Steamworks.ServerList.Custom]]( `IEnumerable\` **serverList** ) -*No documentation available* - -##### `Request` [[Favourites|Facepunch.Steamworks.ServerList.Favourites]]( ) -Favourite filters don't seem to work, so we don't bother. - You should apply them post process'dly - -##### `Request` [[History|Facepunch.Steamworks.ServerList.History]]( ) -History filters don't seem to work, so we don't bother. - You should apply them post process'dly - -##### `Request` [[Internet|Facepunch.Steamworks.ServerList.Internet]]( `Filter` **filter** ) -*No documentation available* - -##### `bool` [[IsFavourite|Facepunch.Steamworks.ServerList.IsFavourite]]( `Server` **server** ) -*No documentation available* - -##### `void` [[RemoveFromFavourite|Facepunch.Steamworks.ServerList.RemoveFromFavourite]]( `Server` **server** ) -*No documentation available* - -##### `void` [[RemoveFromHistory|Facepunch.Steamworks.ServerList.RemoveFromHistory]]( `Server` **server** ) -*No documentation available* - - -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.ServerQuery.md b/Facepunch.Steamworks.ServerQuery.md index 0a1a2c0..7e52475 100644 --- a/Facepunch.Steamworks.ServerQuery.md +++ b/Facepunch.Steamworks.ServerQuery.md @@ -1,13 +1,9 @@ # ServerQuery -## Methods -##### `bool` [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( `Packet&` **packet** ) -*No documentation available* +### Methods +* `bool` [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( `Packet&` **packet** ) +* `void` [[Handle|Facepunch.Steamworks.ServerQuery.Handle]]( `Byte[]` **data**, `int` **size**, `UInt32` **address**, `UInt16` **port** ) -##### `void` [[Handle|Facepunch.Steamworks.ServerQuery.Handle]]( `Byte[]` **data**, `int` **size**, `UInt32` **address**, `UInt16` **port** ) -*No documentation available* +### Properties - -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.ServerStats.md b/Facepunch.Steamworks.ServerStats.md index 278a989..9ad2cd2 100644 --- a/Facepunch.Steamworks.ServerStats.md +++ b/Facepunch.Steamworks.ServerStats.md @@ -1,25 +1,13 @@ # ServerStats -## Methods -##### `void` [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( `ulong` **steamid** ) -*No documentation available* +### Methods +* `void` [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( `ulong` **steamid** ) +* `Single` [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( `ulong` **steamid**, `string` **name**, `Single` **defaultValue** ) +* `int` [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( `ulong` **steamid**, `string` **name**, `int` **defaultValue** ) +* `void` [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( `ulong` **steamid** ) +* `bool` [[Set|Facepunch.Steamworks.ServerStats.Set]]( `ulong` **steamid**, `string` **name**, `int` **stat** ) +* `bool` [[Set|Facepunch.Steamworks.ServerStats.Set]]( `ulong` **steamid**, `string` **name**, `Single` **stat** ) -##### `Single` [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( `ulong` **steamid**, `string` **name**, `Single` **defaultValue** ) -*No documentation available* +### Properties -##### `int` [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( `ulong` **steamid**, `string` **name**, `int` **defaultValue** ) -*No documentation available* - -##### `void` [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( `ulong` **steamid** ) -*No documentation available* - -##### `bool` [[Set|Facepunch.Steamworks.ServerStats.Set]]( `ulong` **steamid**, `string` **name**, `int` **stat** ) -*No documentation available* - -##### `bool` [[Set|Facepunch.Steamworks.ServerStats.Set]]( `ulong` **steamid**, `string` **name**, `Single` **stat** ) -*No documentation available* - - -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.Stats.md b/Facepunch.Steamworks.Stats.md index 9e984bf..34fd49f 100644 --- a/Facepunch.Steamworks.Stats.md +++ b/Facepunch.Steamworks.Stats.md @@ -1,25 +1,13 @@ # Stats -## Methods -##### `Single` [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( `string` **name** ) -*No documentation available* +### Methods +* `Single` [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( `string` **name** ) +* `Double` [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( `string` **name** ) +* `Int64` [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( `string` **name** ) +* `int` [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( `string` **name** ) +* `void` [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( `int` **days** ) +* `void` [[UpdateStats|Facepunch.Steamworks.Stats.UpdateStats]]( ) -##### `Double` [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( `string` **name** ) -*No documentation available* +### Properties -##### `Int64` [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( `string` **name** ) -*No documentation available* - -##### `int` [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( `string` **name** ) -*No documentation available* - -##### `void` [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( `int` **days** ) -*No documentation available* - -##### `void` [[UpdateStats|Facepunch.Steamworks.Stats.UpdateStats]]( ) -*No documentation available* - - -##### Properties - -## Fields +### Fields diff --git a/Facepunch.Steamworks.SteamFriend.md b/Facepunch.Steamworks.SteamFriend.md index fa27274..9ffa27f 100644 --- a/Facepunch.Steamworks.SteamFriend.md +++ b/Facepunch.Steamworks.SteamFriend.md @@ -1,44 +1,31 @@ # SteamFriend -## Methods -##### `void` [[Refresh|Facepunch.Steamworks.SteamFriend.Refresh]]( ) -*No documentation available* +### Methods +* `void` [[Refresh|Facepunch.Steamworks.SteamFriend.Refresh]]( ) + +### Properties +* `ulong` [[CurrentAppId|Facepunch.Steamworks.SteamFriend.CurrentAppId]] + +* `ulong` [[Id|Facepunch.Steamworks.SteamFriend.Id]] + +* `bool` [[IsBlocked|Facepunch.Steamworks.SteamFriend.IsBlocked]] + +* `bool` [[IsFriend|Facepunch.Steamworks.SteamFriend.IsFriend]] + +* `bool` [[IsOnline|Facepunch.Steamworks.SteamFriend.IsOnline]] + +* `bool` [[IsPlaying|Facepunch.Steamworks.SteamFriend.IsPlaying]] + +* `bool` [[IsPlayingThisGame|Facepunch.Steamworks.SteamFriend.IsPlayingThisGame]] + +* `int` [[ServerGamePort|Facepunch.Steamworks.SteamFriend.ServerGamePort]] + +* `UInt32` [[ServerIp|Facepunch.Steamworks.SteamFriend.ServerIp]] + +* `ulong` [[ServerLobbyId|Facepunch.Steamworks.SteamFriend.ServerLobbyId]] + +* `int` [[ServerQueryPort|Facepunch.Steamworks.SteamFriend.ServerQueryPort]] -##### Properties -### `ulong` [[CurrentAppId|Facepunch.Steamworks.SteamFriend.CurrentAppId]] -The AppId this guy is playing - -### `ulong` [[Id|Facepunch.Steamworks.SteamFriend.Id]] -Steam Id - -### `bool` [[IsBlocked|Facepunch.Steamworks.SteamFriend.IsBlocked]] -Return true if blocked - -### `bool` [[IsFriend|Facepunch.Steamworks.SteamFriend.IsFriend]] -Return true if is a friend. Returns false if blocked, request etc. - -### `bool` [[IsOnline|Facepunch.Steamworks.SteamFriend.IsOnline]] -Returns true if this friend is online - -### `bool` [[IsPlaying|Facepunch.Steamworks.SteamFriend.IsPlaying]] -Returns true if this friend is online and playing this game - -### `bool` [[IsPlayingThisGame|Facepunch.Steamworks.SteamFriend.IsPlayingThisGame]] -Returns true if this friend is online and playing this game - -### `int` [[ServerGamePort|Facepunch.Steamworks.SteamFriend.ServerGamePort]] -*No documentation available* - -### `UInt32` [[ServerIp|Facepunch.Steamworks.SteamFriend.ServerIp]] -*No documentation available* - -### `ulong` [[ServerLobbyId|Facepunch.Steamworks.SteamFriend.ServerLobbyId]] -*No documentation available* - -### `int` [[ServerQueryPort|Facepunch.Steamworks.SteamFriend.ServerQueryPort]] -*No documentation available* - - -## Fields -### Name +### Fields +* `string` [[Name|Facepunch.Steamworks.SteamFriend.Name]] diff --git a/Facepunch.Steamworks.Voice.md b/Facepunch.Steamworks.Voice.md index 83483fa..f84fc4e 100644 --- a/Facepunch.Steamworks.Voice.md +++ b/Facepunch.Steamworks.Voice.md @@ -1,33 +1,22 @@ # Voice -## Methods -##### `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `Byte[]` **input**, `MemoryStream` **output**, `UInt32` **samepleRate** ) -*No documentation available* +### Methods +* `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `Byte[]` **input**, `MemoryStream` **output**, `UInt32` **samepleRate** ) +* `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `IntPtr` **input**, `int` **inputoffset**, `int` **inputsize**, `MemoryStream` **output**, `UInt32` **samepleRate** ) +* `void` [[Dispose|Facepunch.Steamworks.Voice.Dispose]]( ) -##### `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `IntPtr` **input**, `int` **inputoffset**, `int` **inputsize**, `MemoryStream` **output**, `UInt32` **samepleRate** ) -*No documentation available* +### Properties +* `DateTime` [[LastVoiceRecordTime|Facepunch.Steamworks.Voice.LastVoiceRecordTime]] -##### `void` [[Dispose|Facepunch.Steamworks.Voice.Dispose]]( ) -*No documentation available* +* `UInt32` [[OptimalSampleRate|Facepunch.Steamworks.Voice.OptimalSampleRate]] + +* `TimeSpan` [[TimeSinceLastVoiceRecord|Facepunch.Steamworks.Voice.TimeSinceLastVoiceRecord]] + +* `bool` [[WantsRecording|Facepunch.Steamworks.Voice.WantsRecording]] -##### Properties -### `DateTime` [[LastVoiceRecordTime|Facepunch.Steamworks.Voice.LastVoiceRecordTime]] -The last time voice was detected, recorded - -### `UInt32` [[OptimalSampleRate|Facepunch.Steamworks.Voice.OptimalSampleRate]] -Returns the optimal sample rate for voice - according to Steam - -### `TimeSpan` [[TimeSinceLastVoiceRecord|Facepunch.Steamworks.Voice.TimeSinceLastVoiceRecord]] -*No documentation available* - -### `bool` [[WantsRecording|Facepunch.Steamworks.Voice.WantsRecording]] -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. - - -## Fields -### OnCompressedData -### OnUncompressedData -### IsRecording -### DesiredSampleRate +### Fields +* `Action\` [[OnCompressedData|Facepunch.Steamworks.Voice.OnCompressedData]] +* `Action\` [[OnUncompressedData|Facepunch.Steamworks.Voice.OnUncompressedData]] +* `bool` [[IsRecording|Facepunch.Steamworks.Voice.IsRecording]] +* `UInt32` [[DesiredSampleRate|Facepunch.Steamworks.Voice.DesiredSampleRate]] diff --git a/Facepunch.Steamworks.Workshop.md b/Facepunch.Steamworks.Workshop.md index 865329f..6cad76e 100644 --- a/Facepunch.Steamworks.Workshop.md +++ b/Facepunch.Steamworks.Workshop.md @@ -1,22 +1,12 @@ # Workshop -## Methods -##### `Editor` [[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]( `ItemType` **type** ) -*No documentation available* +### Methods +* `Editor` [[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]( `ItemType` **type** ) +* `Query` [[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]( ) +* `void` [[Dispose|Facepunch.Steamworks.Workshop.Dispose]]( ) +* `Editor` [[EditItem|Facepunch.Steamworks.Workshop.EditItem]]( `ulong` **itemId** ) +* `Item` [[GetItem|Facepunch.Steamworks.Workshop.GetItem]]( `ulong` **itemid** ) -##### `Query` [[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]( ) -*No documentation available* +### Properties -##### `void` [[Dispose|Facepunch.Steamworks.Workshop.Dispose]]( ) -*No documentation available* - -##### `Editor` [[EditItem|Facepunch.Steamworks.Workshop.EditItem]]( `ulong` **itemId** ) -*No documentation available* - -##### `Item` [[GetItem|Facepunch.Steamworks.Workshop.GetItem]]( `ulong` **itemid** ) -*No documentation available* - - -##### Properties - -## Fields +### Fields