Other great resources: Official JS API docs, Scripting Forum
eventBeacon()
- Aubergine
Owned by Aubergine
This event is triggered each time a new beacon is received.
Â
Syntax
function eventBeacon(x, y, sender, to[, message]) { // do stuff }
Parameters
Parameter | Type | Mandatory | Description |
---|---|---|---|
x | Number | The x co-ordinate of the beacon. | |
y | Number | The y co-ordinate of the beacon. | |
sender | Number | The id of the player who sent the beacon. | |
to | Number Constant | The id of the player who received the beacon. Or ALLIES if sender sent to allies. | |
message | String | 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:
- eventBeaconRemoved() – triggered when a beacon is removed
- addBeacon() – send a beacon to a player or allies
- removeBeacon() – remove beacons sent to a player or allies
Â