Class ISteamMatchmakingPlayersResponse

Managed implementation of the C++ ISteamMatchmakingPlayersResponse callback sink passed to PlayerDetails(uint, ushort, ISteamMatchmakingPlayersResponse). One ISteamMatchmakingPlayersResponse.AddPlayerToListHandler call is made per player, followed by either ISteamMatchmakingPlayersResponse.PlayersRefreshCompleteHandler or ISteamMatchmakingPlayersResponse.PlayersFailedToRespondHandler. Dispose it after that call or after CancelServerQuery(HServerQuery), and not before. An undisposed sink is never collected.

Handlers are invoked on the thread that dispatches the pipe: the package's callback thread, or the thread that calls RunFrameCallbacks(bool) or performs its own dispatch. When that is not the main thread, calls to Unity APIs must be marshalled to the main thread. Handler exceptions are caught and routed to ExceptionHandler.

Inheritance

object

ISteamMatchmakingPlayersResponse

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Steamworks.Interop

Assembly: Unity.Steamworks.Interop.dll

Syntax

public sealed class ISteamMatchmakingPlayersResponse : IDisposable

Constructors

ISteamMatchmakingPlayersResponse(AddPlayerToListHandler, PlayersFailedToRespondHandler, PlayersRefreshCompleteHandler)

Creates the native object that Steam calls back into. Every handler is required.

Declaration

public ISteamMatchmakingPlayersResponse(ISteamMatchmakingPlayersResponse.AddPlayerToListHandler onAddPlayerToList, ISteamMatchmakingPlayersResponse.PlayersFailedToRespondHandler onPlayersFailedToRespond, ISteamMatchmakingPlayersResponse.PlayersRefreshCompleteHandler onPlayersRefreshComplete)

Parameters

Type	Name	Description
ISteamMatchmakingPlayersResponse.AddPlayerToListHandler	onAddPlayerToList	Called once per player as the server reports them.
ISteamMatchmakingPlayersResponse.PlayersFailedToRespondHandler	onPlayersFailedToRespond	Called when the server did not answer.
ISteamMatchmakingPlayersResponse.PlayersRefreshCompleteHandler	onPlayersRefreshComplete	Called once every player has been reported.

Methods

Dispose()

Frees the native response object and releases the handle that kept this sink alive.

Declaration

public void Dispose()

Operators

explicit operator IntPtr(ISteamMatchmakingPlayersResponse)

The native interface pointer the flat API takes for this sink.

Declaration

public static explicit operator IntPtr(ISteamMatchmakingPlayersResponse that)

Parameters

Type	Name	Description
ISteamMatchmakingPlayersResponse	that	The sink to convert; may be null.

Returns

Type	Description
IntPtr	The native object's address, or Zero when that is null or disposed.

Implements

IDisposable