The indexes in the array are sequential and not based on player IDs.
Uses caching to boost performance. The cache is automatically invalidated every game tick. See Cache API for details.
Example
Iterating through allies
Players.allies.forEach(function(ally) {
// ally = players object for current ally
// ally.id = id of allied player
});
Check if specific player is an ally
// you could do this:
var isAlly = allianceExistsBetween(me, playerID);
// but it won't filter out spectators or vacant slots
// this, on the other hand, does filter them out:
var isAlly = Players[playerID].isAlly;
// if you want to know if they are living ally:
var isLivingAlly = Players[playerID].isAlly && Players[playerID].isAlive;
isSpectator() — A global function that performs a basic, un-cached check to determine if a player is a spectator based on presence of a Satellite Uplink at the start of the game.
Players[] — Main interface to Players API and an array of all players in the game, including Scavengers.
Players.alliesAndMe[] — Returns an array of players objects for living allied players, including me.
Players.alive[] — Returns an array of players objects for living players.
Players.allies[] — Returns an array of players objects for living allied players.