This AI is still in early stages of development.
A global event triggered when a player is defeated.
Syntax
function eventPlayerDefeated(playerID) {
// code to run when player dies
}
Parameters
| Parameter | Type | Mandatory | Notes | API Version |
|---|---|---|---|---|
| playerID | Number |  | The ID of the player that has just been defeated. | 1.0 |
Return value
The return value is not currently processed.
Notes
The event is not triggered for players identified as spectators or vacant slots.
After the player is defeated, the event may lag behind a little - it's only triggered the next time a script tries to determine if the player is alive (and even then only when the cache invalidates). If you want to force a periodical check, set a timer as follows:
Force state check ever second
function checkPlayerStates() {
void Players.alive; // will cause applicable events to be triggered
}
setTimer("checkPlayerStates", 1000); // check every second
Example
Display message when player defeated
function eventPlayerDefeated(playerID) {
console(""+Players[playerID]+" has been defeated");
// maybe now would be a good time to claim their oil? ;)
}
Contents
Jump to:
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).