You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: mppm/about.md
+12-8
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,11 @@ title: About Multiplayer Play Mode
4
4
description: Overview of Multiplayer Play Mode
5
5
---
6
6
7
-
Use Multiplayer Play Mode to test multiplayer functionality within the Unity Editor. You can simulate up to four players (the Main Editor and three Virtual Players) simultaneously on the same development device while using the same source assets on disk. Multiplayer Play Mode can help you create multiplayer development workflows that reduce project build times, run it locally, and test the server-client relationship.
7
+
Use Multiplayer Play Mode to test multiplayer functionality within the Unity Editor. You can simulate up to four Players (the main Editor Player and three Virtual Players) simultaneously on the same development device while using the same source assets on disk. Multiplayer Play Mode can help you create multiplayer development workflows that reduce project build times, run it locally, and test the server-client relationship.
8
+
9
+
## Compatibility
10
+
11
+
Multiplayer Play Mode version 1.1.0 is compatible with Unity Editor versions 6000.0.3f1 or later.
8
12
9
13
## Compatibility
10
14
@@ -14,24 +18,24 @@ Multiplayer Play Mode version 1.1.0 is compatible with Unity Editor versions 600
14
18
15
19
The following have specific meaning in relation to Multiplayer Play Mode:
16
20
17
-
*Main Editor: The original instance of the project in the Unity Editor. This is the only instance with full authoring capabilities.
18
-
* Virtual Players: Simulated players created with Multiplayer Play Mode. These players open in a separate window with limited authoring capabilities when you enter [Play mode](https://docs.unity3d.com/Manual/GameView.html).
19
-
* Players: All player instances, including the Main Editor Player and all Virtual Players.
21
+
*main Editor Player: The original instance of the project in the Unity Editor. This is the only instance with full authoring capabilities.
22
+
* Virtual Players: Simulated Players created with Multiplayer Play Mode. These Players open in a separate window with limited authoring capabilities when you enter [Play mode](https://docs.unity3d.com/Manual/GameView.html).
23
+
* Players: All Player instances, including the main Editor Player and all Virtual Players.
20
24
21
25
## Limitations
22
26
23
27
Multiplayer Play Mode has some inherent technical limitations, specifically around [scale](#scale) and [authoring](#authoring).
24
28
25
29
### Scale
26
30
27
-
The Unity Editor and Virtual Players require a lot of system resources, so you shouldn't use Multiplayer Play Mode at scale. Multiplayer Play Mode is designed for small-scale, local testing environments that can only support up to four total players (the Main Editor and three Virtual Players).
31
+
The Unity Editor and Virtual Players require a lot of system resources, so you shouldn't use Multiplayer Play Mode at scale. Multiplayer Play Mode is designed for small-scale, local testing environments that can only support up to four total Players (the main Editor Player and three Virtual Players).
28
32
29
33
### Authoring
30
-
You can't create or change the properties of GameObjects in a Virtual Player. Instead, use the Main Editor to make changes and a Virtual Player to test multiplayer functionality. Any changes you make in Play Mode in the Main Editor reset when you exit Play Mode.
34
+
You can't create or change the properties of GameObjects in a Virtual Player. Instead, use the main Editor Player to make changes and a Virtual Player to test multiplayer functionality. Any changes you make in Play Mode in the main Editor Player reset when you exit Play Mode.
31
35
:::note
32
-
You can't access any Main Editor functionality from Virtual Players.
36
+
You can't access any main Editor Player functionality from Virtual Players.
33
37
:::
34
38
35
39
## Performance impact
36
40
37
-
To reduce the demand on system resources caused by each Virtual Player instance, Multiplayer Play Mode shares specific resources, such as the artifact database and imports between the Main Editor and each Virtual Player.
41
+
To reduce the demand on system resources caused by each Virtual Player instance, Multiplayer Play Mode shares specific resources, such as the artifact database and imports between the main Editor Player and each Virtual Player.
title: Assign virtual players to a multiplayer role
4
-
description: Learn how to use the dedicated server package to assign virtual players to a multiplayer role.
3
+
title: Assign Virtual Players to a multiplayer role
4
+
description: Learn how to use the dedicated server package to assign Virtual Players to a multiplayer role.
5
5
---
6
6
7
-
Install the [Dedicated Server package](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) with Multiplayer Play Mode to switch players between the server and client role without a script.
7
+
Install the [Dedicated Server package](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) with Multiplayer Play Mode to switch Players between the server and client role without a script.
8
8
9
9
::: Important
10
10
To avoid errors, install the Dedicated Server package version that is the same as the Multiplayer Play mode version that exists in your project.
11
11
:::
12
12
13
-
## Set the main editor player multiplayer role
13
+
## Set the main Editor Player multiplayer role
14
14
15
-
To set the role of a the main editor player, do the following:
15
+
To set the role of a the main Editor Player, do the following:
16
16
17
17
1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**).
18
-
2. In the **Main Editor Player** section, expand the **Multiplayer Role** dropdown.
19
-
3. Select the [multiplayer role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want the main editor to use.
18
+
2. In the **main Editor Player** section, expand the **Multiplayer Role** dropdown.
19
+
3. Select the [multiplayer role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want the main Editor Player to use.
20
20
21
-
## Set the multiplayer role of a virtual player
21
+
## Set the multiplayer role of a Virtual Player
22
22
23
-
To set the role of a [virtual player](../../virtual-players), do the following:
23
+
To set the role of a [Virtual Player](../../virtual-players), do the following:
24
24
25
25
1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**).
26
-
2. In the **Virtual Players** section, expand a virtual player's **Multiplayer Role** dropdown.
27
-
3. Select the [multiplayer role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want this player to use.
26
+
2. In the **Virtual Players** section, expand a Virtual Player's **Multiplayer Role** dropdown.
27
+
3. Select the [multiplayer role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want this Player to use.
description: Use these steps to create Player Tags to configure the player actions in Multiplayer Play Mode.
3
+
title: Create a tag
4
+
description: Use these steps to create tags to configure the player actions in Multiplayer Play Mode.
5
5
---
6
6
7
-
To create a **Player Tag**, perform the following actions:
7
+
To create a tag, perform the following actions:
8
8
9
9
1. To open the Multiplayer Play mode window, navigate to **Window** > **Multiplayer Play Mode**.
10
-
2. Expand the Tags dropdown for a Player or the Main Editor.
10
+
2. Expand the Tags dropdown for a Player or the main Editor Player.
11
11
3. Select  Create Tag.
12
-
4. Name the **Player Tag**.
12
+
4. Name the tag.
13
13
5. Select **Save**. The new tag is automatically added to the local project directory in `...Projects\[example-project-name]\ProjectSettings\VirtualProjectsConfig.json`.
14
14
6. The new tag also appears under the **Player Tags** section of the **Multiplayer Play Mode** window and in the dropdown menu for the **Tag** option of each **Player**.
description: Learn how to use Player Tags to configure player actions in Multiplayer Play Mode.
3
+
title: Information about tags
4
+
description: Learn how to use tags to configure Player actions in Multiplayer Play Mode.
5
5
---
6
6
7
-
Player Tags are similar to launch arguments for Players (both the Main Editor Player and Virtual Players) that you can use to configure Players to behave in a specific way. For example:
7
+
Tags are similar to launch arguments for Players (both the main Editor Player and Virtual Players) that you can use to configure Players to behave in a specific way. For example:
8
8
9
9
- Run as a client, server, or host automatically
10
10
- Automatically run as a member of a specific team (for example, “Red Team” or “Blue Team”)
11
11
- Move faster or slower to simulate their network connection
12
12
13
-
You can assign multiple tags to a player.
13
+
You can assign multiple tags to a Player.
14
14
15
15
<!--
16
16
<div className="table-columns-plain" >
@@ -20,6 +20,6 @@ You can assign multiple tags to a player.
20
20
21
21
|**Page**|**Description**|
22
22
|-|-|
23
-
|[Create Player Tag](../player-tags/player-tags-create)| Learn how to create player tags in code.|
24
-
|[Configure Player tag](../player-tags/player-tags-configure)| Learn how to set up player tags to work in your project|
25
-
|[Attach a Player Tag to a player](../player-tags/player-tags-attach)| Learn how to assign tags to a specific player.|
23
+
|[Create tag](../player-tags/player-tags-create)| Learn how to create tags in code.|
24
+
|[Configure tag](../player-tags/player-tags-configure)| Learn how to set up tags to work in your project|
25
+
|[Attach a tag to a Player](../player-tags/player-tags-attach)| Learn how to assign tags to a specific Player.|
Copy file name to clipboardExpand all lines: mppm/player-tags/target-instance.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
---
2
2
id: target-instance
3
-
title: Use Player Tags to run a player as a server, client, or host
3
+
title: Use tags to run a player as a server, client, or host
4
4
description: This example shows how you can use Netcode for GameObjects to run a Player as a server, client, or host in Multiplayer Play Mode.
5
5
---
6
6
7
-
This example explains how to target **Player Tags** in your game scripts with `CurrentPlayer.ReadOnlyTags()`. You can place these scripts where you want, but you must attach the scripts to a [NetworkObject](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkobject/) (such as the **Player**).
7
+
This example explains how to target tags in your game scripts with `CurrentPlayer.ReadOnlyTags()`. You can place these scripts where you want, but you must attach the scripts to a [NetworkObject](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkobject/) (such as the **Player**).
8
8
9
-
You can also use the dedicated server package to set a player tag to server, client, or host. For more information, refer to [Use Multiplayer Play Mode with a Dedicated Server](../dedicated-server/play-mode-dedicated-server.md).
9
+
You can also use the dedicated server package to set a tag to server, client, or host. For more information, refer to [Use Multiplayer Play Mode with a Dedicated Server](../dedicated-server/play-mode-dedicated-server.md).
10
10
11
-
## Set a player tag to server, client, or host in a script
11
+
## Set a tag to server, client, or host in a script
12
12
13
-
The following script uses the Netcode for GameObjects [NetworkManager](https://docs-multiplayer.unity3d.com/netcode/current/components/networkmanager/) to automatically connect the Virtual Player as a server, client, or host based on their Player Tag. A Player with the `Server`Player Tag automatically runs as a server, and a Player with the `Client`Player Tag automatically runs as a client.
13
+
The following script uses the Netcode for GameObjects [NetworkManager](https://docs-multiplayer.unity3d.com/netcode/current/components/networkmanager/) to automatically connect the Virtual Player as a server, client, or host based on their tag. A Player with the `Server`tag automatically runs as a server, and a Player with the `Client`tag automatically runs as a client.
14
14
15
15
:::important
16
16
This example uses the `Contains` method, which is case-sensitive by default. To make it case-insensitive, pass the `System.StringComparison.CurrentCultureIgnoreCase` method.
Copy file name to clipboardExpand all lines: mppm/player-tags/target-network.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@ title: Configure a Player to simulate different network connections example
4
4
description: This example shows how you can use the Network Simulator and Players to test different network connections in Multiplayer Play Mode.
5
5
---
6
6
7
-
The logic in the following example checks if the **Player Tag**has a string rather than if it’s equal to a string to allow for more flexibility with the name of the **Player Tag**. You can change this logic so that it checks for an exact match.
7
+
The logic in the following example checks if the tag has a string rather than if it’s equal to a string to allow for more flexibility with the name of the tag. You can change this logic so that it checks for an exact match.
8
8
9
9
## Simulate network conditions
10
10
11
-
This example script uses the Network Simulation Presets from the [Multiplayer Tools package](https://docs-multiplayer.unity3d.com/tools/current/install-tools/) to automatically simulate a fast or slow network based on the Player Tag. A Player with the `FastNetwork`Player Tag simulates a common [Home Broadband](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/#home-broadband-connections) connection, and a Player with the `SlowNetwork`Player Tag simulates a [Mobile 2.5G](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/#mobile-25g) connection.
11
+
This example script uses the Network Simulation Presets from the [Multiplayer Tools package](https://docs-multiplayer.unity3d.com/tools/current/install-tools/) to automatically simulate a fast or slow network based on the tag. A Player with the `FastNetwork`tag simulates a common [Home Broadband](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/#home-broadband-connections) connection, and a Player with the `SlowNetwork`tag simulates a [Mobile 2.5G](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/#mobile-25g) connection.
12
12
13
13
:::note
14
14
This example uses the [Network Simulator](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/) tool from the `com.unity.multiplayer.tools` package.
0 commit comments