GitHub/Facepunch.Steamworks
2
0
Fork 0
mirror of https://github.com/Facepunch/Facepunch.Steamworks.git synced 2025-08-02 10:31:38 +03:00
Code Issues Projects Releases Wiki Activity

Latest docs

Garry Newman 2016-11-04 20:11:24 +00:00
parent 9cd60bba55
commit 4be1ed99e8
38 changed files with 101 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Facepunch.Steamworks.BaseSteamworks.IsValid.md

@ -5,5 +5,6 @@ bool IsValid
``` ```
## Summary ## Summary
``` ```
No documentation available Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.
``` ```

9
Facepunch.Steamworks.BaseSteamworks.UpdateWhile.md Normal file

@ -0,0 +1,9 @@
# UpdateWhile
## Method
```
void UpdateWhile( Func\<bool\> func )
```
## Summary
```
No documentation available
```

6
Facepunch.Steamworks.BaseSteamworks.md

@ -2,12 +2,12 @@
### Summary ### Summary
``` ```
No documentation available Implements shared functionality between Steamworks.Client and Steamworks.Server
``` ```
### Methods ### Methods
* **void** [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( ) * **void** [[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]( )
* **void** [[SetupCommonInterfaces|Facepunch.Steamworks.BaseSteamworks.SetupCommonInterfaces]]( )
* **void** [[Update|Facepunch.Steamworks.BaseSteamworks.Update]]( ) * **void** [[Update|Facepunch.Steamworks.BaseSteamworks.Update]]( )
* **void** [[UpdateWhile|Facepunch.Steamworks.BaseSteamworks.UpdateWhile]]( **Func\<bool\>** func )
### Properties ### Properties
* **uint** [[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]] * **uint** [[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]]
@ -17,5 +17,3 @@ No documentation available
* **Workshop** [[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]] * **Workshop** [[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]]
### Fields ### Fields
* **Action\<MessageType, string\>** [[OnMessage|Facepunch.Steamworks.BaseSteamworks.OnMessage]]
* **Action** [[OnUpdate|Facepunch.Steamworks.BaseSteamworks.OnUpdate]]

2
Facepunch.Steamworks.Client.BetaName.md

@ -5,5 +5,5 @@ string BetaName
``` ```
## Summary ## Summary
``` ```
Current Beta name, if ser Current Beta name, if we're using a beta branch.
``` ```

2
Facepunch.Steamworks.Client.Dispose.md

@ -5,5 +5,5 @@ void Dispose( )
``` ```
## Summary ## Summary
``` ```
No documentation available Call when finished to shut down the Steam client.
``` ```

3
Facepunch.Steamworks.Client.IsValid.md

@ -5,5 +5,6 @@ bool IsValid
``` ```
## Summary ## Summary
``` ```
No documentation available Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.
``` ```

2
Facepunch.Steamworks.Client.md

@ -27,5 +27,3 @@ No documentation available
* **Workshop** [[Workshop|Facepunch.Steamworks.Client.Workshop]] * **Workshop** [[Workshop|Facepunch.Steamworks.Client.Workshop]]
### Fields ### Fields
* **Action\<MessageType, string\>** [[OnMessage|Facepunch.Steamworks.Client.OnMessage]]
* **Action** [[OnUpdate|Facepunch.Steamworks.Client.OnUpdate]]

2
Facepunch.Steamworks.Editor.Progress.md

@ -1,7 +1,7 @@
# Progress # Progress
## Property ## Property
``` ```
Double Progress double Progress
``` ```
## Summary ## Summary
``` ```

2
Facepunch.Steamworks.Editor.md

@ -18,7 +18,7 @@ No documentation available
* **ulong** [[Id|Facepunch.Steamworks.Editor.Id]] * **ulong** [[Id|Facepunch.Steamworks.Editor.Id]]
* **bool** [[NeedToAgreeToWorkshopLegal|Facepunch.Steamworks.Editor.NeedToAgreeToWorkshopLegal]] * **bool** [[NeedToAgreeToWorkshopLegal|Facepunch.Steamworks.Editor.NeedToAgreeToWorkshopLegal]]
* **string** [[PreviewImage|Facepunch.Steamworks.Editor.PreviewImage]] * **string** [[PreviewImage|Facepunch.Steamworks.Editor.PreviewImage]]
* **Double** [[Progress|Facepunch.Steamworks.Editor.Progress]] * **double** [[Progress|Facepunch.Steamworks.Editor.Progress]]
* **bool** [[Publishing|Facepunch.Steamworks.Editor.Publishing]] * **bool** [[Publishing|Facepunch.Steamworks.Editor.Publishing]]
* **List\<string\>** [[Tags|Facepunch.Steamworks.Editor.Tags]] * **List\<string\>** [[Tags|Facepunch.Steamworks.Editor.Tags]]
* **string** [[Title|Facepunch.Steamworks.Editor.Title]] * **string** [[Title|Facepunch.Steamworks.Editor.Title]]

2
Facepunch.Steamworks.Inventory.PriceCategoryToFloat.md

@ -1,7 +1,7 @@
# PriceCategoryToFloat # PriceCategoryToFloat
## Method ## Method
``` ```
Single PriceCategoryToFloat( string price ) float PriceCategoryToFloat( string price )
``` ```
## Summary ## Summary
``` ```

2
Facepunch.Steamworks.Inventory.md

@ -10,7 +10,7 @@ No documentation available
* **void** [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( ) * **void** [[Dispose|Facepunch.Steamworks.Inventory.Dispose]]( )
* **Definition** [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( **int** DefinitionId ) * **Definition** [[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]( **int** DefinitionId )
* **void** [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]( ) * **void** [[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]( )
* **Single** [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( **string** price ) * **float** [[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]( **string** price )
* **void** [[Refresh|Facepunch.Steamworks.Inventory.Refresh]]( ) * **void** [[Refresh|Facepunch.Steamworks.Inventory.Refresh]]( )
### Properties ### Properties

2
Facepunch.Steamworks.Item.DownloadProgress.md

@ -1,7 +1,7 @@
# DownloadProgress # DownloadProgress
## Property ## Property
``` ```
Double DownloadProgress double DownloadProgress
``` ```
## Summary ## Summary
``` ```

2
Facepunch.Steamworks.Item.Score.md

@ -1,7 +1,7 @@
# Score # Score
## Property ## Property
``` ```
Single Score float Score
``` ```
## Summary ## Summary
``` ```

4
Facepunch.Steamworks.Item.md

@ -21,7 +21,7 @@ No documentation available
* **string** [[DiscussUrl|Facepunch.Steamworks.Item.DiscussUrl]] * **string** [[DiscussUrl|Facepunch.Steamworks.Item.DiscussUrl]]
* **bool** [[Downloading|Facepunch.Steamworks.Item.Downloading]] * **bool** [[Downloading|Facepunch.Steamworks.Item.Downloading]]
* **bool** [[DownloadPending|Facepunch.Steamworks.Item.DownloadPending]] * **bool** [[DownloadPending|Facepunch.Steamworks.Item.DownloadPending]]
* **Double** [[DownloadProgress|Facepunch.Steamworks.Item.DownloadProgress]] * **double** [[DownloadProgress|Facepunch.Steamworks.Item.DownloadProgress]]
* **int** [[FavouriteCount|Facepunch.Steamworks.Item.FavouriteCount]] * **int** [[FavouriteCount|Facepunch.Steamworks.Item.FavouriteCount]]
* **int** [[FollowerCount|Facepunch.Steamworks.Item.FollowerCount]] * **int** [[FollowerCount|Facepunch.Steamworks.Item.FollowerCount]]
* **ulong** [[Id|Facepunch.Steamworks.Item.Id]] * **ulong** [[Id|Facepunch.Steamworks.Item.Id]]
@ -32,7 +32,7 @@ No documentation available
* **string** [[OwnerName|Facepunch.Steamworks.Item.OwnerName]] * **string** [[OwnerName|Facepunch.Steamworks.Item.OwnerName]]
* **string** [[PreviewImageUrl|Facepunch.Steamworks.Item.PreviewImageUrl]] * **string** [[PreviewImageUrl|Facepunch.Steamworks.Item.PreviewImageUrl]]
* **int** [[ReportScore|Facepunch.Steamworks.Item.ReportScore]] * **int** [[ReportScore|Facepunch.Steamworks.Item.ReportScore]]
* **Single** [[Score|Facepunch.Steamworks.Item.Score]] * **float** [[Score|Facepunch.Steamworks.Item.Score]]
* **ulong** [[Size|Facepunch.Steamworks.Item.Size]] * **ulong** [[Size|Facepunch.Steamworks.Item.Size]]
* **string** [[StartsUrl|Facepunch.Steamworks.Item.StartsUrl]] * **string** [[StartsUrl|Facepunch.Steamworks.Item.StartsUrl]]
* **bool** [[Subscribed|Facepunch.Steamworks.Item.Subscribed]] * **bool** [[Subscribed|Facepunch.Steamworks.Item.Subscribed]]

11
Facepunch.Steamworks.Networking.SetListenChannel.md Normal file

@ -0,0 +1,11 @@
# SetListenChannel
## Method
```
void SetListenChannel( int ChannelId, bool Listen )
```
## Summary
```
Enable or disable listening on a specific channel.
If you donp't enable the channel we won't listen to it,
so you won't be able to receive messages on it.
```

1
Facepunch.Steamworks.Networking.md

@ -7,6 +7,7 @@ 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 )
* **void** [[SetListenChannel|Facepunch.Steamworks.Networking.SetListenChannel]]( **int** ChannelId, **bool** Listen )
### Properties ### Properties

2
Facepunch.Steamworks.Result.Block.md

@ -1,7 +1,7 @@
# Block # Block
## Method ## Method
``` ```
bool Block( Single maxWait ) bool Block( float maxWait )
``` ```
## Summary ## Summary
``` ```

2
Facepunch.Steamworks.Result.md

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

9
Facepunch.Steamworks.Server.Dispose.md Normal file

@ -0,0 +1,9 @@
# Dispose
## Method
```
void Dispose( )
```
## Summary
```
Shutdown interface, disconnect from Steam
```

3
Facepunch.Steamworks.Server.GameTags.md

@ -5,5 +5,6 @@ string GameTags
``` ```
## Summary ## Summary
``` ```
Gets or sets the current GameTags Gets or sets the current GameTags. This is a comma seperated list of tags for this server.
When querying the server list you can filter by these tags.
``` ```

3
Facepunch.Steamworks.Server.IsValid.md

@ -5,5 +5,6 @@ bool IsValid
``` ```
## Summary ## Summary
``` ```
No documentation available Returns true if this instance has initialized properly.
If this returns false you should Dispose and throw an error.
``` ```

2
Facepunch.Steamworks.Server.LogOnAnonymous.md

@ -5,5 +5,5 @@ void LogOnAnonymous( )
``` ```
## Summary ## Summary
``` ```
Log onto Steam anonymously Log onto Steam anonymously.
``` ```

3
Facepunch.Steamworks.Server.LoggedOn.md

@ -5,5 +5,6 @@ bool LoggedOn
``` ```
## Summary ## Summary
``` ```
No documentation available Returns true if the server is connected and registered with the Steam master server
You should have called LogOnAnonymous etc on startup.
``` ```

2
Facepunch.Steamworks.Server.Product.md

@ -5,5 +5,5 @@ string Product
``` ```
## Summary ## Summary
``` ```
Gets or sets the current Product Gets or sets the current product. This isn't really used.
``` ```

11
Facepunch.Steamworks.Server.PublicIp.md Normal file

@ -0,0 +1,11 @@
# PublicIp
## Property
```
IPAddress PublicIp
```
## Summary
```
To the best of its ability this tries to get the server's
current public ip address. Be aware that this is likely to return
null for the first few seconds after initialization.
```

5
Facepunch.Steamworks.Server.SetKey.md

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

4
Facepunch.Steamworks.Server.UpdatePlayer.md

@ -5,5 +5,7 @@ void UpdatePlayer( ulong steamid, string name, int score )
``` ```
## Summary ## Summary
``` ```
No documentation available Update this connected player's information. You should really call this
any time a player's name or score changes. This keeps the information shown
to server queries up to date.
``` ```

4
Facepunch.Steamworks.Server.md

@ -2,7 +2,9 @@
### Summary ### Summary
``` ```
No documentation available Initialize this class for Game Servers.
Game servers offer a limited amount of Steam functionality - and don't require the Steam client.
``` ```
### Methods ### Methods
* **void** [[FetchRules|Facepunch.Steamworks.Server.FetchRules]]( ) * **void** [[FetchRules|Facepunch.Steamworks.Server.FetchRules]]( )

2
Facepunch.Steamworks.ServerQuery.md

@ -2,7 +2,7 @@
### Summary ### Summary
``` ```
No documentation available If you're manually processing the server queries, you should use this class.
``` ```
### Methods ### Methods
* **bool** [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( **Packet&** packet ) * **bool** [[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]( **Packet&** packet )

2
Facepunch.Steamworks.ServerStats.Commit.md

@ -1,7 +1,7 @@
# Commit # Commit
## Method ## Method
``` ```
void Commit( ulong steamid ) void Commit( ulong steamid, Action\<bool\> Callback )
``` ```
## Summary ## Summary
``` ```

6
Facepunch.Steamworks.ServerStats.GetFloat.md

@ -1,9 +1,11 @@
# GetFloat # GetFloat
## Method ## Method
``` ```
Single GetFloat( ulong steamid, string name, Single defaultValue ) float GetFloat( ulong steamid, string name, float defaultValue )
``` ```
## Summary ## Summary
``` ```
Set the named stat for this user Get the named stat for this user. If getting the stat failed, will return
defaultValue. You should have called Refresh for this userid - which downloads
the stats from the backend. If you didn't call it this will always return defaultValue.
``` ```

4
Facepunch.Steamworks.ServerStats.GetInt.md

@ -5,5 +5,7 @@ int GetInt( ulong steamid, string name, int defaultValue )
``` ```
## Summary ## Summary
``` ```
Set the named stat for this user Get the named stat for this user. If getting the stat failed, will return
defaultValue. You should have called Refresh for this userid - which downloads
the stats from the backend. If you didn't call it this will always return defaultValue.
``` ```

4
Facepunch.Steamworks.ServerStats.Refresh.md

@ -1,9 +1,9 @@
# Refresh # Refresh
## Method ## Method
``` ```
void Refresh( ulong steamid ) void Refresh( ulong steamid, Action\<bool\> Callback )
``` ```
## Summary ## Summary
``` ```
Retrieve the stats for this user No documentation available
``` ```

5
Facepunch.Steamworks.ServerStats.Set.md

@ -1,9 +1,10 @@
# Set # Set
## Method ## Method
``` ```
bool Set( ulong steamid, string name, Single stat ) bool Set( ulong steamid, string name, float stat )
``` ```
## Summary ## Summary
``` ```
Set the named statistic for this user Set the named stat for this user. Setting stats should follow the rules
you defined in Steamworks.
``` ```

11
Facepunch.Steamworks.ServerStats.md

@ -2,15 +2,16 @@
### Summary ### Summary
``` ```
No documentation available Allows getting and setting stats on users from the gameserver. These stats
should have been set up on the Steamworks website for your app.
``` ```
### Methods ### Methods
* **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid ) * **void** [[Commit|Facepunch.Steamworks.ServerStats.Commit]]( **ulong** steamid, **Action\<bool\>** Callback )
* **Single** [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( **ulong** steamid, **string** name, **Single** defaultValue ) * **float** [[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]( **ulong** steamid, **string** name, **float** defaultValue )
* **int** [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( **ulong** steamid, **string** name, **int** defaultValue ) * **int** [[GetInt|Facepunch.Steamworks.ServerStats.GetInt]]( **ulong** steamid, **string** name, **int** defaultValue )
* **void** [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( **ulong** steamid ) * **void** [[Refresh|Facepunch.Steamworks.ServerStats.Refresh]]( **ulong** steamid, **Action\<bool\>** Callback )
* **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **int** stat ) * **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **int** stat )
* **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **Single** stat ) * **bool** [[Set|Facepunch.Steamworks.ServerStats.Set]]( **ulong** steamid, **string** name, **float** stat )
### Properties ### Properties

2
Facepunch.Steamworks.Stats.GetFloat.md

@ -1,7 +1,7 @@
# GetFloat # GetFloat
## Method ## Method
``` ```
Single GetFloat( string name ) float GetFloat( string name )
``` ```
## Summary ## Summary
``` ```

2
Facepunch.Steamworks.Stats.GetGlobalFloat.md

@ -1,7 +1,7 @@
# GetGlobalFloat # GetGlobalFloat
## Method ## Method
``` ```
Double GetGlobalFloat( string name ) double GetGlobalFloat( string name )
``` ```
## Summary ## Summary
``` ```

4
Facepunch.Steamworks.Stats.md

@ -5,8 +5,8 @@
No documentation available No documentation available
``` ```
### Methods ### Methods
* **Single** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name ) * **float** [[GetFloat|Facepunch.Steamworks.Stats.GetFloat]]( **string** name )
* **Double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name ) * **double** [[GetGlobalFloat|Facepunch.Steamworks.Stats.GetGlobalFloat]]( **string** name )
* **Int64** [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( **string** name ) * **Int64** [[GetGlobalInt|Facepunch.Steamworks.Stats.GetGlobalInt]]( **string** name )
* **int** [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( **string** name ) * **int** [[GetInt|Facepunch.Steamworks.Stats.GetInt]]( **string** name )
* **void** [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( **int** days ) * **void** [[UpdateGlobalStats|Facepunch.Steamworks.Stats.UpdateGlobalStats]]( **int** days )