Configure a multiplayer widget
Multiplayer widgets that can join a session include a component that uses the Widget Configuration asset. The component is specific to each widget:
| Multiplayer widget | Component |
|---|---|
| Create Session | CreateSession |
| Quick Create Session | QuickCreateSession |
| Session List | SessionList |
| Join Session By Code | JoinSessionByCode |
| Quick Join Session | QuickJoinSession |
Use this component to set parameters for the session. To learn what each property in the Widget Configuration asset controls, refer to Widget Configuration reference.
Each Create Session component automatically assigns the DefaultWidgetConfiguration asset to its Widget Configuration field. You can use this asset to set the maximum number of players for this session and control the connection type that a session uses. Choose from the following connection types:
- None: Only creates a Session without further networking capabilities.
- Direct: Uses the IP address of a specific device to connect to it.
- Relay: Connects to devices outside the host network.
- Distributed Authority: Uses the distributed authority network topology. Requires
com.unity.netcode.gameobjects(Netcode for GameObjects) version 2.0.0 or later.
Configure a custom session
To set up a custom Widget Configuration asset, do the following:
- Go to Assets > Create > Multiplayer > Widgets > WidgetConfiguration.
- In the Create Session component assign the new Widget Configuration asset to the Widget Configuration field.
- Change the values of the Widget Configuration reference properties.