Syntax

Garry Newman 2016-11-02 20:02:03 +00:00
parent 927e7ceb4d
commit f4dc093829
71 changed files with 284 additions and 142 deletions

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

@ -1,5 +1,7 @@
### [[Facepunch.Steamworks.Auth|Facepunch.Steamworks.Auth]].GetAuthSessionTicket
## **Ticket** [[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]( )
# GetAuthSessionTicket
```
Method
```
```
Creates an auth ticket.
Which you can send to a server to authenticate that you are who you say you are.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -1,5 +1,7 @@
### [[Facepunch.Steamworks.Inventory|Facepunch.Steamworks.Inventory]].PlaytimeHeartbeat
## **void** [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]( )
# PlaytimeHeartbeat
```
Method
```
```
Call this at least every two minutes, every frame doesn't hurt.
You should call it when you consider it active play time.

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

@ -1,5 +1,7 @@
### [[Facepunch.Steamworks.Inventory|Facepunch.Steamworks.Inventory]].Refresh
## **void** [[Refresh|Facepunch.Steamworks.Inventory.Refresh]]( )
# Refresh
```
Method
```
```
Call this to retrieve the items.
Note that if this has already been called it won't

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@ -1,5 +1,7 @@
### [[Facepunch.Steamworks.ServerList|Facepunch.Steamworks.ServerList]].Favourites
## **Request** [[Favourites|Facepunch.Steamworks.ServerList.Favourites]]( )
# Favourites
```
Method
```
```
Favourite filters don't seem to work, so we don't bother.
You should apply them post process'dly

@ -1,5 +1,7 @@
### [[Facepunch.Steamworks.ServerList|Facepunch.Steamworks.ServerList]].History
## **Request** [[History|Facepunch.Steamworks.ServerList.History]]( )
# History
```
Method
```
```
History filters don't seem to work, so we don't bother.
You should apply them post process'dly

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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