Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt

Returns an array of players objects for living enemy players.

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
var enemies = Players.enemies; // array of enemy players objects

Return value

An array of enemy Players Objects, including Scavengers (if they are alive), excluding spectators and vacant slots.

Notes

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

Code Block
themeRDark
languagejavascript
titleIterating through enemies
linenumberstrue
Players.enemies.forEach(function(enemy) {
  // enemy = players object for current enemy
  // enemy.id = id of enemy player
});
Code Block
themeRDark
languagejavascript
titleCheck if specific player is an enemy
linenumberstrue
// you could do this:
var isEnemy = !allianceExistsBetween(me, playerID);
 
// but it won't filter out spectators or vacant slots
 
// this, on the other hand, does filter them out:
var isEnemy = Players[playerID].isEnemy;
 
// if you want to know if they are living enemy:
var isLivingEnemy = Players[playerID].isEnemy && Players[playerID].isAlive;

 

 

Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

See also

Related articles:

Div
classbox

Players API

Topics:

Child pages (Children Display)
alltrue
depthall
pagePlayers API
excerpttrue