mirror of
https://github.com/Facepunch/Facepunch.Steamworks.git
synced 2025-04-20 16:22:28 +03:00
Documentation, examples support
parent
17a90e1f1d
commit
5cef757e4a
@ -2,7 +2,8 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BuildId|Facepunch.Steamworks.App.BuildId]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Returns the current BuildId of the game.
|
||||
This is pretty useless, as it isn't guarenteed to return
|
||||
the build id you're playing, or the latest build id.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[MarkContentCorrupt|Facepunch.Steamworks.App.MarkContentCorrupt]]**( [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] missingFilesOnly );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Constructor
|
||||
public **[[Auth|Facepunch.Steamworks.Auth.Auth.1]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Method
|
||||
public [[Ticket|Facepunch.Steamworks.Auth.Ticket]] **[[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]**( );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Creates an auth ticket.
|
||||
Which you can send to a server to authenticate that you are who you say you are.
|
||||
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Cancel|Facepunch.Steamworks.Auth.Ticket.Cancel]]**( );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Cancels a ticket.
|
||||
You should cancel your ticket when you close the game or leave a server.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Data|Facepunch.Steamworks.Auth.Ticket.Data]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Auth.Ticket.Dispose]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Handle|Facepunch.Steamworks.Auth.Ticket.Handle]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Constructor
|
||||
public **[[Ticket|Facepunch.Steamworks.Auth.Ticket.Ticket.1]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.BaseSteamworks.AppId]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Current running program's AppId
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Constructor
|
||||
public **[[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks.BaseSteamworks.1]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Inventory|Facepunch.Steamworks.Inventory]] **[[Inventory|Facepunch.Steamworks.BaseSteamworks.Inventory]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Property
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.BaseSteamworks.IsValid]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Returns true if this instance has initialized properly.
|
||||
If this returns false you should Dispose and throw an error.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Networking|Facepunch.Steamworks.Networking]] **[[Networking|Facepunch.Steamworks.BaseSteamworks.Networking]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.BaseSteamworks.Update]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,7 +2,8 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UpdateWhile|Facepunch.Steamworks.BaseSteamworks.UpdateWhile]]**( [[Func<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] func );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Run Update until func returns false.
|
||||
This will cause your program to lock up until it finishes.
|
||||
This is useful for things like tests or command line utilities etc.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Workshop|Facepunch.Steamworks.Workshop]] **[[Workshop|Facepunch.Steamworks.BaseSteamworks.Workshop]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -3,6 +3,7 @@
|
||||
### Summary
|
||||
Implements shared functionality between Steamworks.Client and Steamworks.Server
|
||||
|
||||
|
||||
### Constructors
|
||||
* public **[[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks.BaseSteamworks.1]]**( );
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[App|Facepunch.Steamworks.App]] **[[App|Facepunch.Steamworks.Client.App]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.Client.AppId]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Current running program's AppId
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Auth|Facepunch.Steamworks.Auth]] **[[Auth|Facepunch.Steamworks.Client.Auth]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BetaName|Facepunch.Steamworks.Client.BetaName]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Current Beta name, if we're using a beta branch.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Constructor
|
||||
public **[[Client|Facepunch.Steamworks.Client.Client.1]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Client.Dispose]]**( );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Call when finished to shut down the Steam client.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Friends|Facepunch.Steamworks.Friends]] **[[Friends|Facepunch.Steamworks.Client.Friends]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Inventory|Facepunch.Steamworks.Inventory]] **[[Inventory|Facepunch.Steamworks.Client.Inventory]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Property
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsValid|Facepunch.Steamworks.Client.IsValid]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Returns true if this instance has initialized properly.
|
||||
If this returns false you should Dispose and throw an error.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Networking|Facepunch.Steamworks.Networking]] **[[Networking|Facepunch.Steamworks.Client.Networking]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Overlay|Facepunch.Steamworks.Overlay]] **[[Overlay|Facepunch.Steamworks.Client.Overlay]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Screenshots|Facepunch.Steamworks.Screenshots]] **[[Screenshots|Facepunch.Steamworks.Client.Screenshots]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[ServerList|Facepunch.Steamworks.ServerList]] **[[ServerList|Facepunch.Steamworks.Client.ServerList]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Stats|Facepunch.Steamworks.Stats]] **[[Stats|Facepunch.Steamworks.Client.Stats]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SteamId|Facepunch.Steamworks.Client.SteamId]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Current user's SteamId
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Client.Update]]**( );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Should be called at least once every frame
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Username|Facepunch.Steamworks.Client.Username]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Current user's Username
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Voice|Facepunch.Steamworks.Voice]] **[[Voice|Facepunch.Steamworks.Client.Voice]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Workshop|Facepunch.Steamworks.Workshop]] **[[Workshop|Facepunch.Steamworks.Client.Workshop]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[a|Facepunch.Steamworks.Color.a]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[b|Facepunch.Steamworks.Color.b]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[g|Facepunch.Steamworks.Color.g]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[byte|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[r|Facepunch.Steamworks.Color.r]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,7 +2,8 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ForcePlatform|Facepunch.Steamworks.Config.ForcePlatform]]**( [[OperatingSystem|Facepunch.Steamworks.OperatingSystem]] os, [[Architecture|Facepunch.Steamworks.Architecture]] arch );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
You can force the platform to a particular one here.
|
||||
This is useful if you're on OSX because some versions of mono don't have a way
|
||||
to tell which platform we're running
|
||||
|
||||
|
@ -2,9 +2,10 @@
|
||||
## Property
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UseThisCall|Facepunch.Steamworks.Config.UseThisCall]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Some platforms allow/need CallingConvention.ThisCall. If you're crashing with argument null
|
||||
errors on certain platforms, try flipping this to true.
|
||||
I owe this logic to Riley Labrecque's hard work on Steamworks.net - I don't have the knowledge
|
||||
or patience to find this shit on my own, so massive thanks to him. And also massive thanks to him
|
||||
for releasing his shit open source under the MIT license so we can all learn and iterate.
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[All|Facepunch.Steamworks.Friends.All]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Returns all friends, even blocked, ignored, friend requests etc
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AllFriends|Facepunch.Steamworks.Friends.AllFriends]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
### Summary
|
||||
Returns only friends
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[SteamFriend|Facepunch.Steamworks.SteamFriend]] **[[Get|Facepunch.Steamworks.Friends.Get]]**( [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[Image|Facepunch.Steamworks.Image]] **[[GetAvatar|Facepunch.Steamworks.Friends.GetAvatar]]**( [[AvatarSize|Facepunch.Steamworks.Friends.AvatarSize]] size, [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetName|Facepunch.Steamworks.Friends.GetName]]**( [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Refresh|Facepunch.Steamworks.Friends.Refresh]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Data|Facepunch.Steamworks.Image.Data]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[Color|Facepunch.Steamworks.Color]] **[[GetPixel|Facepunch.Steamworks.Image.GetPixel]]**( [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] x, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] y );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Height|Facepunch.Steamworks.Image.Height]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Id|Facepunch.Steamworks.Image.Id]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Constructor
|
||||
public **[[Image|Facepunch.Steamworks.Image.Image.1]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsError|Facepunch.Steamworks.Image.IsError]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Return true if this image couldn't be loaded for some reason
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsLoaded|Facepunch.Steamworks.Image.IsLoaded]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Width|Facepunch.Steamworks.Image.Width]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,7 +2,8 @@
|
||||
## Method
|
||||
public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[CraftItem|Facepunch.Steamworks.Inventory.CraftItem]]**( [[Item[]|Facepunch.Steamworks.Inventory.Item]] list, [[Definition|Facepunch.Steamworks.Inventory.Definition]] target );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Crafting! Uses the passed items to buy the target item.
|
||||
You need to have set up the appropriate exchange rules in your item
|
||||
definitions.
|
||||
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Method
|
||||
public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]**( [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] id );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Some definitions aren't sent to the client, and all aren't available on the server.
|
||||
Manually getting a Definition here lets you call functions on those definitions.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Created|Facepunch.Steamworks.Inventory.Definition.Created]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Description|Facepunch.Steamworks.Inventory.Definition.Description]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Property
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ExchangeSchema|Facepunch.Steamworks.Inventory.Definition.ExchangeSchema]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
If this item can be created using other items this string will contain a comma seperated
|
||||
list of definition ids that can be used, ie "100,101;102x5;103x3,104x3"
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[T|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetProperty|Facepunch.Steamworks.Inventory.Definition.GetProperty]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetStringProperty|Facepunch.Steamworks.Inventory.Definition.GetStringProperty]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Id|Facepunch.Steamworks.Inventory.Definition.Id]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[IngredientFor|Facepunch.Steamworks.Inventory.Definition.IngredientFor]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
A list of recepies we're included in
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Modified|Facepunch.Steamworks.Inventory.Definition.Modified]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Name|Facepunch.Steamworks.Inventory.Definition.Name]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[Recipes|Facepunch.Steamworks.Inventory.Definition.Recipes]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
A list of recepies for creating this item. Can be null if none.
|
||||
|
||||
|
@ -2,7 +2,8 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SetProperty|Facepunch.Steamworks.Inventory.Definition.SetProperty]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name, [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] value );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
If you're manually occupying the Definition (because maybe you're on a server
|
||||
and want to hack around the fact that definitions aren't presented to you),
|
||||
you can use this to set propertis.
|
||||
|
||||
|
@ -2,8 +2,9 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[TriggerItemDrop|Facepunch.Steamworks.Inventory.Definition.TriggerItemDrop]]**( );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Trigger an item drop. Call this when it's a good time to award
|
||||
an item drop to a player. This won't automatically result in giving
|
||||
an item to a player. Just call it every minute or so, or on launch.
|
||||
ItemDefinition is usually a generator
|
||||
|
||||
|
@ -5,6 +5,7 @@ An item definition. This describes an item in your Steam inventory, but is
|
||||
not unique to that item. For example, this might be a tshirt, but you might be able to own
|
||||
multiple tshirts.
|
||||
|
||||
|
||||
### Methods
|
||||
* public [[T|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetProperty|Facepunch.Steamworks.Inventory.Definition.GetProperty]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name );
|
||||
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetStringProperty|Facepunch.Steamworks.Inventory.Definition.GetStringProperty]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name );
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Property
|
||||
public [[Definition[]|Facepunch.Steamworks.Inventory.Definition]] **[[Definitions|Facepunch.Steamworks.Inventory.Definitions]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
A list of items defined for this app.
|
||||
This should be immediately populated and available.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[Deserialize|Facepunch.Steamworks.Inventory.Deserialize]]**( [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] data, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] dataLength );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Inventory.Dispose]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Method
|
||||
public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[FindDefinition|Facepunch.Steamworks.Inventory.FindDefinition]]**( [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] DefinitionId );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
You really need me to explain what this does?
|
||||
Use your brains.
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|Facepunch.Steamworks.Inventory.Item.Definition]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Careful, this might not be available. Especially on a game server.
|
||||
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[DefinitionId|Facepunch.Steamworks.Inventory.Item.DefinitionId]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Id|Facepunch.Steamworks.Inventory.Item.Id]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Constructor
|
||||
public **[[Item|Facepunch.Steamworks.Inventory.Item.Item.1]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Quantity|Facepunch.Steamworks.Inventory.Item.Quantity]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[TradeLocked|Facepunch.Steamworks.Inventory.Item.TradeLocked]]**;
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -3,6 +3,7 @@
|
||||
### Summary
|
||||
An item in your inventory.
|
||||
|
||||
|
||||
### Constructors
|
||||
* public **[[Item|Facepunch.Steamworks.Inventory.Item.Item.1]]**( );
|
||||
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Property
|
||||
public [[Item[]|Facepunch.Steamworks.Inventory.Item]] **[[Items|Facepunch.Steamworks.Inventory.Items]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
A list of items owned by this user. You should call Refresh() before trying to access this,
|
||||
and then wait until it's non null or listen to OnUpdate to find out immediately when it's populated.
|
||||
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Property
|
||||
public [[Action|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OnUpdate|Facepunch.Steamworks.Inventory.OnUpdate]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Called when the local client's items are first retrieved, and when they change.
|
||||
Obviously not called on the server.
|
||||
|
||||
|
@ -2,8 +2,9 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[PlaytimeHeartbeat|Facepunch.Steamworks.Inventory.PlaytimeHeartbeat]]**( );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
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.
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Method
|
||||
public [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[PriceCategoryToFloat|Facepunch.Steamworks.Inventory.PriceCategoryToFloat]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] price );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Utility, given a "1;VLV250" string, convert it to a 2.5
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Count|Facepunch.Steamworks.Inventory.Recipe.Ingredient.Count]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
The amount of this item needed. Generally this will be 1.
|
||||
|
||||
|
@ -2,6 +2,7 @@
|
||||
## Property
|
||||
public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|Facepunch.Steamworks.Inventory.Recipe.Ingredient.Definition]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
If we don't know about this item definition this might be null.
|
||||
In which case, DefinitionId should still hold the correct id.
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[DefinitionId|Facepunch.Steamworks.Inventory.Recipe.Ingredient.DefinitionId]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
The definition ID of the ingredient.
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[Ingredient[]|Facepunch.Steamworks.Inventory.Recipe.Ingredient]] **[[Ingredients|Facepunch.Steamworks.Inventory.Recipe.Ingredients]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
The items, with quantity required to create this item.
|
||||
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Result|Facepunch.Steamworks.Inventory.Recipe.Result]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
The item that this will create.
|
||||
|
||||
|
@ -4,6 +4,7 @@
|
||||
Represents a crafting recepie which was defined using the exchange
|
||||
section in the item schema.
|
||||
|
||||
|
||||
### Fields
|
||||
* public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Result|Facepunch.Steamworks.Inventory.Recipe.Result]]**;
|
||||
* public [[Ingredient[]|Facepunch.Steamworks.Inventory.Recipe.Ingredient]] **[[Ingredients|Facepunch.Steamworks.Inventory.Recipe.Ingredients]]**;
|
||||
|
@ -2,7 +2,8 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Refresh|Facepunch.Steamworks.Inventory.Refresh]]**( );
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
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,5 +2,3 @@
|
||||
## Method
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Block|Facepunch.Steamworks.Inventory.Result.Block]]**( [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] maxWait );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Method
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Inventory.Result.Dispose]]**( );
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsPending|Facepunch.Steamworks.Inventory.Result.IsPending]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,3 @@
|
||||
## Property
|
||||
public [[Item[]|Facepunch.Steamworks.Inventory.Item]] **[[Items|Facepunch.Steamworks.Inventory.Result.Items]]** { get; set; }
|
||||
|
||||
## Summary
|
||||
No documentation available
|
||||
|
@ -2,5 +2,6 @@
|
||||
## Property
|
||||
public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SerializedExpireTime|Facepunch.Steamworks.Inventory.SerializedExpireTime]]**;
|
||||
|
||||
## Summary
|
||||
### Summary
|
||||
Serialized data exprires after an hour. This is the time the value in SerializedItems will expire.
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user