Functions

Garry Newman 2016-11-02 19:54:18 +00:00
parent 5cd772faff
commit 28216e1936
77 changed files with 370 additions and 7 deletions

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

@ -0,0 +1,6 @@
# 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.
```

@ -0,0 +1,5 @@
# Dispose
##= **void** [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( )
```
No documentation available
```

@ -0,0 +1,5 @@
# SetupCommonInterfaces
##= **void** [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( )
```
No documentation available
```

@ -0,0 +1,5 @@
# Update
##= **void** [[Update|Facepunch.Steamworks.BaseSteamworks.Update]]( )
```
No documentation available
```

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

@ -0,0 +1,5 @@
# Dispose
##= **void** [[Dispose|Facepunch.Steamworks.Client.Dispose]]( )
```
No documentation available
```

@ -0,0 +1,5 @@
# Update
##= **void** [[Update|Facepunch.Steamworks.Client.Update]]( )
```
Should be called at least once every frame
```

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

@ -0,0 +1,5 @@
# Get
##= **SteamFriend** [[Get|Facepunch.Steamworks.Friends.Get]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetAvatar
##= **Image** [[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]( **AvatarSize** size, **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetName
##= **string** [[GetName|Facepunch.Steamworks.Friends.GetName]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# Refresh
##= **void** [[Refresh|Facepunch.Steamworks.Friends.Refresh]]( )
```
No documentation available
```

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

@ -4,7 +4,7 @@
* **Color** [[GetPixel|Facepunch.Steamworks.Image.GetPixel]]( **int** x, **int** y )
### Properties
* **Byte[]** [[Data|Facepunch.Steamworks.Image.Data]]
* **byte[]** [[Data|Facepunch.Steamworks.Image.Data]]
* **int** [[Height|Facepunch.Steamworks.Image.Height]]

@ -0,0 +1,5 @@
# CreateDefinition
##= **Definition** [[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]( **int** id )
```
No documentation available
```

@ -0,0 +1,5 @@
# Deserialize
##= **Result** [[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]( **byte[]** data, **int** dataLength )
```
No documentation available
```

@ -0,0 +1,5 @@
# Dispose
##= **void** [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( )
```
No documentation available
```

@ -0,0 +1,5 @@
# FindDefinition
##= **Definition** [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( **int** DefinitionId )
```
No documentation available
```

@ -0,0 +1,8 @@
# 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.
```

@ -0,0 +1,5 @@
# PriceCategoryToFloat
##= **Single** [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( **string** price )
```
No documentation available
```

@ -0,0 +1,7 @@
# 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
```

@ -2,7 +2,7 @@
### Methods
* **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 )
* **void** [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( )
* **Definition** [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( **int** DefinitionId )
* **void** [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]( )
@ -14,6 +14,6 @@
### Fields
* **Action** [[OnUpdate|Facepunch.Steamworks.Inventory.OnUpdate]]
* **Item[]** [[Items|Facepunch.Steamworks.Inventory.Items]]
* **Byte[]** [[SerializedItems|Facepunch.Steamworks.Inventory.SerializedItems]]
* **byte[]** [[SerializedItems|Facepunch.Steamworks.Inventory.SerializedItems]]
* **DateTime** [[SerializedExpireTime|Facepunch.Steamworks.Inventory.SerializedExpireTime]]
* **Definition[]** [[Definitions|Facepunch.Steamworks.Inventory.Definitions]]

@ -0,0 +1,5 @@
# Dispose
##= **void** [[Dispose|Facepunch.Steamworks.Networking.Dispose]]( )
```
No documentation available
```

@ -0,0 +1,5 @@
# SendP2PPacket
##= **bool** [[SendP2PPacket|Facepunch.Steamworks.Networking.SendP2PPacket]]( **ulong** steamid, **byte[]** data, **int** length, **SendType** eP2PSendType, **int** nChannel )
```
No documentation available
```

@ -2,7 +2,7 @@
### Methods
* **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 )
### Properties

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

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

@ -0,0 +1,5 @@
# IgnoreFriendRequest
##= **void** [[IgnoreFriendRequest|Facepunch.Steamworks.Overlay.IgnoreFriendRequest]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# OpenAchievements
##= **void** [[OpenAchievements|Facepunch.Steamworks.Overlay.OpenAchievements]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# OpenChat
##= **void** [[OpenChat|Facepunch.Steamworks.Overlay.OpenChat]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# OpenProfile
##= **void** [[OpenProfile|Facepunch.Steamworks.Overlay.OpenProfile]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# OpenStats
##= **void** [[OpenStats|Facepunch.Steamworks.Overlay.OpenStats]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# OpenTrade
##= **void** [[OpenTrade|Facepunch.Steamworks.Overlay.OpenTrade]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# OpenUrl
##= **void** [[OpenUrl|Facepunch.Steamworks.Overlay.OpenUrl]]( **string** url )
```
No documentation available
```

@ -0,0 +1,5 @@
# OpenUserPage
##= **void** [[OpenUserPage|Facepunch.Steamworks.Overlay.OpenUserPage]]( **string** name, **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# RemoveFriend
##= **void** [[RemoveFriend|Facepunch.Steamworks.Overlay.RemoveFriend]]( **ulong** steamid )
```
No documentation available
```

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

@ -0,0 +1,5 @@
# LogOnAnonymous
##= **void** [[LogOnAnonymous|Facepunch.Steamworks.Server.LogOnAnonymous]]( )
```
Log onto Steam anonymously
```

@ -0,0 +1,5 @@
# SetKey
##= **void** [[SetKey|Facepunch.Steamworks.Server.SetKey]]( **string** Key, **string** Value )
```
No documentation available
```

@ -0,0 +1,5 @@
# Update
##= **void** [[Update|Facepunch.Steamworks.Server.Update]]( )
```
Should be called at least once every frame
```

@ -0,0 +1,5 @@
# UpdatePlayer
##= **void** [[UpdatePlayer|Facepunch.Steamworks.Server.UpdatePlayer]]( **ulong** steamid, **string** name, **int** score )
```
No documentation available
```

@ -0,0 +1,5 @@
# EndSession
##= **void** [[EndSession|Facepunch.Steamworks.ServerAuth.EndSession]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# StartSession
##= **bool** [[StartSession|Facepunch.Steamworks.ServerAuth.StartSession]]( **byte[]** data, **ulong** steamid )
```
No documentation available
```

@ -2,7 +2,7 @@
### Methods
* **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 )
### Properties

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

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

@ -0,0 +1,5 @@
# Custom
##= **Request** [[Custom|Facepunch.Steamworks.ServerList.Custom]]( **IEnumerable\<string\>** serverList )
```
No documentation available
```

@ -0,0 +1,6 @@
# 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
```

@ -0,0 +1,6 @@
# 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
```

@ -0,0 +1,5 @@
# Internet
##= **Request** [[Internet|Facepunch.Steamworks.ServerList.Internet]]( **Filter** filter )
```
No documentation available
```

@ -0,0 +1,5 @@
# IsFavourite
##= **bool** [[IsFavourite|Facepunch.Steamworks.ServerList.IsFavourite]]( **Server** server )
```
No documentation available
```

@ -0,0 +1,5 @@
# RemoveFromFavourite
##= **void** [[RemoveFromFavourite|Facepunch.Steamworks.ServerList.RemoveFromFavourite]]( **Server** server )
```
No documentation available
```

@ -0,0 +1,5 @@
# RemoveFromHistory
##= **void** [[RemoveFromHistory|Facepunch.Steamworks.ServerList.RemoveFromHistory]]( **Server** server )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetOutgoingPacket
##= **bool** [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( **Packet&** packet )
```
No documentation available
```

@ -0,0 +1,5 @@
# Handle
##= **void** [[Handle|Facepunch.Steamworks.ServerQuery.Handle]]( **byte[]** data, **int** size, **uint** address, **UInt16** port )
```
No documentation available
```

@ -2,7 +2,7 @@
### Methods
* **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 )
### Properties

@ -0,0 +1,5 @@
# Commit
##= **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid )
```
No documentation available
```

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

@ -0,0 +1,5 @@
# GetInt
##= **int** [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( **ulong** steamid, **string** name, **int** defaultValue )
```
No documentation available
```

@ -0,0 +1,5 @@
# Refresh
##= **void** [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( **ulong** steamid )
```
No documentation available
```

@ -0,0 +1,5 @@
# Set
##= **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **Single** stat )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetFloat
##= **Single** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetGlobalFloat
##= **Double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetGlobalInt
##= **Int64** [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( **string** name )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetInt
##= **int** [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( **string** name )
```
No documentation available
```

@ -0,0 +1,5 @@
# UpdateGlobalStats
##= **void** [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( **int** days )
```
No documentation available
```

@ -0,0 +1,5 @@
# UpdateStats
##= **void** [[UpdateStats|Facepunch.Steamworks.Stats.UpdateStats]]( )
```
No documentation available
```

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

@ -0,0 +1,5 @@
# Decompress
##= **bool** [[Decompress|Facepunch.Steamworks.Voice.Decompress]]( **IntPtr** input, **int** inputoffset, **int** inputsize, **MemoryStream** output, **uint** samepleRate )
```
No documentation available
```

@ -0,0 +1,5 @@
# Dispose
##= **void** [[Dispose|Facepunch.Steamworks.Voice.Dispose]]( )
```
No documentation available
```

@ -1,7 +1,7 @@
# Voice
### 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 )
* **void** [[Dispose|Facepunch.Steamworks.Voice.Dispose]]( )

@ -0,0 +1,5 @@
# CreateItem
##= **Editor** [[CreateItem|Facepunch.Steamworks.Workshop.CreateItem]]( **ItemType** type )
```
No documentation available
```

@ -0,0 +1,5 @@
# CreateQuery
##= **Query** [[CreateQuery|Facepunch.Steamworks.Workshop.CreateQuery]]( )
```
No documentation available
```

@ -0,0 +1,5 @@
# Dispose
##= **void** [[Dispose|Facepunch.Steamworks.Workshop.Dispose]]( )
```
No documentation available
```

@ -0,0 +1,5 @@
# EditItem
##= **Editor** [[EditItem|Facepunch.Steamworks.Workshop.EditItem]]( **ulong** itemId )
```
No documentation available
```

@ -0,0 +1,5 @@
# GetItem
##= **Item** [[GetItem|Facepunch.Steamworks.Workshop.GetItem]]( **ulong** itemid )
```
No documentation available
```