Add sound event schema and use where appropriate (#120)

* Fix typo in module name * Add sound_event schema and add it where appropriate
2022-10-02 21:51:03 +02:00
parent 8b599b4562
commit c60e5c0d39
28 changed files with 444 additions and 38 deletions
--- a/source/behavior/entities/format/behaviors/admire_item.json
+++ b/source/behavior/entities/format/behaviors/admire_item.json
@@ -10,7 +10,7 @@
    },
    "admire_item_sound": {
      "title": "Admire Item Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "description": "The sound event to play when admiring the item."
    },
    "on_admire_item_start": {
--- a/source/behavior/entities/format/behaviors/avoid_block.json
+++ b/source/behavior/entities/format/behaviors/avoid_block.json
@@ -44,9 +44,9 @@
      "items": { "title": "Block ID", "$ref": "../../../../general/item/descriptor.json" }
    },
    "avoid_block_sound": {
-      "type": "string",
      "title": "Avoid Block Sound",
-      "description": "The sound event to play when the mob is avoiding a block."
+      "description": "The sound event to play when the mob is avoiding a block.",
+      "$ref": "../../../../general/sound_event.json"
    },
    "walk_speed_modifier": {
      "type": "number",
--- a/source/behavior/entities/format/behaviors/avoid_mob_type.json
+++ b/source/behavior/entities/format/behaviors/avoid_mob_type.json
@@ -11,9 +11,9 @@
    },
    "avoid_mob_sound": {
      "title": "Avoid Mob Sound",
-      "type": "string",
      "default": "",
-      "description": "The sound event to play when the mob is avoiding another mob."
+      "description": "The sound event to play when the mob is avoiding another mob.",
+      "$ref": "../../../../general/sound_event.json"
    },
    "avoid_target_xz": {
      "title": "Avoid Target XZ",
--- a/source/behavior/entities/format/behaviors/celebrate.json
+++ b/source/behavior/entities/format/behaviors/celebrate.json
@@ -7,10 +7,10 @@
  "properties": {
    "priority": { "$ref": "types/priority.json" },
    "celebration_sound": {
-      "type": "string",
      "default": "",
      "description": "The sound event to trigger during the celebration.",
-      "title": "Celebration Sound"
+      "title": "Celebration Sound",
+      "$ref": "../../../../general/sound_event.json"
    },
    "duration": {
      "type": "number",
--- a/source/behavior/entities/format/behaviors/defend_trusted_target.json
+++ b/source/behavior/entities/format/behaviors/defend_trusted_target.json
@@ -10,7 +10,7 @@
    },
    "aggro_sound": {
      "title": "Aggro Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sound to occasionally play while defending."
    },
--- a/source/behavior/entities/format/behaviors/delayed_attack.json
+++ b/source/behavior/entities/format/behaviors/delayed_attack.json
@@ -152,7 +152,6 @@
      "random_stop_interval": 0,
      "reach_multiplier": 2,
      "require_complete_path": true,
-      "sound_event": "example",
      "track_target": false
    }
  ]
--- a/source/behavior/entities/format/behaviors/eat_mob.json
+++ b/source/behavior/entities/format/behaviors/eat_mob.json
@@ -15,7 +15,7 @@
    },
    "eat_mob_sound": {
      "title": "Eat Mob Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sets the sound that should play when eating a mob."
    },
--- a/source/behavior/entities/format/behaviors/go_and_give_items_to_noteblock.json
+++ b/source/behavior/entities/format/behaviors/go_and_give_items_to_noteblock.json
@@ -45,7 +45,7 @@
    },
    "throw_sound": {
      "title": "Throw Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sound to play when this mob throws an item."
    },
--- a/source/behavior/entities/format/behaviors/go_and_give_items_to_owner.json
+++ b/source/behavior/entities/format/behaviors/go_and_give_items_to_owner.json
@@ -40,7 +40,7 @@
    },
    "throw_sound": {
      "title": "Throw Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "item_thrown",
      "description": "Sound to play when this mob throws an item."
    },
--- a/source/behavior/entities/format/behaviors/lay_egg.json
+++ b/source/behavior/entities/format/behaviors/lay_egg.json
@@ -29,7 +29,7 @@
    },
    "lay_egg_sound": {
      "title": "Lay Egg Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "lay_egg",
      "description": "[EXPERIMENTAL] Sound event name for laying egg. Defaulted to lay_egg which is used for Turtles."
    },
--- a/source/behavior/entities/format/behaviors/panic.json
+++ b/source/behavior/entities/format/behaviors/panic.json
@@ -41,7 +41,7 @@
    },
    "panic_sound": {
      "title": "Panic Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "description": "The sound event to play when this mob is in panic."
    },
    "sound_interval": {
--- a/source/behavior/entities/format/behaviors/ram_attack.json
+++ b/source/behavior/entities/format/behaviors/ram_attack.json
@@ -46,7 +46,7 @@
    },
    "pre_ram_sound": {
      "title": "Pre Ram Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "The sound to play when an entity is about to perform a ram attack."
    },
@@ -58,7 +58,7 @@
    },
    "ram_impact_sound": {
      "title": "Ram Impact Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "The sound to play when an entity is impacting on a ram attack."
    },
--- a/source/behavior/entities/format/behaviors/send_event.json
+++ b/source/behavior/entities/format/behaviors/send_event.json
@@ -23,7 +23,7 @@
            "description": "The event to send to the entity."
          },
          "sound_event": {
-            "type": "string",
+            "$ref": "../../../../general/sound_event.json",
            "default": "",
            "description": "The sound event to play when this step happens."
          }
@@ -101,7 +101,7 @@
            "$comment": "UNDOCUMENTED"
          },
          "start_sound_event": {
-            "type": "string",
+            "$ref": "../../../../general/sound_event.json",
            "title": "Start Sound Event",
            "description": "The sound event to play when using this spell.",
            "$comment": "UNDOCUMENTED"
--- a/source/behavior/entities/format/behaviors/sneeze.json
+++ b/source/behavior/entities/format/behaviors/sneeze.json
@@ -34,7 +34,7 @@
      "pattern": "^loot_tables/.*.json$"
    },
    "prepare_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sound to play when the sneeze is about to happen.",
      "title": "Prepare Sound"
@@ -54,7 +54,7 @@
      "title": "Probability"
    },
    "sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sound to play when the sneeze occurs.",
      "title": "Sound"
--- a/source/behavior/entities/format/behaviors/sonic_boom.json
+++ b/source/behavior/entities/format/behaviors/sonic_boom.json
@@ -33,13 +33,13 @@
    },
    "attack_sound": {
      "title": "Attack Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sound event for the attack."
    },
    "charge_sound": {
      "title": "Charge Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sound event for the charge up."
    },
--- a/source/behavior/entities/format/behaviors/stomp_attack.json
+++ b/source/behavior/entities/format/behaviors/stomp_attack.json
@@ -153,7 +153,6 @@
      "random_stop_interval": 0,
      "reach_multiplier": 2,
      "require_complete_path": false,
-      "sound": "example",
      "track_target": false,
      "stomp_range_multiplier": 0.0,
      "no_damage_range_multiplier": 0.0
--- a/source/behavior/entities/format/behaviors/summon_entity.json
+++ b/source/behavior/entities/format/behaviors/summon_entity.json
@@ -121,7 +121,7 @@
                  "title": "Size"
                },
                "sound_event": {
-                  "type": "string",
+                  "$ref": "../../../../general/sound_event.json",
                  "description": "The sound event to play for this step.",
                  "title": "Sound Event"
                },
@@ -147,7 +147,7 @@
            }
          },
          "start_sound_event": {
-            "type": "string",
+            "$ref": "../../../../general/sound_event.json",
            "description": "The sound event to play when using this spell.",
            "title": "Start Sound Event"
          },
--- a/source/behavior/entities/format/behaviors/tempt.json
+++ b/source/behavior/entities/format/behaviors/tempt.json
@@ -50,7 +50,7 @@
      ]
    },
    "tempt_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "description": "Sound to play while the mob is being tempted.",
      "title": "Tempt Sound"
    },
--- a/source/behavior/entities/format/components/ambient_sound_interval.json
+++ b/source/behavior/entities/format/components/ambient_sound_interval.json
@@ -23,7 +23,7 @@
            "title": "Condition"
          },
          "event_name": {
-            "type": "string",
+            "$ref": "../../../../general/sound_event.json",
            "description": "Level sound event to be played as the ambient sound.",
            "title": "Event Name"
          }
--- a/source/behavior/entities/format/components/angry.json
+++ b/source/behavior/entities/format/components/angry.json
@@ -45,7 +45,7 @@
    },
    "angry_sound": {
      "title": "Angry Sound",
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "The sound event to play when the mob is angry."
    },
--- a/source/behavior/entities/format/components/celebrate_hunt.json
+++ b/source/behavior/entities/format/components/celebrate_hunt.json
@@ -17,7 +17,7 @@
      "title": "Celeberation Targets"
    },
    "celebrate_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "The sound event to play when the mob is celebrating.",
      "title": "Celebrate Sound"
--- a/source/behavior/entities/format/components/damage_sensor.json
+++ b/source/behavior/entities/format/components/damage_sensor.json
@@ -61,7 +61,7 @@
          "$ref": "../types/trigger.json"
        },
        "on_damage_sound_event": {
-          "type": "string",
+          "$ref": "../../../../general/sound_event.json",
          "description": "Defines what sound to play, if any, when the on_damage filters are met.",
          "title": "On Damage Sound Event"
        }
--- a/source/behavior/entities/format/components/interact.json
+++ b/source/behavior/entities/format/components/interact.json
@@ -97,7 +97,7 @@
        },
        "play_sounds": {
          "title": "Play Sounds",
-          "type": "string",
+          "$ref": "../../../../general/sound_event.json",
          "default": "",
          "description": "List of sounds to play when the interaction occurs."
        },
--- a/source/behavior/entities/format/components/projectile.json
+++ b/source/behavior/entities/format/components/projectile.json
@@ -54,13 +54,13 @@
      "title": "Gravity"
    },
    "hit_ground_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "The sound that plays when the projectile hits the ground.",
      "title": "Hit Ground Sound"
    },
    "hit_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "The sound that plays when the projectile hits something.",
      "title": "Hit Sound"
@@ -601,7 +601,7 @@
      "title": "Semi Random Diff Damage"
    },
    "shoot_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "The sound that plays when the projectile is shot.",
      "title": "Shoot Sound"
--- a/source/behavior/entities/format/components/spawn_entity.json
+++ b/source/behavior/entities/format/components/spawn_entity.json
@@ -69,7 +69,7 @@
          "title": "Spawn Method"
        },
        "spawn_sound": {
-          "type": "string",
+          "$ref": "../../../../general/sound_event.json",
          "default": "plop",
          "description": "Identifier of the sound effect to play when the entity is spawned.",
          "title": "Spawn Sound"
--- a/source/behavior/entities/format/components/transformation.json
+++ b/source/behavior/entities/format/components/transformation.json
@@ -21,7 +21,7 @@
      }
    },
    "begin_transform_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "description": "Sound to play when the transformation starts.",
      "title": "Begin Transform Sound"
    },
@@ -106,7 +106,7 @@
      "title": "Preserve Equipment"
    },
    "transformation_sound": {
-      "type": "string",
+      "$ref": "../../../../general/sound_event.json",
      "default": "",
      "description": "Sound to play when the entity is done transforming.",
      "title": "Transformation Sound"