/
Modding Players API
This AI is still in early stages of development.
Modding Players API
Aubergine
Owned by Aubergine
The Players API supports modding...
Define "alive"...
Change the rules that define whether a player is deemed to be "alive" by providing a custom isPlayerAlive() definition.
Note: To maintain some level of consistency, the Players API will always treat spectators and vacant slots as non-living players.
Define "spectator"...
Change the rules that define whether a player is a "spectator" (observer) by providing a custom isSpectator() definition.
By default, any player slot on a map that defines a SAT_UPLINK is considered a Spectator slot.
Custom extensions
You can add accessors, properties and methods to the Players[] array and/or players objects (even specific players objects) using Players.mod().
Custom diagnostics
You can add custom diagnostics via the Diag API.
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).