` | The gamemode(s) of this map. If this is not specified the map will set the gamemode(s) to whatever modules are used. | Gamemode ID |
```xml
@@ -66,7 +66,7 @@ There can be multiple authors and contributors to a map.
The contribution attribute should be used to specify what their contribution to the map was.
A player's name should **not** be used to credit them, instead their UUID should be used.
-A UUID is a unique user identifier that is used to keep track of players even if they change their name.
+A UUID is a universally unique identifier that is used to keep track of players even if they change their name.
You can check player UUIDs at [mcuuid.net](https://mcuuid.net/).
If an author or contributor is defined without a UUID, that player will not get any mapmaker perks on the map.
@@ -85,7 +85,7 @@ If an author or contributor is defined without a UUID, that player will not get
| Attribute | Description | Value |
|---|---|---|
| `uuid` | The UUID used to identify a Minecraft player. | String |
- | `contribution` | The contribution this author or contributor made to the map. | String |
+ | `contribution` | A description of the contribution this author or contributor made to the map. | String |
```xml
@@ -148,13 +148,13 @@ Additionally, a variant can also contain constants, which allows you to define t
| ` ` | A map variant. | String |
-#### Variant Attributes
+##### Variant Attributes
| Attribute | Description | Value | Default |
|---|---|---|---|
| `id` | RequiredUnique identifier used to reference this map variant from other places in the XML. | String |
- | `world` | Specify the world the variant should use during a match. | String |
+ | `world` | The world the variant should use during a match. | String |
| `override` | Toggle if the variant name should override the base map name. If set to false, PGM will append `: [variant]` to the base map name. | true/false | false |
@@ -167,7 +167,7 @@ Additionally, a variant can also contain constants, which allows you to define t
| ` ` | Apply an XML section for all variants except for a specific variant when loaded. | XML Modules |
-#### If/Unless Conditional Attributes
+##### If/Unless Conditional Attributes
| Attribute | Description | Value |
@@ -192,7 +192,7 @@ PGM will search and replace any corresponding placeholders (`${constant_id}`) wi
| ` ` | An individual constant. | String |
-#### Constant Attributes
+##### Constant Attributes
| Attribute | Description | Value | Default |
@@ -250,33 +250,34 @@ This means that a map that uses destroyables and flags would be displayed as "DT
| ID | Description |
|---|---|
- | `ad` | Attack/Defend |
| `arcade` | Arcade |
+ | `ad` | Attack/Defend |
| `bedwars` | Bed Wars |
| `blitz` | Blitz |
| `br` | Blitz: Rage |
| `bridge` | Bridge |
- | `cp` | Control the Point |
| `ctf` | Capture the Flag |
| `ctw` | Capture the Wool |
+ | `cp` | Control the Point |
+ | `tdm` | Deathmatch |
| `dtc` | Destroy the Core |
| `dtm` | Destroy the Monument |
- | `ffa` | Free for All |
+ | `5cp` | 5 Control Points |
| `ffb` | Flag Football |
+ | `ffa` | Free for All |
| `infection` | Infection |
| `kotf` | King of the Flag |
| `koth` | King of the Hill |
| `mixed` | Mixed |
| `payload` | Payload |
- | `rage` | Rage |
| `rfw` | Race for Wool |
+ | `rage` | Rage |
| `scorebox` | Scorebox |
| `skywars` | Skywars |
| `sg` | Survival Games |
- | `tdm` | Deathmatch |
-Example
+##### Example
```xml
diff --git a/docs/modules/information/broadcasts.mdx b/docs/modules/information/broadcasts.mdx
index 7a83cbe8..0490c9ca 100644
--- a/docs/modules/information/broadcasts.mdx
+++ b/docs/modules/information/broadcasts.mdx
@@ -42,7 +42,7 @@ It should not be used for generic server-related messages.
| Element | Description | Value |
|---|---|---|
- | `` | PropertyDuration to wait after the match starts to show the message. | [Filters](/docs/modules/mechanics/filters) |
+ | `` | PropertyFilter if the broadcast message should be sent after the duration has passed, or if it is skipped. | [Filters](/docs/modules/mechanics/filters) |
### Examples
diff --git a/docs/modules/mechanics/actions-triggers.mdx b/docs/modules/mechanics/actions-triggers.mdx
index 51d7415e..374d05c2 100644
--- a/docs/modules/mechanics/actions-triggers.mdx
+++ b/docs/modules/mechanics/actions-triggers.mdx
@@ -1,6 +1,7 @@
---
id: actions-triggers
title: Actions & Triggers
+toc_max_heading_level: 4
---
Actions are a set of features that are applied to players, teams, or matches, similiar to [Kits](/docs/modules/gear/kits).
@@ -23,7 +24,11 @@ In the future, some features that are currently used in Kits may be transferred
| `
` | Removes entities based on a filter. |
| `
` | Applies a [Kit](/docs/modules/gear/kits). |
| `
` | Places blocks in a block-bounded region. |
+ | `
` | Places a structure at a specified location when triggered. |
| `
` | Finds and replaces certain items. |
+ | `
` | Allow players to pay with items in their inventory to trigger an action. |
+ | `
` | A player-scoped kit that applies velocity to the player. |
+ | `
` | Teleport a player to a specific location. |
+ | Element | Description | Value |
+ |---|---|---|
+ | `` | A list of replacements.
**Note:** In the future, more replacements such as player names will be supported. | Replacements Sub-elements |
+
+ | Sub-element | Description |
+ |---|---|
+ | `` | A numerical placeholder. |
+
+
+##### Decimal Attributes
+
+
+ | Attribute | Description | Value |
+ |---|---|---|
+ | `id` | Unique identifier used to reference this decimal from other places in the XML. | String |
+ | `value` | RequiredThe variable this decimal should evaluate. It can be used with formulas. | Expression |
+ | `format` | Customize how the decimal should be displayed, e.g. `#.00`. | [Java DecimalFormat pattern](https://docs.oracle.com/javase/8/docs/api/java/text/DecimalFormat.html) |
+
+
### Sound Attributes
@@ -78,7 +105,8 @@ In the future, some features that are currently used in Kits may be transferred
| Attribute | Description | Value |
|---|---|---|
| `var` | RequiredThe variable to update. | [Variable](/docs/modules/mechanics/variables) |
- | `value` | RequiredSets a new value for the variable. | String |
+ | `index` | If setting an array-type variable, the expression to be evaluated.
*Required when using array-type variables.* | Expression |
+ | `value` | RequiredSets a new value for the variable. | Expression |
### Kill-Entities Attributes
@@ -96,23 +124,77 @@ In the future, some features that are currently used in Kits may be transferred
|---|---|---|---|
| `region` | PropertyRequiredThe region to fill in. Multiple regions will be treated as an union. | [Region](/docs/modules/mechanics/regions) |
| `material` | RequiredThe filling material. | [Single Material Pattern](/docs/reference/items/inventory#material-matchers) |
- | `filter` | Filters which blocks get affected. *May impact preformace for large fills.* | [Filter](/docs/modules/mechanics/filters) |
- | `events` | Calls events for block placements and removals, which will make it affected by other filters and PGM features. *May impact preformace for large fills.* | true/false | false |
+ | `filter` | Filters which blocks get affected. *May impact performance for large fills.* | [Filter](/docs/modules/mechanics/filters) |
+ | `events` | Calls events for block placements and removals, which will make it affected by other filters and PGM features. *May impact performance for large fills.* | true/false | false |
-### Replace Item Attributes/Elements
+### Paste-Structure Attributes
| Attribute | Description | Value |
|---|---|---|
- | `` | The item to find. | [Item Attributes](/docs/modules/gear/items#item-attributes) |
+ | `x` | The X coordinate of the location to paste the structure, measured in east-west. | Expression |
+ | `y` | The Y coordinate of the location to paste the structure, measured in altitude. | Expression |
+ | `z` | The Z coordinate of the location to paste the structure, measured in north-south. | Expression |
+ | `structure` | The structure to paste. | [Structure ID](/docs/modules/blocks/structures) |
+
+
+### Replace Item
+
+#### Sub-elements
+
+
+ | Sub-elements | Description | Value |
+ |---|---|---|
+ | `` | The item to find in a player's inventory. | [Item Attributes](/docs/modules/gear/items#item-attributes) |
| `` | The new item to replace with. | [Item Attributes](/docs/modules/gear/items#item-attributes) |
+
+
+#### Attributes
+
+
+ | Attribute | Description | Value |
+ |---|---|---|
| `keep-amount` | Player recives the same amount of the new item as they had of the old item. | true/false |
| `keep-enchants` | Enchantments on the old item will be applied to the new item. | true/false |
| `ignore-metadata` | Filters which entities to remove. | true/false |
| `amount` | Match for item stacks that have a certain amount of items in a range. | Range |
+### Take-Payment
+
+#### Sub-elements
+
+
+ | Sub-elements | Description | Value |
+ |---|---|---|
+ | `
` |
PropertyRequiredAn individual payment. | [Item Attributes](/docs/modules/gear/items#item-attributes) |
+ | `
` |
PropertyThe action to trigger upon a successful payment. |
Action |
+ | `
` |
PropertyThe action to trigger upon a failed payment. |
Action |
+
+ | Attribute | Description | Value |
+ |---|---|---|
+ | `material` | RequiredThe item to display as an icon. | [Material Name](/docs/reference/items/inventory#material-matchers) |
+ | `price` | The amount of a currency needed to purchase. | Number |
+ | `currency` | The currency needed to purchase. | [Filter](/docs/modules/mechanics/filters) |
+
+
+### Velocity & Teleport Attributes
+
+
+ | Attribute | Description | Value |
+ |---|---|---|
+ | `x` | The X coordinate, measured in east-west. | Expression |
+ | `y` | The Y coordinate, measured in altitude. | Expression |
+ | `z` | The Z coordinate, measured in north-south. | Expression |
+ | `yaw` | The horizontal angle a user looks to. | Expression |
+ | `pitch` | The vertical angle a user looks to. | Expression |
+
+
## Trigger Element
The trigger element waits for a dynamic filter to activate it, and afterwards it will trigger an action.
@@ -168,7 +250,7 @@ This example uses the `expose` attribute in Action to allow moderators to enable
a "Blitz Mode" using the `/action` command. Moderators must have the `GAMEPLAY` permissions
in order to use `/action`. See [Commands](/docs/commands/main) for more details.
-```
+```xml
diff --git a/docs/modules/mechanics/damage.mdx b/docs/modules/mechanics/damage.mdx
index b55df417..a25af5c6 100644
--- a/docs/modules/mechanics/damage.mdx
+++ b/docs/modules/mechanics/damage.mdx
@@ -27,8 +27,8 @@ The difficulty level can be set to `peaceful`, `easy`, `normal`, or `hard`. The
### Hunger
-Specify if a player can starve to death, usually used with the difficulty setting.
-This can also be accomplished with the `naturalRegeneration` [gamerule](/docs/modules/mechanics/gamerules).
+Specify if a player can starve to death, usually used with the difficulty setting.
+This can also be accomplished with the [`naturalRegeneration` gamerule](/docs/modules/mechanics/gamerules).
```xml
@@ -94,6 +94,14 @@ While almost every form of damage can be disabled safely, it is recommended that
| ` ` | The damage type that is disabled. | [Damage Cause](#damage-causes) |
+#### Damage Attributes
+
+ | Attribute | Description | Value |
+ |---|---|---|
+ | `attacker-action` | The action to trigger for the attacker. | [Action ID](/docs/modules/mechanics/actions-triggers) |
+ | `victim-action` | The action to trigger for the victim. | [Action ID](/docs/modules/mechanics/actions-triggers) |
+
+
_Example_
```xml
@@ -103,6 +111,15 @@ _Example_
```
+```xml
+
+
+
+ explosion
+
+
+```
+
#### Block Explosion Attributes
The `BLOCK_EXPLOSION` damage cause has several extended attributes to customize who/what gets damaged. Only attributes with `false` as the value need to be explicitly defined since all attributes default to `true`.
diff --git a/docs/modules/mechanics/spawns.mdx b/docs/modules/mechanics/spawns.mdx
index 432f3a01..1cc15afd 100644
--- a/docs/modules/mechanics/spawns.mdx
+++ b/docs/modules/mechanics/spawns.mdx
@@ -140,7 +140,7 @@ If a player has a bed spawn location set, it overrides all other spawn regions f
| `auto` | Automatically respawn the player after the delay time has elapsed. | true/false | false |
| `blackout` | Dead players get a blindness effect applied. | true/false | false |
| `spectate` | Allow dead players to fly around. | true/false | false |
- | `bed` | N/AAllow players to respawn from beds. | true/false | false |
+ | `bed` | N/AAllow players to respawn from beds. | true/false | false |
| `message` | PropertyMessage to display on the respawn screen to respawning players. | Formatted Text |
diff --git a/docs/modules/mechanics/tracking-compass.mdx b/docs/modules/mechanics/tracking-compass.mdx
new file mode 100644
index 00000000..625b2190
--- /dev/null
+++ b/docs/modules/mechanics/tracking-compass.mdx
@@ -0,0 +1,65 @@
+---
+id: tracking-compass
+title: 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 |
+ |---|---|
+ | `
` | Node containing all compass properties used in this map. |
+
+ | Sub-element ||
+ |---|---|
+ | `
` | An individual compass property pointing to the nearest player passing a filter. |
+ | `` | An individual compass property pointing to a specific flag. |
+
+ | 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](/docs/modules/mechanics/filters) |
+ | `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](/docs/modules/mechanics/filters) |
+ | `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 `
` sub-element. | true/false | false |
+
+ | Attribute | Description | Value |
+ |---|---|---|
+ | `id` | Unique identifier used to reference this array-type variable from other places in the XML. | String |
+ | `size` | RequiredThe size of this array. | 1 - 1024 |
+
+
### With-Team Attributes
@@ -45,6 +56,15 @@ You can define as many variables as you want and all variables must have a scope
| `team` | The team to target. | [Team ID](/docs/modules/format/teams#team-attributes) |
+### Player-Location Attributes
+
+
+ | Attribute | Description | Value |
+ |---|---|---|
+ | `id` | Unique identifier used to reference this player-location variable from other places in the XML. | String |
+ | `component` | The player's location component to target. `XYZ`, `YAW`, and `PITCH` represents the player's position/angle, `DIR_XYZ` represents the player's direction, and `VEL_XYZ` represents the player's velocity. | `X`, `Y`, `Z`, `PITCH`, `YAW`,
`DIR_X`, `DIR_Y`, `DIR_Z`,
`VEL_X`, `VEL_Y`, and `VEL_Z` |
+
+
## Examples
### Setting Variables
diff --git a/docs/modules/objectives/scoring.mdx b/docs/modules/objectives/scoring.mdx
index cf305d24..6ddebafe 100644
--- a/docs/modules/objectives/scoring.mdx
+++ b/docs/modules/objectives/scoring.mdx
@@ -61,7 +61,7 @@ A score box will give points to a players team when they enter or bring a redeem
| `silent` | Do not notify players when points are scored in this box. | true/false | false |
| `region` | PropertyRequiredThe location and size of the score box. | [Region](/docs/modules/mechanics/regions) |
| `filter` | PropertyFilter who can score in this box. | [Filter](/docs/modules/mechanics/filters) | No Filter |
- | `trigger` | PropertyDynamic conditions under which this score box is applied. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) |
+ | `trigger` | N/APropertyDynamic conditions under which this score box is applied. | [Dynamic Filter](/docs/modules/mechanics/filters#dynamic-filters) |
#### Box Sub-elements
diff --git a/docusaurus.config.js b/docusaurus.config.js
index c5f5d7f4..b4009ac0 100644
--- a/docusaurus.config.js
+++ b/docusaurus.config.js
@@ -86,7 +86,7 @@ const config = {
announcementBar: {
id: 'new_features',
content:
- 'New Features: Consumables, Map Variants, Constants, and Structures',
+ 'New Features: Tracking Compass, Consumables, Map Variants, and Constants',
backgroundColor: '#fafbfc',
textColor: '#091E42',
isCloseable: true,
diff --git a/sidebars.js b/sidebars.js
index 9f9917a5..12175f6e 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -53,7 +53,8 @@ const sidebars = {
"modules/mechanics/lanes",
"modules/mechanics/damage",
"modules/mechanics/gamerules",
- "modules/mechanics/spawners",],
+ "modules/mechanics/spawners",
+ "modules/mechanics/tracking-compass"],
},
{
type: 'category',