This module is used to specify the teams used in the match and what their attributes are. Matches without teams can be setup with the players module.
The soft player limit for each team is set with the max="" attribute and the hard limit with max-overfill. If max overfill is not explicitly defined the default will be set to 25% over the maximum team size. Players will not be able to join teams once the max overfill team size is reached.
The team’s name is specified inside the <team> element. The name should be kept as short as possible and not contain “Team”, for example, “Azure” and not “Azure Team”.
A team’s plural attribute specifies if the team name is plural, e.g. “Attackers”; PGM will use this to pick appropriate win messages, etc. The show-name-tags attribute specifies who can see player name tags, this only applies to players, observers will always see all name tags.
It is common for maps to only have 2 teams, although more are possible it usually just causes confusion.
| Teams Element | Description | |
|---|---|---|
<teams> </teams>
|
The teams node, containing all the individual teams. | |
| Sub-elements | Value/Children | |
<team> </team>
|
A single team node containing the teams name. | String |
| Attribute | Description | Value |
|---|---|---|
id
|
Unique identifier used to reference teams from other places in the XML. | String |
color
|
The team's display color. | Chat Color Name |
overhead-color
|
The color of a player's name tag on this team. | Chat Color Name |
plural
|
The team's name is plural, used in status messages.
e.g., Defenders win! instead of Defenders wins!
|
true/false |
show-name-tags
|
Specify who can see the name tags of players in this team.
Accepts: true, false, allies or enemies
|
Enum |
min
|
Required amount of players for this team. | Number |
max
|
Maximum players for this team, normal players cannot join the team once it reaches this size.
Premium players may join over this limit until max-overfill is reached.
|
Number |
max-overfill
|
Maximum players hard limit for this team, nobody can join the team once this limit is reached.
Must be greater than the defined max.
|
Number |
XML Documentation
<teams>
<team id="red-team" color="dark red" max="50" max-overfill="70">Red</team>
<team id="blue-team" color="blue" max="50" max-overfill="70">Blue</team>
</teams>
The total maximum number of players in the example given above is 100, however, the max overfill will allow up to 140 players. Servers currently have a player limit of 150, so 100 players in total would allow 50 observers, or 10 observers if teams are at max overfill.