Updated from v0.3

Garry Newman 2017-02-13 10:09:16 +00:00
parent 01965e0935
commit 887a81fa90
22 changed files with 96 additions and 1 deletions

@ -0,0 +1,8 @@
# RunUpdateCallbacks
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunUpdateCallbacks|Facepunch.Steamworks.BaseSteamworks.RunUpdateCallbacks]]**( );
### Summary
This gets called automatically in Update. Only call it manually if you know why you're doing it.

@ -10,6 +10,7 @@ Implements shared functionality between Steamworks.Client and Steamworks.Server
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.BaseSteamworks.Dispose]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunUpdateCallbacks|Facepunch.Steamworks.BaseSteamworks.RunUpdateCallbacks]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.BaseSteamworks.Update]]**( );
* 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 );

@ -0,0 +1,8 @@
# RunCallbacks
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunCallbacks|Facepunch.Steamworks.Client.RunCallbacks]]**( );
### Summary
This is called in Update() - there's no need to call it manually unless you're running your own Update

@ -6,6 +6,7 @@
### Methods
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Client.Dispose]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RunCallbacks|Facepunch.Steamworks.Client.RunCallbacks]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Client.Update]]**( );
### Properties

@ -0,0 +1,8 @@
# ForUnity
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ForUnity|Facepunch.Steamworks.Config.ForUnity]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] platform );
### Summary
Should be called before creating any interfaces, to configure Steam for Unity.

@ -3,6 +3,7 @@
### Methods
* 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 );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ForUnity|Facepunch.Steamworks.Config.ForUnity]]**( [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] platform );
### Properties
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UseThisCall|Facepunch.Steamworks.Config.UseThisCall]]** { get; set; }

@ -1,6 +1,6 @@
# CraftItem
## Method
public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[CraftItem|Facepunch.Steamworks.Inventory.CraftItem]]**( [[Item[]|Facepunch.Steamworks.Inventory.Item]] list, [[Definition|Facepunch.Steamworks.Inventory.Definition]] target );
public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[CraftItem|Facepunch.Steamworks.Inventory.CraftItem]]**( [[Amount[]|Facepunch.Steamworks.Inventory.Item.Amount]] list, [[Definition|Facepunch.Steamworks.Inventory.Definition]] target );
### Summary
Crafting! Uses the passed items to buy the target item.

@ -0,0 +1,4 @@
# Item
## Property
public [[Item|Facepunch.Steamworks.Inventory.Item]] **[[Item|Facepunch.Steamworks.Inventory.Item.Amount.Item]]**;

@ -0,0 +1,4 @@
# Quantity
## Property
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Quantity|Facepunch.Steamworks.Inventory.Item.Amount.Quantity]]**;

@ -0,0 +1,6 @@
# Amount
### Fields
* public [[Item|Facepunch.Steamworks.Inventory.Item]] **[[Item|Facepunch.Steamworks.Inventory.Item.Amount.Item]]**;
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Quantity|Facepunch.Steamworks.Inventory.Item.Amount.Quantity]]**;

@ -2,3 +2,7 @@
## Property
public [[Item[]|Facepunch.Steamworks.Inventory.Item]] **[[Consumed|Facepunch.Steamworks.Inventory.Result.Consumed]]** { get; set; }
### Summary
Items that have been consumed, like in a craft or something

@ -2,3 +2,7 @@
## Property
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsPending|Facepunch.Steamworks.Inventory.Result.IsPending]]** { get; set; }
### Summary
Returns true if this result is still pending

@ -2,3 +2,7 @@
## Property
public [[Item[]|Facepunch.Steamworks.Inventory.Item]] **[[Items|Facepunch.Steamworks.Inventory.Result.Items]]** { get; set; }
### Summary
Items that exist, or that have been created, or changed

@ -2,3 +2,7 @@
## Property
public [[Item[]|Facepunch.Steamworks.Inventory.Item]] **[[Removed|Facepunch.Steamworks.Inventory.Result.Removed]]** { get; set; }
### Summary
Items that have been removed or somehow destroyed

@ -0,0 +1,8 @@
# Update
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Inventory.Update]]**( );
### Summary
No need to call this manually if you're calling Update

@ -3,6 +3,7 @@
### Methods
* public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[CraftItem|Facepunch.Steamworks.Inventory.CraftItem]]**( [[Item[]|Facepunch.Steamworks.Inventory.Item]] list, [[Definition|Facepunch.Steamworks.Inventory.Definition]] target );
* public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[CraftItem|Facepunch.Steamworks.Inventory.CraftItem]]**( [[Amount[]|Facepunch.Steamworks.Inventory.Item.Amount]] list, [[Definition|Facepunch.Steamworks.Inventory.Definition]] target );
* public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[CreateDefinition|Facepunch.Steamworks.Inventory.CreateDefinition]]**( [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] id );
* 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 );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Inventory.Dispose]]**( );
@ -12,6 +13,7 @@
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Refresh|Facepunch.Steamworks.Inventory.Refresh]]**( );
* public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[SplitStack|Facepunch.Steamworks.Inventory.SplitStack]]**( [[Item|Facepunch.Steamworks.Inventory.Item]] item, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] quantity );
* public [[Result|Facepunch.Steamworks.Inventory.Result]] **[[Stack|Facepunch.Steamworks.Inventory.Stack]]**( [[Item|Facepunch.Steamworks.Inventory.Item]] source, [[Item|Facepunch.Steamworks.Inventory.Item]] dest, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] quantity );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Inventory.Update]]**( );
### Fields
* public [[Action|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OnUpdate|Facepunch.Steamworks.Inventory.OnUpdate]]**;

@ -0,0 +1,8 @@
# Update
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Networking.Update]]**( );
### Summary
No need to call this manually if you're calling Update()

@ -5,6 +5,7 @@
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Networking.Dispose]]**( );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SendP2PPacket|Facepunch.Steamworks.Networking.SendP2PPacket]]**( [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid, [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] data, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] length, [[SendType|Facepunch.Steamworks.Networking.SendType]] eP2PSendType, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] nChannel );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SetListenChannel|Facepunch.Steamworks.Networking.SetListenChannel]]**( [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] ChannelId, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] Listen );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Networking.Update]]**( );
### Fields
* public [[Action<ulong, MemoryStream, int>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OnP2PData|Facepunch.Steamworks.Networking.OnP2PData]]**;

@ -0,0 +1,8 @@
# Update
## Method
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Voice.Update]]**( );
### Summary
This gets called inside Update - so there's no need to call this manually if you're calling update

@ -5,6 +5,7 @@
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Decompress|Facepunch.Steamworks.Voice.Decompress]]**( [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] input, [[MemoryStream|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] output, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] samepleRate );
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Decompress|Facepunch.Steamworks.Voice.Decompress]]**( [[IntPtr|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] input, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] inputoffset, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] inputsize, [[MemoryStream|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] output, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] samepleRate );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.Voice.Dispose]]**( );
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Update|Facepunch.Steamworks.Voice.Update]]**( );
### Properties
* public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[LastVoiceRecordTime|Facepunch.Steamworks.Voice.LastVoiceRecordTime]]** { get; set; }

@ -0,0 +1,9 @@
# RankedByTrendDays
## Property
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RankedByTrendDays|Facepunch.Steamworks.Workshop.Query.RankedByTrendDays]]** { get; set; }
### Summary
If order is RankedByTrend, this value represents how many days to take
into account.

@ -19,6 +19,7 @@
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Page|Facepunch.Steamworks.Workshop.Query.Page]]** { get; set; }
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[PerPage|Facepunch.Steamworks.Workshop.Query.PerPage]]** { get; set; }
* public [[QueryType|Facepunch.Steamworks.Workshop.QueryType]] **[[QueryType|Facepunch.Steamworks.Workshop.Query.QueryType]]** { get; set; }
* public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RankedByTrendDays|Facepunch.Steamworks.Workshop.Query.RankedByTrendDays]]** { get; set; }
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RequireAllTags|Facepunch.Steamworks.Workshop.Query.RequireAllTags]]** { get; set; }
* public [[List<string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RequireTags|Facepunch.Steamworks.Workshop.Query.RequireTags]]** { get; set; }
* public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SearchText|Facepunch.Steamworks.Workshop.Query.SearchText]]** { get; set; }