Events and Properties

Events and properties

This page contains a list of all events and properties supported by the mod. For information on how music packs and the configuration language works, see the music packs page.

If in doubt about the values of events or properties, you can (by default) press Page Down when a world is loaded to print all current event and property values to the Minecraft logs.

Events

All events are boolean (true/false/undefined) values. Generally, there are only undefined events when no world is loaded and the concept of, e.g., @day does not currently exist.

Global events

Event	Supported AM versions	Description
`@main_menu`	$\geq$`2.0.0`	Active while on the Minecraft title screen.
`@joining`	$\geq$`2.0.0`	Active while the game is joining a world.
`@disconnected`	$\geq$`2.0.0`	Active while on the Minecraft "lost connection" screen.
`@paused`	$\geq$`2.1.0`	Active while the pause-screen is opened in a non-LAN single-player world. I.e., when the game fully stops while the pause-screen is open.
`@in_game`	$\geq$`2.0.0`	Active when the player is currently in a loaded world.
`@credits`	$\geq$`2.0.0`	Active while on the credits screen shown after defeating the Ender Dragon and leaving The End through the portal.

Time events

Event	Supported AM versions	Description
`@day`	$\geq$`2.0.0`	Active when the player cannot sleep in a bed (based on time only). Note: this event can be active at the same time as `@dusk` or `@dawn`.
`@dawn`	$\geq$`2.0.0`	Active for the first few minutes after night-time.
`@dusk`	$\geq$`2.0.0`	Active for the last few minutes before night-time.
`@night`	$\geq$`2.0.0`	Active when the player is allowed to sleep in bed (based on time only).

Weather events

Event	Supported AM versions	Description
`@downfall`	$\geq$`2.0.0`	Active when it is raining or snowing.
`@rain`	$\geq$`2.0.0`	Active when it is raining (can only happen in non-cold biomes).
`@snow`	$\geq$`2.0.0`	Active when it is snowing (can only happen in cold biomes).
`@thunder`	$\geq$`2.0.0`	Active when there is a thunderstorm.

Special location events

Event	Supported AM versions	Description
`@village`	$\geq$`2.0.0`	Active when the player is near three or more villagers (configurable in mod-config since 2.1.0).
`@ranch`	$\geq$`2.0.0`	Active when the player is near 15 or more animals (configurable in mod-config since 2.1.0).

Elevation events (2.0.0 only)

Event	Supported AM versions	Description
`@under_deepslate`	$=$`2.0.0`	Active while the player's Y-coordinate is less than 0. NOTE: From 2.1.0, use the `$elevation`-property instead.
`@underground`	$=$`2.0.0`	Active while the the current biome is "underground type" or when the player's Y-coordinate is less than 60 and the sky is not visible above the player and no sky-light reaches the player. NOTE: From 2.1.0, use the `$cave_score`-property instead.
`@high_up`	$=$`2.0.0`	Active while the player's Y-coordinate is above 150. NOTE: From 2.1.0, use the `$elevation`-property instead.

Player state events

Event	Supported AM versions	Description
`@under_water`	$\geq$`2.0.0`	Active while the player is fully submerged under water.
`@in_lava`	$\geq$`2.1.0`	Active while the player is touching lava.
`@dead`	$\geq$`2.0.0`	Active while the death-screen is visible.
`@sleeping`	$\geq$`2.0.0`	Active while the player is sleeping in a bed or similar.
`@fishing`	$\geq$`2.0.0`	Active while the player has thrown a fishing hook into water. Will stay active for four seconds (configurable since 2.1.0) after reeling in the hook or until the player starts moving.
`@drowning`	$\geq$`2.4.0`	Active while the player has no air-bubbles left. Cannot be active in creative and spectator mode.
`@on_fire`	$\geq$`2.7.0`	Active while the player is on fire.
`@in_pweder_snow`	$\geq$`2.7.0`	Active while the player is inside powder snow.

Mount-like events

Event	Supported AM versions	Description
`@minecart`	$\geq$`2.0.0`	Active while the player is in a minecart.
`@boat`	$\geq$`2.0.0`	Active while the player is in a boat.
`@horse`	$\geq$`2.0.0`	Active while the player is riding a horse.
`@donkey`	$\geq$`2.0.0`	Active while the player is riding a donkey.
`@pig`	$\geq$`2.0.0`	Active while the player is riding a pig.
`@elytra`	$\geq$`2.1.0`	Active while the player is flying using an elytra.

Combat events

Event	Supported AM versions	Description
`@is_targeted`	$\geq$`2.7.1`	Requires server support! Active while any mob is targeting the player.
`@is_fighting`	$\geq$`2.7.1`	More accurate with server support! Active while fighting any mob that is hostile to the player.
`@in_combat`	$\geq$`2.2.0`	More accurate with server support! Active while in combat, which is determined by a combination of "targeting" (if available) and "figting" mobs.
`@boss_fight`	$\geq$`2.0.0`	Active while fighting any boss (ender dragon, the wither, a raid, etc.), which is when a big health-bar is visible at the top of the screen.
`@warden_nearby`	$\geq$`2.5.0`	Active while a warden is within two chunks (32 blocks) of the player.

Properties

If in doubt, see the music packs page about the meaning of "Types".

World properties

Property	Supported AM versions	Type	Description
`$difficulty`	$\geq$`2.4.0`	`string`	The current difficulty of the game/world. Examples: `"peaceful"`, `"easy"`, `"medium"`, `"hard"`, `"hardcore"`.
`$dimension`	$\geq$`2.0.0`	`string`	The name/id of the player's current dimension. Can also be found in the F3-menu as shown in the image below. Examples: `minecraft:overworld`, `minecraft:the_end`, `minecraft:the_nether`.
`$biome`	$\geq$`2.0.0`	`string`	The name/id of the player's current biome. Can also be found in the F3-menu as shown in the image below. Examples: `minecraft:forest`, `minecraft:plains` .
`$biome_tags`	$\geq$`2.3.0`	`list<string>`	The list of all tags of the current biome. Example: `[ "minecraft:is_cold", "minecraft:is_snowy" ]`.
`$time`	$\geq$`2.0.0`	`int`	The current time of day in the range `[0 ; 23999]`. Examples: `0` (when day starts), `13000` (when night starts).
`$cave_score`	$\geq$`2.1.0`	`float`	A decimal score between `-1.0` (outside or above ground) and `+1.0` (underground or in a cave) based on the surrounding types of blocks and lighting (natural and artificial). `$cave_score >= 0.45` is a good threshold in my experience.
`$skylight_potential`	$\geq$`2.4.0`	`float`	The average, maximal possible skylight (assuming middle of the day) in the player's vicinity. Will be a decimal value between `0.0` and `15.0`.

Location properties

Property	Supported AM versions	Type	Description
`$areas`	$\geq$`2.5.0`	`list<area>`	The list of all areas that the player is currently inside. The first area is the smallest and the last area is the biggest. Example: `[ { name="Home", dimension="minecraft:overworld", owner="some_uuid", isShared=true, isLocal=false } , { name="Safe spot", dimension="minecraft:the_end", owner=undefined, isShared=false, isLocal=true } ]`.
`$structures`	$\geq$`2.5.0`	`list<string>`	Requires server support! The list of the ids of all auto generated structures that the player is currently inside. Beware that removing the blocks associated with the structure does not actually remove the "knowledge of the structure" from the world. Example: `[ "minecraft:village_plains" ]`

Player properties

Property	Supported AM versions	Type	Description
`$uuid`	$\geq$`2.5.0`	`string`	The id or uuid of the currently logged in player. This is used to determine the owner of an area. Example: `20b76fb2-9043-4ab5-9287-2c28477467aa`
`$game_mode`	$\geq$`2.4.0`	`string`	The current game mode of the player. Examples: `"survival"`, `"adventure"`, `"creative"`, `"spectator"`.
`$vehicle`	$\geq$`2.0.0`	`string`	The name/id of whatever the player is currently riding. Examples: `""`, `"minecraft:boat"`, `"minecraft:minecart"`, `"minecraft:horse"`.
`$elevation`	$\geq$`2.0.0`	`float`	The current Y-coordinate (elevation) of the player. Examples: `-50`, `0`, `42`.
`$health`	$\geq$`2.1.0`	`float`	The current health points of the player. Examples: `7`, `9`, `13`.
`$max_health`	$\geq$`2.1.0`	`float`	The current maximum health points of the player. Examples: `20`, `30`.
`$effects`	$\geq$`2.3.0`	`list<string>`	The list of all potion/buff/debuff effects currently active on the player. Example: `[ "minecraft:regeneration", "minecraft:absorption" ]`

Combat properties

Property	Supported AM versions	Type	Description
`$combatant_count`	$\geq$`2.2.0`	`int`	The number of monsters currently fighting the player (more precise if mod is installed on server).
`$combatants`	$\geq$`2.7.0`	`list<combatant>`	The list of all mobs that the player is currently fighting. Example: `[ { type_id="minecraft:skeleton", health=10.0, max_health=20.0, health_percent=50.0, targeting_player=true, fighting_player=true } ]`.
`$boss`	$\geq$`2.0.0`	`string`	The name of the (first) currently active boss (if any). Examples: `""`, `"ender_dragon"`, `"wither"`, `"raid"`. NOTE: Use the approximate string comparison operator (`~~`) when testing on the boss name since I extract it from the translation key used to show the name in the boss health bar and there is other content in the key apart from the boss name.
`$bosses`	$\geq$`2.3.0`	`list<string>`	The list of all currently active bosses.