diff --git a/docs/modules/mechanics/actions-triggers.mdx b/docs/modules/mechanics/actions-triggers.mdx index 6810ea0d..e15b1b37 100644 --- a/docs/modules/mechanics/actions-triggers.mdx +++ b/docs/modules/mechanics/actions-triggers.mdx @@ -25,7 +25,7 @@ In the future, some features that are currently used in Kits may be transferred - A single Action. + A group of actions running in a sequence. @@ -39,6 +39,12 @@ In the future, some features that are currently used in Kits may be transferred A message that is sent to the player. + + + + + A sound that is played for the player. + @@ -96,7 +102,7 @@ In the future, some features that are currently used in Kits may be transferred - An ID. + Unique identifier used to reference this action from other places in the XML. String @@ -105,7 +111,7 @@ In the future, some features that are currently used in Kits may be transferred - Runs the filter against a certain query. + Sets the scope target an action should operate against. , , @@ -156,7 +162,7 @@ In the future, some features that are currently used in Kits may be transferred - An ID. + Unique identifier used to reference this switch-scope from other places in the XML. String @@ -165,7 +171,7 @@ In the future, some features that are currently used in Kits may be transferred - Runs the filter against a new query. + Specify the scope of the inner action. , , @@ -174,7 +180,12 @@ In the future, some features that are currently used in Kits may be transferred - The previously defined query. + Specify the scope outside of an action. +
+ + In some cases, this can be omitted as PGM will automatically infer the outer scope. + + , , @@ -207,7 +218,7 @@ In the future, some features that are currently used in Kits may be transferred > Property - The text that will be sent to a player. + The text that will be sent in the chat to a player. Formatted Text @@ -216,7 +227,7 @@ In the future, some features that are currently used in Kits may be transferred - + Property - The title text. + The text above the hotbar. Formatted Text @@ -234,7 +245,7 @@ In the future, some features that are currently used in Kits may be transferred - + Property - The subtitle text. + The title text that will appear in the center of the player's screen. Formatted Text @@ -252,7 +263,7 @@ In the future, some features that are currently used in Kits may be transferred - + Property - The text above the hotbar. + The subtitle text that will appear below the title text. Formatted Text @@ -272,7 +283,7 @@ In the future, some features that are currently used in Kits may be transferred - How long the text will fade in. + How long the title and subtitle text will fade in. Time Period @@ -282,7 +293,7 @@ In the future, some features that are currently used in Kits may be transferred - How long the text will display for. + How long the title and subtitle text will display for. Time Period @@ -292,7 +303,7 @@ In the future, some features that are currently used in Kits may be transferred - How long the text will fade out. + How long the title and subtitle text will fade out. Time Period @@ -302,6 +313,65 @@ In the future, some features that are currently used in Kits may be transferred +### Sound Attributes + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionValueDefault
+ + Allows you to reuse a pre-existing sound with predefined volume and pitch. + Sound Presets + + +
+ + The sound type that will be played for a player. + Sound Keys +
+ + How loud or quiet a sound should be. + Number + 1.0
+ + The tone of the sound. + Number + 1.0
+
+ ### Set Attributes
@@ -318,7 +388,10 @@ In the future, some features that are currently used in Kits may be transferred - Required The variable to update. + + Required + The variable to update. + Variable @@ -327,7 +400,9 @@ In the future, some features that are currently used in Kits may be transferred - Required Sets a new value for the variable. + + Required + Sets a new value for the variable. String @@ -370,6 +445,7 @@ In the future, some features that are currently used in Kits may be transferred Attribute Description Value + Default @@ -377,10 +453,21 @@ In the future, some features that are currently used in Kits may be transferred - The region to fill in. + + + Property + + Required + The region to fill in. Multiple regions will be treated + as an union. + Region + @@ -392,6 +479,7 @@ In the future, some features that are currently used in Kits may be transferred Single Material Pattern + @@ -401,6 +489,7 @@ In the future, some features that are currently used in Kits may be transferred Filter + @@ -413,6 +502,7 @@ In the future, some features that are currently used in Kits may be transferred true/false + false @@ -550,7 +640,7 @@ trigger an Action. - Runs the filter against a certain query. + Specify the scope for which to test the filter. , , @@ -575,7 +665,7 @@ _Example_ - diamond + @@ -602,29 +692,29 @@ in order to use `/action`. See [Commands](/docs/commands/main) for more details. ``` - - - - - - - + + + + + + + - - - - - + + + + + - + - - 1 + + 1 ``` diff --git a/docs/reference/misc/colors.mdx b/docs/reference/misc/colors.mdx index fb042420..06bebf86 100644 --- a/docs/reference/misc/colors.mdx +++ b/docs/reference/misc/colors.mdx @@ -3,20 +3,31 @@ id: colors title: Dye Colors --- -Dye color names are used to define a wools color on [CTW](/docs/modules/objectives/ctw) maps and the dyes hex color can be used to color armor. Teams are created with the chat color names defined in [formatting](/docs/reference/misc/formatting#chat-colors). +Dye color names are used to define a wool's color on [Capture the Wool (CTW)](/docs/modules/objectives/ctw) and a flag's color on [Capture the Flag (CTF)](/docs/modules/objectives/ctf) maps. +The dye's HEX color can be used to color leather armor. +Teams are created with the chat color names defined in [Text Formatting](/docs/reference/misc/formatting#chat-colors). +However, you can use the `dye-color` attribute to force a specific dye color for an individual team.
- - + + + + @@ -26,6 +37,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -35,6 +50,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -44,6 +63,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -53,6 +76,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -62,6 +89,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -71,6 +102,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -80,6 +115,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -89,6 +128,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -98,6 +141,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -107,6 +154,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -116,6 +167,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -125,6 +180,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -134,6 +193,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -143,6 +206,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + @@ -152,6 +219,10 @@ Dye color names are used to define a wools color on [CTW](/docs/modules/objectiv + diff --git a/docs/reference/misc/sounds.mdx b/docs/reference/misc/sounds.mdx new file mode 100644 index 00000000..968673a3 --- /dev/null +++ b/docs/reference/misc/sounds.mdx @@ -0,0 +1,164 @@ +--- +id: sounds +title: Sound Presets +--- + +Sounds are used to draw a player's attention to certain events on a map. PGM comes with several preset sounds that can be quickly used for scenarios. +It can be used in combination with other actions, as defined in [Actions & Triggers](/docs/modules/mechanics/actions-triggers#sound-attributes). + +
+
Color NameHex ColorHex Firework Color + + Damage Value + Armor HEX ColorFirework HEX Color
WHITE + ■ + 0 +
ORANGE + ■ + 1 +
MAGENTA + ■ + 2 +
LIGHT_BLUE + ■ + 3 +
YELLOW + ■ + 4 +
LIME + ■ + 5 +
PINK + ■ + 6 +
GRAY + ■ + 7 +
SILVER + ■ + 8 +
CYAN + ■ + 9 +
PURPLE + ■ + 10 +
BLUE + ■ + 11 +
BROWN + ■ + 12 +
GREEN + ■ + 13 +
RED + ■ + 14 +
BLACK + ■ + 15 +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Sound TypeDescriptionDefault VolumeDefault Pitch
CUSTOM + Note pling; fallback sound when no sound are defined. + + + + +
TIP + Used for Tip broadcast messages. + + + + +
ALERT + High-pitched note pling; used for Alert broadcast messages. + + + + +
PORTAL + Used for Portals. + + + + +
SCORE + Used when the player enters a Score Box. + + + + +
+ OBJECTIVE_FIREWORKS_FAR +
+ OBJECTIVE_FIREWORKS_TWINKLE + 		+ Used for Destroyables when is enabled. + + + + +
OBJECTIVE_GOOD + Used when the player's team completes or captures an objective. + + + + +
OBJECTIVE_BAD + Used when the enemy team completes or captures an objective. + + + + +
OBJECTIVE_MODE + Used when Monument Modes are triggered. + + + + +
DEATH_OWN + Used when the player or a teammate dies during a match. + + + + +
DEATH_OTHER + Used when an enemy player dies during a match. + + + + +
+
+ +Copied from: [Kyori Adventure docs - Sound](https://docs.advntr.dev/sound.html) + +### Sound Keys + +A list of sound keys available in Minecraft 1.8 can be found on [Minecraft Wiki - Sounds.json](https://minecraft.wiki/w/Sounds.json/Java_Edition_values_before_1.9). \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index d4e2cc0b..772031a3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -97,6 +97,7 @@ const sidebars = { "reference/misc/formatting", "reference/misc/objective-names", "reference/misc/colors", + "reference/misc/sounds", "reference/misc/time-periods", ], },