Other great resources: Official JS API docs, Scripting Forum
removeBeacon()
Send a beacon to a specific player or allies...
Syntax
removeBeacon(sentTo);Parameters
Parameter | Type | Mandatory | Notes | Game Version |
|---|---|---|---|---|
sentTo | Number Constant | The player id who you had previously sent a beacon to. Alternatively you can send the beacon to all ALLIES. | 3.2 |
Return values
Value | Type | Notes | Game Version |
|---|---|---|---|
| Boolean | Indicates the beacon was successfully removed. | 3.2 |
| Boolean | Indicates the beacon did not get removed. (why??) | 3.2 |
<error> | Error | Invalid parameters. | 3.2 |
Example
var obj;
function eventAttacked(victim, attacker) {
if (!obj) {
obj = victim;
addBeacon(obj.x, obj.y, ALLIES, "I just got attacked"); // add beacon
}
}
function eventDestroyed(victim) {
if (victim.id == obj.id) {
obj = null;
removeBeacon(ALLIES); // remove beacon
}
}