v1.0.0
Latest
2022.3+

Namespace Unity.Services.Multiplayer

Classes

BackfillingConfiguration

Allow to configure the backfilling behavior on the session.

BaseSessionOptions

Common options for all session flows

FilterOption

A Generic class for creating option for querying sessions.

JoinSessionOptions

Options to configure a session when joining. Some options will only be used if a session needs to be created. Options can be customized to provide additional feature configuration.

MatchmakerExtensions

Extension methods of an ISession that can be used when using the Matchmaker service.

MatchmakerOptions

Options for finding a match with Unity Matchmaker

MatchmakerServerExtensions

Extension methods of SessionOptions that can be used the manage the state of the matchmaking on the server side.

MultiplayerServerService

The entry class of the Multiplayer SDK and session system.

MultiplayerService

The entry class of the Multiplayer SDK and session system.

MultiplayServerOptions

Allows configuring the server options of a Game Server Hosting server.

MultiplaySessionManagerEventCallbacks

Class for providing your callbacks, which are used by the Multiplayer SDK when a MultiplaySessionManager Event occurs.

MultiplaySessionManagerOptions

Represents the options for to start the Game Server Hosting server and create the session the player will connect to.

NetworkConfiguration

Configuration data for network handlers.

PlayerProperty

Represents a property of a player.

QuerySessionsOptions

A Generic class for creating options for querying sessions.

QuerySessionsResults

Results from a session query.

QuickJoinOptions

Options to provide quick join filters, timeout and backup flow

ReconnectSessionOptions

Options to configure a session when reconnecting.

ServerAllocation

Provides information about a Game Server Hosting allocation.

SessionException

The exception for session operations

SessionOptions

Options to configure a session when either joining or creating. Some options will only be used if a session needs to be created. Options can be customized to provide additional feature configuration.

SessionOptionsExtensions

Provides extension methods to configure session networking options.

SessionProperty

Represents a property of a session.

SortOption

Options representing how to sort the results of a session query.

Interfaces

IHostSession

A host's mutable handle on a session.

IMultiplayAllocation

Represents an allocation for a Game Server Hosting server.

IMultiplayerServerService

Facade for session browsing, session management and matchmaking.

IMultiplayerService

Facade for session browsing, session management and matchmaking.

IMultiplaySessionManager

Provides methods to manage a Game Server Hosting server.

INetworkHandler

A handler that configures the network as a session start and stops.

IPlayer

An interface that allows to modify the properties of a Player.

IReadOnlyPlayer

A read only interface representing a player in the session.

IServerSession

An interface that can be used by a server to manage a session and access more privileged operations.

ISession

An interface that can be used by a client to access the information of a session.

ISessionInfo

ISessionInfo represents information about a session.

Enums

FilterField

Supported fields and indices to sort query results by.

FilterOperation

The operation used to compare the field to the filter value.

MatchmakerState

Represents the state of a matchmaking process.

MultiplaySessionManagerState

Represents the state of a Game Server Hosting server.

NetworkRole

Networking role.

NetworkType

The type of network used for a session.

PropertyIndex

The name of the column to index this property value under, either S# for strings or N# for numeric values. If an index is specified on a property, then you can use that index name in a QueryFilter to filter results by that property. You will not be prevented from indexing multiple objects having properties with different names but the same index, but you will likely receive unexpected results from a query.

SessionError

The type of error related to sessions

SessionEventConnectionState

An enum describing the current state of a Session Event subscription's connection status.

SessionState

Indicates the state of a session.

SortField

Supported fields to sort results by.

SortOrder

Order in which results will be sorted.

VisibilityPropertyOptions

Indicates for whom the property should be visible. If public, the property will be visible to everyone and will be included in query results. If member, the data will only be visible to users who are members of the Session (i.e. those who have successfully joined). If private, the metadata will only be visible to the Session member.