Tracking Compass

The Tracking Compass module allows you to override the vanilla compass behavior by pointing it to a player of interest. In addition, you can control how the compass selects the target to track.

Compass Element

Element	Description
<compass> </compass>	Node containing all compass properties used in this map.

Sub-element
<player>	An individual compass property pointing to the nearest player passing a filter.
<flag>	An individual compass property pointing to a specific flag.

Compass Attributes

Attribute	Description	Value	Default
order	When using DEFINITION_ORDER, the compass targets first matching target. When using CLOSEST, the compass goes through all matching targets and chooses the one closest to the player.	DEFINITION_ORDER CLOSEST
show-distance	Show the distance between the compass holder and tracked player in meters.	true/false	false

Player/Flag Attribute

Attribute	Description	Value	Default
filter	Filters who should be tracked by the compass.	Filter
holder-filter	Filters out what compass targets can be eligible for what players, e.g. a team targets a different flag than the other team.	Filter
name	The title name that describes the tracked flag or player's role, e.g. "Wool Carrier."	Formatted Text
show-player	Show the tracked player's username to the compass holder. Note: This is only applicable to <player> sub-element.	true/false	false

Examples

<compass show-distance="true">
    <player filter="always" show-player="true"/>
</compass>

<compass>
    <player filter="always" name="Wool Carrier"/>
</compass>

<compass order="DEFINITION_ORDER">
    <player filter="wool-carrier" name="Wool Carrier"/>
    <player filter="enemy" show-player="true" name="Nearest Enemy"/>
</compass>

<compass>
    <player holder-filter="red-team" filter="blue-carrier" show-player="true"/>
    <flag holder-filter="red-team">blue-flag</flag>
    
    <player holder-filter="blue-team" filter="red-carrier" show-player="true"/>
    <flag holder-filter="blue-team" name="Some other name">red-flag</flag>
</compass>