AmbienceFX

← Back to Asset Types

Documentation for the AmbienceFX asset type.

Location

Audio/AmbienceFX

Use in Your Files

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

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

Schema

Tree

Conditions unknown

Any of

AmbienceFXConditions

null

Sounds arraynull

Array items: AmbienceFXSound

Music unknown

Any of

AmbienceFXMusic

null

AmbientBed unknown

Any of

AmbienceFXAmbientBed

null

SoundEffect unknown

Any of

AmbienceFXSoundEffect

null

Priority integer

Priority for this AmbienceFX. Only applies to music and sound effect. Higher number means higher priority.

Default:0

Min: 0

BlockedAmbienceFxIds arraynull

Array items: string

AudioCategory stringnull

Audio category to assign this ambienceFX to for additional property routing. Only affects ambient bed and music, not emitters.

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "AmbienceFX.json",
  "title": "AmbienceFX",
  "description": "AmbienceFX asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Conditions": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/AmbienceFXConditions"
        },
        {
          "type": "null"
        }
      ]
    },
    "Sounds": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/AmbienceFXSound"
      }
    },
    "Music": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/AmbienceFXMusic"
        },
        {
          "type": "null"
        }
      ]
    },
    "AmbientBed": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/AmbienceFXAmbientBed"
        },
        {
          "type": "null"
        }
      ]
    },
    "SoundEffect": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/AmbienceFXSoundEffect"
        },
        {
          "type": "null"
        }
      ]
    },
    "Priority": {
      "type": "integer",
      "description": "Priority for this AmbienceFX. Only applies to music and sound effect. Higher number means higher priority.",
      "minimum": 0,
      "default": 0
    },
    "BlockedAmbienceFxIds": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "AudioCategory": {
      "type": [
        "string",
        "null"
      ],
      "description": "Audio category to assign this ambienceFX to for additional property routing. Only affects ambient bed and music, not emitters."
    }
  }
}