Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

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

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
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

Code Block
themeRDark
languagejavascript
titleReply to the person who sent the message
linenumberstrue
function eventBeacon(x, y, sender, to, message) {
	console("Beacon from player +"sender+": "+message);
} 
Div
classbox
Availability
Status
colourYellow
title
Beta
3.2+

Requires:

  • Warzone 3.2 and above.
Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

See also

Related API features: