mirror of
https://github.com/Facepunch/Facepunch.Steamworks.git
synced 2025-06-30 22:39:39 +03:00
Doumentation fixes
parent
9ff9647272
commit
60c991cbe8
@ -3,4 +3,5 @@
|
|||||||
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Cancel|Facepunch.Steamworks.Auth.Ticket.Cancel]]**( )
|
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Cancel|Facepunch.Steamworks.Auth.Ticket.Cancel]]**( )
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Cancels a ticket.
|
||||||
|
You should cancel your ticket when you close the game or leave a server.
|
||||||
|
@ -3,4 +3,5 @@
|
|||||||
[[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ExchangeSchema|Facepunch.Steamworks.Inventory.Definition.ExchangeSchema]]**
|
[[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ExchangeSchema|Facepunch.Steamworks.Inventory.Definition.ExchangeSchema]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
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"
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[IngredientFor|Facepunch.Steamworks.Inventory.Definition.IngredientFor]]**
|
[[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[IngredientFor|Facepunch.Steamworks.Inventory.Definition.IngredientFor]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
A list of recepies we're included in
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[Recipes|Facepunch.Steamworks.Inventory.Definition.Recipes]]**
|
[[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[Recipes|Facepunch.Steamworks.Inventory.Definition.Recipes]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
A list of recepies for creating this item. Can be null if none.
|
||||||
|
@ -3,4 +3,6 @@
|
|||||||
[[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 )
|
[[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
|
||||||
No documentation available
|
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.
|
||||||
|
@ -3,4 +3,7 @@
|
|||||||
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[TriggerItemDrop|Facepunch.Steamworks.Inventory.Definition.TriggerItemDrop]]**( )
|
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[TriggerItemDrop|Facepunch.Steamworks.Inventory.Definition.TriggerItemDrop]]**( )
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
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
|
||||||
|
@ -2,7 +2,9 @@
|
|||||||
|
|
||||||
### Summary
|
### Summary
|
||||||
```
|
```
|
||||||
No documentation available
|
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
|
### Methods
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|Facepunch.Steamworks.Inventory.Item.Definition]]**
|
[[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|Facepunch.Steamworks.Inventory.Item.Definition]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Careful, this might not be available. Especially on a game server.
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
### Summary
|
### Summary
|
||||||
```
|
```
|
||||||
No documentation available
|
An item in your inventory.
|
||||||
```
|
```
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.ServerList.Request.Dispose]]**( )
|
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispose|Facepunch.Steamworks.ServerList.Request.Dispose]]**( )
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Disposing will end the query
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Finished|Facepunch.Steamworks.ServerList.Request.Finished]]**
|
[[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Finished|Facepunch.Steamworks.ServerList.Request.Finished]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
True when we have finished
|
||||||
|
@ -3,4 +3,5 @@
|
|||||||
[[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Responded|Facepunch.Steamworks.ServerList.Request.Responded]]**
|
[[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Responded|Facepunch.Steamworks.ServerList.Request.Responded]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
A list of servers that responded. If you're only interested in servers that responded since you
|
||||||
|
last updated, then simply clear this list.
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Unresponsive|Facepunch.Steamworks.ServerList.Request.Unresponsive]]**
|
[[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Unresponsive|Facepunch.Steamworks.ServerList.Request.Unresponsive]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
A list of servers that were in the master list but didn't respond.
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[FetchRules|Facepunch.Steamworks.ServerList.Server.FetchRules]]**( )
|
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[FetchRules|Facepunch.Steamworks.ServerList.Server.FetchRules]]**( )
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Populates Rules for this server
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[HasRules|Facepunch.Steamworks.ServerList.Server.HasRules]]**
|
[[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[HasRules|Facepunch.Steamworks.ServerList.Server.HasRules]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Returns true if this server has rules
|
||||||
|
@ -3,4 +3,5 @@
|
|||||||
[[Action<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OnReceivedRules|Facepunch.Steamworks.ServerList.Server.OnReceivedRules]]**
|
[[Action<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OnReceivedRules|Facepunch.Steamworks.ServerList.Server.OnReceivedRules]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Callback when rules are receieved.
|
||||||
|
The bool is true if server responded properly.
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[Dictionary<string, string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Rules|Facepunch.Steamworks.ServerList.Server.Rules]]**
|
[[Dictionary<string, string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Rules|Facepunch.Steamworks.ServerList.Server.Rules]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
List of server rules. Use HasRules to see if this is safe to access.
|
||||||
|
@ -2,8 +2,7 @@
|
|||||||
|
|
||||||
### Summary
|
### Summary
|
||||||
```
|
```
|
||||||
Initialize this class for Game Servers.
|
No documentation available
|
||||||
Game servers offer a limited amount of Steam functionality - and don't require the Steam client.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Url|Facepunch.Steamworks.Workshop.Item.Url]]**
|
[[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Url|Facepunch.Steamworks.Workshop.Item.Url]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Return a URL to view this item online
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.Workshop.Query.AppId]]**
|
[[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId|Facepunch.Steamworks.Workshop.Query.AppId]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
The AppId you're querying. This defaults to this appid.
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Block|Facepunch.Steamworks.Workshop.Query.Block]]**( )
|
[[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Block|Facepunch.Steamworks.Workshop.Query.Block]]**( )
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Don't call this in production!
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[List<string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ExcludeTags|Facepunch.Steamworks.Workshop.Query.ExcludeTags]]**
|
[[List<string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ExcludeTags|Facepunch.Steamworks.Workshop.Query.ExcludeTags]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Don't return any items with this tag
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[List<ulong>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[FileId|Facepunch.Steamworks.Workshop.Query.FileId]]**
|
[[List<ulong>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[FileId|Facepunch.Steamworks.Workshop.Query.FileId]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
If you're querying for a particular file or files, add them to this.
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Page|Facepunch.Steamworks.Workshop.Query.Page]]**
|
[[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Page|Facepunch.Steamworks.Workshop.Query.Page]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Page starts at 1 !!
|
||||||
|
@ -3,4 +3,5 @@
|
|||||||
[[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RequireAllTags|Facepunch.Steamworks.Workshop.Query.RequireAllTags]]**
|
[[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RequireAllTags|Facepunch.Steamworks.Workshop.Query.RequireAllTags]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
If true, return items that have all RequireTags
|
||||||
|
If false, return items that have any tags in RequireTags
|
||||||
|
@ -3,4 +3,4 @@
|
|||||||
[[List<string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RequireTags|Facepunch.Steamworks.Workshop.Query.RequireTags]]**
|
[[List<string>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[RequireTags|Facepunch.Steamworks.Workshop.Query.RequireTags]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
Only return items with these tags
|
||||||
|
@ -3,4 +3,5 @@
|
|||||||
[[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UploaderAppId|Facepunch.Steamworks.Workshop.Query.UploaderAppId]]**
|
[[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UploaderAppId|Facepunch.Steamworks.Workshop.Query.UploaderAppId]]**
|
||||||
|
|
||||||
## Summary
|
## Summary
|
||||||
No documentation available
|
The AppId of the app used to upload the item. This defaults to 0
|
||||||
|
which means all/any.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user