Gen

Garry Newman 2016-11-02 18:47:03 +00:00
parent 26b6d4a5a5
commit b7031b610c
24 changed files with 102 additions and 98 deletions

@ -1,11 +1,11 @@
# App
## Methods
### `void` [[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]( `bool` **missingFilesOnly** )
##### `void` [[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]( `bool` **missingFilesOnly** )
*No documentation available*
## Properties
##### 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

@ -1,11 +1,11 @@
# Auth
## Methods
### `Ticket` [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( )
##### `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.
## Properties
##### Properties
## Fields

@ -1,17 +1,17 @@
# BaseSteamworks
## Methods
### `void` [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( )
##### `void` [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( )
*No documentation available*
### `void` [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( )
##### `void` [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( )
*No documentation available*
### `void` [[Update|Facepunch.Steamworks.BaseSteamworks.Update]]( )
##### `void` [[Update|Facepunch.Steamworks.BaseSteamworks.Update]]( )
*No documentation available*
## Properties
##### Properties
### `UInt32` [[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]]
Current running program's AppId

@ -1,10 +1,10 @@
# CallbackHandle
## Methods
### `void` [[Dispose|Facepunch.Steamworks.CallbackHandle.Dispose]]( )
##### `void` [[Dispose|Facepunch.Steamworks.CallbackHandle.Dispose]]( )
*No documentation available*
## Properties
##### Properties
## Fields

@ -2,7 +2,7 @@
## Methods
## Properties
##### Properties
## Fields
### SteamUser

@ -1,14 +1,14 @@
# Client
## Methods
### `void` [[Dispose|Facepunch.Steamworks.Client.Dispose]]( )
##### `void` [[Dispose|Facepunch.Steamworks.Client.Dispose]]( )
*No documentation available*
### `void` [[Update|Facepunch.Steamworks.Client.Update]]( )
##### `void` [[Update|Facepunch.Steamworks.Client.Update]]( )
Should be called at least once every frame
## Properties
##### Properties
### `App` [[App|Facepunch.Steamworks.Client.App]]
*No documentation available*

@ -1,11 +1,11 @@
# Config
## Methods
### `void` [[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]( `OperatingSystem` **os**, `Architecture` **arch** )
##### `void` [[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]( `OperatingSystem` **os**, `Architecture` **arch** )
*No documentation available*
## Properties
##### 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.

@ -2,7 +2,7 @@
## Methods
## Properties
##### Properties
## Fields
### STEAMAPPLIST_INTERFACE_VERSION

@ -1,20 +1,20 @@
# Friends
## Methods
### `SteamFriend` [[Get|Facepunch.Steamworks.Friends.Get]]( `ulong` **steamid** )
##### `SteamFriend` [[Get|Facepunch.Steamworks.Friends.Get]]( `ulong` **steamid** )
*No documentation available*
### `Image` [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( `AvatarSize` **size**, `ulong` **steamid** )
##### `Image` [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( `AvatarSize` **size**, `ulong` **steamid** )
*No documentation available*
### `string` [[GetName|Facepunch.Steamworks.Friends.GetName]]( `ulong` **steamid** )
##### `string` [[GetName|Facepunch.Steamworks.Friends.GetName]]( `ulong` **steamid** )
*No documentation available*
### `void` [[Refresh|Facepunch.Steamworks.Friends.Refresh]]( )
##### `void` [[Refresh|Facepunch.Steamworks.Friends.Refresh]]( )
*No documentation available*
## Properties
##### Properties
### `IEnumerable\<SteamFriend\>` [[All|Facepunch.Steamworks.Friends.All]]
Returns all friends, even blocked, ignored, friend requests etc

@ -1,34 +1,34 @@
# Inventory
## Methods
### `Definition` [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( `int` **id** )
##### `Definition` [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( `int` **id** )
*No documentation available*
### `Result` [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( `Byte[]` **data**, `int` **dataLength** )
##### `Result` [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( `Byte[]` **data**, `int` **dataLength** )
*No documentation available*
### `void` [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( )
##### `void` [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( )
*No documentation available*
### `Definition` [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( `int` **DefinitionId** )
##### `Definition` [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( `int` **DefinitionId** )
*No documentation available*
### `void` [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]( )
##### `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** )
##### `Single` [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( `string` **price** )
*No documentation available*
### `void` [[Refresh|Facepunch.Steamworks.Inventory.Refresh]]( )
##### `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
##### Properties
## Fields
### OnUpdate

@ -1,14 +1,14 @@
# Networking
## Methods
### `void` [[Dispose|Facepunch.Steamworks.Networking.Dispose]]( )
##### `void` [[Dispose|Facepunch.Steamworks.Networking.Dispose]]( )
*No documentation available*
### `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

@ -1,40 +1,40 @@
# Overlay
## Methods
### `void` [[AcceptFriendRequest|Facepunch.Steamworks.Overlay.AcceptFriendRequest]]( `ulong` **steamid** )
##### `void` [[AcceptFriendRequest|Facepunch.Steamworks.Overlay.AcceptFriendRequest]]( `ulong` **steamid** )
*No documentation available*
### `void` [[AddFriend|Facepunch.Steamworks.Overlay.AddFriend]]( `ulong` **steamid** )
##### `void` [[AddFriend|Facepunch.Steamworks.Overlay.AddFriend]]( `ulong` **steamid** )
*No documentation available*
### `void` [[IgnoreFriendRequest|Facepunch.Steamworks.Overlay.IgnoreFriendRequest]]( `ulong` **steamid** )
##### `void` [[IgnoreFriendRequest|Facepunch.Steamworks.Overlay.IgnoreFriendRequest]]( `ulong` **steamid** )
*No documentation available*
### `void` [[OpenAchievements|Facepunch.Steamworks.Overlay.OpenAchievements]]( `ulong` **steamid** )
##### `void` [[OpenAchievements|Facepunch.Steamworks.Overlay.OpenAchievements]]( `ulong` **steamid** )
*No documentation available*
### `void` [[OpenChat|Facepunch.Steamworks.Overlay.OpenChat]]( `ulong` **steamid** )
##### `void` [[OpenChat|Facepunch.Steamworks.Overlay.OpenChat]]( `ulong` **steamid** )
*No documentation available*
### `void` [[OpenProfile|Facepunch.Steamworks.Overlay.OpenProfile]]( `ulong` **steamid** )
##### `void` [[OpenProfile|Facepunch.Steamworks.Overlay.OpenProfile]]( `ulong` **steamid** )
*No documentation available*
### `void` [[OpenStats|Facepunch.Steamworks.Overlay.OpenStats]]( `ulong` **steamid** )
##### `void` [[OpenStats|Facepunch.Steamworks.Overlay.OpenStats]]( `ulong` **steamid** )
*No documentation available*
### `void` [[OpenTrade|Facepunch.Steamworks.Overlay.OpenTrade]]( `ulong` **steamid** )
##### `void` [[OpenTrade|Facepunch.Steamworks.Overlay.OpenTrade]]( `ulong` **steamid** )
*No documentation available*
### `void` [[OpenUrl|Facepunch.Steamworks.Overlay.OpenUrl]]( `string` **url** )
##### `void` [[OpenUrl|Facepunch.Steamworks.Overlay.OpenUrl]]( `string` **url** )
*No documentation available*
### `void` [[OpenUserPage|Facepunch.Steamworks.Overlay.OpenUserPage]]( `string` **name**, `ulong` **steamid** )
##### `void` [[OpenUserPage|Facepunch.Steamworks.Overlay.OpenUserPage]]( `string` **name**, `ulong` **steamid** )
*No documentation available*
### `void` [[RemoveFriend|Facepunch.Steamworks.Overlay.RemoveFriend]]( `ulong` **steamid** )
##### `void` [[RemoveFriend|Facepunch.Steamworks.Overlay.RemoveFriend]]( `ulong` **steamid** )
*No documentation available*
## Properties
##### Properties
## Fields

@ -1,10 +1,10 @@
# Screenshots
## Methods
### `void` [[Trigger|Facepunch.Steamworks.Screenshots.Trigger]]( )
##### `void` [[Trigger|Facepunch.Steamworks.Screenshots.Trigger]]( )
*No documentation available*
## Properties
##### Properties
## Fields

@ -1,20 +1,20 @@
# Server
## Methods
### `void` [[LogOnAnonymous|Facepunch.Steamworks.Server.LogOnAnonymous]]( )
##### `void` [[LogOnAnonymous|Facepunch.Steamworks.Server.LogOnAnonymous]]( )
Log onto Steam anonymously
### `void` [[SetKey|Facepunch.Steamworks.Server.SetKey]]( `string` **Key**, `string` **Value** )
##### `void` [[SetKey|Facepunch.Steamworks.Server.SetKey]]( `string` **Key**, `string` **Value** )
*No documentation available*
### `void` [[Update|Facepunch.Steamworks.Server.Update]]( )
##### `void` [[Update|Facepunch.Steamworks.Server.Update]]( )
Should be called at least once every frame
### `void` [[UpdatePlayer|Facepunch.Steamworks.Server.UpdatePlayer]]( `ulong` **steamid**, `string` **name**, `int` **score** )
##### `void` [[UpdatePlayer|Facepunch.Steamworks.Server.UpdatePlayer]]( `ulong` **steamid**, `string` **name**, `int` **score** )
*No documentation available*
## Properties
##### Properties
### `UInt32` [[AppId|Facepunch.Steamworks.Server.AppId]]
Current running program's AppId

@ -1,14 +1,14 @@
# ServerAuth
## Methods
### `void` [[EndSession|Facepunch.Steamworks.ServerAuth.EndSession]]( `ulong` **steamid** )
##### `void` [[EndSession|Facepunch.Steamworks.ServerAuth.EndSession]]( `ulong` **steamid** )
*No documentation available*
### `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

@ -1,36 +1,36 @@
# ServerList
## Methods
### `void` [[AddToFavourite|Facepunch.Steamworks.ServerList.AddToFavourite]]( `Server` **server** )
##### `void` [[AddToFavourite|Facepunch.Steamworks.ServerList.AddToFavourite]]( `Server` **server** )
*No documentation available*
### `void` [[AddToHistory|Facepunch.Steamworks.ServerList.AddToHistory]]( `Server` **server** )
##### `void` [[AddToHistory|Facepunch.Steamworks.ServerList.AddToHistory]]( `Server` **server** )
*No documentation available*
### `Request` [[Custom|Facepunch.Steamworks.ServerList.Custom]]( `IEnumerable\<string\>` **serverList** )
##### `Request` [[Custom|Facepunch.Steamworks.ServerList.Custom]]( `IEnumerable\<string\>` **serverList** )
*No documentation available*
### `Request` [[Favourites|Facepunch.Steamworks.ServerList.Favourites]]( )
##### `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]]( )
##### `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** )
##### `Request` [[Internet|Facepunch.Steamworks.ServerList.Internet]]( `Filter` **filter** )
*No documentation available*
### `bool` [[IsFavourite|Facepunch.Steamworks.ServerList.IsFavourite]]( `Server` **server** )
##### `bool` [[IsFavourite|Facepunch.Steamworks.ServerList.IsFavourite]]( `Server` **server** )
*No documentation available*
### `void` [[RemoveFromFavourite|Facepunch.Steamworks.ServerList.RemoveFromFavourite]]( `Server` **server** )
##### `void` [[RemoveFromFavourite|Facepunch.Steamworks.ServerList.RemoveFromFavourite]]( `Server` **server** )
*No documentation available*
### `void` [[RemoveFromHistory|Facepunch.Steamworks.ServerList.RemoveFromHistory]]( `Server` **server** )
##### `void` [[RemoveFromHistory|Facepunch.Steamworks.ServerList.RemoveFromHistory]]( `Server` **server** )
*No documentation available*
## Properties
##### Properties
## Fields

@ -1,13 +1,13 @@
# ServerQuery
## Methods
### `bool` [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( `Packet&` **packet** )
##### `bool` [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( `Packet&` **packet** )
*No documentation available*
### `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

@ -1,25 +1,25 @@
# ServerStats
## Methods
### `void` [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( `ulong` **steamid** )
##### `void` [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( `ulong` **steamid** )
*No documentation available*
### `Single` [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( `ulong` **steamid**, `string` **name**, `Single` **defaultValue** )
##### `Single` [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( `ulong` **steamid**, `string` **name**, `Single` **defaultValue** )
*No documentation available*
### `int` [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( `ulong` **steamid**, `string` **name**, `int` **defaultValue** )
##### `int` [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( `ulong` **steamid**, `string` **name**, `int` **defaultValue** )
*No documentation available*
### `void` [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( `ulong` **steamid** )
##### `void` [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( `ulong` **steamid** )
*No documentation available*
### `bool` [[Set|Facepunch.Steamworks.ServerStats.Set]]( `ulong` **steamid**, `string` **name**, `int` **stat** )
##### `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** )
##### `bool` [[Set|Facepunch.Steamworks.ServerStats.Set]]( `ulong` **steamid**, `string` **name**, `Single` **stat** )
*No documentation available*
## Properties
##### Properties
## Fields

@ -1,25 +1,25 @@
# Stats
## Methods
### `Single` [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( `string` **name** )
##### `Single` [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( `string` **name** )
*No documentation available*
### `Double` [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( `string` **name** )
##### `Double` [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( `string` **name** )
*No documentation available*
### `Int64` [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( `string` **name** )
##### `Int64` [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( `string` **name** )
*No documentation available*
### `int` [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( `string` **name** )
##### `int` [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( `string` **name** )
*No documentation available*
### `void` [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( `int` **days** )
##### `void` [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( `int` **days** )
*No documentation available*
### `void` [[UpdateStats|Facepunch.Steamworks.Stats.UpdateStats]]( )
##### `void` [[UpdateStats|Facepunch.Steamworks.Stats.UpdateStats]]( )
*No documentation available*
## Properties
##### Properties
## Fields

@ -1,11 +1,11 @@
# SteamFriend
## Methods
### `void` [[Refresh|Facepunch.Steamworks.SteamFriend.Refresh]]( )
##### `void` [[Refresh|Facepunch.Steamworks.SteamFriend.Refresh]]( )
*No documentation available*
## Properties
##### Properties
### `ulong` [[CurrentAppId|Facepunch.Steamworks.SteamFriend.CurrentAppId]]
The AppId this guy is playing

@ -1,17 +1,17 @@
# Voice
## Methods
### `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `Byte[]` **input**, `MemoryStream` **output**, `UInt32` **samepleRate** )
##### `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `Byte[]` **input**, `MemoryStream` **output**, `UInt32` **samepleRate** )
*No documentation available*
### `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `IntPtr` **input**, `int` **inputoffset**, `int` **inputsize**, `MemoryStream` **output**, `UInt32` **samepleRate** )
##### `bool` [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( `IntPtr` **input**, `int` **inputoffset**, `int` **inputsize**, `MemoryStream` **output**, `UInt32` **samepleRate** )
*No documentation available*
### `void` [[Dispose|Facepunch.Steamworks.Voice.Dispose]]( )
##### `void` [[Dispose|Facepunch.Steamworks.Voice.Dispose]]( )
*No documentation available*
## Properties
##### Properties
### `DateTime` [[LastVoiceRecordTime|Facepunch.Steamworks.Voice.LastVoiceRecordTime]]
The last time voice was detected, recorded

@ -1,22 +1,22 @@
# Workshop
## Methods
### `Editor` [[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]( `ItemType` **type** )
##### `Editor` [[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]( `ItemType` **type** )
*No documentation available*
### `Query` [[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]( )
##### `Query` [[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]( )
*No documentation available*
### `void` [[Dispose|Facepunch.Steamworks.Workshop.Dispose]]( )
##### `void` [[Dispose|Facepunch.Steamworks.Workshop.Dispose]]( )
*No documentation available*
### `Editor` [[EditItem|Facepunch.Steamworks.Workshop.EditItem]]( `ulong` **itemId** )
##### `Editor` [[EditItem|Facepunch.Steamworks.Workshop.EditItem]]( `ulong` **itemId** )
*No documentation available*
### `Item` [[GetItem|Facepunch.Steamworks.Workshop.GetItem]]( `ulong` **itemid** )
##### `Item` [[GetItem|Facepunch.Steamworks.Workshop.GetItem]]( `ulong` **itemid** )
*No documentation available*
## Properties
##### Properties
## Fields

@ -1,5 +1,11 @@
# Facepunch.Steamworks
## SteamNative
* [[CallbackIdentifiers|SteamNative.CallbackIdentifiers]]
* [[Defines|SteamNative.Defines]]
* [[CallbackHandle|SteamNative.CallbackHandle]]
## Facepunch.Steamworks
* [[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks]]
* [[Inventory|Facepunch.Steamworks.Inventory]]
@ -21,7 +27,5 @@
* [[ServerAuth|Facepunch.Steamworks.ServerAuth]]
* [[ServerQuery|Facepunch.Steamworks.ServerQuery]]
* [[ServerStats|Facepunch.Steamworks.ServerStats]]
* [[Color|Facepunch.Steamworks.Color]]
## Facepunch.Steamworks.Callbacks
* [[Result|Facepunch.Steamworks.Callbacks.Result]]

@ -1,11 +1,11 @@
# Image
## Methods
### `Color` [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( `int` **x**, `int` **y** )
##### `Color` [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( `int` **x**, `int` **y** )
*No documentation available*
## Properties
##### Properties
### `Byte[]` [[Data|Facepunch.Steamworks.Image.Data]]
*No documentation available*