Class summary

Garry Newman 2016-11-02 20:38:18 +00:00
parent e642a3966f
commit 6dc80fa771
32 changed files with 135 additions and 2 deletions

@ -1,5 +1,9 @@
# App
### Summary
```
No documentation available
```
### Methods
* **void** [[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]( **bool** missingFilesOnly )

@ -1,5 +1,9 @@
# Auth
### Summary
```
No documentation available
```
### Methods
* **Ticket** [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( )

@ -1,5 +1,9 @@
# BaseSteamworks
### Summary
```
No documentation available
```
### Methods
* **void** [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( )
* **void** [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( )

@ -1,5 +1,9 @@
# CallbackHandle
### Summary
```
No documentation available
```
### Methods
* **void** [[Dispose|Facepunch.Steamworks.CallbackHandle.Dispose]]( )

@ -1,5 +1,9 @@
# Client
### Summary
```
No documentation available
```
### Methods
* **void** [[Dispose|Facepunch.Steamworks.Client.Dispose]]( )
* **void** [[Update|Facepunch.Steamworks.Client.Update]]( )

@ -1,5 +1,9 @@
# Config
### Summary
```
No documentation available
```
### Methods
* **void** [[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]( **OperatingSystem** os, **Architecture** arch )

@ -1,5 +1,9 @@
# Definition
### Summary
```
No documentation available
```
### Methods
* **T** [[GetProperty|Facepunch.Steamworks.Definition.GetProperty]]( **string** name )
* **string** [[GetStringProperty|Facepunch.Steamworks.Definition.GetStringProperty]]( **string** name )

@ -1,5 +1,9 @@
# Editor
### Summary
```
No documentation available
```
### Methods
* **void** [[Delete|Facepunch.Steamworks.Editor.Delete]]( )
* **void** [[Publish|Facepunch.Steamworks.Editor.Publish]]( )

@ -1,5 +1,9 @@
# Filter
### Summary
```
No documentation available
```
### Methods
* **void** [[Add|Facepunch.Steamworks.Filter.Add]]( **string** k, **string** v )

@ -1,5 +1,9 @@
# Friends
### Summary
```
No documentation available
```
### Methods
* **SteamFriend** [[Get|Facepunch.Steamworks.Friends.Get]]( **ulong** steamid )
* **Image** [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( **AvatarSize** size, **ulong** steamid )

@ -1,5 +1,9 @@
# Image
### Summary
```
No documentation available
```
### Methods
* **Color** [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( **int** x, **int** y )

@ -1,5 +1,9 @@
# Inventory
### Summary
```
No documentation available
```
### Methods
* **Definition** [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( **int** id )
* **Result** [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( **byte[]** data, **int** dataLength )

@ -1,5 +1,9 @@
# Item
### Summary
```
No documentation available
```
### Methods
* **void** [[Download|Facepunch.Steamworks.Item.Download]]( **bool** highPriority )
* **Editor** [[Edit|Facepunch.Steamworks.Item.Edit]]( )

@ -1,5 +1,9 @@
# Networking
### Summary
```
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 )

@ -1,5 +1,9 @@
# Overlay
### Summary
```
No documentation available
```
### Methods
* **void** [[AcceptFriendRequest|Facepunch.Steamworks.Overlay.AcceptFriendRequest]]( **ulong** steamid )
* **void** [[AddFriend|Facepunch.Steamworks.Overlay.AddFriend]]( **ulong** steamid )

@ -1,5 +1,9 @@
# Query
### Summary
```
No documentation available
```
### Methods
* **void** [[Block|Facepunch.Steamworks.Query.Block]]( )
* **void** [[Dispose|Facepunch.Steamworks.Query.Dispose]]( )

@ -1,5 +1,9 @@
# Request
### Summary
```
No documentation available
```
### Methods
* **void** [[Dispose|Facepunch.Steamworks.Request.Dispose]]( )

@ -1,5 +1,9 @@
# Result
### Summary
```
No documentation available
```
### Methods
* **bool** [[Block|Facepunch.Steamworks.Result.Block]]( **Single** maxWait )
* **void** [[Dispose|Facepunch.Steamworks.Result.Dispose]]( )

@ -1,5 +1,9 @@
# Screenshots
### Summary
```
No documentation available
```
### Methods
* **void** [[Trigger|Facepunch.Steamworks.Screenshots.Trigger]]( )

@ -1,5 +1,9 @@
# Server
### Summary
```
No documentation available
```
### Methods
* **void** [[FetchRules|Facepunch.Steamworks.Server.FetchRules]]( )

@ -1,5 +1,9 @@
# ServerAuth
### Summary
```
No documentation available
```
### Methods
* **void** [[EndSession|Facepunch.Steamworks.ServerAuth.EndSession]]( **ulong** steamid )
* **bool** [[StartSession|Facepunch.Steamworks.ServerAuth.StartSession]]( **byte[]** data, **ulong** steamid )

@ -1,5 +1,9 @@
# ServerList
### Summary
```
No documentation available
```
### Methods
* **void** [[AddToFavourite|Facepunch.Steamworks.ServerList.AddToFavourite]]( **Server** server )
* **void** [[AddToHistory|Facepunch.Steamworks.ServerList.AddToHistory]]( **Server** server )

@ -1,5 +1,9 @@
# ServerQuery
### Summary
```
No documentation available
```
### Methods
* **bool** [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( **Packet&** packet )
* **void** [[Handle|Facepunch.Steamworks.ServerQuery.Handle]]( **byte[]** data, **int** size, **uint** address, **UInt16** port )

@ -1,5 +1,9 @@
# ServerStats
### Summary
```
No documentation available
```
### Methods
* **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid )
* **Single** [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( **ulong** steamid, **string** name, **Single** defaultValue )

@ -1,5 +1,9 @@
# Stats
### Summary
```
No documentation available
```
### Methods
* **Single** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name )
* **Double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name )

@ -1,5 +1,9 @@
# SteamAPIWarningMessageHook
### Summary
```
No documentation available
```
### Methods
* **IAsyncResult** [[BeginInvoke|Facepunch.Steamworks.SteamAPIWarningMessageHook.BeginInvoke]]( **int** nSeverity, **string** pchDebugText, **AsyncCallback** callback, **object** object )
* **void** [[EndInvoke|Facepunch.Steamworks.SteamAPIWarningMessageHook.EndInvoke]]( **IAsyncResult** result )

@ -1,5 +1,9 @@
# SteamFriend
### Summary
```
No documentation available
```
### Methods
* **void** [[Refresh|Facepunch.Steamworks.SteamFriend.Refresh]]( )

@ -1,5 +1,9 @@
# Ticket
### Summary
```
No documentation available
```
### Methods
* **void** [[Cancel|Facepunch.Steamworks.Ticket.Cancel]]( )
* **void** [[Dispose|Facepunch.Steamworks.Ticket.Dispose]]( )

@ -1,5 +1,9 @@
# Voice
### Summary
```
No documentation available
```
### Methods
* **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 )

@ -5,5 +5,8 @@ Query CreateQuery( )
```
## Summary
```
No documentation available
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,
or just getting a list of the items you've uploaded.
```

@ -5,5 +5,5 @@ void Dispose( )
```
## Summary
```
No documentation available
You should never have to call this manually
```

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