GitHub/Facepunch.Steamworks
2
0
Fork 0
mirror of https://github.com/Facepunch/Facepunch.Steamworks.git synced 2025-07-31 17:41:36 +03:00
Code Issues Projects Releases Wiki Activity

Format descriptions

Garry Newman 2016-11-04 20:57:34 +00:00
parent 3026928223
commit 5a2f068e93
39 changed files with 72 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Facepunch.Steamworks.Config.UseThisCall.md

@ -7,7 +7,6 @@ bool UseThisCall
``` ```
Some platforms allow/need CallingConvention.ThisCall. If you're crashing with argument null Some platforms allow/need CallingConvention.ThisCall. If you're crashing with argument null
errors on certain platforms, try flipping this to true. 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 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 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. for releasing his shit open source under the MIT license so we can all learn and iterate.

1
Facepunch.Steamworks.Server.SetKey.md

@ -7,6 +7,5 @@ void SetKey( string Key, string Value )
``` ```
Sets a Key Value. These can be anything you like, and are accessible Sets a Key Value. These can be anything you like, and are accessible
when querying servers from the server list. when querying servers from the server list.
Information describing gamemodes are common here. Information describing gamemodes are common here.
``` ```

9
Facepunch.Steamworks.Server.md

@ -3,7 +3,6 @@
### Summary ### Summary
``` ```
Initialize this class for Game Servers. Initialize this class for Game Servers.
Game servers offer a limited amount of Steam functionality - and don't require the Steam client. Game servers offer a limited amount of Steam functionality - and don't require the Steam client.
``` ```
@ -20,6 +19,7 @@ Initialize this class for Game Servers.
### Properties ### Properties
* **uint** [[AppId|Facepunch.Steamworks.Server.AppId]] * **uint** [[AppId|Facepunch.Steamworks.Server.AppId]]
* **ServerAuth** [[Auth|Facepunch.Steamworks.Server.Auth]]
* **int** [[BotCount|Facepunch.Steamworks.Server.BotCount]] * **int** [[BotCount|Facepunch.Steamworks.Server.BotCount]]
* **string** [[GameDescription|Facepunch.Steamworks.Server.GameDescription]] * **string** [[GameDescription|Facepunch.Steamworks.Server.GameDescription]]
* **string** [[GameTags|Facepunch.Steamworks.Server.GameTags]] * **string** [[GameTags|Facepunch.Steamworks.Server.GameTags]]
@ -33,12 +33,9 @@ Initialize this class for Game Servers.
* **bool** [[Passworded|Facepunch.Steamworks.Server.Passworded]] * **bool** [[Passworded|Facepunch.Steamworks.Server.Passworded]]
* **string** [[Product|Facepunch.Steamworks.Server.Product]] * **string** [[Product|Facepunch.Steamworks.Server.Product]]
* **IPAddress** [[PublicIp|Facepunch.Steamworks.Server.PublicIp]] * **IPAddress** [[PublicIp|Facepunch.Steamworks.Server.PublicIp]]
* **ServerQuery** [[Query|Facepunch.Steamworks.Server.Query]]
* **string** [[ServerName|Facepunch.Steamworks.Server.ServerName]] * **string** [[ServerName|Facepunch.Steamworks.Server.ServerName]]
* **ulong** [[SteamId|Facepunch.Steamworks.Server.SteamId]] * **ServerStats** [[Stats|Facepunch.Steamworks.Server.Stats]]
* **string** [[Username|Facepunch.Steamworks.Server.Username]]
* **Workshop** [[Workshop|Facepunch.Steamworks.Server.Workshop]] * **Workshop** [[Workshop|Facepunch.Steamworks.Server.Workshop]]
### Fields ### Fields
* **ServerQuery** [[Query|Facepunch.Steamworks.Server.Query]]
* **ServerStats** [[Stats|Facepunch.Steamworks.Server.Stats]]
* **ServerAuth** [[Auth|Facepunch.Steamworks.Server.Auth]]

3
Facepunch.Steamworks.Voice.md

@ -5,9 +5,6 @@
No documentation available No documentation available
``` ```
### Constructors
* [[Voice|Facepunch.Steamworks.Voice.Voice.1]]( **Client** client )
### Methods ### Methods
* **bool** [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( **byte[]** input, **MemoryStream** output, **uint** samepleRate ) * **bool** [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( **byte[]** input, **MemoryStream** output, **uint** samepleRate )
* **bool** [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( **IntPtr** input, **int** inputoffset, **int** inputsize, **MemoryStream** output, **uint** samepleRate ) * **bool** [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( **IntPtr** input, **int** inputoffset, **int** inputsize, **MemoryStream** output, **uint** samepleRate )

1
Facepunch.Steamworks.Workshop.CreateQuery.md

@ -6,7 +6,6 @@ Query CreateQuery( )
## Summary ## Summary
``` ```
Creates a query object, which is used to get a list of items. Creates a query object, which is used to get a list of items.
This could be a list of the most popular items, or a search, This could be a list of the most popular items, or a search,
or just getting a list of the items you've uploaded. or just getting a list of the items you've uploaded.
``` ```

3
Facepunch.Steamworks.Workshop.md

@ -4,13 +4,10 @@
``` ```
Allows you to interact with Steam's UGC stuff (User Generated Content). Allows you to interact with Steam's UGC stuff (User Generated Content).
To put simply, this allows you to upload a folder of files to Steam. To put simply, this allows you to upload a folder of files to Steam.
To upload a new file use CreateItem. This returns an Editor object. To upload a new file use CreateItem. This returns an Editor object.
This object is also used to edit existing items. This object is also used to edit existing items.
To get a list of items you can call CreateQuery. From there you can download To get a list of items you can call CreateQuery. From there you can download
an item and retrieve the folder that it's downloaded to. an item and retrieve the folder that it's downloaded to.
Generally there's no need to compress and decompress your uploads, so you should Generally there's no need to compress and decompress your uploads, so you should
usually be able to use the content straight from the destination folder. usually be able to use the content straight from the destination folder.
``` ```