docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Namespace Unity.Services.Multiplayer

    Classes

    BackfillingConfiguration

    Allow to configure the backfilling behavior on the session.

    BaseSessionOptions

    Common options for all session flows

    ConnectionExtensions

    Provides extension methods on SessionOptions to configure connection options for sessions.

    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

    MultiplayerService

    The entry class of the Multiplayer SDK and session system.

    PlayerProperty

    Represents a property of a player.

    QuerySessionsOptions

    A Generic class for creating options for querying sessions.

    QuerySessionsResults

    The result of the query sessions operation.

    QuickJoinOptions

    Options to provide quick join filters, timeout and backup flow

    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.

    SessionProperty

    Represents a property of a session.

    SortOption

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

    Interfaces

    IHostSession

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

    IMultiplayerService

    Facade for session browsing, session management and matchmaking.

    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 to sort results by.

    FilterOperation

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

    MatchmakerState

    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.


    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Classes
    • Interfaces
    • Enums
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)