docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BaseSessionOptions

    Common options for all session flows.

    Inheritance
    object
    BaseSessionOptions
    JoinSessionOptions
    SessionOptions
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.Services.Multiplayer
    Assembly: Unity.Services.Multiplayer.dll
    Syntax
    public abstract class BaseSessionOptions

    Properties

    PlayerProperties

    Custom game-specific properties that apply to an individual player (e.g. 'role' or 'skill').

    Declaration
    public Dictionary<string, PlayerProperty> PlayerProperties { get; set; }
    Property Value
    Type Description
    Dictionary<string, PlayerProperty>
    Remarks

    Up to 10 properties may be set per player. Player properties have different visibility levels.

    See Also
    SessionOptions
    JoinSessionOptions

    Type

    The session type is a client-side key used to uniquely identify a session

    Declaration
    public string Type { get; set; }
    Property Value
    Type Description
    string
    See Also
    SessionOptions
    JoinSessionOptions

    Extension Methods

    SessionOptionsExtensions.WithHostMigration<T>(T)
    SessionOptionsExtensions.WithHostMigration<T>(T, IMigrationDataHandler)
    SessionOptionsExtensions.WithHostMigration<T>(T, IMigrationDataHandler, TimeSpan, TimeSpan)
    SessionOptionsExtensions.WithNetworkHandler<T>(T, INetworkHandler)
    SessionOptionsExtensions.WithPlayerName<T>(T, VisibilityPropertyOptions)

    See Also

    SessionOptions
    JoinSessionOptions
    In This Article
    Back to top
    Copyright © 2025 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)