SoundEvent

← Back to Asset Types

Documentation for the SoundEvent asset type.

Location

Audio/SoundEvents

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/SoundEvent.schema.json" Copy

Schema

Tree

Volume NullableNumberOrSpecial

Volume adjustment of the sound event in decibels.

Pitch NullableNumberOrSpecial

Pitch adjustment of the sound event in semitones.

MusicDuckingVolume NullableNumberOrSpecial

Amount to duck music volume when playing in decibels.

AmbientDuckingVolume NullableNumberOrSpecial

Amount to duck ambient sounds when playing in decibels.

StartAttenuationDistance NullableNumberOrSpecial

Distance at which to begin attenuation in blocks.

MaxDistance NullableNumberOrSpecial

Maximum distance at which this sound event can be heard in blocks (i.e. the distance at which it's attenuated to zero).

MaxInstance integer

Max concurrent number of instances of this sound event.

Default:50

Min: 1Max: 100

PreventSoundInterruption boolean

Whether to prevent interruption of this sound event.

Default:false

Layers array

The layered sounds that make up this sound event.

Array items: SoundEventLayer

AudioCategory stringnull

Audio category to assign this sound event to for additional property routing.

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "SoundEvent.json",
  "title": "SoundEvent",
  "description": "SoundEvent asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Volume": {
      "description": "Volume adjustment of the sound event in decibels.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "Pitch": {
      "description": "Pitch adjustment of the sound event in semitones.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "MusicDuckingVolume": {
      "description": "Amount to duck music volume when playing in decibels.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "AmbientDuckingVolume": {
      "description": "Amount to duck ambient sounds when playing in decibels.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "StartAttenuationDistance": {
      "description": "Distance at which to begin attenuation in blocks.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "MaxDistance": {
      "description": "Maximum distance at which this sound event can be heard in blocks (i.e. the distance at which it's attenuated to zero).",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "MaxInstance": {
      "type": "integer",
      "description": "Max concurrent number of instances of this sound event.",
      "minimum": 1,
      "maximum": 100,
      "default": 50
    },
    "PreventSoundInterruption": {
      "type": "boolean",
      "description": "Whether to prevent interruption of this sound event.",
      "default": false
    },
    "Layers": {
      "type": "array",
      "description": "The layered sounds that make up this sound event.",
      "items": {
        "$ref": "common.schema.json#/$defs/SoundEventLayer"
      },
      "minItems": 1
    },
    "AudioCategory": {
      "type": [
        "string",
        "null"
      ],
      "description": "Audio category to assign this sound event to for additional property routing."
    }
  }
}