mirror of
https://github.com/Facepunch/Facepunch.Steamworks.git
synced 2025-04-08 10:39:03 +03:00
Retain indents
parent
bfce0191b5
commit
0a8d4778ed
@ -3,7 +3,8 @@
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BuildId|Facepunch.Steamworks.App.BuildId]]** { get; set; }
|
||||
|
||||
### Summary
|
||||
Returns the current BuildId of the game.
|
||||
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.
|
||||
|
||||
|
||||
|
@ -3,6 +3,7 @@
|
||||
public [[Ticket|Facepunch.Steamworks.Auth.Ticket]] **[[GetAuthSessionTicket|Facepunch.Steamworks.Auth.GetAuthSessionTicket]]**( );
|
||||
|
||||
### Summary
|
||||
Creates an auth ticket.
|
||||
Creates an auth ticket.
|
||||
Which you can send to a server to authenticate that you are who you say you are.
|
||||
|
||||
|
||||
|
@ -3,6 +3,7 @@
|
||||
public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Cancel|Facepunch.Steamworks.Auth.Ticket.Cancel]]**( );
|
||||
|
||||
### Summary
|
||||
Cancels a ticket.
|
||||
Cancels a ticket.
|
||||
You should cancel your ticket when you close the game or leave a server.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId
|
||||
### Summary
|
||||
Current running program's AppId
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsVal
|
||||
Returns true if this instance has initialized properly.
|
||||
If this returns false you should Dispose and throw an error.
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ 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.
|
||||
|
||||
|
||||
|
@ -4,6 +4,7 @@
|
||||
Implements shared functionality between Steamworks.Client and Steamworks.Server
|
||||
|
||||
|
||||
|
||||
### Constructors
|
||||
* public **[[BaseSteamworks|Facepunch.Steamworks.BaseSteamworks.BaseSteamworks.1]]**( );
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId
|
||||
### Summary
|
||||
Current running program's AppId
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Bet
|
||||
### Summary
|
||||
Current Beta name, if we're using a beta branch.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispo
|
||||
### Summary
|
||||
Call when finished to shut down the Steam client.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsVal
|
||||
Returns true if this instance has initialized properly.
|
||||
If this returns false you should Dispose and throw an error.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Stea
|
||||
### Summary
|
||||
Current user's SteamId
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Updat
|
||||
### Summary
|
||||
Should be called at least once every frame
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Use
|
||||
### Summary
|
||||
Current user's Username
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ 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
|
||||
|
||||
|
||||
|
@ -5,7 +5,10 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[UseTh
|
||||
### 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.
|
||||
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library
|
||||
### Summary
|
||||
Returns all friends, even blocked, ignored, friend requests etc
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library
|
||||
### Summary
|
||||
Returns all blocked users
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[IEnumerable<SteamFriend>|https://msdn.microsoft.com/en-us/library
|
||||
### Summary
|
||||
Returns only friends
|
||||
|
||||
|
||||
|
@ -3,12 +3,14 @@
|
||||
### Summary
|
||||
Handles most interactions with people in Steam, not just friends as the name would suggest.
|
||||
|
||||
|
||||
### Example
|
||||
```
|
||||
foreach ( var friend in client.Friends.AllFriends )
|
||||
{
|
||||
Console.WriteLine( $"{friend.Id}: {friend.Name}" );
|
||||
Console.WriteLine( $"{friend.Id}: {friend.Name}" );
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsErr
|
||||
### Summary
|
||||
Return true if this image couldn't be loaded for some reason
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ Crafting! Uses the passed items to buy the target item.
|
||||
You need to have set up the appropriate exchange rules in your item
|
||||
definitions.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[CreateDefini
|
||||
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.
|
||||
|
||||
|
||||
|
@ -3,6 +3,7 @@
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[ExchangeSchema|Facepunch.Steamworks.Inventory.Definition.ExchangeSchema]]** { get; set; }
|
||||
|
||||
### Summary
|
||||
If this item can be created using other items this string will contain a comma seperated
|
||||
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"
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[IngredientFor|Face
|
||||
### Summary
|
||||
A list of recepies we're included in
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[Recipe[]|Facepunch.Steamworks.Inventory.Recipe]] **[[Recipes|Facepunch.
|
||||
### Summary
|
||||
A list of recepies for creating this item. Can be null if none.
|
||||
|
||||
|
||||
|
@ -4,6 +4,7 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SetPr
|
||||
|
||||
### 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),
|
||||
and want to hack around the fact that definitions aren't presented to you),
|
||||
you can use this to set propertis.
|
||||
|
||||
|
||||
|
@ -8,3 +8,4 @@ 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
|
||||
|
||||
|
||||
|
@ -6,6 +6,7 @@ not unique to that item. For example, this might be a tshirt, but you might be a
|
||||
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 );
|
||||
|
@ -3,6 +3,7 @@
|
||||
public [[Definition[]|Facepunch.Steamworks.Inventory.Definition]] **[[Definitions|Facepunch.Steamworks.Inventory.Definitions]]**;
|
||||
|
||||
### Summary
|
||||
A list of items defined for this app.
|
||||
A list of items defined for this app.
|
||||
This should be immediately populated and available.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[FindDefiniti
|
||||
You really need me to explain what this does?
|
||||
Use your brains.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|F
|
||||
### Summary
|
||||
Careful, this might not be available. Especially on a game server.
|
||||
|
||||
|
||||
|
@ -4,6 +4,7 @@
|
||||
An item in your inventory.
|
||||
|
||||
|
||||
|
||||
### Constructors
|
||||
* public **[[Item|Facepunch.Steamworks.Inventory.Item.Item.1]]**( );
|
||||
|
||||
|
@ -3,6 +3,7 @@
|
||||
public [[Item[]|Facepunch.Steamworks.Inventory.Item]] **[[Items|Facepunch.Steamworks.Inventory.Items]]**;
|
||||
|
||||
### Summary
|
||||
A list of items owned by this user. You should call Refresh() before trying to access this,
|
||||
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.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[Action|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[OnU
|
||||
Called when the local client's items are first retrieved, and when they change.
|
||||
Obviously not called on the server.
|
||||
|
||||
|
||||
|
@ -8,3 +8,4 @@ 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.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Pric
|
||||
### Summary
|
||||
Utility, given a "1;VLV250" string, convert it to a 2.5
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Count|
|
||||
### Summary
|
||||
The amount of this item needed. Generally this will be 1.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Definition|F
|
||||
If we don't know about this item definition this might be null.
|
||||
In which case, DefinitionId should still hold the correct id.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Defini
|
||||
### Summary
|
||||
The definition ID of the ingredient.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[Ingredient[]|Facepunch.Steamworks.Inventory.Recipe.Ingredient]] **[[Ing
|
||||
### Summary
|
||||
The items, with quantity required to create this item.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[Definition|Facepunch.Steamworks.Inventory.Definition]] **[[Result|Facep
|
||||
### Summary
|
||||
The item that this will create.
|
||||
|
||||
|
||||
|
@ -5,6 +5,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]]**;
|
||||
|
@ -7,3 +7,4 @@ 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
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[DateTime|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[S
|
||||
### Summary
|
||||
Serialized data exprires after an hour. This is the time the value in SerializedItems will expire.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Ser
|
||||
You can send this data to a server, or another player who can then deserialize it
|
||||
and get a verified list of items.
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ 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.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[AppId
|
||||
### Summary
|
||||
Current running program's AppId
|
||||
|
||||
|
||||
|
@ -3,6 +3,7 @@
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[BotCount|Facepunch.Steamworks.Server.BotCount]]** { get; set; }
|
||||
|
||||
### Summary
|
||||
Gets or sets the current BotCount.
|
||||
Gets or sets the current BotCount.
|
||||
This doesn't enforce any kind of limit, it just updates the master server.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispo
|
||||
### Summary
|
||||
Shutdown interface, disconnect from Steam
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Gam
|
||||
### Summary
|
||||
Gets or sets the current Product
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Gam
|
||||
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.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsVal
|
||||
Returns true if this instance has initialized properly.
|
||||
If this returns false you should Dispose and throw an error.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[LogOn
|
||||
### Summary
|
||||
Log onto Steam anonymously.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Logge
|
||||
Returns true if the server is connected and registered with the Steam master server
|
||||
You should have called LogOnAnonymous etc on startup.
|
||||
|
||||
|
||||
|
@ -3,5 +3,6 @@
|
||||
public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[MapName|Facepunch.Steamworks.Server.MapName]]** { get; set; }
|
||||
|
||||
### Summary
|
||||
Gets or sets the current Map Name.
|
||||
Gets or sets the current Map Name.
|
||||
|
||||
|
||||
|
@ -3,6 +3,7 @@
|
||||
public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[MaxPlayers|Facepunch.Steamworks.Server.MaxPlayers]]** { get; set; }
|
||||
|
||||
### Summary
|
||||
Gets or sets the current MaxPlayers.
|
||||
Gets or sets the current MaxPlayers.
|
||||
This doesn't enforce any kind of limit, it just updates the master server.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Mod
|
||||
### Summary
|
||||
Gets or sets the current ModDir
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Passw
|
||||
### Summary
|
||||
Set whether the server should report itself as passworded
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Pro
|
||||
### Summary
|
||||
Gets or sets the current product. This isn't really used.
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ 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,3 +5,4 @@ public **[[Server|Facepunch.Steamworks.Server.Server.1]]**( [[uint|https://msdn.
|
||||
### Summary
|
||||
Initialize a Steam Server instance
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public **[[Server|Facepunch.Steamworks.Server.Server.2]]**( [[uint|https://msdn.
|
||||
### Summary
|
||||
Initialize a Steam Server instance
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public **[[Server|Facepunch.Steamworks.Server.Server.3]]**( [[uint|https://msdn.
|
||||
Initialize a server - query port will use the same as GamePort (MASTERSERVERUPDATERPORT_USEGAMESOCKETSHARE)
|
||||
This means you'll need to detect and manually process and reply to server queries.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Ser
|
||||
### Summary
|
||||
Gets or sets the current ServerName
|
||||
|
||||
|
||||
|
@ -5,5 +5,7 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[SetKe
|
||||
### Summary
|
||||
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.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Updat
|
||||
### Summary
|
||||
Should be called at least once every frame
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ 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.
|
||||
|
||||
|
||||
|
@ -2,9 +2,11 @@
|
||||
|
||||
### Summary
|
||||
Initialize this class for Game Servers.
|
||||
|
||||
Game servers offer a limited amount of Steam functionality - and don't require the Steam client.
|
||||
|
||||
|
||||
|
||||
### Constructors
|
||||
* public **[[Server|Facepunch.Steamworks.Server.Server.1]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] IpAddress, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] SteamPort, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] GamePort, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] QueryPort, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] Secure, [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] VersionString );
|
||||
* public **[[Server|Facepunch.Steamworks.Server.Server.2]]**( [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] appId, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] IpAddress, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] GamePort, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] QueryPort, [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] Secure, [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] VersionString );
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[EndSe
|
||||
### Summary
|
||||
Forget this guy. They're no longer in the game.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[Action<ulong, ulong, Status>|https://msdn.microsoft.com/en-us/lib
|
||||
### Summary
|
||||
Steamid, Ownerid, Status
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Start
|
||||
### Summary
|
||||
Start authorizing a ticket. This user isn't authorized yet. Wait for a call to OnAuthChange.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[Request|Facepunch.Steamworks.ServerList.Request]] **[[Favourites|Facepu
|
||||
Favourite filters don't seem to work, so we don't bother.
|
||||
You should apply them post process'dly
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[Request|Facepunch.Steamworks.ServerList.Request]] **[[History|Facepunch
|
||||
History filters don't seem to work, so we don't bother.
|
||||
You should apply them post process'dly
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dispo
|
||||
### Summary
|
||||
Disposing will end the query
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Finis
|
||||
### Summary
|
||||
True when we have finished
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.as
|
||||
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,5 +3,6 @@
|
||||
public [[List<Server>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Unresponsive|Facepunch.Steamworks.ServerList.Request.Unresponsive]]**;
|
||||
|
||||
### Summary
|
||||
A list of servers that were in the master list but didn't respond.
|
||||
A list of servers that were in the master list but didn't respond.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Fetch
|
||||
### Summary
|
||||
Populates Rules for this server
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[HasRu
|
||||
### Summary
|
||||
Returns true if this server has rules
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[Action<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.as
|
||||
Callback when rules are receieved.
|
||||
The bool is true if server responded properly.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[Dictionary<string, string>|https://msdn.microsoft.com/en-us/libra
|
||||
### Summary
|
||||
List of server rules. Use HasRules to see if this is safe to access.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetOu
|
||||
If true, Steam wants to send a packet. You should respond by sending
|
||||
this packet in an unconnected way to the returned Address and Port.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Handl
|
||||
### Summary
|
||||
We have received a server query on our game port. Pass it to Steam to handle.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Addre
|
||||
### Summary
|
||||
Target IP address
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Dat
|
||||
This data is pooled. Make a copy if you don't use it immediately.
|
||||
This buffer is also quite large - so pay attention to Size.
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Por
|
||||
### Summary
|
||||
Target port
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Size|F
|
||||
### Summary
|
||||
Size of the data
|
||||
|
||||
|
||||
|
@ -4,6 +4,7 @@
|
||||
A server query packet.
|
||||
|
||||
|
||||
|
||||
### Properties
|
||||
* public [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Address|Facepunch.Steamworks.ServerQuery.Packet.Address]]** { get; set; }
|
||||
* public [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Data|Facepunch.Steamworks.ServerQuery.Packet.Data]]** { get; set; }
|
||||
|
@ -4,6 +4,7 @@
|
||||
If you're manually processing the server queries, you should use this class.
|
||||
|
||||
|
||||
|
||||
### Methods
|
||||
* public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetOutgoingPacket|Facepunch.Steamworks.ServerQuery.GetOutgoingPacket]]**( [[Packet&|Facepunch.Steamworks.ServerQuery.Packet]] packet );
|
||||
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Handle|Facepunch.Steamworks.ServerQuery.Handle]]**( [[byte[]|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] data, [[int|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] size, [[uint|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] address, [[UInt16|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] port );
|
||||
|
@ -7,3 +7,4 @@ Once you've set a stat change on a user you need to commit your changes.
|
||||
You can do that using this function. The callback will let you know if
|
||||
your action succeeded, but most of the time you can fire and forget.
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ 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.
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ 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.
|
||||
|
||||
|
||||
|
@ -7,3 +7,4 @@ Retrieve the stats for this user. If you pass a callback function in
|
||||
this will be called when the stats are recieved, the bool will signify whether
|
||||
it was successful or not.
|
||||
|
||||
|
||||
|
@ -6,3 +6,4 @@ public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Set|F
|
||||
Set the named stat for this user. Setting stats should follow the rules
|
||||
you defined in Steamworks.
|
||||
|
||||
|
||||
|
@ -5,6 +5,7 @@ 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
|
||||
* public [[void|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Commit|Facepunch.Steamworks.ServerStats.Commit]]**( [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid, [[Action<bool>|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] Callback );
|
||||
* public [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[GetFloat|Facepunch.Steamworks.ServerStats.GetFloat]]**( [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] steamid, [[string|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] name, [[float|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] defaultValue );
|
||||
|
@ -5,3 +5,4 @@ public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Curr
|
||||
### Summary
|
||||
The AppId this guy is playing
|
||||
|
||||
|
||||
|
@ -5,3 +5,4 @@ public [[ulong|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[Id|F
|
||||
### Summary
|
||||
Steam Id
|
||||
|
||||
|
||||
|
@ -3,5 +3,6 @@
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsBlocked|Facepunch.Steamworks.SteamFriend.IsBlocked]]** { get; set; }
|
||||
|
||||
### Summary
|
||||
Return true if blocked
|
||||
Return true if blocked
|
||||
|
||||
|
||||
|
@ -3,5 +3,6 @@
|
||||
public [[bool|https://msdn.microsoft.com/en-us/library/ya5y69ds.aspx]] **[[IsFriend|Facepunch.Steamworks.SteamFriend.IsFriend]]** { get; set; }
|
||||
|
||||
### Summary
|
||||
Return true if is a friend. Returns false if blocked, request etc.
|
||||
Return true if is a friend. Returns false if blocked, request etc.
|
||||
|
||||
|
||||
|
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