ambient_sound_zone
Play ambient sound in a region — misc entry.
Entry Information
| Property | Value |
|---|---|
| Entry ID | ambient_sound_zone |
| Type | Misc |
| Color | Green |
| Icon | mdi:weather-windy |
Description
An ambient sound zone plays a looping sound when a player is inside a protection region or WorldGuard region. When the player enters the region, the sound fades in. When the player exits, the sound fades out. If multiple zones overlap, the one with the highest priority takes precedence.
Fields
| Field | Type | Description |
|---|---|---|
protectionRegionId | String | The protection region ID where the ambient sound plays (primary). Use the ID of a region_definition entry. |
worldGuardRegionId | String | WorldGuard region name (optional fallback if protection region is not set) |
sound | Var<Sound> | The sound to play in this zone |
layer | AudioLayer | The audio layer to use |
zoneVolume | Var<Float> | Volume multiplier for this zone (0.0 to 1.0) |
fadeIn | Duration | Fade in duration when entering the zone |
fadeOut | Duration | Fade out duration when exiting the zone |
looping | Boolean | Whether the sound should loop while in the zone |
priority | Int | Priority when multiple zones overlap (higher wins) |
Usage Example
- entry: ambient_sound_zone
name: "Play ambient sound in a region"
protectionRegionId: ""
worldGuardRegionId: ""
sound: ""
layer: ""
zoneVolume: 0
fadeIn: ""
fadeOut: ""
looping: false
priority: 0