Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Migrated to Confluence 5.3
| Excerpt |
|---|
Returns an array of players objects for dead players. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var defeated = Players.dead; // array of defeated players objects |
Return value
An array of defeated Players Objects, including Scavengers (if applicable), excluding spectators and vacant slots.
Notes
The indexes in the array are sequential and not based on player IDs.
Uses caching to boost performance. The cache is automatically invalidated every game tick. See Cache API for details.
Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Players.dead.forEach(function(corpse) {
// corpse = players object for current dead player
// corpse.id = id of dead player
}); |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
// quicknote: checktreats -spectators doesn'tand checkvacant ifslots they are a spectator or vacant slot as dead var isDead = !Players[playerID].isAlive; |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||
|---|---|---|
| ||
See alsoRelated articles:
|
| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Players APITopics:
|