This AI is still in early stages of development.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Returns an array of players objects for living allied players, including me.

 

Syntax

var alliesAndMe = Players.alliesAndMe; // array of my + allies players objects

Return value

An array of allied Players Objects, including me, spectators and vacant slots.

If you want a similar array that excludes me, use Players.allies[] instead.

Notes

The indexes in the array are sequential and not based on player IDs.

Example

Iterating through allies
Players.alliesAndMe.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;

 

 

Availability STABLE

Requires:

Contents

Jump to:

See also

Related articles:

Players API

Topics:

  • isPlayerAlive() — A global function that performs a basic, un-cached check to determine if a player is alive.
  • eventTeamRevived() — A global event triggered when a team is revived (one or more of it's players resurrected).
  • eventPlayerDefeated() — A global event triggered when a player is defeated.
  • eventPlayerRevived() — A global event triggered when a player is revived (brought back to life).
  • Modding Players API — The Players API supports modding...
  • 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.
    • Players.refresh() — Rebuilds all Players Objects, use with care!
    • Players.dead[] — Returns an array of players objects for dead players.
    • Players.scavenger — Returns the players object associated with the Scavenger faction, even if Scavengers are disabled.
    • Players.me — Returns the player object associated with your script.
    • Players.enemies[] — Returns an array of players objects for living enemy players.
    • Players.mod() — Extend the Players API and Players Objects with your own features...
  • Players Objects — The objects returned by the Players API are enhanced versions of Player objects...
  • eventTeamDefeated() — A global event triggered when a team is defeated (all it's players defeated).

 

  • No labels