Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt

A global event triggered when a team is defeated (all it's players defeated).

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
function eventTeamDefeated(team) {
  // code to run when team is defeated
}

Parameters

ParameterTypeMandatoryNotesAPI Version
teamObject(tick)

An object containing two properties:

  • .id– the team ID (number)
  • .name– the team letter (uppercase string)

The object has two methods:

  • .valueOf() – returns the id
  • .toString() – returns the name
1.0

Return value

The return value is not currently processed.

Notes

The event is not triggered for teams consisting only of spectators and/or vacant slots.

After the team is defeated, the event may lag behind a little - it's only triggered the next time a script tries to determine if the players in the team are alive (and even then only when any caches invalidate). If you want to force a periodical check, set a timer as follows:

Code Block
themeRDark
languagejavascript
titleForce state check every 2 seconds
linenumberstrue
function checkPlayerStates() {
  void Players.alive; // will cause applicable events to be triggered
}
setTimer("checkPlayerStates", 2000); // check every 2 seconds

The eventTeamDefeated() event will be triggered after the eventPlayerDefeated() event that led to the team being defeated (team state is checked whenever a player is defeated or revived).

Example

Code Block
themeRDark
languagejavascript
titleDisplay message when team defeated
linenumberstrue
function eventTeamDefeated(team) {
  // .toString() will be invoked = team.name
  console("Team "+team+" has been defeated!");
 
  // want to find out what players were in that team?
  var members = Players.filter(function(player) {
    return (player.team == team);
  });
  // members is now an array of players objects
  // associated with the players in the team
}
Div
classbox
Availability
Status
colourGreen
titleStable

Requires:

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

See also

Related articles:

Div
classbox

Players API

Topics:

Child pages (Children Display)
alltrue
depthall
pagePlayers API
excerpttrue