mirror of
https://github.com/Facepunch/Facepunch.Steamworks.git
synced 2025-07-05 16:55:11 +03:00
Class summary
parent
e642a3966f
commit
6dc80fa771
@ -1,5 +1,9 @@
|
|||||||
# App
|
# App
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]( **bool** missingFilesOnly )
|
* **void** [[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]( **bool** missingFilesOnly )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Auth
|
# Auth
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **Ticket** [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( )
|
* **Ticket** [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# BaseSteamworks
|
# BaseSteamworks
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( )
|
* **void** [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( )
|
||||||
* **void** [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( )
|
* **void** [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# CallbackHandle
|
# CallbackHandle
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.CallbackHandle.Dispose]]( )
|
* **void** [[Dispose|Facepunch.Steamworks.CallbackHandle.Dispose]]( )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Client
|
# Client
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.Client.Dispose]]( )
|
* **void** [[Dispose|Facepunch.Steamworks.Client.Dispose]]( )
|
||||||
* **void** [[Update|Facepunch.Steamworks.Client.Update]]( )
|
* **void** [[Update|Facepunch.Steamworks.Client.Update]]( )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Config
|
# Config
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]( **OperatingSystem** os, **Architecture** arch )
|
* **void** [[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]( **OperatingSystem** os, **Architecture** arch )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Definition
|
# Definition
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **T** [[GetProperty|Facepunch.Steamworks.Definition.GetProperty]]( **string** name )
|
* **T** [[GetProperty|Facepunch.Steamworks.Definition.GetProperty]]( **string** name )
|
||||||
* **string** [[GetStringProperty|Facepunch.Steamworks.Definition.GetStringProperty]]( **string** name )
|
* **string** [[GetStringProperty|Facepunch.Steamworks.Definition.GetStringProperty]]( **string** name )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Editor
|
# Editor
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Delete|Facepunch.Steamworks.Editor.Delete]]( )
|
* **void** [[Delete|Facepunch.Steamworks.Editor.Delete]]( )
|
||||||
* **void** [[Publish|Facepunch.Steamworks.Editor.Publish]]( )
|
* **void** [[Publish|Facepunch.Steamworks.Editor.Publish]]( )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Filter
|
# Filter
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Add|Facepunch.Steamworks.Filter.Add]]( **string** k, **string** v )
|
* **void** [[Add|Facepunch.Steamworks.Filter.Add]]( **string** k, **string** v )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Friends
|
# Friends
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **SteamFriend** [[Get|Facepunch.Steamworks.Friends.Get]]( **ulong** steamid )
|
* **SteamFriend** [[Get|Facepunch.Steamworks.Friends.Get]]( **ulong** steamid )
|
||||||
* **Image** [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( **AvatarSize** size, **ulong** steamid )
|
* **Image** [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( **AvatarSize** size, **ulong** steamid )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Image
|
# Image
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **Color** [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( **int** x, **int** y )
|
* **Color** [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( **int** x, **int** y )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Inventory
|
# Inventory
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **Definition** [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( **int** id )
|
* **Definition** [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( **int** id )
|
||||||
* **Result** [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( **byte[]** data, **int** dataLength )
|
* **Result** [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( **byte[]** data, **int** dataLength )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Item
|
# Item
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Download|Facepunch.Steamworks.Item.Download]]( **bool** highPriority )
|
* **void** [[Download|Facepunch.Steamworks.Item.Download]]( **bool** highPriority )
|
||||||
* **Editor** [[Edit|Facepunch.Steamworks.Item.Edit]]( )
|
* **Editor** [[Edit|Facepunch.Steamworks.Item.Edit]]( )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Networking
|
# Networking
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.Networking.Dispose]]( )
|
* **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 )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Overlay
|
# Overlay
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[AcceptFriendRequest|Facepunch.Steamworks.Overlay.AcceptFriendRequest]]( **ulong** steamid )
|
* **void** [[AcceptFriendRequest|Facepunch.Steamworks.Overlay.AcceptFriendRequest]]( **ulong** steamid )
|
||||||
* **void** [[AddFriend|Facepunch.Steamworks.Overlay.AddFriend]]( **ulong** steamid )
|
* **void** [[AddFriend|Facepunch.Steamworks.Overlay.AddFriend]]( **ulong** steamid )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Query
|
# Query
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Block|Facepunch.Steamworks.Query.Block]]( )
|
* **void** [[Block|Facepunch.Steamworks.Query.Block]]( )
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.Query.Dispose]]( )
|
* **void** [[Dispose|Facepunch.Steamworks.Query.Dispose]]( )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Request
|
# Request
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.Request.Dispose]]( )
|
* **void** [[Dispose|Facepunch.Steamworks.Request.Dispose]]( )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Result
|
# Result
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **bool** [[Block|Facepunch.Steamworks.Result.Block]]( **Single** maxWait )
|
* **bool** [[Block|Facepunch.Steamworks.Result.Block]]( **Single** maxWait )
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.Result.Dispose]]( )
|
* **void** [[Dispose|Facepunch.Steamworks.Result.Dispose]]( )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Screenshots
|
# Screenshots
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Trigger|Facepunch.Steamworks.Screenshots.Trigger]]( )
|
* **void** [[Trigger|Facepunch.Steamworks.Screenshots.Trigger]]( )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Server
|
# Server
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[FetchRules|Facepunch.Steamworks.Server.FetchRules]]( )
|
* **void** [[FetchRules|Facepunch.Steamworks.Server.FetchRules]]( )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# ServerAuth
|
# ServerAuth
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[EndSession|Facepunch.Steamworks.ServerAuth.EndSession]]( **ulong** steamid )
|
* **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 )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# ServerList
|
# ServerList
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[AddToFavourite|Facepunch.Steamworks.ServerList.AddToFavourite]]( **Server** server )
|
* **void** [[AddToFavourite|Facepunch.Steamworks.ServerList.AddToFavourite]]( **Server** server )
|
||||||
* **void** [[AddToHistory|Facepunch.Steamworks.ServerList.AddToHistory]]( **Server** server )
|
* **void** [[AddToHistory|Facepunch.Steamworks.ServerList.AddToHistory]]( **Server** server )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# ServerQuery
|
# ServerQuery
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **bool** [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( **Packet&** packet )
|
* **bool** [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( **Packet&** packet )
|
||||||
* **void** [[Handle|Facepunch.Steamworks.ServerQuery.Handle]]( **byte[]** data, **int** size, **uint** address, **UInt16** port )
|
* **void** [[Handle|Facepunch.Steamworks.ServerQuery.Handle]]( **byte[]** data, **int** size, **uint** address, **UInt16** port )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# ServerStats
|
# ServerStats
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid )
|
* **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid )
|
||||||
* **Single** [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( **ulong** steamid, **string** name, **Single** defaultValue )
|
* **Single** [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( **ulong** steamid, **string** name, **Single** defaultValue )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Stats
|
# Stats
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **Single** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name )
|
* **Single** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name )
|
||||||
* **Double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name )
|
* **Double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# SteamAPIWarningMessageHook
|
# SteamAPIWarningMessageHook
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **IAsyncResult** [[BeginInvoke|Facepunch.Steamworks.SteamAPIWarningMessageHook.BeginInvoke]]( **int** nSeverity, **string** pchDebugText, **AsyncCallback** callback, **object** object )
|
* **IAsyncResult** [[BeginInvoke|Facepunch.Steamworks.SteamAPIWarningMessageHook.BeginInvoke]]( **int** nSeverity, **string** pchDebugText, **AsyncCallback** callback, **object** object )
|
||||||
* **void** [[EndInvoke|Facepunch.Steamworks.SteamAPIWarningMessageHook.EndInvoke]]( **IAsyncResult** result )
|
* **void** [[EndInvoke|Facepunch.Steamworks.SteamAPIWarningMessageHook.EndInvoke]]( **IAsyncResult** result )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# SteamFriend
|
# SteamFriend
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Refresh|Facepunch.Steamworks.SteamFriend.Refresh]]( )
|
* **void** [[Refresh|Facepunch.Steamworks.SteamFriend.Refresh]]( )
|
||||||
|
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Ticket
|
# Ticket
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### Methods
|
### Methods
|
||||||
* **void** [[Cancel|Facepunch.Steamworks.Ticket.Cancel]]( )
|
* **void** [[Cancel|Facepunch.Steamworks.Ticket.Cancel]]( )
|
||||||
* **void** [[Dispose|Facepunch.Steamworks.Ticket.Dispose]]( )
|
* **void** [[Dispose|Facepunch.Steamworks.Ticket.Dispose]]( )
|
||||||
|
@ -1,5 +1,9 @@
|
|||||||
# Voice
|
# Voice
|
||||||
|
|
||||||
|
### Summary
|
||||||
|
```
|
||||||
|
No documentation available
|
||||||
|
```
|
||||||
### 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 )
|
||||||
|
@ -5,5 +5,8 @@ Query CreateQuery( )
|
|||||||
```
|
```
|
||||||
## Summary
|
## 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
|
## Summary
|
||||||
```
|
```
|
||||||
No documentation available
|
You should never have to call this manually
|
||||||
```
|
```
|
||||||
|
@ -1,5 +1,19 @@
|
|||||||
# Workshop
|
# 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
|
### Methods
|
||||||
* **Editor** [[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]( **ItemType** type )
|
* **Editor** [[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]( **ItemType** type )
|
||||||
* **Query** [[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]( )
|
* **Query** [[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]( )
|
||||||
|
Loading…
x
Reference in New Issue
Block a user