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

eventBeacon()

This event is triggered each time a new beacon is received.

 

Syntax

function eventBeacon(x, y, sender, to[, message]) {
  // do stuff
}

Parameters

ParameterTypeMandatoryDescription
xNumber(tick)The x co-ordinate of the beacon.
yNumber(tick)The y co-ordinate of the beacon.
senderNumber(tick)The id of the player who sent the beacon.
to

Number

Constant

(tick)

The id of the player who received the beacon.

Or ALLIES if sender sent to allies.

messageString(error)The message associated with the beacon, if applicable.

Return value

Warzone does not process the event handler return value currently.

Example

Reply to the person who sent the message
function eventBeacon(x, y, sender, to, message) {
	console("Beacon from player +"sender+": "+message);
} 
Availability 3.2+

Requires:

  • Warzone 3.2 and above.
Contents

Jump to:

See also

Related API features:

Â