Sound Playing (Entity Condition Type)

Checks whether a given sound started playing near the entity within the last duration ticks. Use it to react to music discs, mob calls, ambience or your own apoli:play_sound effects.

Type ID: apoli:sound_playing

Fields

Field	Type	Default	Description
`sound`	Identifier	required	The sound event to watch for, such as `minecraft:entity.ender_dragon.growl`.
`category`	String	optional	Only matches this sound category: `master`, `music`, `record`, `weather`, `block`, `hostile`, `neutral`, `players`, `ambient` or `voice`. Leave it out to match any.
`duration`	Integer	`20`	How many ticks after the sound starts it still counts as playing. Set it to roughly the length of the sound.
`range`	Float	the sound's own range	The furthest the entity can be from the point the sound was played. Left out, the sound's own audible radius is used, so the condition is true exactly for entities that could hear it.

How it works

Apoli records the sound events it sees being played, and the condition looks them up in that list. It tests recent sounds and doesn't ask the audio engine: it answers whether this sound started near the entity in the last duration ticks, which is why duration exists. A looping sound is only recorded again when it restarts, so give long or looping sounds a duration that covers them.

Only sounds that some loaded power asks about are recorded, so a pack that never uses this condition pays nothing for it.

note

duration is your estimate of how long the sound lasts, because the game doesn't give data packs the length of a sound. Too short and the condition turns off early, and too long and it stays true after the sound has finished.

Examples

Glow while a warden's heartbeat can be heard:

{
    "type": "apoli:glowing",
    "condition": {
        "type": "apoli:sound_playing",
        "sound": "minecraft:entity.warden.heartbeat",
        "duration": 40
    }
}

Dance to a jukebox, with a screen overlay that only shows while a record is playing within 16 blocks:

{
    "type": "apoli:overlay",
    "texture": "example:textures/gui/disco.png",
    "strength": 0.5,
    "condition": {
        "type": "apoli:sound_playing",
        "sound": "minecraft:music_disc.pigstep",
        "category": "record",
        "range": 16,
        "duration": 2952
    }
}

Take damage from a creeper's fuse, wherever it is on the server:

{
    "type": "apoli:action_over_time",
    "interval": 5,
    "entity_action": { "type": "apoli:damage", "amount": 1, "damage_type": "minecraft:generic" },
    "condition": {
        "type": "apoli:sound_playing",
        "sound": "minecraft:entity.creeper.primed",
        "duration": 30
    }
}