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

addBeacon()

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

 

Syntax

addBeacon(x, y, to[, message]);

Parameters

ParameterTypeMandatoryNotesGame Version
xNumber(tick)The x co-ordinate of the beacon.3.2
yNumber(tick)The y co-ordinate of the beacon.3.2
to

Number

Constant

(tick)

The player id who the beacon is for.

Alternatively you can send the beacon to all ALLIES.

3.2
messageString(error)An optional message to send with the beacon.3.2

Return values

ValueTypeNotesGame Version
trueBooleanIndicates the beacon was successfully added.3.2
falseBooleanIndicates the beacon did not get added. (why??)3.2
<error>ErrorInvalid parameters.3.2

Example

function eventObjectSeen(sensor, gameObject) {
	addBeacon(gameObject.x, gameObject.y, ALLIES, "I just spotted a "+gameObject.name);
}
Availability 3.2+

Requires:

  • Warzone 3.2 or above
Contents

Jump to:

See also

Related articles: