| Excerpt |
|---|
An array of Player objects describing each human/AI player slot on the current map regardless of whether those slots have been assigned players for the current game. |
Overview
By inspecting the player data stored in this array, you can determine some useful information about your opponents/allies. For example, what colour or difficulty was set on the game set-up screen?
Players Panel or the .ini file that defined the game settings?
Note: Reordering players in the list changes their start position, not their player ID.
There can be up to 10 "normal" – human (human or AI bot (eg. Nexus, Semperfi, NullBot, etc) – players ) players in a game and, optionally, a Scavenger player.an additional scavengers player.
| Note |
|---|
The Scavenger Faction is not listed in the playerData array, and it's player ID will always be ≥maxPlayers. You can get the ID of the scavenger faction using scavengerPlayer. As such, it's not possible to determine the colour, etc., for the scavengers faction. |
If a player slot is "Closed" (no player assigned) on the game set-up screen, they or "Empty", it will still be included in the playerData array – so you cannot assume that each of the players listed in the array are active players.
Properties
The Scavenger player does not appear in the playerData array and does not have a player object.
See scavengers and scavengerPlayer globals for more information on working with Scavengers..
When players are defeated, they do not get removed from the array.
Properties
| Property | Type | Notes | Game Version |
|---|---|---|---|
| <N> | Player object | The numeric element indexes in the array represent the player IDs. So, playerData[me] gives the player object for the player associated with your script, playerData[0] is the player object for player #0, etc.Note: Not the same as a map position! Example: Player 2 might be in map position 0. The "position" property of a player object states which map position a player is inPlayer IDs are set based on the order in which a player joins the game, not the order in which they appear on the Players Panel. The order they appear in the players panel defines their startPositions[]. The human game host is always player ID 0. | 3.1 |
| .length | Number | The number of "normal" players in the game (same value as maxPlayers). Players are zero-indexed, so if a game as 4 players the <n> elements would be numbered 0..3, etc. | 3.1 |
The playerData array is a normal array and thus inherits all standard methods and properties of the Javascript Array class.
Examples
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
playerData.forEach( function get(data, player) {
// player = player id
// data = Player object containing info about that player
}); |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Available since:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||
|---|---|---|
| ||
See alsoRelated API features:
You might also like:
|