docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Join Session With Matchmaker component reference

    Properties of the Join Session With Matchmaker component. The Join Session By Matchmaker multiplayer widget includes this component by default.

    Property Description
    Script Identifies the script this component uses. Select this field to highlight the script asset in the Project window. You can’t change this property.
    Queues The queue that defines the rules for this matchmaking session. To learn more, refer to Deploy a Matchmaker queue
    Refresh Remote Queues Update the Queues dropdown to match any changes you made to Queues on your Unity Cloud dashboard.
    Configure Matchmaker on the Cloud Dashboard Open the Matchmaker section of the Unity Cloud dashboard in a local browser window.
    Create new Matchmaker Queue Asset Create a new Matchmaker queue configuration file in your Assets folder. Use this script to define the rules for this matchmaker session. For more information, refer to Deploy a Matchmaker queue
    Widget Configuration The script that sets the parameters of this session.. To learn more, refer to Configure a Widget.
    Joining Session () Select Add + to specify the UnityEvent that occurs when a user attempts to join a specific session.
    Joined Session (ISession) Select Add + to specify the UnityEvent that occurs when a user is in a session.
    Failed To Join Session (SessionException) Select Add + to specify the UnityEvent that occurs when a user can't join a session because of an error.

    Additional resources

    • Use a multiplayer widget to create and join a session
    • Queues and pools
    • Deploy a Matchmaker environment

    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
    • Additional resources
    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)