Proximity Alarms

Proximity Alarms can be used to alert players when an enemy enters a specified area. Flares will go off around the protected area, with the color of the detected player's team, and all allied players will receive an alert message with sound.

If the <notify> subelement is not defined, the proximity-alarm message is sent only to players who cannot be detected, i.e. those who do not match the detection filter. If the <detect> attribute is missing no message will be sent, which means that only players who can see or hear the flares will know when the alarm is tripped.

Flares will only be set off if a flare-radius="" is defined. If this attribute is missing a message must be specified to alert players. This is how the alarm can be made "silent", so that enemies may not realize that they have been detected.

Element	Description
<proximity-alarms> </proximity-alarms>	Node containing this map's proximity-alarms.

Sub-elements		Value/Children
<proximity-alarm>	An individual proximity-alarm node.	Proximity-alarm Sub-elements

Proximity-alarm Attributes

Attribute	Description	Value
region	PropertyRequiredThe region this alarm applies to.	Region
message	The message to show in chat when a player is detected.	Formatted Text
flare-radius	The radius of the circular area to show flares in, centered on the proximity-alarm region.	Number

Proximity-alarm Sub-elements

Element	Description	Value/Children
<region>	PropertyRequiredThe region this alarm applies to, treated as a region union.	Regions
<detect>	Filter who gets detected by the proximity alarm.	Filter
<notify>	Filter who gets notified by the proximity alarm.	Filter

Examples

<proximity-alarms>
    <proximity-alarm message="Enemy detected at Blue monument!" flare-radius="4">
        <region>
            <cylinder base="27.5,119,-26.5" radius="7.5" height="15"/>
        </region>
        <detect>
            <team>red</team>
        </detect>
    </proximity-alarm>
</proximity-alarms>