Players API

Features

The API exposes a global Players[] array with the following features:

• Spectator support!
• Easily filter to living enemies, allies, etc.
• Scavengers treated as a first-class citizen
• Caching for improved performance

The Players Objects are similar to their JS API counterparts so all the usual properties are there, but they include lots of new stuff as well:

• Properties added in WZ 3.2 are backported to WZ 3.1
• The .colour and .team properties are now {id, name} objects
• .id – the ID of the player the object relates to
• .isVacant – denotes a vacant (closed) player slot
• .isSpectator – denotes the player is a spectator
• .isScavenger – denotes the player is the Scavengers faction
• .isHost – denotes the player is the game host

The API also provides a number of new events:

• eventPlayerDefeated()
• eventPlayerRevived()
• eventTeamDefeated()
• eventTeamRevived()

And, as if that wasn't enough, the API is moddable so you can customise and extend it!

Important

Due to inclusion of Scavengers, there might be gaps in the player list indexes. So, always use .forEach() to iterate over the array as it handles that scenario for you.

Players.forEach(function(player) {
  // player == players object
  // player.id == player id
});