isPlayerAlive()

Syntax

var alive = isPlayerAlive(playerID);

Parameters

Parameter	Type	Mandatory	Notes	API Version
playerID	Number		The ID of the player that is to be checked.	1.0

Return value

Notes

The isPlayerAlive() function is not cached and does not check to see if a player is a spectator or empty slot. As such, it is recommended that you use Players Objects to determine if a player is alive as it will be quicker and more accurate:

var alive = Players[playerID].isAlive;

Redefining isPlayerAlive()

You can define a custom isPlayerAlive() function if desired, using the following syntax:

// must be *after* including Define API
 
Define("isPlayerAlive", function isPlayerAlive(playerID) {
  // return true if alive, false if dead
});
 
// and *before* including Players API

The Players API will use your custom function instead of its own if the function is defined as specified in the code above.

If no custom function has been defined prior to including the Players API, a default definition is created in accordance with standard game rules: A player is deemed to be living if they have either a FACTORY or a CYBORG_FACTORY or a DROID.

For reference, the default definition uses code similar to that shown below to determine if a player is alive:

if (typeof countDroid == "function") { // WZ 3.2+
  return (countStruct(FACTORY, playerID)
       || countStruct(CYBORG_FACTORY, playerID)
       || countDroid(playerID));
} else { // WZ 3.1
  return (enumStruct(playerID, FACTORY).length
       || enumStruct(playerID, CYBORG_FACTORY).length
       || enumDroid(playerID).length);
}