Warzone does not process the event handler's return value.
Notes
This event is useful for retreating damaged units, or repairing damage buildings, after an enemy attacks them.
The event is "throttled", which means that it won't be called for every single attack. Instead, it will only be triggered when a cluster (group of game objects in close proximity to one another) of game objects is attacked. The victim parameter is the first object in the first object in the cluster. There is also a short delay before subsequent attacks on the same cluster will trigger the event again.
If a burning unit flees the cluster, it will start triggering the event at regular intervals until it stops burning.
If you want to micromanage units during combat consider using eventAttackedUnthrottled() instead, as it gets triggered every time a game object takes damage.
Example
Work out who our main aggressors are
// make an array to count attacks by each player
var attackers = new Array(playerData.length);
// initialise values in array
for (var i=0;i<attackers.length;i++) attackers[i] = 0;
// now monitor attacks
function eventAttacked(victim,attacker) {
// increment counter for the attacking player
attackers[attacker.player] += 1;
// find player who has attacked us most
var maxAttacks = 0;
var mainAggressor = attacker.player;
for (var i=0;i<attackers.length;i++) {
if (attackers[i]>maxAttacks) {
maxAttacks = attackers[i];
mainAggressor = i;
}
}
console("Attacked "+maxAttacks+" time(s) by player #"+mainAggressor+" ("+playerData[mainAggressor].colour+")");
}
Is attacked unit retreating?
// useful if you want to play audio messages based on what attacked droid is doing
function eventAttacked(victim) {
if (victim.type == DROID) {
switch (victim.order) {
case DORDER_RTB: {
// droid is returning to base (retreating)
break;
}
case DORDER_RTR:
case DORDER_RTR_SPECIFIED: {
// droid is returning for repairs
}
case DORDER_REARM: {
// VTOL is returning for repairs/rearming
}
}
}
}
Availability STABLE
Requires:
Warzone 3.1 Beta 1 and above.
Contents
Jump to:
See also
Related articles:
bind() – monitor when stuff that doesn't belong to you gets destroyed
Droids – summary of all API features relating to droids