Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Excerpt |
---|
A global event triggered when a team is defeated (all it's players defeated). |
Syntax
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
function eventTeamDefeated(team) { // code to run when team is defeated } |
Parameters
Parameter | Type | Mandatory | Notes | API Version |
---|---|---|---|---|
team | Object | An object containing two properties:
The object has two methods:
| 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 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
Div | ||||
---|---|---|---|---|
| ||||
ContentsJump to:
|
Div | ||
---|---|---|
| ||
See alsoRelated articles:
|
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Players APITopics:
|