SoundSet

← Back to Asset Types

Documentation for the SoundSet asset type.

Location

Audio/SoundSets

Use in Your Files

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

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

Schema

Tree

SoundEvents object

Additional properties: string

Category string

Enum:"Music""Ambient""SFX""UI"

Default:"SFX"

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "SoundSet.json",
  "title": "SoundSet",
  "description": "SoundSet asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "SoundEvents": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "Category": {
      "type": "string",
      "title": "SoundCategory",
      "enum": [
        "Music",
        "Ambient",
        "SFX",
        "UI"
      ],
      "default": "SFX"
    }
  }
}