(info) This AI is still in early stages of development.

Players.me

Owned by Aubergine
Last updated: Nov 08, 2012Version comment
1 min read
Returns the player object associated with your script.

 

Syntax

var myObj = Players.me; // returns my players object

Return value

The Players Object associated with your script.

Notes

This will always return the Players Object associated with player me, in other words the player your script is bound to.

If your script is associated with a human player (eg. rules.js) remember that the human can use the Debug Menu to switch to another player, but the value of me will remain unchanged. If you want the player object of the player the human is currently controlling, use Players[selectedPlayer] instead (see example below).

Example

Get players object associated with my script
// players object associated with your script
var myObj = Players.me;
 
// players object for whichever player the local human is looking at
var localHumanObj = Players[selectedPlayer];
Availability STABLE

Requires:

Contents

Jump to:

See also

Related articles:

  • Player Scripts – which scripts are associated with which players?
  • me – the player ID associated with your script
  • selectedPlayer – the player ID that the localhost human is currently controlling

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).