diff --git a/Facepunch.Steamworks.App.BuildId.md b/Facepunch.Steamworks.App.BuildId.md new file mode 100644 index 0000000..55a83b7 --- /dev/null +++ b/Facepunch.Steamworks.App.BuildId.md @@ -0,0 +1,11 @@ +# BuildId +## Property +``` +int BuildId +``` +## Summary +``` +Returns the current BuildId of the game. + This is pretty useless, as it isn't guarenteed to return + the build id you're playing, or the latest build id. +``` diff --git a/Facepunch.Steamworks.BaseSteamworks.AppId.md b/Facepunch.Steamworks.BaseSteamworks.AppId.md new file mode 100644 index 0000000..1547f6f --- /dev/null +++ b/Facepunch.Steamworks.BaseSteamworks.AppId.md @@ -0,0 +1,9 @@ +# AppId +## Property +``` +uint AppId +``` +## Summary +``` +Current running program's AppId +``` diff --git a/Facepunch.Steamworks.BaseSteamworks.Inventory.md b/Facepunch.Steamworks.BaseSteamworks.Inventory.md new file mode 100644 index 0000000..613972a --- /dev/null +++ b/Facepunch.Steamworks.BaseSteamworks.Inventory.md @@ -0,0 +1,9 @@ +# Inventory +## Property +``` +Inventory Inventory +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.BaseSteamworks.IsValid.md b/Facepunch.Steamworks.BaseSteamworks.IsValid.md new file mode 100644 index 0000000..bc55ae8 --- /dev/null +++ b/Facepunch.Steamworks.BaseSteamworks.IsValid.md @@ -0,0 +1,9 @@ +# IsValid +## Property +``` +bool IsValid +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.BaseSteamworks.Networking.md b/Facepunch.Steamworks.BaseSteamworks.Networking.md new file mode 100644 index 0000000..b1109b3 --- /dev/null +++ b/Facepunch.Steamworks.BaseSteamworks.Networking.md @@ -0,0 +1,9 @@ +# Networking +## Property +``` +Networking Networking +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.BaseSteamworks.OnMessage.md b/Facepunch.Steamworks.BaseSteamworks.OnMessage.md new file mode 100644 index 0000000..5698a53 --- /dev/null +++ b/Facepunch.Steamworks.BaseSteamworks.OnMessage.md @@ -0,0 +1,9 @@ +# OnMessage +## Property +``` +Action\ OnMessage +``` +## Summary +``` +Called with a message from Steam +``` diff --git a/Facepunch.Steamworks.BaseSteamworks.OnUpdate.md b/Facepunch.Steamworks.BaseSteamworks.OnUpdate.md new file mode 100644 index 0000000..f6a76ec --- /dev/null +++ b/Facepunch.Steamworks.BaseSteamworks.OnUpdate.md @@ -0,0 +1,9 @@ +# OnUpdate +## Property +``` +Action OnUpdate +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.BaseSteamworks.Workshop.md b/Facepunch.Steamworks.BaseSteamworks.Workshop.md new file mode 100644 index 0000000..01e9738 --- /dev/null +++ b/Facepunch.Steamworks.BaseSteamworks.Workshop.md @@ -0,0 +1,9 @@ +# Workshop +## Property +``` +Workshop Workshop +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.CallbackIdentifiers.md b/Facepunch.Steamworks.CallbackIdentifiers.md index 3f8cd05..d38387f 100644 --- a/Facepunch.Steamworks.CallbackIdentifiers.md +++ b/Facepunch.Steamworks.CallbackIdentifiers.md @@ -5,50 +5,3 @@ ### Properties ### 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.App.md b/Facepunch.Steamworks.Client.App.md new file mode 100644 index 0000000..b12ed4c --- /dev/null +++ b/Facepunch.Steamworks.Client.App.md @@ -0,0 +1,9 @@ +# App +## Property +``` +App App +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.AppId.md b/Facepunch.Steamworks.Client.AppId.md new file mode 100644 index 0000000..1547f6f --- /dev/null +++ b/Facepunch.Steamworks.Client.AppId.md @@ -0,0 +1,9 @@ +# AppId +## Property +``` +uint AppId +``` +## Summary +``` +Current running program's AppId +``` diff --git a/Facepunch.Steamworks.Client.Auth.md b/Facepunch.Steamworks.Client.Auth.md new file mode 100644 index 0000000..3ae5225 --- /dev/null +++ b/Facepunch.Steamworks.Client.Auth.md @@ -0,0 +1,9 @@ +# Auth +## Property +``` +Auth Auth +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.BetaName.md b/Facepunch.Steamworks.Client.BetaName.md new file mode 100644 index 0000000..c0e077b --- /dev/null +++ b/Facepunch.Steamworks.Client.BetaName.md @@ -0,0 +1,9 @@ +# BetaName +## Property +``` +string BetaName +``` +## Summary +``` +Current Beta name, if ser +``` diff --git a/Facepunch.Steamworks.Client.Friends.md b/Facepunch.Steamworks.Client.Friends.md new file mode 100644 index 0000000..ec5461e --- /dev/null +++ b/Facepunch.Steamworks.Client.Friends.md @@ -0,0 +1,9 @@ +# Friends +## Property +``` +Friends Friends +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.Inventory.md b/Facepunch.Steamworks.Client.Inventory.md new file mode 100644 index 0000000..613972a --- /dev/null +++ b/Facepunch.Steamworks.Client.Inventory.md @@ -0,0 +1,9 @@ +# Inventory +## Property +``` +Inventory Inventory +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.IsValid.md b/Facepunch.Steamworks.Client.IsValid.md new file mode 100644 index 0000000..bc55ae8 --- /dev/null +++ b/Facepunch.Steamworks.Client.IsValid.md @@ -0,0 +1,9 @@ +# IsValid +## Property +``` +bool IsValid +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.Networking.md b/Facepunch.Steamworks.Client.Networking.md new file mode 100644 index 0000000..b1109b3 --- /dev/null +++ b/Facepunch.Steamworks.Client.Networking.md @@ -0,0 +1,9 @@ +# Networking +## Property +``` +Networking Networking +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.OnMessage.md b/Facepunch.Steamworks.Client.OnMessage.md new file mode 100644 index 0000000..5698a53 --- /dev/null +++ b/Facepunch.Steamworks.Client.OnMessage.md @@ -0,0 +1,9 @@ +# OnMessage +## Property +``` +Action\ OnMessage +``` +## Summary +``` +Called with a message from Steam +``` diff --git a/Facepunch.Steamworks.Client.OnUpdate.md b/Facepunch.Steamworks.Client.OnUpdate.md new file mode 100644 index 0000000..f6a76ec --- /dev/null +++ b/Facepunch.Steamworks.Client.OnUpdate.md @@ -0,0 +1,9 @@ +# OnUpdate +## Property +``` +Action OnUpdate +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.Overlay.md b/Facepunch.Steamworks.Client.Overlay.md new file mode 100644 index 0000000..9b76056 --- /dev/null +++ b/Facepunch.Steamworks.Client.Overlay.md @@ -0,0 +1,9 @@ +# Overlay +## Property +``` +Overlay Overlay +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.Screenshots.md b/Facepunch.Steamworks.Client.Screenshots.md new file mode 100644 index 0000000..67497a3 --- /dev/null +++ b/Facepunch.Steamworks.Client.Screenshots.md @@ -0,0 +1,9 @@ +# Screenshots +## Property +``` +Screenshots Screenshots +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.ServerList.md b/Facepunch.Steamworks.Client.ServerList.md new file mode 100644 index 0000000..39350d2 --- /dev/null +++ b/Facepunch.Steamworks.Client.ServerList.md @@ -0,0 +1,9 @@ +# ServerList +## Property +``` +ServerList ServerList +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.Stats.md b/Facepunch.Steamworks.Client.Stats.md new file mode 100644 index 0000000..cb82ace --- /dev/null +++ b/Facepunch.Steamworks.Client.Stats.md @@ -0,0 +1,9 @@ +# Stats +## Property +``` +Stats Stats +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.SteamId.md b/Facepunch.Steamworks.Client.SteamId.md new file mode 100644 index 0000000..bc6bb8b --- /dev/null +++ b/Facepunch.Steamworks.Client.SteamId.md @@ -0,0 +1,9 @@ +# SteamId +## Property +``` +ulong SteamId +``` +## Summary +``` +Current user's SteamId +``` diff --git a/Facepunch.Steamworks.Client.Username.md b/Facepunch.Steamworks.Client.Username.md new file mode 100644 index 0000000..a817ec3 --- /dev/null +++ b/Facepunch.Steamworks.Client.Username.md @@ -0,0 +1,9 @@ +# Username +## Property +``` +string Username +``` +## Summary +``` +Current user's Username +``` diff --git a/Facepunch.Steamworks.Client.Voice.md b/Facepunch.Steamworks.Client.Voice.md new file mode 100644 index 0000000..ab5bbdc --- /dev/null +++ b/Facepunch.Steamworks.Client.Voice.md @@ -0,0 +1,9 @@ +# Voice +## Property +``` +Voice Voice +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Client.Workshop.md b/Facepunch.Steamworks.Client.Workshop.md new file mode 100644 index 0000000..01e9738 --- /dev/null +++ b/Facepunch.Steamworks.Client.Workshop.md @@ -0,0 +1,9 @@ +# Workshop +## Property +``` +Workshop Workshop +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Config.UseThisCall.md b/Facepunch.Steamworks.Config.UseThisCall.md new file mode 100644 index 0000000..b0cb105 --- /dev/null +++ b/Facepunch.Steamworks.Config.UseThisCall.md @@ -0,0 +1,14 @@ +# UseThisCall +## Property +``` +bool UseThisCall +``` +## Summary +``` +Some platforms allow/need CallingConvention.ThisCall. If you're crashing with argument null + errors on certain platforms, try flipping this to true. + + I owe this logic to Riley Labrecque's hard work on Steamworks.net - I don't have the knowledge + or patience to find this shit on my own, so massive thanks to him. And also massive thanks to him + for releasing his shit open source under the MIT license so we can all learn and iterate. +``` diff --git a/Facepunch.Steamworks.Defines.md b/Facepunch.Steamworks.Defines.md index c76af52..756849e 100644 --- a/Facepunch.Steamworks.Defines.md +++ b/Facepunch.Steamworks.Defines.md @@ -5,27 +5,3 @@ ### Properties ### 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.All.md b/Facepunch.Steamworks.Friends.All.md new file mode 100644 index 0000000..35268dd --- /dev/null +++ b/Facepunch.Steamworks.Friends.All.md @@ -0,0 +1,9 @@ +# All +## Property +``` +IEnumerable\ All +``` +## Summary +``` +Returns all friends, even blocked, ignored, friend requests etc +``` diff --git a/Facepunch.Steamworks.Friends.AllBlocked.md b/Facepunch.Steamworks.Friends.AllBlocked.md new file mode 100644 index 0000000..ec71861 --- /dev/null +++ b/Facepunch.Steamworks.Friends.AllBlocked.md @@ -0,0 +1,9 @@ +# AllBlocked +## Property +``` +IEnumerable\ AllBlocked +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Friends.AllFriends.md b/Facepunch.Steamworks.Friends.AllFriends.md new file mode 100644 index 0000000..20034a1 --- /dev/null +++ b/Facepunch.Steamworks.Friends.AllFriends.md @@ -0,0 +1,9 @@ +# AllFriends +## Property +``` +IEnumerable\ AllFriends +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Image.Data.md b/Facepunch.Steamworks.Image.Data.md new file mode 100644 index 0000000..e97b32d --- /dev/null +++ b/Facepunch.Steamworks.Image.Data.md @@ -0,0 +1,9 @@ +# Data +## Property +``` +byte[] Data +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Image.Height.md b/Facepunch.Steamworks.Image.Height.md new file mode 100644 index 0000000..56cb94f --- /dev/null +++ b/Facepunch.Steamworks.Image.Height.md @@ -0,0 +1,9 @@ +# Height +## Property +``` +int Height +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Image.Id.md b/Facepunch.Steamworks.Image.Id.md new file mode 100644 index 0000000..9e26502 --- /dev/null +++ b/Facepunch.Steamworks.Image.Id.md @@ -0,0 +1,9 @@ +# Id +## Property +``` +int Id +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Image.IsError.md b/Facepunch.Steamworks.Image.IsError.md new file mode 100644 index 0000000..d7ac5e8 --- /dev/null +++ b/Facepunch.Steamworks.Image.IsError.md @@ -0,0 +1,9 @@ +# IsError +## Property +``` +bool IsError +``` +## Summary +``` +Return true if this image couldn't be loaded for some reason +``` diff --git a/Facepunch.Steamworks.Image.IsLoaded.md b/Facepunch.Steamworks.Image.IsLoaded.md new file mode 100644 index 0000000..3bb9031 --- /dev/null +++ b/Facepunch.Steamworks.Image.IsLoaded.md @@ -0,0 +1,9 @@ +# IsLoaded +## Property +``` +bool IsLoaded +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Image.Width.md b/Facepunch.Steamworks.Image.Width.md new file mode 100644 index 0000000..49a14c6 --- /dev/null +++ b/Facepunch.Steamworks.Image.Width.md @@ -0,0 +1,9 @@ +# Width +## Property +``` +int Width +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Inventory.Definitions.md b/Facepunch.Steamworks.Inventory.Definitions.md new file mode 100644 index 0000000..97fd687 --- /dev/null +++ b/Facepunch.Steamworks.Inventory.Definitions.md @@ -0,0 +1,10 @@ +# Definitions +## Property +``` +Definition[] Definitions +``` +## Summary +``` +A list of items defined for this app. + This should be immediately populated and available. +``` diff --git a/Facepunch.Steamworks.Inventory.Items.md b/Facepunch.Steamworks.Inventory.Items.md new file mode 100644 index 0000000..e0dbae2 --- /dev/null +++ b/Facepunch.Steamworks.Inventory.Items.md @@ -0,0 +1,10 @@ +# Items +## Property +``` +Item[] Items +``` +## Summary +``` +A list of items owned by this user. You should call Refresh() before trying to access this, + and then wait until it's non null or listen to OnUpdate to find out immediately when it's populated. +``` diff --git a/Facepunch.Steamworks.Inventory.OnUpdate.md b/Facepunch.Steamworks.Inventory.OnUpdate.md new file mode 100644 index 0000000..7837998 --- /dev/null +++ b/Facepunch.Steamworks.Inventory.OnUpdate.md @@ -0,0 +1,10 @@ +# OnUpdate +## Property +``` +Action OnUpdate +``` +## Summary +``` +Called when the local client's items are first retrieved, and when they change. + Obviously not called on the server. +``` diff --git a/Facepunch.Steamworks.Inventory.SerializedExpireTime.md b/Facepunch.Steamworks.Inventory.SerializedExpireTime.md new file mode 100644 index 0000000..2c31d29 --- /dev/null +++ b/Facepunch.Steamworks.Inventory.SerializedExpireTime.md @@ -0,0 +1,9 @@ +# SerializedExpireTime +## Property +``` +DateTime SerializedExpireTime +``` +## Summary +``` +Serialized data exprires after an hour. This is the time the value in SerializedItems will expire. +``` diff --git a/Facepunch.Steamworks.Inventory.SerializedItems.md b/Facepunch.Steamworks.Inventory.SerializedItems.md new file mode 100644 index 0000000..d9235fd --- /dev/null +++ b/Facepunch.Steamworks.Inventory.SerializedItems.md @@ -0,0 +1,10 @@ +# SerializedItems +## Property +``` +byte[] SerializedItems +``` +## Summary +``` +You can send this data to a server, or another player who can then deserialize it + and get a verified list of items. +``` diff --git a/Facepunch.Steamworks.Networking.OnConnectionFailed.md b/Facepunch.Steamworks.Networking.OnConnectionFailed.md new file mode 100644 index 0000000..42c317a --- /dev/null +++ b/Facepunch.Steamworks.Networking.OnConnectionFailed.md @@ -0,0 +1,9 @@ +# OnConnectionFailed +## Property +``` +Action\ OnConnectionFailed +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Networking.OnIncomingConnection.md b/Facepunch.Steamworks.Networking.OnIncomingConnection.md new file mode 100644 index 0000000..a13c9ba --- /dev/null +++ b/Facepunch.Steamworks.Networking.OnIncomingConnection.md @@ -0,0 +1,9 @@ +# OnIncomingConnection +## Property +``` +Func\ OnIncomingConnection +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Networking.OnP2PData.md b/Facepunch.Steamworks.Networking.OnP2PData.md new file mode 100644 index 0000000..f0741d3 --- /dev/null +++ b/Facepunch.Steamworks.Networking.OnP2PData.md @@ -0,0 +1,9 @@ +# OnP2PData +## Property +``` +Action\ OnP2PData +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.AppId.md b/Facepunch.Steamworks.Server.AppId.md new file mode 100644 index 0000000..1547f6f --- /dev/null +++ b/Facepunch.Steamworks.Server.AppId.md @@ -0,0 +1,9 @@ +# AppId +## Property +``` +uint AppId +``` +## Summary +``` +Current running program's AppId +``` diff --git a/Facepunch.Steamworks.Server.Auth.md b/Facepunch.Steamworks.Server.Auth.md new file mode 100644 index 0000000..855bcd0 --- /dev/null +++ b/Facepunch.Steamworks.Server.Auth.md @@ -0,0 +1,9 @@ +# Auth +## Property +``` +ServerAuth Auth +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.BotCount.md b/Facepunch.Steamworks.Server.BotCount.md new file mode 100644 index 0000000..45d9151 --- /dev/null +++ b/Facepunch.Steamworks.Server.BotCount.md @@ -0,0 +1,10 @@ +# BotCount +## Property +``` +int BotCount +``` +## Summary +``` +Gets or sets the current BotCount. + This doesn't enforce any kind of limit, it just updates the master server. +``` diff --git a/Facepunch.Steamworks.Server.GameDescription.md b/Facepunch.Steamworks.Server.GameDescription.md new file mode 100644 index 0000000..11dfcd1 --- /dev/null +++ b/Facepunch.Steamworks.Server.GameDescription.md @@ -0,0 +1,9 @@ +# GameDescription +## Property +``` +string GameDescription +``` +## Summary +``` +Gets or sets the current Product +``` diff --git a/Facepunch.Steamworks.Server.GameTags.md b/Facepunch.Steamworks.Server.GameTags.md new file mode 100644 index 0000000..6133fc1 --- /dev/null +++ b/Facepunch.Steamworks.Server.GameTags.md @@ -0,0 +1,9 @@ +# GameTags +## Property +``` +string GameTags +``` +## Summary +``` +Gets or sets the current GameTags +``` diff --git a/Facepunch.Steamworks.Server.Inventory.md b/Facepunch.Steamworks.Server.Inventory.md new file mode 100644 index 0000000..613972a --- /dev/null +++ b/Facepunch.Steamworks.Server.Inventory.md @@ -0,0 +1,9 @@ +# Inventory +## Property +``` +Inventory Inventory +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.IsValid.md b/Facepunch.Steamworks.Server.IsValid.md new file mode 100644 index 0000000..bc55ae8 --- /dev/null +++ b/Facepunch.Steamworks.Server.IsValid.md @@ -0,0 +1,9 @@ +# IsValid +## Property +``` +bool IsValid +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.LoggedOn.md b/Facepunch.Steamworks.Server.LoggedOn.md new file mode 100644 index 0000000..d714c6c --- /dev/null +++ b/Facepunch.Steamworks.Server.LoggedOn.md @@ -0,0 +1,9 @@ +# LoggedOn +## Property +``` +bool LoggedOn +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.MapName.md b/Facepunch.Steamworks.Server.MapName.md new file mode 100644 index 0000000..0e553a9 --- /dev/null +++ b/Facepunch.Steamworks.Server.MapName.md @@ -0,0 +1,9 @@ +# MapName +## Property +``` +string MapName +``` +## Summary +``` +Gets or sets the current Map Name. +``` diff --git a/Facepunch.Steamworks.Server.MaxPlayers.md b/Facepunch.Steamworks.Server.MaxPlayers.md new file mode 100644 index 0000000..f4c09af --- /dev/null +++ b/Facepunch.Steamworks.Server.MaxPlayers.md @@ -0,0 +1,10 @@ +# MaxPlayers +## Property +``` +int MaxPlayers +``` +## Summary +``` +Gets or sets the current MaxPlayers. + This doesn't enforce any kind of limit, it just updates the master server. +``` diff --git a/Facepunch.Steamworks.Server.ModDir.md b/Facepunch.Steamworks.Server.ModDir.md new file mode 100644 index 0000000..813e7b2 --- /dev/null +++ b/Facepunch.Steamworks.Server.ModDir.md @@ -0,0 +1,9 @@ +# ModDir +## Property +``` +string ModDir +``` +## Summary +``` +Gets or sets the current ModDir +``` diff --git a/Facepunch.Steamworks.Server.Networking.md b/Facepunch.Steamworks.Server.Networking.md new file mode 100644 index 0000000..b1109b3 --- /dev/null +++ b/Facepunch.Steamworks.Server.Networking.md @@ -0,0 +1,9 @@ +# Networking +## Property +``` +Networking Networking +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.OnMessage.md b/Facepunch.Steamworks.Server.OnMessage.md new file mode 100644 index 0000000..5698a53 --- /dev/null +++ b/Facepunch.Steamworks.Server.OnMessage.md @@ -0,0 +1,9 @@ +# OnMessage +## Property +``` +Action\ OnMessage +``` +## Summary +``` +Called with a message from Steam +``` diff --git a/Facepunch.Steamworks.Server.OnUpdate.md b/Facepunch.Steamworks.Server.OnUpdate.md new file mode 100644 index 0000000..f6a76ec --- /dev/null +++ b/Facepunch.Steamworks.Server.OnUpdate.md @@ -0,0 +1,9 @@ +# OnUpdate +## Property +``` +Action OnUpdate +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.Passworded.md b/Facepunch.Steamworks.Server.Passworded.md new file mode 100644 index 0000000..cfc81da --- /dev/null +++ b/Facepunch.Steamworks.Server.Passworded.md @@ -0,0 +1,9 @@ +# Passworded +## Property +``` +bool Passworded +``` +## Summary +``` +Gets or sets the current Passworded +``` diff --git a/Facepunch.Steamworks.Server.Product.md b/Facepunch.Steamworks.Server.Product.md new file mode 100644 index 0000000..1ca01e3 --- /dev/null +++ b/Facepunch.Steamworks.Server.Product.md @@ -0,0 +1,9 @@ +# Product +## Property +``` +string Product +``` +## Summary +``` +Gets or sets the current Product +``` diff --git a/Facepunch.Steamworks.Server.Query.md b/Facepunch.Steamworks.Server.Query.md new file mode 100644 index 0000000..9cf89a7 --- /dev/null +++ b/Facepunch.Steamworks.Server.Query.md @@ -0,0 +1,9 @@ +# Query +## Property +``` +ServerQuery Query +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.ServerName.md b/Facepunch.Steamworks.Server.ServerName.md new file mode 100644 index 0000000..b9cfb1d --- /dev/null +++ b/Facepunch.Steamworks.Server.ServerName.md @@ -0,0 +1,9 @@ +# ServerName +## Property +``` +string ServerName +``` +## Summary +``` +Gets or sets the current ServerName +``` diff --git a/Facepunch.Steamworks.Server.Stats.md b/Facepunch.Steamworks.Server.Stats.md new file mode 100644 index 0000000..384c273 --- /dev/null +++ b/Facepunch.Steamworks.Server.Stats.md @@ -0,0 +1,9 @@ +# Stats +## Property +``` +ServerStats Stats +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Server.SteamId.md b/Facepunch.Steamworks.Server.SteamId.md new file mode 100644 index 0000000..bc6bb8b --- /dev/null +++ b/Facepunch.Steamworks.Server.SteamId.md @@ -0,0 +1,9 @@ +# SteamId +## Property +``` +ulong SteamId +``` +## Summary +``` +Current user's SteamId +``` diff --git a/Facepunch.Steamworks.Server.Username.md b/Facepunch.Steamworks.Server.Username.md new file mode 100644 index 0000000..a817ec3 --- /dev/null +++ b/Facepunch.Steamworks.Server.Username.md @@ -0,0 +1,9 @@ +# Username +## Property +``` +string Username +``` +## Summary +``` +Current user's Username +``` diff --git a/Facepunch.Steamworks.Server.Workshop.md b/Facepunch.Steamworks.Server.Workshop.md new file mode 100644 index 0000000..01e9738 --- /dev/null +++ b/Facepunch.Steamworks.Server.Workshop.md @@ -0,0 +1,9 @@ +# Workshop +## Property +``` +Workshop Workshop +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.ServerAuth.OnAuthChange.md b/Facepunch.Steamworks.ServerAuth.OnAuthChange.md new file mode 100644 index 0000000..a64cc27 --- /dev/null +++ b/Facepunch.Steamworks.ServerAuth.OnAuthChange.md @@ -0,0 +1,9 @@ +# OnAuthChange +## Property +``` +Action\ OnAuthChange +``` +## Summary +``` +Steamid, Ownerid, Status +``` diff --git a/Facepunch.Steamworks.SteamFriend.CurrentAppId.md b/Facepunch.Steamworks.SteamFriend.CurrentAppId.md new file mode 100644 index 0000000..ff8f36b --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.CurrentAppId.md @@ -0,0 +1,9 @@ +# CurrentAppId +## Property +``` +ulong CurrentAppId +``` +## Summary +``` +The AppId this guy is playing +``` diff --git a/Facepunch.Steamworks.SteamFriend.Id.md b/Facepunch.Steamworks.SteamFriend.Id.md new file mode 100644 index 0000000..577c980 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.Id.md @@ -0,0 +1,9 @@ +# Id +## Property +``` +ulong Id +``` +## Summary +``` +Steam Id +``` diff --git a/Facepunch.Steamworks.SteamFriend.IsBlocked.md b/Facepunch.Steamworks.SteamFriend.IsBlocked.md new file mode 100644 index 0000000..45deb20 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.IsBlocked.md @@ -0,0 +1,9 @@ +# IsBlocked +## Property +``` +bool IsBlocked +``` +## Summary +``` +Return true if blocked +``` diff --git a/Facepunch.Steamworks.SteamFriend.IsFriend.md b/Facepunch.Steamworks.SteamFriend.IsFriend.md new file mode 100644 index 0000000..c10d046 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.IsFriend.md @@ -0,0 +1,9 @@ +# IsFriend +## Property +``` +bool IsFriend +``` +## Summary +``` +Return true if is a friend. Returns false if blocked, request etc. +``` diff --git a/Facepunch.Steamworks.SteamFriend.IsOnline.md b/Facepunch.Steamworks.SteamFriend.IsOnline.md new file mode 100644 index 0000000..4391440 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.IsOnline.md @@ -0,0 +1,9 @@ +# IsOnline +## Property +``` +bool IsOnline +``` +## Summary +``` +Returns true if this friend is online +``` diff --git a/Facepunch.Steamworks.SteamFriend.IsPlaying.md b/Facepunch.Steamworks.SteamFriend.IsPlaying.md new file mode 100644 index 0000000..4aad965 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.IsPlaying.md @@ -0,0 +1,9 @@ +# IsPlaying +## Property +``` +bool IsPlaying +``` +## Summary +``` +Returns true if this friend is online and playing this game +``` diff --git a/Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md b/Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md new file mode 100644 index 0000000..2b8f5f6 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.IsPlayingThisGame.md @@ -0,0 +1,9 @@ +# IsPlayingThisGame +## Property +``` +bool IsPlayingThisGame +``` +## Summary +``` +Returns true if this friend is online and playing this game +``` diff --git a/Facepunch.Steamworks.SteamFriend.Name.md b/Facepunch.Steamworks.SteamFriend.Name.md new file mode 100644 index 0000000..48fb6a5 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.Name.md @@ -0,0 +1,9 @@ +# Name +## Property +``` +string Name +``` +## Summary +``` +Their current display name +``` diff --git a/Facepunch.Steamworks.SteamFriend.ServerGamePort.md b/Facepunch.Steamworks.SteamFriend.ServerGamePort.md new file mode 100644 index 0000000..5df5839 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.ServerGamePort.md @@ -0,0 +1,9 @@ +# ServerGamePort +## Property +``` +int ServerGamePort +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.SteamFriend.ServerIp.md b/Facepunch.Steamworks.SteamFriend.ServerIp.md new file mode 100644 index 0000000..e39d9a5 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.ServerIp.md @@ -0,0 +1,9 @@ +# ServerIp +## Property +``` +uint ServerIp +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.SteamFriend.ServerLobbyId.md b/Facepunch.Steamworks.SteamFriend.ServerLobbyId.md new file mode 100644 index 0000000..a311ace --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.ServerLobbyId.md @@ -0,0 +1,9 @@ +# ServerLobbyId +## Property +``` +ulong ServerLobbyId +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.SteamFriend.ServerQueryPort.md b/Facepunch.Steamworks.SteamFriend.ServerQueryPort.md new file mode 100644 index 0000000..1633e57 --- /dev/null +++ b/Facepunch.Steamworks.SteamFriend.ServerQueryPort.md @@ -0,0 +1,9 @@ +# ServerQueryPort +## Property +``` +int ServerQueryPort +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Voice.DesiredSampleRate.md b/Facepunch.Steamworks.Voice.DesiredSampleRate.md new file mode 100644 index 0000000..12cad4b --- /dev/null +++ b/Facepunch.Steamworks.Voice.DesiredSampleRate.md @@ -0,0 +1,9 @@ +# DesiredSampleRate +## Property +``` +uint DesiredSampleRate +``` +## Summary +``` +If set we will capture the audio at this rate. If unset (set to 0) will capture at OptimalSampleRate +``` diff --git a/Facepunch.Steamworks.Voice.IsRecording.md b/Facepunch.Steamworks.Voice.IsRecording.md new file mode 100644 index 0000000..8b219b1 --- /dev/null +++ b/Facepunch.Steamworks.Voice.IsRecording.md @@ -0,0 +1,9 @@ +# IsRecording +## Property +``` +bool IsRecording +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Voice.LastVoiceRecordTime.md b/Facepunch.Steamworks.Voice.LastVoiceRecordTime.md new file mode 100644 index 0000000..a306729 --- /dev/null +++ b/Facepunch.Steamworks.Voice.LastVoiceRecordTime.md @@ -0,0 +1,9 @@ +# LastVoiceRecordTime +## Property +``` +DateTime LastVoiceRecordTime +``` +## Summary +``` +The last time voice was detected, recorded +``` diff --git a/Facepunch.Steamworks.Voice.OnCompressedData.md b/Facepunch.Steamworks.Voice.OnCompressedData.md new file mode 100644 index 0000000..fa5d9df --- /dev/null +++ b/Facepunch.Steamworks.Voice.OnCompressedData.md @@ -0,0 +1,9 @@ +# OnCompressedData +## Property +``` +Action\ OnCompressedData +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Voice.OnUncompressedData.md b/Facepunch.Steamworks.Voice.OnUncompressedData.md new file mode 100644 index 0000000..005be03 --- /dev/null +++ b/Facepunch.Steamworks.Voice.OnUncompressedData.md @@ -0,0 +1,9 @@ +# OnUncompressedData +## Property +``` +Action\ OnUncompressedData +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Voice.OptimalSampleRate.md b/Facepunch.Steamworks.Voice.OptimalSampleRate.md new file mode 100644 index 0000000..393dc79 --- /dev/null +++ b/Facepunch.Steamworks.Voice.OptimalSampleRate.md @@ -0,0 +1,9 @@ +# OptimalSampleRate +## Property +``` +uint OptimalSampleRate +``` +## Summary +``` +Returns the optimal sample rate for voice - according to Steam +``` diff --git a/Facepunch.Steamworks.Voice.TimeSinceLastVoiceRecord.md b/Facepunch.Steamworks.Voice.TimeSinceLastVoiceRecord.md new file mode 100644 index 0000000..8492c23 --- /dev/null +++ b/Facepunch.Steamworks.Voice.TimeSinceLastVoiceRecord.md @@ -0,0 +1,9 @@ +# TimeSinceLastVoiceRecord +## Property +``` +TimeSpan TimeSinceLastVoiceRecord +``` +## Summary +``` +No documentation available +``` diff --git a/Facepunch.Steamworks.Voice.WantsRecording.md b/Facepunch.Steamworks.Voice.WantsRecording.md new file mode 100644 index 0000000..c02c679 --- /dev/null +++ b/Facepunch.Steamworks.Voice.WantsRecording.md @@ -0,0 +1,10 @@ +# WantsRecording +## Property +``` +bool WantsRecording +``` +## Summary +``` +If set to true we are listening to the mic. + You should usually toggle this with the press of a key for push to talk. +``` diff --git a/Image.md b/Image.md deleted file mode 100644 index e64afbf..0000000 --- a/Image.md +++ /dev/null @@ -1,28 +0,0 @@ -# Image - -## Methods -##### `Color` [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( `int` **x**, `int` **y** ) -*No documentation available* - - -##### Properties -### `Byte[]` [[Data|Facepunch.Steamworks.Image.Data]] -*No documentation available* - -### `int` [[Height|Facepunch.Steamworks.Image.Height]] -*No documentation available* - -### `int` [[Id|Facepunch.Steamworks.Image.Id]] -*No documentation available* - -### `bool` [[IsError|Facepunch.Steamworks.Image.IsError]] -Return true if this image couldn't be loaded for some reason - -### `bool` [[IsLoaded|Facepunch.Steamworks.Image.IsLoaded]] -*No documentation available* - -### `int` [[Width|Facepunch.Steamworks.Image.Width]] -*No documentation available* - - -## Fields diff --git a/Poop/Auth.md b/Poop/Auth.md new file mode 100644 index 0000000..8fa3f24 --- /dev/null +++ b/Poop/Auth.md @@ -0,0 +1,8 @@ +# Auth + +### Methods +* **Ticket** [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( ) + +### Properties + +### Fields