Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.

Commit 54ecd26

Browse files
Terminology update (#1297)
Co-authored-by: Amy Reeve <[email protected]>
1 parent f46dfac commit 54ecd26

File tree

90 files changed

+489
-489
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+489
-489
lines changed

mppm/about.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: About Multiplayer Play Mode
44
description: Overview of Multiplayer Play Mode
55
---
66

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.
88

99
## Compatibility
1010

@@ -14,24 +14,24 @@ Multiplayer Play Mode version 1.1.0 is compatible with Unity Editor versions 600
1414

1515
The following have specific meaning in relation to Multiplayer Play Mode:
1616

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.
17+
* main Editor Player: 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.
2020

2121
## Limitations
2222

2323
Multiplayer Play Mode has some inherent technical limitations, specifically around [scale](#scale) and [authoring](#authoring).
2424

2525
### Scale
2626

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).
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 Player and three Virtual Players).
2828

2929
### 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.
30+
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.
3131
:::note
32-
You can't access any Main Editor functionality from Virtual Players.
32+
You can't access any main Editor Player functionality from Virtual Players.
3333
:::
3434

3535
## Performance impact
3636

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.
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 Player and each Virtual Player.
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
---
22
id: 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.
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.
55
---
66

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.
88

99
::: Important
1010
To avoid errors, install the Dedicated Server package version that is the same as the Multiplayer Play mode version that exists in your project.
1111
:::
1212

13-
## Set the main editor player multiplayer role
13+
## Set the main Editor Player multiplayer role
1414

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:
1616

1717
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.
2020

21-
## Set the multiplayer role of a virtual player
21+
## Set the multiplayer role of a Virtual Player
2222

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:
2424

2525
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.

mppm/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ To install the Multiplayer Play Mode package, follow these steps:
1616

1717
## Next steps
1818

19-
You can now access and configure your [Virtual Players](../virtual-players) and their [Player Tags](../player-tags).
19+
You can now access and configure your [Virtual Players](../virtual-players) and their [tags](../player-tags).
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
id: player-tags-attach
3-
title: Attach Player Tags to a player
4-
description: Learn how to attach Player Tags to a player in Multiplayer Play Mode.
3+
title: Attach tags to a Player
4+
description: Learn how to attach tags to a Player in Multiplayer Play Mode.
55
---
66

7-
To assign one or more [Player Tags](../../player-tags) to any player, do the following:
7+
To assign one or more [tags](../../player-tags) to any Player, do the following:
88

99
1. Open the Multiplayer Play mode window (**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.
1111
3. Select **+ Create Tag**.
1212
4. In the Project Settings window that appears, select the **Add** (**+**) icon.
13-
5. In the New Player Tag field that appears, type a name for your tag.
13+
5. In the New tag field that appears, type a name for your tag.
1414
6. Select **Save**.
1515
7. In the Multiplayer Play Mode window, expand the **Tags** dropdown.
1616
8. Select the tag you just created.

mppm/player-tags/player-tags-configure.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
id: player-tags-configure
3-
title: Configure Player Tags
4-
description: Set up Player Tags to use them to configure the player actions.
3+
title: Configure tags
4+
description: Set up tags to use them to configure the player actions.
55
---
66

7-
Player Tags don't do anything until you configure them. To configure a player tag, do the following:
7+
Tags don't do anything until you configure them. To configure a tag, do the following:
88

9-
1. Use `CurrentPlayer.ReadOnlyTags()` to target the Player Tag in a script.
9+
1. Use `CurrentPlayer.ReadOnlyTags()` to target the tag in a script.
1010
2. Attach the script to a [NetworkObject](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkobject/), for example, the **Player**.
1111

12-
Use the following **Player Tag** examples as guides for your own scripts:
12+
Use the following tag examples as guides for your own scripts:
1313

1414
- [For a **Player** to run as a server, client, or host](../target-instance)
1515
- [To automatically assign a **Player** to a team](../target-team)
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
id: player-tags-create
3-
title: Create a Player Tags
4-
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.
55
---
66

7-
To create a **Player Tag**, perform the following actions:
7+
To create a tag, perform the following actions:
88

99
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.
1111
3. Select ![plus sign](/img/add.png) Create Tag.
12-
4. Name the **Player Tag**.
12+
4. Name the tag.
1313
5. Select **Save**. The new tag is automatically added to the local project directory in `...Projects\[example-project-name]\ProjectSettings\VirtualProjectsConfig.json`.
1414
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**.

mppm/player-tags/player-tags.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
id: player-tags
3-
title: Player Tags
4-
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.
55
---
66

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:
88

99
- Run as a client, server, or host automatically
1010
- Automatically run as a member of a specific team (for example, “Red Team” or “Blue Team”)
1111
- Move faster or slower to simulate their network connection
1212

13-
You can assign multiple tags to a player.
13+
You can assign multiple tags to a Player.
1414

1515
<!--
1616
<div className="table-columns-plain" >
@@ -20,6 +20,6 @@ You can assign multiple tags to a player.
2020

2121
|**Page** |**Description**|
2222
|-|-|
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.|

mppm/player-tags/target-instance.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
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
44
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.
55
---
66

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**).
88

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).
1010

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
1212

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.
1414

1515
:::important
1616
This example uses the `Contains` method, which is case-sensitive by default. To make it case-insensitive, pass the `System.StringComparison.CurrentCultureIgnoreCase` method.

mppm/player-tags/target-network.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ title: Configure a Player to simulate different network connections example
44
description: This example shows how you can use the Network Simulator and Players to test different network connections in Multiplayer Play Mode.
55
---
66

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.
88

99
## Simulate network conditions
1010

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.
1212

1313
:::note
1414
This example uses the [Network Simulator](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/) tool from the `com.unity.multiplayer.tools` package.

mppm/player-tags/target-team.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
id: target-team
3-
title: Use player tags to assign a player to a team
3+
title: Use tags to assign a player to a team
44
description: Automatically assign Players to different teams in Multiplayer Play Mode.
55
---
66

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.
88

99
:::important
1010
The following example uses the `Contains` method, which is case-sensitive by default. You can make it case-insensitive by passing the `System.StringComparison.CurrentCultureIgnoreCase` method.
1111
:::
1212

1313
## Automatically assign a Player to a team
1414

15-
The following script automatically sets a [NetworkVariable](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkvariable/) called `Team` based on the Player Tag.
15+
The following script automatically sets a [NetworkVariable](https://docs-multiplayer.unity3d.com/netcode/current/basics/networkvariable/) called `Team` based on the tag.
1616

17-
A Player with a `Red` Player Tag automatically sets the `Team` NetworkVariable to `Red`. A Player with a `Blue` Player Tag automatically sets the `Team` NetworkVariable to `Blue`.
17+
A Player with a `Red` tag automatically sets the `Team` NetworkVariable to `Red`. A Player with a `Blue` tag automatically sets the `Team` NetworkVariable to `Blue`.
1818

1919
```csharp
2020
using Unity.Netcode;
@@ -24,7 +24,7 @@ using Unity.Multiplayer.Playmode;
2424
public enum Team { Blue, Red, }
2525

2626
/// A player with a team that is automatically assigned
27-
/// based on the Player Tag of the client that owns them
27+
/// based on the tag of the client that owns them
2828
public class Player : NetworkBehaviour
2929
{
3030
public NetworkVariable<Team> team = new (writePerm: NetworkVariableWritePermission.Owner);

0 commit comments

Comments
 (0)