docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Namespace Unity.Services.Lobbies

    Classes

    CreateLobbyOptions

    Optional parameter class for Lobby creation requests.

    JoinLobbyByCodeOptions

    Optional parameter class for Lobby Join By Code requests

    JoinLobbyByIdOptions

    Optional parameter class for Lobby Join By ID requests

    LobbyPlayerChanges

    Contains information about a set of changes to a player.

    LobbyService

    Here is the first point and call for accessing the Lobby Package's features! Use the .Instance method to get a singleton of the ILobbyServiceSDK, and from there you can make various requests to the Lobby service API.

    LobbyServiceException

    Represents an exception that occurs when communicating with the Unity Lobby Service.

    LobbyValue

    Helper class for instantiating ChangedLobbyValue and ChangedOrRemovedLobbyValue!

    QueryLobbiesOptions

    Query parameters for Lobby service requests.

    QuickJoinLobbyOptions

    Optional parameters for Quick Joining a Lobby. Includes queryable fields for Lobby selection criterion.

    UpdateLobbyOptions

    Parameters to update on a given UpdateLobby request.

    UpdatePlayerOptions

    Paramters to update on a given UpdatePlayer request.

    Structs

    ChangedLobbyValue<T>

    Contains whether or not a particular change has occurred, and if it has, the value of the change.

    ChangedOrRemovedLobbyValue<T>

    Contains whether or not a particular change or removal has occurred. If a change has occurred, also provides the value of the change.

    LobbyPlayerJoined

    Contains information about the player that joined.

    Interfaces

    ILobbyChanges

    An interface providing a set of changes to apply to a lobby model.

    ILobbyEvents

    An interface for managing a lobby events subscription and the callbacks associated with it.

    ILobbyService

    Service for Lobbies. Provides user the ability to create, delete, update, and query Lobbies. Includes operations for interacting with given players in a Lobby context.

    ILobbyServiceSDK

    This interface is marked for deprecation. Please use ILobbyService instead.

    ILobbyServiceSDKConfiguration

    Interface used for editing the configuration of the lobby service SDK. Primary usage is for testing purposes.

    Enums

    LobbyEventConnectionState

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

    LobbyExceptionReason

    Enumerates the known error causes when communicating with the Lobby Service. N.B. Error code range for this service: 16000-16999

    LobbyValueChangeType

    An enum providing the change type of a given change.


    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
    • Structs
    • 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)