(info) Other great resources: Official JS API docs, Scripting Forum

removeBeacon()

Send a beacon to a specific player or allies...

 

Syntax

removeBeacon(sentTo);

Parameters

ParameterTypeMandatoryNotesGame Version
sentTo

Number

Constant

(tick)

The player id who you had previously sent a beacon to.

Alternatively you can send the beacon to all ALLIES.

3.2

Return values

ValueTypeNotesGame Version
trueBooleanIndicates the beacon was successfully removed.3.2
falseBooleanIndicates the beacon did not get removed. (why??)3.2
<error>ErrorInvalid 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
	}
}
Availability BETA

Requires:

  • Warzone 3.2 or above
Contents

Jump to:

See also

Related articles:

  • addBeacon() – send a beacon to a player or allies
  • chat() – send chat message

Â