Namespace Unity.Services.Multiplayer

Classes

BackfillingConfiguration

Allow to configure the backfilling behavior on the session.

DirectNetworkOptions

Represents configuration options for direct network connections.

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

Represents a Matchmaker queue configuration asset.
This asset is created in the Unity Editor when importing a Matchmaker queue configuration from a .mmq file.
It can be used to reference the queue in code from a MonoBehaviour or another asset so that changing the queue configuration from the mmq file will update it where it is used.

MultiplayerService

The entry class of the Multiplayer SDK and session system.

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.

RelayNetworkOptions

Represents Relay options.

SessionException

The exception for session operations

SessionMigrationData

Class for host migration data model.

SessionObserver

This class can be used to track events related to an ISession of a specific Type.

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 options.

SessionProperty

Represents a property of a session.

SortOption

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

Structs

AddingSessionOptions

Options configured when adding a session.

ListenIPAddress

Represents a network address (IPv4 or IPv6).

NetworkEndpointAddress

Represents a network endpoint, wrapping a Unity.Networking.Transport.NetworkEndpoint. Provides utility properties and constructors for working with IP addresses and ports in Unity Multiplayer.

PublishIPAddress

Represents a network address (IPv4 or IPv6).

Interfaces

IClientSessionNetwork

A handle to the network handler used by the Client's Session.

IHostSession

A host's mutable handle on a session.

IHostSessionNetwork

A handle to the network handler used by the Host's Session.

IIpValidator

Provides methods for validating and parsing IP addresses.

IMigrationDataHandler

An interface that can be used by a client to provide custom migration data generation and apply.

IMultiplayerService

Facade for session browsing, session management and matchmaking.

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.

NetworkRole

Networking role.

NetworkState

Represents the states of the underlying network.

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.