2023-05-31 18:36:33 +02:00
|
|
|
<?xml version="1.0"?>
|
|
|
|
<doc>
|
|
|
|
<assembly>
|
|
|
|
<name>Facepunch.Steamworks.Win32</name>
|
|
|
|
</assembly>
|
|
|
|
<members>
|
|
|
|
<member name="T:Steamworks.CallResult`1">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
An awaitable version of a SteamAPICall_t
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.CallResult`1.OnCompleted(System.Action)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This gets called if IsComplete returned false on the first call.
|
|
|
|
The Action "continues" the async call. We pass it to the Dispatch
|
|
|
|
to be called when the callback returns.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.CallResult`1.GetResult">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the result. This is called internally by the async shit.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.CallResult`1.IsCompleted">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if complete or failed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.CallResult`1.GetAwaiter">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This is what makes this struct awaitable
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.ICallbackData">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gives us a generic way to get the CallbackId of structs
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.AuthTicket.Cancel">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Cancels a ticket.
|
|
|
|
You should cancel your ticket when you close the game or leave a server.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.Dispatch">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Responsible for all callback/callresult handling
|
|
|
|
|
|
|
|
This manually pumps Steam's message queue and dispatches those
|
|
|
|
events to any waiting callbacks/callresults.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Dispatch.OnDebugCallback">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If set then we'll call this function every time a callback is generated.
|
|
|
|
|
|
|
|
This is SLOW!! - it's for debugging - don't keep it on all the time. If you want to access a specific
|
|
|
|
callback then please create an issue on github and I'll add it!
|
|
|
|
|
|
|
|
Params are : [Callback Type] [Callback Contents] [server]
|
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Dispatch.OnException">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called if an exception happens during a callback/callresult.
|
|
|
|
This is needed because the exception isn't always accessible when running
|
|
|
|
async.. and can fail silently. With this hooked you won't be stuck wondering
|
|
|
|
what happened.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.Init">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This gets called from Client/Server Init
|
|
|
|
It's important to switch to the manual dispatcher
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Dispatch.runningFrame">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Make sure we don't call Frame in a callback - because that'll cause some issues for everyone.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.Frame(Steamworks.Data.HSteamPipe)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Calls RunFrame and processes events from this Steam Pipe
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Dispatch.actionsToCall">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
To be safe we don't call the continuation functions while iterating
|
|
|
|
the Callback list. This is maybe overly safe because the only way this
|
|
|
|
could be an issue is if the callback list is modified in the continuation
|
|
|
|
which would only happen if starting or shutting down in the callback.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.ProcessCallback(Steamworks.Dispatch.CallbackMsg_t,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A callback is a general global message
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.CallbackToString(Steamworks.CallbackType,System.IntPtr,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Given a callback, try to turn it into a string
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.ProcessResult(Steamworks.Dispatch.CallbackMsg_t)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A result is a reply to a specific command
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.LoopClientAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Pumps the queue in an async loop so we don't
|
|
|
|
have to think about it. This has the advantage that
|
|
|
|
you can call .Wait() on async shit and it still works.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.LoopServerAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Pumps the queue in an async loop so we don't
|
|
|
|
have to think about it. This has the advantage that
|
|
|
|
you can call .Wait() on async shit and it still works.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.OnCallComplete``1(Steamworks.Data.SteamAPICall_t,System.Action,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Watch for a steam api call
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Dispatch.Install``1(System.Action{``0},System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Install a global callback. The passed function will get called if it's all good.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.LeaderboardDisplay.Numeric">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The score is just a simple numerical value
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.LeaderboardDisplay.TimeSeconds">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The score represents a time, in seconds
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.LeaderboardDisplay.TimeMilliSeconds">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The score represents a time, in milliseconds
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.LeaderboardSort.Ascending">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The top-score is the lowest number
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.LeaderboardSort.Descending">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The top-score is the highest number
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.SendType.Unreliable">
|
2023-06-01 17:03:48 +02:00
|
|
|
<summary>
|
|
|
|
Send the message unreliably. Can be lost. Messages *can* be larger than a
|
|
|
|
single MTU (UDP packet), but there is no retransmission, so if any piece
|
|
|
|
of the message is lost, the entire message will be dropped.
|
|
|
|
|
|
|
|
The sending API does have some knowledge of the underlying connection, so
|
|
|
|
if there is no NAT-traversal accomplished or there is a recognized adjustment
|
|
|
|
happening on the connection, the packet will be batched until the connection
|
|
|
|
is open again.
|
|
|
|
</summary>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.SendType.NoNagle">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Disable Nagle's algorithm.
|
|
|
|
By default, Nagle's algorithm is applied to all outbound messages. This means
|
|
|
|
that the message will NOT be sent immediately, in case further messages are
|
|
|
|
sent soon after you send this, which can be grouped together. Any time there
|
|
|
|
is enough buffered data to fill a packet, the packets will be pushed out immediately,
|
|
|
|
but partially-full packets not be sent until the Nagle timer expires.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.SendType.NoDelay">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If the message cannot be sent very soon (because the connection is still doing some initial
|
|
|
|
handshaking, route negotiations, etc), then just drop it. This is only applicable for unreliable
|
|
|
|
messages. Using this flag on reliable messages is invalid.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Data.SendType.Reliable">
|
2023-06-01 17:03:48 +02:00
|
|
|
Reliable message send. Can send up to 0.5mb in a single message.
|
2023-05-31 18:36:33 +02:00
|
|
|
Does fragmentation/re-assembly of messages under the hood, as well as a sliding window for
|
|
|
|
efficient sends of large chunks of data.
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetIdentity.LocalHost">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return a NetIdentity that represents LocalHost
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetIdentity.IsLocalHost">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if this identity is localhost
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetIdentity.op_Implicit(Steamworks.SteamId)~Steamworks.Data.NetIdentity">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Convert to a SteamId
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="value"></param>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetIdentity.op_Implicit(Steamworks.Data.NetAddress)~Steamworks.Data.NetIdentity">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set the specified Address
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetIdentity.op_Implicit(Steamworks.Data.NetIdentity)~Steamworks.SteamId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Automatically convert to a SteamId
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="value"></param>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetIdentity.SteamId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns NULL if we're not a SteamId
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetIdentity.Address">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns NULL if we're not a NetAddress
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetIdentity.ToString">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We override tostring to provide a sensible representation
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetAddress.Port">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The Port. This is redundant documentation.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetAddress.AnyIp(System.UInt16)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Any IP, specific port
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetAddress.LocalHost(System.UInt16)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Localhost IP, specific port
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetAddress.From(System.String,System.UInt16)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Specific IP, specific port
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetAddress.From(System.Net.IPAddress,System.UInt16)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Specific IP, specific port
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetAddress.Cleared">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set everything to zero
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetAddress.IsIPv6AllZeros">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if the IP is ::0. (Doesn't check port.)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetAddress.IsIPv4">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if IP is mapped IPv4
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetAddress.IsLocalHost">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if this identity is localhost. (Either IPv6 ::1, or IPv4 127.0.0.1)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.NetAddress.Address">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get the Address section
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.Data.Connection">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Used as a base to create your client connection. This creates a socket
|
|
|
|
to a single connection.
|
|
|
|
|
|
|
|
You can override all the virtual functions to turn it into what you
|
|
|
|
want it to do.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.Accept">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Accept an incoming connection that has been received on a listen socket.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.Close(System.Boolean,System.Int32,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Disconnects from the remote host and invalidates the connection handle. Any unread data on the
|
|
|
|
connection is discarded..
|
|
|
|
reasonCode is defined and used by you.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Connection.UserData">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get/Set connection user data
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Connection.ConnectionName">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A name for the connection, used mostly for debugging
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.SendMessage(System.IntPtr,System.Int32,Steamworks.Data.SendType)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This is the best version to use.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.SendMessage(System.Byte[],Steamworks.Data.SendType)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Ideally should be using an IntPtr version unless you're being really careful with the byte[] array and
|
|
|
|
you're not creating a new one every frame (like using .ToArray())
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.SendMessage(System.Byte[],System.Int32,System.Int32,Steamworks.Data.SendType)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Ideally should be using an IntPtr version unless you're being really careful with the byte[] array and
|
|
|
|
you're not creating a new one every frame (like using .ToArray())
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.SendMessage(System.String,Steamworks.Data.SendType)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This creates a ton of garbage - so don't do anything with this beyond testing!
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.Flush">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Flush any messages waiting on the Nagle timer and send them at the next transmission
|
|
|
|
opportunity (often that means right now).
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Connection.DetailedStatus">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns detailed connection stats in text format. Useful
|
|
|
|
for dumping to a log, etc.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<returns>Plain text connection info</returns>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.Data.ConnectionInfo">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Describe the state of a connection
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.ConnectionInfo.State">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
High level state of the connection
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.ConnectionInfo.Address">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Remote address. Might be all 0's if we don't know it, or if this is N/A.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.ConnectionInfo.Identity">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Who is on the other end? Depending on the connection type and phase of the connection, we might not know
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.ConnectionInfo.EndReason">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Basic cause of the connection termination or problem.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.Data.NetPingLocation">
|
2023-06-01 17:03:48 +02:00
|
|
|
<summary>
|
|
|
|
|
|
|
|
Object that describes a "location" on the Internet with sufficient
|
|
|
|
detail that we can reasonably estimate an upper bound on the ping between
|
|
|
|
the two hosts, even if a direct route between the hosts is not possible,
|
|
|
|
and the connection must be routed through the Steam Datagram Relay network.
|
|
|
|
This does not contain any information that identifies the host. Indeed,
|
|
|
|
if two hosts are in the same building or otherwise have nearly identical
|
|
|
|
networking characteristics, then it's valid to use the same location
|
|
|
|
object for both of them.
|
|
|
|
|
|
|
|
NOTE: This object should only be used in the same process! Do not serialize it,
|
|
|
|
send it over the wire, or persist it in a file or database! If you need
|
|
|
|
to do that, convert it to a string representation using the methods in
|
|
|
|
ISteamNetworkingUtils().
|
|
|
|
|
|
|
|
</summary>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.NetPingLocation.EstimatePingTo(Steamworks.Data.NetPingLocation)">
|
2023-06-01 17:03:48 +02:00
|
|
|
Estimate the round-trip latency between two arbitrary locations, in
|
|
|
|
milliseconds. This is a conservative estimate, based on routing through
|
|
|
|
the relay network. For most basic relayed connections, this ping time
|
|
|
|
will be pretty accurate, since it will be based on the route likely to
|
|
|
|
be actually used.
|
|
|
|
|
|
|
|
If a direct IP route is used (perhaps via NAT traversal), then the route
|
|
|
|
will be different, and the ping time might be better. Or it might actually
|
|
|
|
be a bit worse! Standard IP routing is frequently suboptimal!
|
|
|
|
|
|
|
|
But even in this case, the estimate obtained using this method is a
|
|
|
|
reasonable upper bound on the ping time. (Also it has the advantage
|
|
|
|
of returning immediately and not sending any packets.)
|
|
|
|
|
|
|
|
In a few cases we might not able to estimate the route. In this case
|
|
|
|
a negative value is returned. k_nSteamNetworkingPing_Failed means
|
|
|
|
the reason was because of some networking difficulty. (Failure to
|
|
|
|
ping, etc) k_nSteamNetworkingPing_Unknown is returned if we cannot
|
|
|
|
currently answer the question for some other reason.
|
|
|
|
|
|
|
|
Do you need to be able to do this from a backend/matchmaking server?
|
|
|
|
You are looking for the "ticketgen" library.
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Socket.Close">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Destroy a listen socket. All the connections that were accepting on the listen
|
|
|
|
socket are closed ungracefully.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Achievement.State">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
True if unlocked
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Achievement.UnlockTime">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Should hold the unlock time if State is true
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Achievement.GetIcon">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the icon of the achievement. This can return a null image even though the image exists if the image
|
|
|
|
hasn't been downloaded by Steam yet. You can use GetIconAsync if you want to wait for the image to be
|
|
|
|
downloaded.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Achievement.GetIconAsync(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the icon of the achievement, waits for it to load if we have to
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Achievement.GlobalUnlocked">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the fraction (0-1) of users who have unlocked the specified achievement, or -1 if no data
|
|
|
|
available.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Achievement.Trigger(System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Make this achievement earned
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Achievement.Clear">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Reset this achievement to not achieved
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.Data.DurationControl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sent for games with enabled anti indulgence / duration control, for enabled users.
|
|
|
|
Lets the game know whether persistent rewards or XP should be granted at normal rate, half rate, or zero
|
|
|
|
rate.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.DurationControl.Appid">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
appid generating playtime
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.DurationControl.Applicable">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
is duration control applicable to user + game combination
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.DurationControl.PlaytimeInLastFiveHours">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
playtime since most recent 5 hour gap in playtime, only counting up to regulatory limit of playtime, in
|
|
|
|
seconds
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.DurationControl.PlaytimeToday">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
playtime on current calendar day
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.DurationControl.Progress">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
recommended progress
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Leaderboard.Name">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
the name of a leaderboard
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Leaderboard.ReplaceScore(System.Int32,System.Int32[])">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Submit your score and replace your old score even if it was better
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Leaderboard.SubmitScoreAsync(System.Int32,System.Int32[])">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Submit your new score, but won't replace your high score if it's lower
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Leaderboard.AttachUgc(Steamworks.Data.Ugc)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Attaches a piece of user generated content the user's entry on a leaderboard
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Leaderboard.GetScoresAsync(System.Int32,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Used to query for a sequential range of leaderboard entries by leaderboard Sort.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Leaderboard.GetScoresAroundUserAsync(System.Int32,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Used to retrieve leaderboard entries relative a user's entry. If there are not enough entries in the
|
|
|
|
leaderboard
|
|
|
|
before or after the user's entry, Steam will adjust the range to try to return the number of entries
|
|
|
|
requested.
|
|
|
|
For example, if the user is #1 on the leaderboard and start is set to -2, end is set to 2, Steam will
|
|
|
|
return the first
|
|
|
|
5 entries in the leaderboard. If The current user has no entry, this will return null.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Leaderboard.GetScoresFromFriendsAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Used to retrieve all leaderboard entries for friends of the current user
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.Join">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Try to join this room. Will return RoomEnter.Success on success,
|
|
|
|
and anything else is a failure
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.Leave">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Leave a lobby; this will take effect immediately on the client side
|
|
|
|
other users in the lobby will be notified by a LobbyChatUpdate_t callback
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.InviteFriend(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Invite another user to the lobby
|
|
|
|
will return true if the invite is successfully sent, whether or not the target responds
|
|
|
|
returns false if the local user is not connected to the Steam servers
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Lobby.MemberCount">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns the number of users in the specified lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Lobby.Members">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns current members. Need to be in the lobby to see the users.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.GetData(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get data associated with this lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.SetData(System.String,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get data associated with this lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.DeleteData(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Removes a metadata key from the lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Lobby.Data">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get all data for this lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.GetMemberData(Steamworks.Friend,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets per-user metadata for someone in this lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.SetMemberData(System.String,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sets per-user metadata (for the local user implicitly)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.SendChatString(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sends a string to the chat room
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.SendChatBytes(System.Byte[])">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sends bytes the the chat room
|
|
|
|
this isn't exposed because there's no way to read raw bytes atm,
|
|
|
|
and I figure people can send json if they want something more advanced
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.Refresh">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Refreshes metadata for a lobby you're not necessarily in right now
|
|
|
|
you never do this for lobbies you're a member of, only if your
|
|
|
|
this will send down all the metadata associated with a lobby
|
|
|
|
this is an asynchronous call
|
|
|
|
returns false if the local user is not connected to the Steam servers
|
|
|
|
results will be returned by a LobbyDataUpdate_t callback
|
|
|
|
if the specified lobby doesn't exist, LobbyDataUpdate_t::m_bSuccess will be set to false
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Lobby.MaxMembers">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Max members able to join this lobby. Cannot be over 250.
|
|
|
|
Can only be set by the owner
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.SetGameServer(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
[SteamID variant]
|
|
|
|
Allows the owner to set the game server associated with the lobby. Triggers the
|
|
|
|
Steammatchmaking.OnLobbyGameCreated event.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.SetGameServer(System.String,System.UInt16)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
[IP/Port variant]
|
|
|
|
Allows the owner to set the game server associated with the lobby. Triggers the
|
|
|
|
Steammatchmaking.OnLobbyGameCreated event.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.GetGameServer(System.UInt32@,System.UInt16@,Steamworks.SteamId@)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the details of the lobby's game server, if set. Returns true if the lobby is
|
|
|
|
valid and has a server set, otherwise returns false.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.Lobby.Owner">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
You must be the lobby owner to set the owner
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Lobby.IsOwnedBy(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Check if the specified SteamId owns the lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.FilterDistanceClose">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
only lobbies in the same immediate region will be returned
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.FilterDistanceFar">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
only lobbies in the same immediate region will be returned
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.FilterDistanceWorldwide">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
only lobbies in the same immediate region will be returned
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.WithKeyValue(System.String,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Filter by specified key/value pair; string parameters
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.WithLower(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Numerical filter where value is less than the value provided
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.WithHigher(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Numerical filter where value is greater than the value provided
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.WithEqual(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Numerical filter where value must be equal to the value provided
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.WithNotEqual(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Numerical filter where value must not equal the value provided
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.AddNumericalFilter(System.String,System.Int32,Steamworks.LobbyComparison)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Test key, initialize numerical filter list if necessary, then add new numerical filter
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.OrderByNear(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Order filtered results according to key/values nearest the provided key/value pair.
|
|
|
|
Can specify multiple near value filters; each successive filter is lower priority than the previous.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.WithSlotsAvailable(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns only lobbies with the specified number of slots available
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.WithMaxResults(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
sets how many results to return, the lower the count the faster it is to download the lobby results
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.LobbyQuery.RequestAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Run the query, get the matching lobbies
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.Data.OutgoingPacket">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A server query packet.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.OutgoingPacket.Address">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Target IP address
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.OutgoingPacket.Port">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Target port
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.OutgoingPacket.Data">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.OutgoingPacket.Size">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Size of the data
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.Data.RemotePlaySession">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Represents a RemotePlaySession from the SteamRemotePlay interface
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.RemotePlaySession.IsValid">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if this session was valid when created. This will stay true even
|
|
|
|
after disconnection - so be sure to watch SteamRemotePlay.OnSessionDisconnected
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.RemotePlaySession.SteamId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get the SteamID of the connected user
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.RemotePlaySession.ClientName">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get the name of the session client device
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.RemotePlaySession.FormFactor">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get the name of the session client device
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Screenshot.TagUser(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Tags a user as being visible in the screenshot
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Screenshot.SetLocation(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Tags a user as being visible in the screenshot
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.Screenshot.TagPublishedFile(Steamworks.Data.PublishedFileId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Tags a user as being visible in the screenshot
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Data.ServerInfo.Tags">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the individual tags for this server
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.ServerInfo.AddToHistory">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Add this server to our history list
|
|
|
|
If we're already in the history list, weill set the last played time to now
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.ServerInfo.QueryRulesAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If this server responds to source engine style queries, we'll be able to get a list of rules here
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.ServerInfo.RemoveFromHistory">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Remove this server from our history list
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.ServerInfo.AddToFavourites">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Add this server to our favourite list
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Data.ServerInfo.RemoveFromFavourites">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Remove this server from our favourite list
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.GetResultStatus(Steamworks.Data.SteamInventoryResult_t)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Find out the status of an asynchronous inventory result handle.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.GetResultItems(Steamworks.Data.SteamInventoryResult_t,Steamworks.Data.SteamItemDetails_t[],System.UInt32@)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Copies the contents of a result set into a flat array. The specific contents of the result set depend on
|
|
|
|
which query which was used.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.GetResultTimestamp(Steamworks.Data.SteamInventoryResult_t)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the server time at which the result was generated. Compare against the value of
|
|
|
|
IClientUtils::GetServerRealTime() to determine age.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.CheckResultSteamID(Steamworks.Data.SteamInventoryResult_t,Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if the result belongs to the target steam ID or false if the result does not. This is
|
|
|
|
important when using DeserializeResult to verify that a remote player is not pretending to have a
|
|
|
|
different users inventory.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.DestroyResult(Steamworks.Data.SteamInventoryResult_t)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Destroys a result handle and frees all associated memory.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.GetAllItems(Steamworks.Data.SteamInventoryResult_t@)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Captures the entire state of the current users Steam inventory.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.GetItemsByID(Steamworks.Data.SteamInventoryResult_t@,Steamworks.Data.InventoryItemId@,System.UInt32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Captures the state of a subset of the current users Steam inventory identified by an array of item
|
|
|
|
instance IDs.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.GrantPromoItems(Steamworks.Data.SteamInventoryResult_t@)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
GrantPromoItems() checks the list of promotional items for which the user may be eligible and grants the
|
|
|
|
items (one time only).
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.ConsumeItem(Steamworks.Data.SteamInventoryResult_t@,Steamworks.Data.InventoryItemId,System.UInt32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
ConsumeItem() removes items from the inventory permanently.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.SendItemDropHeartbeat">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Deprecated method. Playtime accounting is performed on the Steam servers.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.TriggerItemDrop(Steamworks.Data.SteamInventoryResult_t@,Steamworks.Data.InventoryDefId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Playtime credit must be consumed and turned into item drops by your game.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamInventory.LoadItemDefinitions">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
LoadItemDefinitions triggers the automatic load and refresh of item definitions.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISteamUserStats.DownloadLeaderboardEntriesForUsers(Steamworks.Data.SteamLeaderboard_t,Steamworks.SteamId[],System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Downloads leaderboard entries for an arbitrary set of users - ELeaderboardDataRequest is
|
|
|
|
k_ELeaderboardDataRequestUsers
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.ConnectionManager.Interface">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
An optional interface to use instead of deriving
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.ConnectionManager.Connection">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The actual connection we're managing
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.ConnectionManager.ConnectionInfo">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The last received ConnectionInfo
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ConnectionManager.OnConnecting(Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We're trying to connect!
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ConnectionManager.OnConnected(Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Client is connected. They move from connecting to Connections
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ConnectionManager.OnDisconnected(Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The connection has been closed remotely or disconnected locally. Check data.State for details.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.IConnectionManager.OnConnecting(Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We started connecting to this guy
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.IConnectionManager.OnConnected(Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when the connection is fully connected and can start being communicated with
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.IConnectionManager.OnDisconnected(Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We got disconnected
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.IConnectionManager.OnMessage(System.IntPtr,System.Int32,System.Int64,System.Int64,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Received a message
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISocketManager.OnConnecting(Steamworks.Data.Connection,Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Must call Accept or Close on the connection within a second or so
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISocketManager.OnConnected(Steamworks.Data.Connection,Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when the connection is fully connected and can start being communicated with
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISocketManager.OnDisconnected(Steamworks.Data.Connection,Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when the connection leaves
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ISocketManager.OnMessage(Steamworks.Data.Connection,Steamworks.Data.NetIdentity,System.IntPtr,System.Int32,System.Int64,System.Int64,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Received a message from a connection
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SocketManager">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Used as a base to create your networking server. This creates a socket
|
|
|
|
and listens/communicates with multiple queries.
|
|
|
|
|
|
|
|
You can override all the virtual functions to turn it into what you
|
|
|
|
want it to do.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SocketManager.OnConnecting(Steamworks.Data.Connection,Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Default behaviour is to accept every connection
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SocketManager.OnConnected(Steamworks.Data.Connection,Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Client is connected. They move from connecting to Connections
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SocketManager.OnDisconnected(Steamworks.Data.Connection,Steamworks.Data.ConnectionInfo)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The connection has been closed remotely or disconnected locally. Check data.State for details.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.ServerList.Base.AppId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Which app we're querying. Defaults to the current app.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.ServerList.Base.OnChanges">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
When a new server is added, this function will get called
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.ServerList.Base.OnResponsiveServer">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called for every responsive server
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.ServerList.Base.Responsive">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A list of servers that responded. If you're only interested in servers that responded since you
|
|
|
|
last updated, then simply clear this list.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.ServerList.Base.Unresponsive">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A list of servers that were in the master list but didn't respond.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.ServerList.Base.RunQueryAsync(System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Query the server list. Task result will be true when finished
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<returns></returns>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamApps">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Exposes a wide range of information and actions for applications and Downloadable Content (DLC).
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamApps.OnDlcInstalled">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
posted after the user gains ownership of DLC and that DLC is installed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamApps.OnNewLaunchParameters">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
posted after the user gains executes a Steam URL with command line or query parameters
|
|
|
|
such as steam://run/appid//-commandline/?param1=value1(and)param2=value2(and)param3=value3 etc
|
|
|
|
while the game is already running. The new params can be queried
|
|
|
|
with GetLaunchQueryParam and GetLaunchCommandLine
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.IsSubscribed">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the active user is subscribed to the current App ID
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.IsSubscribedFromFamilySharing">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Check if user borrowed this game via Family Sharing, If true, call GetAppOwner() to get the lender
|
|
|
|
SteamID
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.IsLowVoilence">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the license owned by the user provides low violence depots.
|
|
|
|
Low violence depots are useful for copies sold in countries that have content restrictions
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.IsCybercafe">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks whether the current App ID license is for Cyber Cafes.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.IsVACBanned">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
CChecks if the user has a VAC ban on their account
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.GameLanguage">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the current language that the user has set.
|
|
|
|
This falls back to the Steam UI language if the user hasn't explicitly picked a language for the title.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.AvailableLanguages">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a list of the languages the current app supports.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.IsSubscribedToApp(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the active user is subscribed to a specified AppId.
|
|
|
|
Only use this if you need to check ownership of another game related to yours, a demo for example.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.IsDlcInstalled(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the user owns a specific DLC and if the DLC is installed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.PurchaseTime(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the time of the purchase of the app
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.IsSubscribedFromFreeWeekend">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the user is subscribed to the current app through a free weekend
|
|
|
|
This function will return false for users who have a retail or other type of license
|
|
|
|
Before using, please ask your Valve technical contact how to package and secure your free weekened
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.DlcInformation">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns metadata for all available DLC
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.InstallDlc(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Install/Uninstall control for optional DLC
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.UninstallDlc(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Install/Uninstall control for optional DLC
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.CurrentBetaName">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns null if we're not on a beta branch, else the name of the branch
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.MarkContentCorrupt(System.Boolean)">
|
2023-06-01 17:03:48 +02:00
|
|
|
<summary>
|
|
|
|
Allows you to force verify game content on next launch.
|
|
|
|
|
|
|
|
If you detect the game is out-of-date(for example, by having the client detect a version mismatch with a
|
|
|
|
server),
|
|
|
|
you can call use MarkContentCorrupt to force a verify, show a message to the user, and then quit.
|
|
|
|
</summary>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.InstalledDepots(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a list of all installed depots for a given App ID in mount order
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.AppInstallDir(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the install folder for a specific AppID.
|
|
|
|
This works even if the application is not installed, based on where the game would be installed with the
|
|
|
|
default Steam library location.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.IsAppInstalled(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The app may not actually be owned by the current user, they may have it left over from a free weekend,
|
|
|
|
etc.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.AppOwner">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the Steam ID of the original owner of the current app. If it's different from the current user then
|
|
|
|
it is borrowed..
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.GetLaunchParam(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the associated launch parameter if the game is run via
|
|
|
|
steam://run/appid/?param1=value1;param2=value2;param3=value3 etc.
|
|
|
|
Parameter names starting with the character '@' are reserved for internal use and will always return an
|
|
|
|
empty string.
|
|
|
|
Parameter names starting with an underscore '_' are reserved for steam features -- they can be queried
|
|
|
|
by the game,
|
|
|
|
but it is advised that you not param names beginning with an underscore for your own features.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.DlcDownloadProgress(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the download progress for optional DLC.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.BuildId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the buildid of this app, may change at any time based on backend updates to the game.
|
|
|
|
Defaults to 0 if you're not running a build downloaded from steam.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamApps.GetFileDetailsAsync(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Asynchronously retrieves metadata details about a specific file in the depot manifest.
|
|
|
|
Currently provides:
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamApps.CommandLine">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get command line if game was launched via Steam URL, e.g. steam://run/appid//command line/.
|
|
|
|
This method of passing a connect string (used when joining via rich presence, accepting an
|
|
|
|
invite, etc) is preferable to passing the connect string on the operating system command
|
|
|
|
line, which is a security risk. In order for rich presence joins to go through this
|
|
|
|
path and not be placed on the OS command line, you must set a value in your app's
|
|
|
|
configuration on Steam. Ask Valve for help with this.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamClient.Init(System.UInt32,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Initialize the steam client.
|
|
|
|
If asyncCallbacks is false you need to call RunCallbacks manually every frame.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamClient.IsLoggedOn">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the current user's Steam client is connected to the Steam servers.
|
|
|
|
If it's not then no real-time services provided by the Steamworks API will be enabled. The Steam
|
|
|
|
client will automatically be trying to recreate the connection as often as possible. When the
|
|
|
|
connection is restored a SteamServersConnected_t callback will be posted.
|
|
|
|
You usually don't need to check for this yourself. All of the API calls that rely on this will
|
|
|
|
check internally. Forcefully disabling stuff when the player loses access is usually not a
|
|
|
|
very good experience for the player and you could be preventing them from accessing APIs that do not
|
|
|
|
need a live connection to Steam.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamClient.SteamId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the Steam ID of the account currently logged into the Steam client. This is
|
|
|
|
commonly called the 'current user', or 'local user'.
|
|
|
|
A Steam ID is a unique identifier for a Steam accounts, Steam groups, Lobbies and Chat
|
|
|
|
rooms, and used to differentiate users in all parts of the Steamworks API.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamClient.Name">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns the local players name - guaranteed to not be NULL.
|
|
|
|
this is the same name as on the users community profile page
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamClient.State">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
gets the status of the current user
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamClient.AppId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns the appID of the current process
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamClient.RestartAppIfNecessary(System.UInt32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if your executable was launched through Steam and relaunches it through Steam if it wasn't
|
|
|
|
this returns true then it starts the Steam client if required and launches your game again through it,
|
|
|
|
and you should quit your process as soon as possible. This effectively runs steam://run/AppId so it
|
|
|
|
may not relaunch the exact executable that called it, as it will always relaunch from the version
|
|
|
|
installed in your Steam library folder/
|
|
|
|
Note that during development, when not launching via Steam, this might always return true.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamClient.ValidCheck">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called in interfaces that rely on this being initialized
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamFriends">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Undocumented Parental Settings
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamFriends.OnChatMessage">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when chat message has been received from a friend. You'll need to turn on
|
|
|
|
ListenForFriendsMessages to recieve this. (friend, msgtype, message)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamFriends.OnPersonaStateChange">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
called when a friends' status changes
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamFriends.OnGameRichPresenceJoinRequested">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when the user tries to join a game from their friends list
|
|
|
|
rich presence will have been set with the "connect" key which is set here
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamFriends.OnGameOverlayActivated">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Posted when game overlay activates or deactivates
|
|
|
|
the game can use this to be pause or resume single player games
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamFriends.OnGameServerChangeRequested">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when the user tries to join a different game server from their friends list
|
|
|
|
game client should attempt to connect to specified server when this is received
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamFriends.OnGameLobbyJoinRequested">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when the user tries to join a lobby from their friends list
|
|
|
|
game client should attempt to connect to specified lobby when this is received
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamFriends.OnFriendRichPresenceUpdate">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Callback indicating updated data about friends rich presence information
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.OpenOverlay(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The dialog to open. Valid options are:
|
|
|
|
"friends",
|
|
|
|
"community",
|
|
|
|
"players",
|
|
|
|
"settings",
|
|
|
|
"officialgamegroup",
|
|
|
|
"stats",
|
|
|
|
"achievements".
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.OpenUserOverlay(Steamworks.SteamId,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
"steamid" - Opens the overlay web browser to the specified user or groups profile.
|
|
|
|
"chat" - Opens a chat window to the specified user, or joins the group chat.
|
|
|
|
"jointrade" - Opens a window to a Steam Trading session that was started with the
|
|
|
|
ISteamEconomy/StartTrade Web API.
|
|
|
|
"stats" - Opens the overlay web browser to the specified user's stats.
|
|
|
|
"achievements" - Opens the overlay web browser to the specified user's achievements.
|
|
|
|
"friendadd" - Opens the overlay in minimal mode prompting the user to add the target user as a friend.
|
|
|
|
"friendremove" - Opens the overlay in minimal mode prompting the user to remove the target friend.
|
|
|
|
"friendrequestaccept" - Opens the overlay in minimal mode prompting the user to accept an incoming
|
|
|
|
friend invite.
|
|
|
|
"friendrequestignore" - Opens the overlay in minimal mode prompting the user to ignore an incoming
|
|
|
|
friend invite.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.OpenStoreOverlay(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Activates the Steam Overlay to the Steam store page for the provided app.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.OpenWebOverlay(System.String,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Activates Steam Overlay web browser directly to the specified URL.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.OpenGameInviteOverlay(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Activates the Steam Overlay to open the invite dialog. Invitations sent from this dialog will be for the
|
|
|
|
provided lobby.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.SetPlayedWith(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Mark a target user as 'played with'.
|
|
|
|
NOTE: The current user must be in game with the other player for the association to work.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.RequestUserInformation(Steamworks.SteamId,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Requests the persona name and optionally the avatar of a specified user.
|
|
|
|
NOTE: It's a lot slower to download avatars and churns the local cache, so if you don't need avatars,
|
|
|
|
don't request them.
|
|
|
|
returns true if we're fetching the data, false if we already have it
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.GetRichPresence(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Find a rich presence value by key for current user. Will be null if not found.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.SetRichPresence(System.String,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sets a rich presence value by key for current user.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamFriends.ClearRichPresence">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Clears all of the current user's rich presence data.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamFriends.ListenForFriendsMessages">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Listens for Steam friends chat messages.
|
|
|
|
You can then show these chats inline in the game. For example with a Blizzard style chat message system
|
|
|
|
or the chat system in Dota 2.
|
|
|
|
After enabling this you will receive callbacks when ever the user receives a chat message.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInput.RunFrame">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
You shouldn't really need to call this because it get called by RunCallbacks on SteamClient
|
|
|
|
but Valve think it might be a nice idea if you call it right before you get input info -
|
|
|
|
just to make sure the info you're getting is 100% up to date.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamInput.Controllers">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return a list of connected controllers.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInput.GetDigitalActionGlyph(Steamworks.Controller,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return an absolute path to the PNG image glyph for the provided digital action name. The current
|
|
|
|
action set in use for the controller will be used for the lookup. You should cache the result and
|
|
|
|
maintain your own list of loaded PNG assets.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="controller"></param>
|
|
|
|
<param name="action"></param>
|
|
|
|
<returns></returns>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamInventory">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Undocumented Parental Settings
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.LoadItemDefinitions">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Call this if you're going to want to access definition information. You should be able to get
|
|
|
|
away with calling this once at the start if your game, assuming your items don't change all the time.
|
|
|
|
This will trigger OnDefinitionsUpdated at which point Definitions should be set.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.WaitForDefinitions(System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Will call LoadItemDefinitions and wait until Definitions is not null
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.FindDefinition(Steamworks.Data.InventoryDefId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Try to find the definition that matches this definition ID.
|
|
|
|
Uses a dictionary so should be about as fast as possible.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamInventory.Items">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We will try to keep this list of your items automatically up to date.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.GetAllItems">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Update the list of Items[]
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.GetAllItemsAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get all items and return the InventoryResult
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.GenerateItemAsync(Steamworks.InventoryDef,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This is used to grant a specific item to the user. This should
|
|
|
|
only be used for development prototyping, from a trusted server,
|
|
|
|
or if you don't care about hacked clients granting arbitrary items.
|
|
|
|
This call can be disabled by a setting on Steamworks.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.CraftItemAsync(Steamworks.InventoryItem[],Steamworks.InventoryDef)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Crafting! Uses the passed items to buy the target item.
|
|
|
|
You need to have set up the appropriate exchange rules in your item
|
|
|
|
definitions. This assumes all the items passed in aren't stacked.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.CraftItemAsync(Steamworks.InventoryItem.Amount[],Steamworks.InventoryDef)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Crafting! Uses the passed items to buy the target item.
|
|
|
|
You need to have set up the appropriate exchange rules in your item
|
|
|
|
definitions. This assumes all the items passed in aren't stacked.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.DeserializeAsync(System.Byte[],System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Deserializes a result set and verifies the signature bytes.
|
|
|
|
This call has a potential soft-failure mode where the Result is expired, it will
|
|
|
|
still succeed in this mode.The "expired"
|
|
|
|
result could indicate that the data may be out of date - not just due to timed
|
|
|
|
expiration( one hour ), but also because one of the items in the result set may
|
|
|
|
have been traded or consumed since the result set was generated.You could compare
|
|
|
|
the timestamp from GetResultTimestamp to ISteamUtils::GetServerRealTime to determine
|
|
|
|
how old the data is. You could simply ignore the "expired" result code and
|
|
|
|
continue as normal, or you could request the player with expired data to send
|
|
|
|
an updated result set.
|
|
|
|
You should call CheckResultSteamID on the result handle when it completes to verify
|
|
|
|
that a remote player is not pretending to have a different user's inventory.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.GrantPromoItemsAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Grant all promotional items the user is eligible for
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.TriggerItemDropAsync(Steamworks.Data.InventoryDefId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Trigger an item drop for this user. This is for timed drops.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.AddPromoItemAsync(Steamworks.Data.InventoryDefId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Trigger a promo item drop. You can call this at startup, it won't
|
|
|
|
give users multiple promo drops.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamInventory.StartPurchaseAsync(Steamworks.InventoryDef[])">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Start buying a cart load of items. This will return a positive result is the purchase has
|
|
|
|
begun. You should listen out for SteamUser.OnMicroTxnAuthorizationResponse for a success.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamMatchmaking">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Functions for clients to access matchmaking services, favorites, and to operate on game lobbies
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamMatchmaking.MaxLobbyKeyLength">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Maximum number of characters a lobby metadata key can be
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyInvite">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Someone invited you to a lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyEntered">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
You joined a lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyCreated">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
You created a lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyGameCreated">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A game server has been associated with the lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyDataChanged">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The lobby metadata has changed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyMemberDataChanged">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The lobby member metadata has changed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyMemberJoined">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The lobby member joined
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyMemberLeave">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The lobby member left the room
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyMemberDisconnected">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The lobby member left the room
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyMemberKicked">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The lobby member was kicked. The 3rd param is the user that kicked them.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnLobbyMemberBanned">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The lobby member was banned. The 3rd param is the user that banned them.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMatchmaking.OnChatMessage">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A chat message was recieved from a member of a lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamMatchmaking.CreateLobbyAsync(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Creates a new invisible lobby. Call lobby.SetPublic to take it online.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamMatchmaking.JoinLobbyAsync(Steamworks.SteamId)">
|
|
|
|
<summmary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Attempts to directly join the specified lobby
|
2023-05-31 18:36:33 +02:00
|
|
|
</summmary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamMatchmaking.GetFavoriteServers">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get a list of servers that are on your favorites list
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamMatchmaking.GetHistoryServers">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get a list of servers that you have added to your play history
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamMatchmakingServers">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Functions for clients to access matchmaking services, favorites, and to operate on game lobbies
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamMusic">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Functions to control music playback in the steam client.
|
|
|
|
This gives games the opportunity to do things like pause the music or lower the volume,
|
|
|
|
when an important cut scene is shown, and start playing afterwards.
|
|
|
|
Nothing uses Steam Music though so this can probably get fucked
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMusic.OnPlaybackChanged">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Playback status changed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamMusic.OnVolumeChanged">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Volume changed, parameter is new volume
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamMusic.IsEnabled">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if Steam Music is enabled
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamMusic.IsPlaying">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
true if a song is currently playing, paused, or queued up to play; otherwise false.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamMusic.Status">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the current status of the Steam Music player
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamMusic.PlayPrevious">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Have the Steam Music player play the previous song.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamMusic.PlayNext">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Have the Steam Music player skip to the next song
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamMusic.Volume">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets/Sets the current volume of the Steam Music player
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamNetworking.OnP2PSessionRequest">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This SteamId wants to send you a message. You should respond by calling AcceptP2PSessionWithUser
|
|
|
|
if you want to recieve their messages
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamNetworking.OnP2PConnectionFailed">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when packets can't get through to the specified user.
|
|
|
|
All queued packets unsent at this point will be dropped, further attempts
|
|
|
|
to send will retry making the connection (but will be dropped if we fail again).
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.AcceptP2PSessionWithUser(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This should be called in response to a OnP2PSessionRequest
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.AllowP2PPacketRelay(System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Allow or disallow P2P connects to fall back on Steam server relay if direct
|
|
|
|
connection or NAT traversal can't be established. Applies to connections
|
|
|
|
created after setting or old connections that need to reconnect.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.CloseP2PSessionWithUser(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This should be called when you're done communicating with a user, as this will
|
|
|
|
free up all of the resources allocated for the connection under-the-hood.
|
|
|
|
If the remote user tries to send data to you again, a new OnP2PSessionRequest
|
|
|
|
callback will be posted
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.IsP2PPacketAvailable(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if a P2P packet is available to read, and gets the size of the message if there is one.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.ReadP2PPacket(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Reads in a packet that has been sent from another user via SendP2PPacket..
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.ReadP2PPacket(System.Byte[],System.UInt32@,Steamworks.SteamId@,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Reads in a packet that has been sent from another user via SendP2PPacket..
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.ReadP2PPacket(System.Byte*,System.UInt32,System.UInt32@,Steamworks.SteamId@,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Reads in a packet that has been sent from another user via SendP2PPacket..
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.SendP2PPacket(Steamworks.SteamId,System.Byte[],System.Int32,System.Int32,Steamworks.P2PSend)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sends a P2P packet to the specified user.
|
|
|
|
This is a session-less API which automatically establishes NAT-traversing or Steam relay server
|
|
|
|
connections.
|
|
|
|
NOTE: The first packet send may be delayed as the NAT-traversal code runs.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworking.SendP2PPacket(Steamworks.SteamId,System.Byte*,System.UInt32,System.Int32,Steamworks.P2PSend)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sends a P2P packet to the specified user.
|
|
|
|
This is a session-less API which automatically establishes NAT-traversing or Steam relay server
|
|
|
|
connections.
|
|
|
|
NOTE: The first packet send may be delayed as the NAT-traversal code runs.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingSockets.CreateNormalSocket``1(Steamworks.Data.NetAddress)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Creates a "server" socket that listens for clients to connect to by calling
|
|
|
|
Connect, over ordinary UDP (IPv4 or IPv6)
|
|
|
|
|
|
|
|
To use this derive a class from SocketManager and override as much as you want.
|
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingSockets.CreateNormalSocket(Steamworks.Data.NetAddress,Steamworks.ISocketManager)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Creates a "server" socket that listens for clients to connect to by calling
|
|
|
|
Connect, over ordinary UDP (IPv4 or IPv6).
|
|
|
|
|
|
|
|
To use this you should pass a class that inherits ISocketManager. You can use
|
|
|
|
SocketManager to get connections and send messages, but the ISocketManager class
|
|
|
|
will received all the appropriate callbacks.
|
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingSockets.ConnectNormal``1(Steamworks.Data.NetAddress)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Connect to a socket created via
|
|
|
|
<method>CreateListenSocketIP</method>
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingSockets.ConnectNormal(Steamworks.Data.NetAddress,Steamworks.IConnectionManager)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Connect to a socket created via
|
|
|
|
<method>CreateListenSocketIP</method>
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingSockets.CreateRelaySocket``1(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Creates a server that will be relayed via Valve's network (hiding the IP and improving ping)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingSockets.ConnectRelay``1(Steamworks.SteamId,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Connect to a relay server
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamNetworkingUtils">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Undocumented Parental Settings
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamNetworkingUtils.OnDebugOutput">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A function to receive debug network information on. This will do nothing
|
|
|
|
unless you set DebugLevel to something other than None.
|
|
|
|
|
|
|
|
You should set this to an appropriate level instead of setting it to the highest
|
|
|
|
and then filtering it by hand because a lot of energy is used by creating the strings
|
|
|
|
and your frame rate will tank and you won't know why.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.Status">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The latest available status gathered from the SteamRelayNetworkStatus callback
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingUtils.InitRelayNetworkAccess">
|
2023-06-01 17:03:48 +02:00
|
|
|
<summary>
|
|
|
|
If you know that you are going to be using the relay network (for example,
|
|
|
|
because you anticipate making P2P connections), call this to initialize the
|
|
|
|
relay network. If you do not call this, the initialization will
|
|
|
|
be delayed until the first time you use a feature that requires access
|
|
|
|
to the relay network, which will delay that first access.
|
|
|
|
|
|
|
|
You can also call this to force a retry if the previous attempt has failed.
|
|
|
|
Performing any action that requires access to the relay network will also
|
|
|
|
trigger a retry, and so calling this function is never strictly necessary,
|
|
|
|
but it can be useful to call it a program launch time, if access to the
|
|
|
|
relay network is anticipated.
|
|
|
|
|
|
|
|
Use GetRelayNetworkStatus or listen for SteamRelayNetworkStatus_t
|
|
|
|
callbacks to know when initialization has completed.
|
|
|
|
Typically initialization completes in a few seconds.
|
|
|
|
|
|
|
|
Note: dedicated servers hosted in known data centers do *not* need
|
|
|
|
to call this, since they do not make routing decisions. However, if
|
|
|
|
the dedicated server will be using P2P functionality, it will act as
|
|
|
|
a "client" and this should be called.
|
|
|
|
</summary>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.LocalPingLocation">
|
2023-06-01 17:03:48 +02:00
|
|
|
<summary>
|
|
|
|
Return location info for the current host.
|
|
|
|
|
|
|
|
It takes a few seconds to initialize access to the relay network. If
|
|
|
|
you call this very soon after startup the data may not be available yet.
|
|
|
|
|
|
|
|
This always return the most up-to-date information we have available
|
|
|
|
right now, even if we are in the middle of re-calculating ping times.
|
|
|
|
</summary>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingUtils.EstimatePingTo(Steamworks.Data.NetPingLocation)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Same as PingLocation.EstimatePingTo, but assumes that one location is the local host.
|
|
|
|
This is a bit faster, especially if you need to calculate a bunch of
|
|
|
|
these in a loop to find the fastest one.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingUtils.WaitForPingDataAsync(System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If you need ping information straight away, wait on this. It will return
|
|
|
|
immediately if you already have up to date ping data
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.FakeSendPacketLoss">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
[0 - 100] - Randomly discard N pct of packets
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.FakeRecvPacketLoss">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
[0 - 100] - Randomly discard N pct of packets
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.FakeSendPacketLag">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Delay all packets by N ms
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.FakeRecvPacketLag">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Delay all packets by N ms
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.ConnectionTimeout">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Timeout value (in ms) to use when first connecting
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.Timeout">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Timeout value (in ms) to use after connection is established
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.SendBufferSize">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Upper limit of buffered pending bytes to be sent.
|
|
|
|
If this is reached SendMessage will return LimitExceeded.
|
|
|
|
Default is 524288 bytes (512k)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamNetworkingUtils.DebugLevel">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get Debug Information via OnDebugOutput event
|
|
|
|
|
|
|
|
Except when debugging, you should only use NetDebugOutput.Msg
|
|
|
|
or NetDebugOutput.Warning. For best performance, do NOT
|
|
|
|
request a high detail level and then filter out messages in the callback.
|
|
|
|
|
|
|
|
This incurs all of the expense of formatting the messages, which are then discarded.
|
|
|
|
Setting a high priority value (low numeric value) here allows the library to avoid
|
|
|
|
doing this work.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamNetworkingUtils._debugLevel">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
So we can remember and provide a Get for DebugLEvel
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamNetworkingUtils._debugFunc">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We need to keep the delegate around until it's not used anymore
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingUtils.OnDebugMessage(Steamworks.NetDebugOutput,System.IntPtr)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This can be called from other threads - so we're going to queue these up and process them in a safe
|
|
|
|
place.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamNetworkingUtils.OutputDebugMessages">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called regularly from the Dispatch loop so we can provide a timely
|
|
|
|
stream of messages.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamParental">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Undocumented Parental Settings
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamParental.OnSettingsChanged">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Parental Settings Changed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamParental.IsParentalLockEnabled">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamParental.IsParentalLockLocked">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamParental.IsAppBlocked(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamParental.BIsAppInBlockList(Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamParental.IsFeatureBlocked(Steamworks.ParentalFeature)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamParental.BIsFeatureInBlockList(Steamworks.ParentalFeature)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamParties">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This API can be used to selectively advertise your multiplayer game session in a Steam chat room group.
|
|
|
|
Tell Steam the number of player spots that are available for your party, and a join-game string, and it
|
|
|
|
will show a beacon in the selected group and allow that many users to “follow” the beacon to your party.
|
|
|
|
Adjust the number of open slots if other players join through alternate matchmaking methods.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamParties.OnBeaconLocationsUpdated">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The list of possible Party beacon locations has changed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamParties.OnActiveBeaconsUpdated">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The list of active beacons may have changed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamRemotePlay">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Functions that provide information about Steam Remote Play sessions, streaming your game content to
|
|
|
|
another computer or to a Steam Link app or hardware.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamRemotePlay.OnSessionConnected">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when a session is connected
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamRemotePlay.OnSessionDisconnected">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when a session becomes disconnected
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemotePlay.SessionCount">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get the number of currently connected Steam Remote Play sessions
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemotePlay.GetSession(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get the currently connected Steam Remote Play session ID at the specified index.
|
|
|
|
IsValid will return false if it's out of bounds
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemotePlay.SendInvite(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Invite a friend to Remote Play Together
|
|
|
|
This returns false if the invite can't be sent
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamRemoteStorage">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Undocumented Parental Settings
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FileWrite(System.String,System.Byte[])">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Creates a new file, writes the bytes to the file, and then closes the file.
|
|
|
|
If the target file already exists, it is overwritten
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FileRead(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Opens a binary file, reads the contents of the file into a byte array, and then closes the file.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FileExists(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks whether the specified file exists.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FilePersisted(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if a specific file is persisted in the steam cloud.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FileTime(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the specified file's last modified date/time.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FileSize(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the specified files size in bytes. 0 if not exists.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FileForget(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Deletes the file from remote storage, but leaves it on the local disk and remains accessible from the
|
|
|
|
API.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamRemoteStorage.FileDelete(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Deletes a file from the local disk, and propagates that delete to the cloud.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.QuotaBytes">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Number of bytes total
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.QuotaUsedBytes">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Number of bytes used
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.QuotaRemainingBytes">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Number of bytes remaining until your quota is used
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.IsCloudEnabled">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns true if IsCloudEnabledForAccount AND IsCloudEnabledForApp
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.IsCloudEnabledForAccount">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the account wide Steam Cloud setting is enabled for this user
|
|
|
|
or if they disabled it in the Settings->Cloud dialog.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.IsCloudEnabledForApp">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the per game Steam Cloud setting is enabled for this user
|
|
|
|
or if they disabled it in the Game Properties->Update dialog.
|
|
|
|
|
|
|
|
This must only ever be set as the direct result of the user explicitly
|
|
|
|
requesting that it's enabled or not. This is typically accomplished with
|
|
|
|
a checkbox within your in-game options
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.FileCount">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the total number of local files synchronized by Steam Cloud.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamRemoteStorage.Files">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get a list of filenames synchronized by Steam Cloud
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamScreenshots">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Undocumented Parental Settings
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamScreenshots.OnScreenshotRequested">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A screenshot has been requested by the user from the Steam screenshot hotkey.
|
|
|
|
This will only be called if Hooked is true, in which case Steam
|
|
|
|
will not take the screenshot itself.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamScreenshots.OnScreenshotReady">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A screenshot successfully written or otherwise added to the library and can now be tagged.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamScreenshots.OnScreenshotFailed">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A screenshot attempt failed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamScreenshots.WriteScreenshot(System.Byte[],System.Int32,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Writes a screenshot to the user's screenshot library given the raw image data, which must be in RGB
|
|
|
|
format.
|
|
|
|
The return value is a handle that is valid for the duration of the game process and can be used to apply
|
|
|
|
tags.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamScreenshots.AddScreenshot(System.String,System.String,System.Int32,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Adds a screenshot to the user's screenshot library from disk. If a thumbnail is provided, it must be 200
|
|
|
|
pixels wide and the same aspect ratio
|
|
|
|
as the screenshot, otherwise a thumbnail will be generated if the user uploads the screenshot. The
|
|
|
|
screenshots must be in either JPEG or TGA format.
|
|
|
|
The return value is a handle that is valid for the duration of the game process and can be used to apply
|
|
|
|
tags.
|
|
|
|
JPEG, TGA, and PNG formats are supported.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamScreenshots.TriggerScreenshot">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Causes the Steam overlay to take a screenshot.
|
|
|
|
If screenshots are being hooked by the game then a
|
|
|
|
ScreenshotRequested callback is sent back to the game instead.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamScreenshots.Hooked">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Toggles whether the overlay handles screenshots when the user presses the screenshot hotkey, or if the
|
|
|
|
game handles them.
|
|
|
|
Hooking is disabled by default, and only ever enabled if you do so with this function.
|
|
|
|
If the hooking is enabled, then the ScreenshotRequested_t callback will be sent if the user presses the
|
|
|
|
hotkey or
|
|
|
|
when TriggerScreenshot is called, and then the game is expected to call WriteScreenshot or
|
|
|
|
AddScreenshotToLibrary in response.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamServer">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Provides the core of the Steam Game Servers API
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamServer.OnValidateAuthTicketResponse">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
User has been authed or rejected
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamServer.OnSteamServersConnected">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when a connections to the Steam back-end has been established.
|
|
|
|
This means the server now is logged on and has a working connection to the Steam master server.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamServer.OnSteamServerConnectFailure">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This will occur periodically if the Steam client is not connected, and has failed when retrying to
|
|
|
|
establish a connection (result, stilltrying)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamServer.OnSteamServersDisconnected">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Disconnected from Steam
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.Init(Steamworks.AppId,Steamworks.SteamServerInit,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Initialize the steam server.
|
|
|
|
If asyncCallbacks is false you need to call RunCallbacks manually every frame.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.RunCallbacks">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Run the callbacks. This is also called in Async callbacks.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.DedicatedServer">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sets whether this should be marked as a dedicated server.
|
|
|
|
If not, it is assumed to be a listen server.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.MaxPlayers">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets or sets the current MaxPlayers.
|
|
|
|
This doesn't enforce any kind of limit, it just updates the master server.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.BotCount">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets or sets the current BotCount.
|
|
|
|
This doesn't enforce any kind of limit, it just updates the master server.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.MapName">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets or sets the current Map Name.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.ModDir">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets or sets the current ModDir
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.Product">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the current product
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.GameDescription">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets or sets the current Product
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.ServerName">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets or sets the current ServerName
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.Passworded">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set whether the server should report itself as passworded
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.GameTags">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.LogOnAnonymous">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Log onto Steam anonymously.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.LogOff">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Log onto Steam anonymously.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.LoggedOn">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if the server is connected and registered with the Steam master server
|
|
|
|
You should have called LogOnAnonymous etc on startup.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.PublicIp">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.AutomaticHeartbeats">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Enable or disable heartbeats, which are sent regularly to the master server.
|
|
|
|
Enabled by default.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamServer.AutomaticHeartbeatRate">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set heartbeat interval, if automatic heartbeats are enabled.
|
|
|
|
You can leave this at the default.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.ForceHeartbeat">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Force send a heartbeat to the master server instead of waiting
|
|
|
|
for the next automatic update (if you've left them enabled)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.UpdatePlayer(Steamworks.SteamId,System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.SetKey(System.String,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.ClearKeys">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Remove all key values
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.BeginAuthSession(System.Byte[],Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Start authorizing a ticket. This user isn't authorized yet. Wait for a call to OnAuthChange.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.EndSession(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Forget this guy. They're no longer in the game.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.GetOutgoingPacket(Steamworks.Data.OutgoingPacket@)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="packet">Packet to send. The Data passed is pooled - so use it immediately.</param>
|
|
|
|
<returns>True if we want to send a packet</returns>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.HandleIncomingPacket(System.Byte[],System.Int32,System.UInt32,System.UInt16)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We have received a server query on our game port. Pass it to Steam to handle.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.HandleIncomingPacket(System.IntPtr,System.Int32,System.UInt32,System.UInt16)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
We have received a server query on our game port. Pass it to Steam to handle.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServer.UserHasLicenseForApp(Steamworks.SteamId,Steamworks.AppId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Does the user own this app (which could be DLC)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.RequestUserStatsAsync(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Downloads stats for the user
|
|
|
|
If the user has no stats will return fail
|
|
|
|
these stats will only be auto-updated for clients playing on the server
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.SetInt(Steamworks.SteamId,System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set the named stat for this user. Setting stats should follow the rules
|
|
|
|
you defined in Steamworks.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.SetFloat(Steamworks.SteamId,System.String,System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set the named stat for this user. Setting stats should follow the rules
|
|
|
|
you defined in Steamworks.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.GetInt(Steamworks.SteamId,System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.GetFloat(Steamworks.SteamId,System.String,System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.SetAchievement(Steamworks.SteamId,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Unlocks the specified achievement for the specified user. Must have called Refresh on a steamid first.
|
|
|
|
Remember to use Commit after use.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.ClearAchievement(Steamworks.SteamId,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Resets the unlock status of an achievement for the specified user. Must have called Refresh on a steamid
|
|
|
|
first.
|
|
|
|
Remember to use Commit after use.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.GetAchievement(Steamworks.SteamId,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if available, exists and unlocked
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerStats.StoreUserStats(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
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.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamUGC">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Functions for accessing and manipulating Steam user information.
|
|
|
|
This is also where the APIs for Steam Voice are exposed.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUGC.OnDownloadItemResult">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Posted after Download call
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUGC.Download(Steamworks.Data.PublishedFileId,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Start downloading this item. You'll get notified of completion via OnDownloadItemResult.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="fileId">The ID of the file you want to download</param>
|
|
|
|
<param name="highPriority">If true this should go straight to the top of the download list</param>
|
|
|
|
<returns>true if nothing went wrong and the download is started</returns>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUGC.DownloadAsync(Steamworks.Data.PublishedFileId,System.Action{System.Single},System.Int32,System.Threading.CancellationToken)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Will attempt to download this item asyncronously - allowing you to instantly react to its installation
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="fileId">The ID of the file you want to download</param>
|
|
|
|
<param name="progress">An optional callback</param>
|
|
|
|
<param name="ct">Allows you to send a message to cancel the download anywhere during the process</param>
|
|
|
|
<param name="milisecondsUpdateDelay">How often to call the progress function</param>
|
|
|
|
<returns>true if downloaded and installed correctly</returns>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUGC.QueryFileAsync(Steamworks.Data.PublishedFileId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Utility function to fetch a single item. Internally this uses Ugc.FileQuery -
|
|
|
|
which you can use to query multiple items if you need to.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamUser">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Functions for accessing and manipulating Steam user information.
|
|
|
|
This is also where the APIs for Steam Voice are exposed.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnSteamServersConnected">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when a connections to the Steam back-end has been established.
|
|
|
|
This means the Steam client now has a working connection to the Steam servers.
|
|
|
|
Usually this will have occurred before the game has launched, and should only be seen if the
|
|
|
|
user has dropped connection due to a networking issue or a Steam server update.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnSteamServerConnectFailure">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when a connection attempt has failed.
|
|
|
|
This will occur periodically if the Steam client is not connected,
|
|
|
|
and has failed when retrying to establish a connection.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnSteamServersDisconnected">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called if the client has lost connection to the Steam servers.
|
|
|
|
Real-time services will be disabled until a matching OnSteamServersConnected has been posted.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnClientGameServerDeny">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sent by the Steam server to the client telling it to disconnect from the specified game server,
|
|
|
|
which it may be in the process of or already connected to.
|
|
|
|
The game client should immediately disconnect upon receiving this message.
|
|
|
|
This can usually occur if the user doesn't have rights to play on the game server.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnLicensesUpdated">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called whenever the users licenses (owned packages) changes.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnValidateAuthTicketResponse">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when an auth ticket has been validated.
|
|
|
|
The first parameter is the steamid of this user
|
|
|
|
The second is the Steam ID that owns the game, this will be different from the first
|
|
|
|
if the game is being borrowed via Steam Family Sharing
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnGetAuthSessionTicketResponse">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Used internally for GetAuthSessionTicketAsync
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnMicroTxnAuthorizationResponse">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when a user has responded to a microtransaction authorization request.
|
|
|
|
( appid, orderid, user authorized )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnGameWebCallback">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sent to your game in response to a steam://gamewebcallback/ command from a user clicking a link in the
|
|
|
|
Steam overlay browser.
|
|
|
|
You can use this to add support for external site signups where you want to pop back into the browser
|
|
|
|
after some web page
|
|
|
|
signup sequence, and optionally get back some detail about that.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUser.OnDurationControl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sent for games with enabled anti indulgence / duration control, for enabled users.
|
|
|
|
Lets the game know whether persistent rewards or XP should be granted at normal rate,
|
|
|
|
half rate, or zero rate.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.VoiceRecord">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Starts/Stops voice recording.
|
|
|
|
Once started, use GetAvailableVoice and GetVoice to get the data, and then call StopVoiceRecording
|
|
|
|
when the user has released their push-to-talk hotkey or the game session has completed.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.HasVoiceData">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if we have voice data waiting to be read
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.ReadVoiceData(System.IO.Stream)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Reads the voice data and returns the number of bytes written.
|
|
|
|
The compressed data can be transmitted by your application and decoded back into raw audio data using
|
|
|
|
DecompressVoice on the other side. The compressed data provided is in an arbitrary format and is not
|
|
|
|
meant to be played directly.
|
|
|
|
This should be called once per frame, and at worst no more than four times a second to keep the
|
|
|
|
microphone input delay as low as
|
|
|
|
possible. Calling this any less may result in gaps in the returned stream.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.ReadVoiceDataBytes">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Reads the voice data and returns the bytes. You should obviously ideally be using
|
|
|
|
ReadVoiceData because it won't be creating a new byte array every call. But this
|
|
|
|
makes it easier to get it working, so let the babies have their bottle.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.DecompressVoice(System.IO.Stream,System.Int32,System.IO.Stream)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Decodes the compressed voice data returned by GetVoice.
|
|
|
|
The output data is raw single-channel 16-bit PCM audio.The decoder supports any sample rate from 11025
|
|
|
|
to 48000.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.GetAuthSessionTicket">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Retrieve a authentication ticket to be sent to the entity who wishes to authenticate you.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.GetAuthSessionTicketAsync(System.Double)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Retrieve a authentication ticket to be sent to the entity who wishes to authenticate you.
|
|
|
|
This waits for a positive response from the backend before returning the ticket. This means
|
|
|
|
the ticket is definitely ready to go as soon as it returns. Will return null if the callback
|
|
|
|
times out or returns negatively.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.IsBehindNAT">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks if the current users looks like they are behind a NAT device.
|
|
|
|
This is only valid if the user is connected to the Steam servers and may not catch all forms of NAT.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.SteamLevel">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the Steam level of the user, as shown on their Steam community profile.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.GetStoreAuthUrlAsync(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Requests a URL which authenticates an in-game browser for store check-out, and then redirects to the
|
|
|
|
specified URL.
|
|
|
|
As long as the in-game browser accepts and handles session cookies, Steam microtransaction checkout
|
|
|
|
pages will automatically recognize the user instead of presenting a login page.
|
|
|
|
NOTE: The URL has a very short lifetime to prevent history-snooping attacks, so you should only call
|
|
|
|
this API when you are about to launch the browser, or else immediately navigate to the result URL using
|
|
|
|
a hidden browser window.
|
|
|
|
NOTE: The resulting authorization cookie has an expiration time of one day, so it would be a good idea
|
|
|
|
to request and visit a new auth URL every 12 hours.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.IsPhoneVerified">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks whether the current user has verified their phone number.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.IsTwoFactorEnabled">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks whether the current user has Steam Guard two factor authentication enabled on their account.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.IsPhoneIdentifying">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks whether the user's phone number is used to uniquely identify them.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUser.IsPhoneRequiringVerification">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks whether the current user's phone number is awaiting (re)verification.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.RequestEncryptedAppTicketAsync(System.Byte[])">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Requests an application ticket encrypted with the secret "encrypted app ticket key".
|
|
|
|
The encryption key can be obtained from the Encrypted App Ticket Key page on the App Admin for your app.
|
|
|
|
There can only be one call pending, and this call is subject to a 60 second rate limit.
|
|
|
|
If you get a null result from this it's probably because you're calling it too often.
|
|
|
|
This can fail if you don't have an encrypted ticket set for your app here
|
|
|
|
https://partner.steamgames.com/apps/sdkauth/
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.RequestEncryptedAppTicketAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Requests an application ticket encrypted with the secret "encrypted app ticket key".
|
|
|
|
The encryption key can be obtained from the Encrypted App Ticket Key page on the App Admin for your app.
|
|
|
|
There can only be one call pending, and this call is subject to a 60 second rate limit.
|
|
|
|
This can fail if you don't have an encrypted ticket set for your app here
|
|
|
|
https://partner.steamgames.com/apps/sdkauth/
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUser.GetDurationControl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get anti indulgence / duration control
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUserStats.OnAchievementIconFetched">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
called when the achivement icon is loaded
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUserStats.OnUserStatsReceived">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
called when the latests stats and achievements have been received
|
|
|
|
from the server
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUserStats.OnUserStatsStored">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
result of a request to store the user stats for a game
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUserStats.OnAchievementProgress">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
result of a request to store the achievements for a game, or an
|
|
|
|
"indicate progress" call. If both m_nCurProgress and m_nMaxProgress
|
|
|
|
are zero, that means the achievement has been fully unlocked
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUserStats.OnUserStatsUnloaded">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Callback indicating that a user's stats have been unloaded
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUserStats.Achievements">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get the available achievements
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.IndicateAchievementProgress(System.String,System.Int32,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Show the user a pop-up notification with the current progress toward an achievement.
|
|
|
|
Will return false if RequestCurrentStats has not completed and successfully returned
|
|
|
|
its callback, if the achievement doesn't exist/has unpublished changes in the app's
|
|
|
|
Steamworks Admin page, or if the achievement is unlocked.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.PlayerCountAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Tries to get the number of players currently playing this game.
|
|
|
|
Or -1 if failed.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.StoreStats">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Send the changed stats and achievements data to the server for permanent storage.
|
|
|
|
If this fails then nothing is sent to the server. It's advisable to keep trying until the call is
|
|
|
|
successful.
|
|
|
|
This call can be rate limited. Call frequency should be on the order of minutes, rather than seconds.You
|
|
|
|
should only be calling this during major state changes such as the end of a round, the map changing, or
|
|
|
|
the user leaving a server. This call is required to display the achievement unlock notification dialog
|
|
|
|
though, so if you have called SetAchievement then it's advisable to call this soon after that.
|
|
|
|
If you have stats or achievements that you have saved locally but haven't uploaded with this function
|
|
|
|
when your application process ends then this function will automatically be called.
|
|
|
|
You can find additional debug information written to the %steam_install%\logs\stats_log.txt file.
|
|
|
|
This function returns true upon success if :
|
|
|
|
RequestCurrentStats has completed and successfully returned its callback AND
|
|
|
|
the current game has stats associated with it in the Steamworks Partner backend, and those stats are
|
|
|
|
published.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.RequestCurrentStats">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Asynchronously request the user's current stats and achievements from the server.
|
|
|
|
You must always call this first to get the initial status of stats and achievements.
|
|
|
|
Only after the resulting callback comes back can you start calling the rest of the stats
|
|
|
|
and achievement functions for the current user.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.RequestGlobalStatsAsync(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Asynchronously fetches global stats data, which is available for stats marked as
|
|
|
|
"aggregated" in the App Admin panel of the Steamworks website.
|
|
|
|
You must have called RequestCurrentStats and it needs to return successfully via
|
|
|
|
its callback prior to calling this.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
<param name="days">How many days of day-by-day history to retrieve in addition to the overall totals. The
|
|
|
|
limit is 60.
|
|
|
|
</param>
|
|
|
|
<returns>OK indicates success, InvalidState means you need to call RequestCurrentStats first, Fail means the
|
|
|
|
remote call failed
|
|
|
|
</returns>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.FindOrCreateLeaderboardAsync(System.String,Steamworks.Data.LeaderboardSort,Steamworks.Data.LeaderboardDisplay)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a leaderboard by name, it will create it if it's not yet created.
|
|
|
|
Leaderboards created with this function will not automatically show up in the Steam Community.
|
|
|
|
You must manually set the Community Name field in the App Admin panel of the Steamworks website.
|
|
|
|
As such it's generally recommended to prefer creating the leaderboards in the App Admin panel on
|
|
|
|
the Steamworks website and using FindLeaderboard unless you're expected to have a large amount of
|
|
|
|
dynamically created leaderboards.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.AddStat(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Adds this amount to the named stat. Internally this calls Get() and adds
|
|
|
|
to that value. Steam doesn't provide a mechanism for atomically increasing
|
|
|
|
stats like this, this functionality is added here as a convenience.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.AddStat(System.String,System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Adds this amount to the named stat. Internally this calls Get() and adds
|
|
|
|
to that value. Steam doesn't provide a mechanism for atomically increasing
|
|
|
|
stats like this, this functionality is added here as a convenience.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.SetStat(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set a stat value. This will automatically call StoreStats() after a successful call
|
|
|
|
unless you pass false as the last argument.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.SetStat(System.String,System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set a stat value. This will automatically call StoreStats() after a successful call
|
|
|
|
unless you pass false as the last argument.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.GetStatInt(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get a Int stat value
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.GetStatFloat(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get a float stat value
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUserStats.ResetAll(System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Practically wipes the slate clean for this user. If includeAchievements is true, will wipe
|
|
|
|
any achievements too.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<returns></returns>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamUtils">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Interface which provides access to a range of miscellaneous utility functions
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUtils.OnIpCountryChanged">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The country of the user changed
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUtils.OnLowBatteryPower">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Fired when running on a laptop and less than 10 minutes of battery is left, fires then every minute
|
|
|
|
The parameter is the number of minutes left
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUtils.OnSteamShutdown">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Called when Steam wants to shutdown
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="E:Steamworks.SteamUtils.OnGamepadTextInputDismissed">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Big Picture gamepad text input has been closed. Parameter is true if text was submitted, false if
|
|
|
|
cancelled etc.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.SecondsSinceAppActive">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the number of seconds since the application was active
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.SecondsSinceComputerActive">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the number of seconds since the user last moved the mouse etc
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.SteamServerTime">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Steam server time. Number of seconds since January 1, 1970, GMT (i.e unix time)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.IpCountry">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns the 2 digit ISO 3166-1-alpha-2 format country code this client is running in (as looked up via
|
|
|
|
an IP-to-location database)
|
|
|
|
e.g "US" or "UK".
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUtils.GetImageSize(System.Int32,System.UInt32@,System.UInt32@)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns true if the image exists, and the buffer was successfully filled out
|
|
|
|
results are returned in RGBA format
|
|
|
|
the destination buffer size should be 4 * height * width * sizeof(char)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUtils.GetImage(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns the image in RGBA format
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.UsingBatteryPower">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if we're using a battery (ie, a laptop not plugged in)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.CurrentBatteryPower">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns battery power [0-1]
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.OverlayNotificationPosition">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sets the position where the overlay instance for the currently calling game should show notifications.
|
|
|
|
This position is per-game and if this function is called from outside of a game context it will do
|
|
|
|
nothing.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.IsOverlayEnabled">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if the overlay is running and the user can access it. The overlay process could take a few
|
|
|
|
seconds to
|
|
|
|
start and hook the game process, so this function will initially return false while the overlay is
|
|
|
|
loading.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.DoesOverlayNeedPresent">
|
2023-06-01 17:03:48 +02:00
|
|
|
<summary>
|
|
|
|
Normally this call is unneeded if your game has a constantly running frame loop that calls the
|
|
|
|
D3D Present API, or OGL SwapBuffers API every frame.
|
|
|
|
|
|
|
|
However, if you have a game that only refreshes the screen on an event driven basis then that can break
|
|
|
|
the overlay, as it uses your Present/SwapBuffers calls to drive it's internal frame loop and it may also
|
|
|
|
need to Present() to the screen any time an even needing a notification happens or when the overlay is
|
|
|
|
brought up over the game by a user. You can use this API to ask the overlay if it currently need a
|
|
|
|
present
|
|
|
|
in that case, and then you can check for this periodically (roughly 33hz is desirable) and make sure you
|
|
|
|
refresh the screen with Present or SwapBuffers to allow the overlay to do it's work.
|
|
|
|
</summary>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUtils.CheckFileSignatureAsync(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Asynchronous call to check if an executable file has been signed using the public key set on the signing
|
|
|
|
tab
|
|
|
|
of the partner site, for example to refuse to load modified executable files.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUtils.ShowGamepadTextInput(Steamworks.GamepadTextInputMode,Steamworks.GamepadTextInputLineMode,System.String,System.Int32,System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Activates the Big Picture text input dialog which only supports gamepad input
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUtils.GetEnteredGamepadText">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns previously entered text
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.SteamUILanguage">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns the language the steam client is running in, you probably want
|
|
|
|
Apps.CurrentGameLanguage instead, this is for very special usage cases
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.IsSteamRunningInVR">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns true if Steam itself is running in VR mode
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUtils.SetOverlayNotificationInset(System.Int32,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sets the inset of the overlay notification from the corner specified by SetOverlayNotificationPosition
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.IsSteamInBigPictureMode">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
returns true if Steam and the Steam Overlay are running in Big Picture mode
|
|
|
|
Games much be launched through the Steam client to enable the Big Picture overlay. During development,
|
|
|
|
a game can be added as a non-steam game to the developers library to test this feature
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamUtils.StartVRDashboard">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
ask SteamUI to create and render its OpenVR dashboard
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.VrHeadsetStreaming">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set whether the HMD content will be streamed via Steam In-Home Streaming
|
|
|
|
If this is set to true, then the scene in the HMD headset will be streamed, and remote input will not be
|
|
|
|
allowed.
|
|
|
|
If this is set to false, then the application window will be streamed instead, and remote input will be
|
|
|
|
allowed.
|
|
|
|
The default is true unless "VRHeadsetStreaming" "0" is in the extended appinfo for a game.
|
|
|
|
(this is useful for games that have asymmetric multiplayer gameplay)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamUtils.IsSteamChinaLauncher">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns whether this steam client is a Steam China specific client, vs the global client
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamVideo">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Undocumented Parental Settings
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamVideo.IsBroadcasting">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if currently using Steam's live broadcasting
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.SteamVideo.NumViewers">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If we're broadcasting, will return the number of live viewers
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Controller.ActionSet">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Reconfigure the controller to use the specified action set (ie 'Menu', 'Walk' or 'Drive')
|
|
|
|
This is cheap, and can be safely called repeatedly. It's often easier to repeatedly call it in
|
|
|
|
our state loops, instead of trying to place it in all of your state transitions.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Controller.GetDigitalState(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the current state of the supplied digital game action
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Controller.GetAnalogState(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the current state of these supplied analog game action
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsMe">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if this is the local user
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsFriend">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if this is a friend
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsBlocked">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if you have this user blocked
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsPlayingThisGame">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return true if this user is playing the game we're running
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsOnline">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if this friend is online
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.RequestInfoAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sometimes we don't know the user's name. This will wait until we have
|
|
|
|
downloaded the information on this user.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsAway">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if this friend is marked as away
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsBusy">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if this friend is marked as busy
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Friend.IsSnoozing">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if this friend is marked as snoozing
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.InviteToGame(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Invite this friend to the game that we are playing
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.SendMessage(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Sends a message to a Steam friend. Returns true if success
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.RequestUserStatsAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Tries to get download the latest user stats
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<returns>True if successful, False if failure</returns>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.GetStatFloat(System.String,System.Single)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a user stat. Must call RequestUserStats first.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="statName">The name of the stat you want to get</param>
|
|
|
|
<param name="defult">Will return this value if not available</param>
|
|
|
|
<returns>The value, or defult if not available</returns>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.GetStatInt(System.String,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a user stat. Must call RequestUserStats first.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="statName">The name of the stat you want to get</param>
|
|
|
|
<param name="defult">Will return this value if not available</param>
|
|
|
|
<returns>The value, or defult if not available</returns>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.GetAchievement(System.String,System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a user achievement state. Must call RequestUserStats first.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="statName">The name of the achievement you want to get</param>
|
|
|
|
<param name="defult">Will return this value if not available</param>
|
|
|
|
<returns>The value, or defult if not available</returns>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Friend.GetAchievementUnlockTime(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a the time this achievement was unlocked.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
<param name="statName">The name of the achievement you want to get</param>
|
2023-06-01 17:03:48 +02:00
|
|
|
<returns>The time unlocked. If it wasn't unlocked, or you haven't downloaded the stats yet - will return
|
|
|
|
DateTime.MinValue
|
|
|
|
</returns>
|
2023-05-31 18:36:33 +02:00
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Name">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetProperty( "name" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Description">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetProperty( "description" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.IconUrl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetProperty( "icon_url" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.IconUrlLarge">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetProperty( "icon_url_large" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.PriceCategory">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetProperty( "price_category" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Type">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetProperty( "type" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.IsGenerator">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns true if this is an item that generates an item, rather
|
|
|
|
than something that is actual an item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.ExchangeSchema">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetProperty( "exchange" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryDef.GetRecipes">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get a list of exchanges that are available to make this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Marketable">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetBoolProperty( "marketable" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Tradable">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Shortcut to call GetBoolProperty( "tradable" )
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Created">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the property timestamp
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Modified">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the property modified
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryDef.GetProperty(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Get a specific property by name
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryDef.GetBoolProperty(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Read a raw property from the definition schema
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryDef.GetProperty``1(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Read a raw property from the definition schema
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.Properties">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets a list of all properties on this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.LocalPrice">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the price of this item in the local currency (SteamInventory.Currency)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryDef.LocalBasePrice">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If the price has been discounted, LocalPrice will differ from LocalBasePrice
|
|
|
|
(assumed, this isn't documented)
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryDef.GetRecipesContainingThis">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return a list of recepies that contain this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryItem.Properties">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Only available if the result set was created with the getproperties
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryItem.IsNoTrade">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This item is account-locked and cannot be traded or given away.
|
|
|
|
This is an item status flag which is permanently attached to specific item instances
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryItem.IsRemoved">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The item has been destroyed, traded away, expired, or otherwise invalidated.
|
|
|
|
This is an action confirmation flag which is only set one time, as part of a result set.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryItem.IsConsumed">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The item quantity has been decreased by 1 via ConsumeItem API.
|
|
|
|
This is an action confirmation flag which is only set one time, as part of a result set.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryItem.ConsumeAsync(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Consumes items from a user's inventory. If the quantity of the given item goes to zero, it is
|
|
|
|
permanently removed.
|
|
|
|
Once an item is removed it cannot be recovered.This is not for the faint of heart - if your game
|
|
|
|
implements item removal at all,
|
|
|
|
a high-friction UI confirmation process is highly recommended.ConsumeItem can be restricted to certain
|
|
|
|
item definitions or fully
|
|
|
|
blocked via the Steamworks website to minimize support/abuse issues such as the classic "my brother
|
|
|
|
borrowed my laptop and deleted all of my rare items".
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryItem.SplitStackAsync(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Split stack into two items
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryItem.AddAsync(Steamworks.InventoryItem,System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Add x units of the target item to this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryItem.Acquired">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Will try to return the date that this item was aquired. You need to have for the items
|
|
|
|
with their properties for this to work.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.InventoryItem.Origin">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Tries to get the origin property. Need properties for this to work.
|
|
|
|
Will return a string like "market"
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.InventoryItem.Amount">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Small utility class to describe an item with a quantity
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.InventoryRecipe">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A structured description of an item exchange
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.InventoryRecipe.Ingredient.DefinitionId">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The definition ID of the ingredient.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.InventoryRecipe.Ingredient.Definition">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If we don't know about this item definition this might be null.
|
|
|
|
In which case, DefinitionId should still hold the correct id.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.InventoryRecipe.Ingredient.Count">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The amount of this item needed. Generally this will be 1.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.InventoryRecipe.Result">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The item that this will create.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.InventoryRecipe.Ingredients">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The items, with quantity required to create this item.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryResult.BelongsTo(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Checks whether an inventory result handle belongs to the specified Steam ID.
|
|
|
|
This is important when using Deserialize, to verify that a remote player is not pretending to have a
|
|
|
|
different user's inventory
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.InventoryResult.Serialize">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Serialized result sets contain a short signature which can't be forged or replayed across different game
|
|
|
|
sessions.
|
|
|
|
A result set can be serialized on the local client, transmitted to other players via your game
|
|
|
|
networking, and
|
|
|
|
deserialized by the remote players.This is a secure way of preventing hackers from lying about posessing
|
|
|
|
rare/high-value items. Serializes a result set with signature bytes to an output buffer.The size of a
|
|
|
|
serialized
|
|
|
|
result depends on the number items which are being serialized.When securely transmitting items to other
|
|
|
|
players,
|
|
|
|
it is recommended to use GetItemsByID first to create a minimal result set.
|
|
|
|
Results have a built-in timestamp which will be considered "expired" after an hour has elapsed.See
|
|
|
|
DeserializeResult
|
|
|
|
for expiration handling.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.PartyBeacon.Owner">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Creator of the beacon
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.PartyBeacon.MetaData">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Creator of the beacon
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.PartyBeacon.JoinAsync">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Will attempt to join the party. If successful will return a connection string.
|
|
|
|
If failed, will return null
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.PartyBeacon.OnReservationCompleted(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
When a user follows your beacon, Steam will reserve one of the open party slots for them, and send your
|
|
|
|
game a ReservationNotification callback.
|
|
|
|
When that user joins your party, call OnReservationCompleted to notify Steam that the user has joined
|
|
|
|
successfully
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.PartyBeacon.CancelReservation(Steamworks.SteamId)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
To cancel a reservation (due to timeout or user input), call this.
|
|
|
|
Steam will open a new reservation slot.
|
|
|
|
Note: The user may already be in-flight to your game, so it's possible they will still connect and try
|
|
|
|
to join your party.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.PartyBeacon.Destroy">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Turn off the beacon
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.SteamServerInit">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Used to set up the server.
|
|
|
|
The variables in here are all required to be set, and can't be changed once the server is created.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamServerInit.VersionString">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The version string is usually in the form x.x.x.x, and is used by the master server to detect when the
|
|
|
|
server is out of date.
|
|
|
|
If you go into the dedicated server tab on steamworks you'll be able to server the latest version. If
|
|
|
|
this version number is
|
|
|
|
less than that latest version then your server won't show.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamServerInit.ModDir">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
This should be the same directory game where gets installed into. Just the folder name, not the whole
|
|
|
|
path. I.e. "Rust", "Garrysmod".
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamServerInit.GameDescription">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The game description. Setting this to the full name of your game is recommended.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.SteamServerInit.DedicatedServer">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Is a dedicated server
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerInit.WithRandomSteamPort">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Set the Steam quert port
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.SteamServerInit.WithQueryShareGamePort">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If you pass MASTERSERVERUPDATERPORT_USEGAMESOCKETSHARE into usQueryPort, then it causes the game server
|
|
|
|
API to use
|
|
|
|
"GameSocketShare" mode, which means that the game is responsible for sending and receiving UDP packets
|
|
|
|
for the master
|
|
|
|
server updater.
|
|
|
|
|
|
|
|
More info about this here: https://partner.steamgames.com/doc/api/ISteamGameServer#HandleIncomingPacket
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Editor.NewCommunityFile">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Create a Normal Workshop item that can be subscribed to
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Editor.NewMicrotransactionFile">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Workshop item that is meant to be voted on for the purpose of selling in-game
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="F:Steamworks.Ugc.PublishResult.NeedsWorkshopAgreement">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
https://partner.steamgames.com/doc/features/workshop/implementation#Legal
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Id">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The actual ID of this file
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Title">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The given title of this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Description">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The description of this item, in your local language if available
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Tags">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A list of tags for this item, all lowercase
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.CreatorApp">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
App Id of the app that created this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.ConsumerApp">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
App Id of the app that will consume this item.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Owner">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
User who created this content
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Score">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The bayesian average for up votes / total votes, between [0,1]
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Created">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Time when the published item was created
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Updated">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Time when the published item was last updated
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.IsPublic">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
True if this is publically visible
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.IsFriendsOnly">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
True if this item is only visible by friends of the creator
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.IsPrivate">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
True if this is only visible to the creator
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.IsBanned">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
True if this item has been banned
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.IsAcceptedForUse">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Whether the developer of this app has specifically flagged this item as accepted in the Workshop
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.VotesUp">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The number of upvotes of this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.VotesDown">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The number of downvotes of this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.Download(System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Start downloading this item.
|
|
|
|
If this returns false the item isn't getting downloaded.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.DownloadBytesTotal">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If we're downloading, how big the total download is
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.DownloadBytesDownloaded">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If we're downloading, how much we've downloaded
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.SizeBytes">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If we're installed, how big is the install
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.DownloadAmount">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
If we're downloading our current progress as a delta betwen 0-1
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.HasTag(System.String)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
A case insensitive check for tag
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.Subscribe">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Allows the user to subscribe to this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.DownloadAsync(System.Action{System.Single},System.Int32,System.Threading.CancellationToken)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Allows the user to subscribe to download this item asyncronously
|
|
|
|
If CancellationToken is default then there is 60 seconds timeout
|
|
|
|
Progress will be set to 0-1
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.Unsubscribe">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Allows the user to unsubscribe from this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.AddFavorite">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Adds item to user favorite list
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.RemoveFavorite">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Removes item from user favorite list
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.Vote(System.Boolean)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Allows the user to rate a workshop item up or down.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.GetUserVote">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Gets the current users vote on the item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.Url">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Return a URL to view this item online
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.ChangelogUrl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The URl to view this item's changelog
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.CommentsUrl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The URL to view the comments on this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.DiscussUrl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The URL to discuss this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.StatsUrl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The URL to view this items stats online
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Ugc.Item.PreviewImageUrl">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
The URL to the preview image for this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Item.Edit">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Edit this item
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Query.MatchAnyTag">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Found items must have at least one of the defined tags
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Ugc.Query.MatchAllTags">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Found items must have all defined tags
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="P:Steamworks.Epoch.Current">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns the current Unix Epoch
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Epoch.ToDateTime(System.Decimal)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Convert an epoch to a datetime
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Epoch.FromDateTime(System.DateTime)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Convert a DateTime to a unix time
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="M:Steamworks.Helpers.TakeBuffer(System.Int32)">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Returns a buffer. This will get returned and reused later on.
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
<member name="T:Steamworks.PreserveAttribute">
|
|
|
|
<summary>
|
2023-06-01 17:03:48 +02:00
|
|
|
Prevent unity from stripping shit we depend on
|
|
|
|
https://docs.unity3d.com/Manual/ManagedCodeStripping.html
|
2023-05-31 18:36:33 +02:00
|
|
|
</summary>
|
|
|
|
</member>
|
|
|
|
</members>
|
|
|
|
</doc>
|