eventPlayerDefeated()

A global event triggered when a player is defeated.

Syntax

function eventPlayerDefeated(player) {
  // code to run when player dies
}

Parameters

Parameter	Type	Mandatory	Notes	API Version
player	Players Object		The players object associated with the player that was 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 any caches invalidate). If you want to force a periodical check, set a timer as follows:

Force state check every 2 seconds

function checkPlayerStates() {
  void Players.alive; // will cause applicable events to be triggered
}
setTimer("checkPlayerStates", 2000); // check every 2 seconds

Example

Display message when player defeated

function eventPlayerDefeated(player) {
  console(""+player+" has been defeated");
  // maybe now would be a good time to claim their oil?
  // or mop up any remaining buildings they have (eg. research labs)
}

Availability STABLE

Requires:

Warzone 3.1 or above
Players 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).

EggPlant AI