This AI is still in early stages of development.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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

 

Syntax

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:

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

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

Display message when team defeated
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
}
Availability STABLE

Requires:

Contents

Jump to:

See also

Related articles:

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).

 

  • No labels