AudioCategory

← Back to Asset Types

Documentation for the AudioCategory asset type.

Location

Audio/AudioCategories

Use in Your Files

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

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

Schema

Tree

Volume NullableNumberOrSpecial

Volume adjustment for the audio category in decibels.

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "AudioCategory.json",
  "title": "AudioCategory",
  "description": "An asset used to define an audio category. Can be used to adjust the volume of all sound events that reference a given category. Note: When using an inheritance structure, these categories act a bit like an audio bus where the category's volume is combined with the volumes further up in the hierarchy. e.g. if the category's volume is 4dB and the parent is -2dB, the final volume will be 2dB.",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Volume": {
      "description": "Volume adjustment for the audio category in decibels.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    }
  }
}