diff --git a/source/behavior/entities/format/behaviors/admire_item.json b/source/behavior/entities/format/behaviors/admire_item.json index 4595866a..f0696fb9 100644 --- a/source/behavior/entities/format/behaviors/admire_item.json +++ b/source/behavior/entities/format/behaviors/admire_item.json @@ -5,7 +5,9 @@ "description": "Enables the mob to admire items that have been configured as admirable. Must be used in combination with the admire_item component.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "admire_item_sound": { "type": "string", "default": "", @@ -32,13 +34,37 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" }, - { "type": "object", "additionalProperties": false, "properties": { "range_min": { "type": "number" }, "range_max": { "type": "number" } } } + { + "type": "number" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "range_min": { + "type": "number" + }, + "range_max": { + "type": "number" + } + } + } ] } - } + }, + "examples": [ + { + "admire_item_sound": "" + } + ] } diff --git a/source/behavior/entities/format/behaviors/avoid_block.json b/source/behavior/entities/format/behaviors/avoid_block.json index 891d86bf..a0d0f81e 100644 --- a/source/behavior/entities/format/behaviors/avoid_block.json +++ b/source/behavior/entities/format/behaviors/avoid_block.json @@ -6,7 +6,9 @@ "$comment": "UNDOCUMENTED", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "tick_interval": { "type": "integer", "title": "Tick Interval", @@ -42,7 +44,12 @@ "title": "Target Blocks", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "items": { "type": "string", "title": "Block ID", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } + "items": { + "type": "string", + "title": "Block ID", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + } }, "avoid_block_sound": { "type": "string", @@ -61,7 +68,9 @@ "title": "Walk Speed Modifier", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "items": { "$ref": "../types/event.json" } + "items": { + "$ref": "../types/event.json" + } }, "sound_interval": { "default": 0, @@ -71,13 +80,45 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" }, - { "type": "object", "additionalProperties": false, "properties": { "range_min": { "type": "number" }, "range_max": { "type": "number" } } } + { + "type": "number" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "range_min": { + "type": "number" + }, + "range_max": { + "type": "number" + } + } + } ] } - } -} + }, + "examples": [ + { + "tick_interval": 0, + "search_range": 0, + "search_height": 0, + "sprint_speed_modifier": 0.0, + "target_selection_method": "example", + "target_blocks": [], + "avoid_block_sound": "example", + "walk_speed_modifier": 0.0, + "on_escape": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/avoid_mob_type.json b/source/behavior/entities/format/behaviors/avoid_mob_type.json index 211becbf..d61f1239 100644 --- a/source/behavior/entities/format/behaviors/avoid_mob_type.json +++ b/source/behavior/entities/format/behaviors/avoid_mob_type.json @@ -6,8 +6,15 @@ "title": "Avoid Mob Type", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "max_dist": { "type": "number", "default": 0, "description": "Maximum distance to look for an entity", "title": "Maximum Dist" }, + "priority": { + "$ref": "./types/priority.json" + }, + "max_dist": { + "type": "number", + "default": 0, + "description": "Maximum distance to look for an entity", + "title": "Maximum Dist" + }, "max_flee": { "type": "number", "default": 0.5, @@ -38,7 +45,11 @@ "description": "If true, visbility between this entity and the mob type will not be checked.", "title": "Ignore Visibility" }, - "entity_types": { "$ref": "../types/entity_types.json", "description": "UNDOCUMENTED: entity types", "title": "Entity Types" }, + "entity_types": { + "$ref": "../types/entity_types.json", + "description": "UNDOCUMENTED: entity types", + "title": "Entity Types" + }, "avoid_mob_sound": { "title": "Avoid Mob Sound", "description": "UNDOCUMENTED", @@ -66,13 +77,44 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" }, - { "type": "object", "additionalProperties": false, "properties": { "range_min": { "type": "number" }, "range_max": { "type": "number" } } } + { + "type": "number" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "range_min": { + "type": "number" + }, + "range_max": { + "type": "number" + } + } + } ] } - } -} + }, + "examples": [ + { + "max_dist": 0, + "max_flee": 0.5, + "walk_speed_multiplier": 1.0, + "sprint_speed_multiplier": 1.0, + "probability_per_strength": 1.0, + "ignore_visibility": false, + "avoid_mob_sound": "example", + "remove_target": true + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/barter.json b/source/behavior/entities/format/behaviors/barter.json index 6f62f3c8..2670466a 100644 --- a/source/behavior/entities/format/behaviors/barter.json +++ b/source/behavior/entities/format/behaviors/barter.json @@ -4,5 +4,9 @@ "title": "Barter", "description": "Enables the mob to barter for items that have been configured as barter currency. Must be used in combination with the barter component", "additionalProperties": false, - "properties": { "priority": { "$ref": "types/priority.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/beg.json b/source/behavior/entities/format/behaviors/beg.json index d19f96e8..a6cf3925 100644 --- a/source/behavior/entities/format/behaviors/beg.json +++ b/source/behavior/entities/format/behaviors/beg.json @@ -6,7 +6,9 @@ "description": "Allows this mob to look at and follow the player that holds food they like.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "items": { "type": "array", "description": "List of items that this mob likes", @@ -18,12 +20,26 @@ }, "title": "Properties" }, - "look_distance": { "type": "number", "default": 8, "description": "Distance in blocks the mob will beg from", "title": "Look Distance" }, + "look_distance": { + "type": "number", + "default": 8, + "description": "Distance in blocks the mob will beg from", + "title": "Look Distance" + }, "look_time": { "description": "The range of time in seconds this mob will stare at the player holding a food they like, begging for it", "$ref": "../types/range_number_type.json", - "default": [2, 4], + "default": [ + 2, + 4 + ], "title": "Look Time" } - } -} + }, + "examples": [ + { + "items": [], + "look_distance": 8 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/break_door.json b/source/behavior/entities/format/behaviors/break_door.json index feacba5d..7d22f94b 100644 --- a/source/behavior/entities/format/behaviors/break_door.json +++ b/source/behavior/entities/format/behaviors/break_door.json @@ -4,6 +4,13 @@ "title": "Break Door", "description": "Allows this mob to break doors.", "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "./types/speed_multiplier.json" } }, + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + } + }, "additionalProperties": false } diff --git a/source/behavior/entities/format/behaviors/breed.json b/source/behavior/entities/format/behaviors/breed.json index 3a146e27..934a500a 100644 --- a/source/behavior/entities/format/behaviors/breed.json +++ b/source/behavior/entities/format/behaviors/breed.json @@ -5,5 +5,12 @@ "title": "Breed", "description": "Allows this mob to breed with other mobs.", "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "./types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/celebrate.json b/source/behavior/entities/format/behaviors/celebrate.json index d42ccfa4..32ada0f6 100644 --- a/source/behavior/entities/format/behaviors/celebrate.json +++ b/source/behavior/entities/format/behaviors/celebrate.json @@ -5,9 +5,21 @@ "description": "This allows the mob celebrate by jumping up and playing a sound periodically.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, - "celebration_sound": { "type": "string", "default": "", "description": "The sound to occasionally play.", "title": "Celebration Sound" }, - "duration": { "type": "number", "default": 1, "description": "The duration of the celebration (in seconds).", "title": "Duration" }, + "priority": { + "$ref": "types/priority.json" + }, + "celebration_sound": { + "type": "string", + "default": "", + "description": "The sound to occasionally play.", + "title": "Celebration Sound" + }, + "duration": { + "type": "number", + "default": 1, + "description": "The duration of the celebration (in seconds).", + "title": "Duration" + }, "jump_interval": { "default": 0, "description": "The range of time in seconds to randomly wait before jumping again.", @@ -16,12 +28,31 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" }, - { "type": "object", "additionalProperties": false, "properties": { "range_min": { "type": "number" }, "range_max": { "type": "number" } } } + { + "type": "number" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "range_min": { + "type": "number" + }, + "range_max": { + "type": "number" + } + } + } ] }, "on_celebration_end_event": { @@ -37,13 +68,38 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" }, - { "type": "object", "additionalProperties": false, "properties": { "range_min": { "type": "number" }, "range_max": { "type": "number" } } } + { + "type": "number" + }, + { + "type": "object", + "additionalProperties": false, + "properties": { + "range_min": { + "type": "number" + }, + "range_max": { + "type": "number" + } + } + } ] } - } -} + }, + "examples": [ + { + "celebration_sound": "", + "duration": 1 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/charge_attack.json b/source/behavior/entities/format/behaviors/charge_attack.json index 0c3006ef..01fc50c4 100644 --- a/source/behavior/entities/format/behaviors/charge_attack.json +++ b/source/behavior/entities/format/behaviors/charge_attack.json @@ -5,5 +5,12 @@ "title": "Charge Attack", "description": "Allows the mob to attack its target by running at it.", "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/charge_held_item.json b/source/behavior/entities/format/behaviors/charge_held_item.json index 2ed49545..02c60922 100644 --- a/source/behavior/entities/format/behaviors/charge_held_item.json +++ b/source/behavior/entities/format/behaviors/charge_held_item.json @@ -6,12 +6,23 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "items": { "type": "array", "title": "Items", "description": "The list of items that can be used to charge the held item.", - "items": { "type": "string", "description": "Items names to be used.", "title": "Item ID" } + "items": { + "type": "string", + "description": "Items names to be used.", + "title": "Item ID" + } } - } -} + }, + "examples": [ + { + "items": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/circle_around_anchor.json b/source/behavior/entities/format/behaviors/circle_around_anchor.json index 5c64435f..46122bd7 100644 --- a/source/behavior/entities/format/behaviors/circle_around_anchor.json +++ b/source/behavior/entities/format/behaviors/circle_around_anchor.json @@ -6,7 +6,9 @@ "description": "Allows the mob to move in a circle around a point or a target.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "speed_multiplier": { "type": "number", "default": 1.0, @@ -15,7 +17,10 @@ }, "radius_range": { "$ref": "../types/range_number_type.json", - "default": [5.0, 15.0], + "default": [ + 5.0, + 15.0 + ], "description": "Range of radius in blocks of the circle to move around.", "title": "Radius Range" }, @@ -27,13 +32,19 @@ }, "height_above_target_range": { "$ref": "../types/range_number_type.json", - "default": [0.0, 0.0], + "default": [ + 0.0, + 0.0 + ], "description": "When the mob finds a target, the range of height in blocks above the target to start the anchor point.", "title": "Height Above Target Range" }, "height_offset_range": { "$ref": "../types/range_number_type.json", - "default": [0.0, 0.0], + "default": [ + 0.0, + 0.0 + ], "description": "The range of height in blocks offset the mob can have from it's anchor point.", "title": "Height Offset Range" }, @@ -73,5 +84,17 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } -} + }, + "examples": [ + { + "speed_multiplier": 1.0, + "radius_change_chance": 250, + "height_change_chance": 350, + "goal_radius": 0.5, + "radius_change": 0.0, + "radius_adjustment_chance": 0.0, + "height_adjustment_chance": 0.0, + "angle_change": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/controlled_by_player.json b/source/behavior/entities/format/behaviors/controlled_by_player.json index d7811c08..e1f791f9 100644 --- a/source/behavior/entities/format/behaviors/controlled_by_player.json +++ b/source/behavior/entities/format/behaviors/controlled_by_player.json @@ -5,12 +5,19 @@ "title": "Controlled By Player", "description": "Allows the mob to be controlled by the player.", "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "mount_speed_multiplier": { "type": "number", "default": 1, "description": "Speed multiplier of mount when controlled by player, defaults to 1.0f", "title": "Mount Speed Multiplier" } - } -} + }, + "examples": [ + { + "mount_speed_multiplier": 1 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/defend_trusted_target.json b/source/behavior/entities/format/behaviors/defend_trusted_target.json index 88dc2326..c2859ade 100644 --- a/source/behavior/entities/format/behaviors/defend_trusted_target.json +++ b/source/behavior/entities/format/behaviors/defend_trusted_target.json @@ -5,9 +5,21 @@ "description": "Allows the mob to target another mob that hurts an entity it trusts.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, - "aggro_sound": { "type": "string", "default": "", "description": "Sound to occasionally play while defending.", "title": "Aggro Sound" }, - "attack_interval": { "type": "integer", "default": 0, "description": "Time in seconds between attacks", "title": "Attack Interval" }, + "priority": { + "$ref": "types/priority.json" + }, + "aggro_sound": { + "type": "string", + "default": "", + "description": "Sound to occasionally play while defending.", + "title": "Aggro Sound" + }, + "attack_interval": { + "type": "integer", + "default": 0, + "description": "Time in seconds between attacks", + "title": "Attack Interval" + }, "must_see": { "type": "boolean", "default": false, @@ -38,6 +50,22 @@ "title": "Entity Types", "additionalProperties": false }, - "sound_chance": { "title": "Sound Chance", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" } - } -} + "sound_chance": { + "title": "Sound Chance", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + } + }, + "examples": [ + { + "aggro_sound": "", + "attack_interval": 0, + "must_see": false, + "must_see_forget_duration": 3, + "within_radius": 0, + "entity_types": {}, + "sound_chance": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/defend_village_target.json b/source/behavior/entities/format/behaviors/defend_village_target.json index 1f7eaa5f..7ef3f3e8 100644 --- a/source/behavior/entities/format/behaviors/defend_village_target.json +++ b/source/behavior/entities/format/behaviors/defend_village_target.json @@ -5,18 +5,31 @@ "title": "Defend Village Target", "description": "Allows the mob to stay in the village and fight mobs hostile to the villagers.", "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entity types this mob considers a threat to the village", "title": "Entity Types" }, - "must_reach": { "title": "Must Reach", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "boolean" }, + "must_reach": { + "title": "Must Reach", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "boolean" + }, "attack_chance": { "title": "Attack Chance", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" } - } -} + }, + "examples": [ + { + "must_reach": true, + "attack_chance": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/delayed_attack.json b/source/behavior/entities/format/behaviors/delayed_attack.json index 65e102b4..3ef157f2 100644 --- a/source/behavior/entities/format/behaviors/delayed_attack.json +++ b/source/behavior/entities/format/behaviors/delayed_attack.json @@ -5,16 +5,30 @@ "title": "Delayed Attack", "description": "Allows the mob to drink potions based on specified environment conditions.", "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "attack_duration": { "type": "number", "default": 1, "description": "The duration of the attack animation in seconds", "title": "Attack Duration" }, - "attack_once": { "type": "boolean", "default": false, "description": "If true, this mob will attack only one time.", "title": "Attack Once" }, - "attack_types": { "type": "string", "default": "", "description": "Defines the entity types this mob will attack", "title": "Attack Types" }, + "attack_once": { + "type": "boolean", + "default": false, + "description": "If true, this mob will attack only one time.", + "title": "Attack Once" + }, + "attack_types": { + "type": "string", + "default": "", + "description": "Defines the entity types this mob will attack", + "title": "Attack Types" + }, "hit_delay_pct": { "type": "number", "default": 1, @@ -33,13 +47,35 @@ "description": "Multiplier for how far outside its box the mob can reach its target (this can be used to simulate a mob with longer arms by making this bigger)", "title": "Reach Multiplier" }, - "require_complete_path": { "type": "boolean", "title": "Require Complet Path", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "sound_event": { "type": "string", "description": "The sound event to play when the attack starts", "title": "Sound Event" }, + "require_complete_path": { + "type": "boolean", + "title": "Require Complet Path", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + }, + "sound_event": { + "type": "string", + "description": "The sound event to play when the attack starts", + "title": "Sound Event" + }, "track_target": { "type": "boolean", "default": false, "description": "If true, this mob will chase after the target as long as it's a valid target", "title": "Track Target" } - } -} + }, + "examples": [ + { + "attack_duration": 1, + "attack_once": false, + "attack_types": "", + "hit_delay_pct": 1, + "random_stop_interval": 0, + "reach_multiplier": 2, + "require_complete_path": true, + "sound_event": "example", + "track_target": false + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/door_interact.json b/source/behavior/entities/format/behaviors/door_interact.json index ad10b385..5ac73819 100644 --- a/source/behavior/entities/format/behaviors/door_interact.json +++ b/source/behavior/entities/format/behaviors/door_interact.json @@ -4,5 +4,9 @@ "type": "object", "title": "Door Interact", "description": "Allows the mob to drink potions based on specified environment conditions.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragonchargeplayer.json b/source/behavior/entities/format/behaviors/dragonchargeplayer.json index 41c05bdf..20a5115d 100644 --- a/source/behavior/entities/format/behaviors/dragonchargeplayer.json +++ b/source/behavior/entities/format/behaviors/dragonchargeplayer.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragonchargeplayer", "description": "Allows the dragon to attack a player by flying fast at them. The player is chosen by the dragonscanning goal. Can only be used by the Ender Dragon.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragondeath.json b/source/behavior/entities/format/behaviors/dragondeath.json index 87f5c64e..7d42014e 100644 --- a/source/behavior/entities/format/behaviors/dragondeath.json +++ b/source/behavior/entities/format/behaviors/dragondeath.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragondeath", "description": "Allows the dragon to go out with glory. This controls the Ender Dragon's death animation and can't be used by other mobs.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragonflaming.json b/source/behavior/entities/format/behaviors/dragonflaming.json index 4dfed4bc..abb1ad4a 100644 --- a/source/behavior/entities/format/behaviors/dragonflaming.json +++ b/source/behavior/entities/format/behaviors/dragonflaming.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragonflaming", "description": "Allows the dragon to use its flame breath attack. Can only be used by the Ender Dragon.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragonholdingpattern.json b/source/behavior/entities/format/behaviors/dragonholdingpattern.json index eb47e962..b7608319 100644 --- a/source/behavior/entities/format/behaviors/dragonholdingpattern.json +++ b/source/behavior/entities/format/behaviors/dragonholdingpattern.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragonholdingpattern", "description": "Allows the Dragon to fly around in a circle around the center podium. Can only be used by the Ender Dragon.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragonlanding.json b/source/behavior/entities/format/behaviors/dragonlanding.json index 382fb713..e89b3182 100644 --- a/source/behavior/entities/format/behaviors/dragonlanding.json +++ b/source/behavior/entities/format/behaviors/dragonlanding.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragonlanding", "description": "Allows the Dragon to stop flying and transition into perching mode. Can only be used by the Ender Dragon.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragonscanning.json b/source/behavior/entities/format/behaviors/dragonscanning.json index d1f1991f..d01484b5 100644 --- a/source/behavior/entities/format/behaviors/dragonscanning.json +++ b/source/behavior/entities/format/behaviors/dragonscanning.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragonscanning", "description": "Allows the dragon to look around for a player to attack while in perch mode. Can only be used by the Ender Dragon.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragonstrafeplayer.json b/source/behavior/entities/format/behaviors/dragonstrafeplayer.json index b65921dc..826ff3ba 100644 --- a/source/behavior/entities/format/behaviors/dragonstrafeplayer.json +++ b/source/behavior/entities/format/behaviors/dragonstrafeplayer.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragonstrafeplayer", "description": "Allows the dragon to fly around looking for a player and shoot fireballs at them. Can only be used by the Ender Dragon.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/dragontakeoff.json b/source/behavior/entities/format/behaviors/dragontakeoff.json index 2e16b20c..82d245b1 100644 --- a/source/behavior/entities/format/behaviors/dragontakeoff.json +++ b/source/behavior/entities/format/behaviors/dragontakeoff.json @@ -4,5 +4,9 @@ "type": "object", "title": "Dragontakeoff", "description": "Allows the dragon to leave perch mode and go back to flying around. Can only be used by the Ender Dragon.", - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/drink_potion.json b/source/behavior/entities/format/behaviors/drink_potion.json index b7b94db7..d7c086b0 100644 --- a/source/behavior/entities/format/behaviors/drink_potion.json +++ b/source/behavior/entities/format/behaviors/drink_potion.json @@ -4,23 +4,39 @@ "title": "Beg", "description": "Allows the mob to drink potions based on specified environment conditions.", "additionalProperties": false, - "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, - "speed_modifier": { "default": 0.0, "description": "Movement speed modifier of the mob when using this AI Goal", "title": "Speed Modifier" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, + "speed_modifier": { + "default": 0.0, + "description": "Movement speed modifier of the mob when using this AI Goal", + "title": "Speed Modifier" + }, "potions": { "type": "array", "description": "A list of potions that this entity can drink.", "title": "Potions", "items": { - "required": ["id", "chance", "filters"], + "required": [ + "id", + "chance", + "filters" + ], "additionalProperties": false, "type": "object", "description": "A potions that this entity can drink.", "title": "Potions", "properties": { - "id": { "type": "integer", "default": -1, "description": "The registry ID of the potion to use", "title": "Id" }, + "id": { + "type": "integer", + "default": -1, + "description": "The registry ID of the potion to use", + "title": "Id" + }, "chance": { "type": "number", "default": 1.0, @@ -36,5 +52,10 @@ } } } - } -} + }, + "examples": [ + { + "potions": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/drop_item_for.json b/source/behavior/entities/format/behaviors/drop_item_for.json index 59b22cb5..89e0f2ae 100644 --- a/source/behavior/entities/format/behaviors/drop_item_for.json +++ b/source/behavior/entities/format/behaviors/drop_item_for.json @@ -5,12 +5,23 @@ "title": "Drop Item For", "type": "object", "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, - "cooldown": { "title": "Cooldown", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, + "cooldown": { + "title": "Cooldown", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, "drop_item_chance": { "type": "number", - "default": [1.0], + "default": [ + 1.0 + ], "description": "The probability that the mob will drop an item.", "title": "Drop Item Chance" }, @@ -25,7 +36,12 @@ "description": "Distance in blocks within the mob considers it has reached the goal. This is the `wiggle room` to stop the AI from bouncing back and forth trying to reach a specific spot", "title": "Goal Radius" }, - "loot_table": { "type": "string", "pattern": "^loot_tables.*\\.json$", "description": "Loot table to select items from.", "title": "Loot Table" }, + "loot_table": { + "type": "string", + "pattern": "^loot_tables.*\\.json$", + "description": "Loot table to select items from.", + "title": "Loot Table" + }, "max_dist": { "type": "number", "default": 0, @@ -46,7 +62,9 @@ }, "offering_distance": { "type": "number", - "default": [1.0], + "default": [ + 1.0 + ], "description": "The distance in blocks the mob will try to be away from the entity when it drops the item.", "title": "Offering Distance" }, @@ -55,9 +73,25 @@ "description": "Event to run when this mob attempts to drop an item.", "title": "On Drop Attempt" }, - "seconds_before_pickup": { "title": "Seconds Before Pickup", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - "search_count": { "type": "integer", "default": 1, "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Search Height" }, - "search_height": { "type": "integer", "default": 1, "description": "Height in blocks from the target the mob can be.", "title": "Search Height" }, + "seconds_before_pickup": { + "title": "Seconds Before Pickup", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + "search_count": { + "type": "integer", + "default": 1, + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Search Height" + }, + "search_height": { + "type": "integer", + "default": 1, + "description": "Height in blocks from the target the mob can be.", + "title": "Search Height" + }, "search_range": { "type": "integer", "default": 0, @@ -69,24 +103,74 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "array", - "items": [{ "type": "number" }, { "type": "number" }, { "type": "number" }] + "items": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ] }, "teleport_offset": { "title": "Teleport Offset", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "array", - "items": [{ "type": "number" }, { "type": "number" }, { "type": "number" }] + "items": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ] }, "time_of_day_range": { - "default": [0.0, 1.0], + "default": [ + 0.0, + 1.0 + ], "description": "The valid times of day that this goal can be used. For reference: noon is 0.0, sunset is 0.25, midnight is 0.5, and sunrise is 0.75, and back to noon for 1.0.", "title": "Time Of Day Range", "type": "array", "items": [ - { "type": "number", "minimum": 0, "maximum": 1 }, - { "type": "number", "minimum": 0, "maximum": 1 } + { + "type": "number", + "minimum": 0, + "maximum": 1 + }, + { + "type": "number", + "minimum": 0, + "maximum": 1 + } ] } - } -} + }, + "examples": [ + { + "cooldown": 0.0, + "drop_item_chance": 0.0, + "goal_radius": 0.5, + "loot_table": "example", + "max_dist": 0, + "minimum_teleport_distance": 0.0, + "max_head_look_at_height": 0.0, + "offering_distance": 0.0, + "seconds_before_pickup": 0.0, + "search_count": 1, + "search_height": 1, + "search_range": 0, + "target_range": [], + "teleport_offset": [], + "time_of_day_range": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/eat_block.json b/source/behavior/entities/format/behaviors/eat_block.json index 7e275712..c6436c3a 100644 --- a/source/behavior/entities/format/behaviors/eat_block.json +++ b/source/behavior/entities/format/behaviors/eat_block.json @@ -7,7 +7,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "on_eat": { "$ref": "../types/trigger.json", "description": "UNDOCUMENTED", @@ -54,5 +56,11 @@ } } } - } -} + }, + "examples": [ + { + "time_until_eat": 0.0, + "eat_and_replace_block_pairs": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/eat_carried_item.json b/source/behavior/entities/format/behaviors/eat_carried_item.json index 36726131..752a9793 100644 --- a/source/behavior/entities/format/behaviors/eat_carried_item.json +++ b/source/behavior/entities/format/behaviors/eat_carried_item.json @@ -5,11 +5,18 @@ "description": "If the mob is carrying a food item, the mob will eat it and the effects will be applied to the mob.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "delay_before_eating": { "type": "number", "description": "Time in seconds the mob should wait before eating the item.", "title": "Delay Before Eating" } - } -} + }, + "examples": [ + { + "delay_before_eating": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/enderman_leave_block.json b/source/behavior/entities/format/behaviors/enderman_leave_block.json index 04bfda68..81519118 100644 --- a/source/behavior/entities/format/behaviors/enderman_leave_block.json +++ b/source/behavior/entities/format/behaviors/enderman_leave_block.json @@ -5,5 +5,9 @@ "additionalProperties": false, "description": "Allows the enderman to drop a block they are carrying. Can only be used by Endermen.", "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/enderman_take_block.json b/source/behavior/entities/format/behaviors/enderman_take_block.json index ed592d98..ec25c9cd 100644 --- a/source/behavior/entities/format/behaviors/enderman_take_block.json +++ b/source/behavior/entities/format/behaviors/enderman_take_block.json @@ -5,5 +5,9 @@ "description": "Allows the enderman to take a block and carry it around. Can only be used by Endermen.", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/equip_item.json b/source/behavior/entities/format/behaviors/equip_item.json index 2148937f..fac49e2d 100644 --- a/source/behavior/entities/format/behaviors/equip_item.json +++ b/source/behavior/entities/format/behaviors/equip_item.json @@ -4,5 +4,9 @@ "title": "Equip Item", "description": "Allows the entity to equip desired equipment.", "additionalProperties": false, - "properties": { "priority": { "$ref": "types/priority.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/explore_outskirts.json b/source/behavior/entities/format/behaviors/explore_outskirts.json index 4851453a..870730c0 100644 --- a/source/behavior/entities/format/behaviors/explore_outskirts.json +++ b/source/behavior/entities/format/behaviors/explore_outskirts.json @@ -6,34 +6,112 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "explore_dist": { "type": "number", "default": 5, "description": "The distance in which the mob will proceed past the village bounds", "title": "Explore Dist" }, - "wait_time": { "type": "integer", "default": 0, "description": "The time the mob will stand around `searching` for POIs", "title": "Wait Time" }, - - "next_xz": { "title": "Next XZ", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "integer" }, - "next_y": { "title": "Next Y", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "integer" }, - "min_wait_time": { "title": "Minimum Wait Time", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - "max_wait_time": { "title": "Maximum Wait Time", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - "max_travel_time": { "title": "Maximum Travel Time", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - "min_perimeter": { "title": "Minimum Perimeter", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - "min_dist_from_target": { "title": "Minimum Distance From Target", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - "timer_ratio": { "title": "Timer Ratio", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, + "wait_time": { + "type": "integer", + "default": 0, + "description": "The time the mob will stand around `searching` for POIs", + "title": "Wait Time" + }, + "next_xz": { + "title": "Next XZ", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "integer" + }, + "next_y": { + "title": "Next Y", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "integer" + }, + "min_wait_time": { + "title": "Minimum Wait Time", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + "max_wait_time": { + "title": "Maximum Wait Time", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + "max_travel_time": { + "title": "Maximum Travel Time", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + "min_perimeter": { + "title": "Minimum Perimeter", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + "min_dist_from_target": { + "title": "Minimum Distance From Target", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + "timer_ratio": { + "title": "Timer Ratio", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, "dist_from_boundary": { "title": "Distance From Boundary", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "array", "items": [ - { "title": "X", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - { "title": "Y", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" }, - { "title": "Z", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" } + { + "title": "X", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + { + "title": "Y", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + }, + { + "title": "Z", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + } ] } - } -} + }, + "examples": [ + { + "explore_dist": 5, + "wait_time": 0, + "next_xz": 0, + "next_y": 0, + "min_wait_time": 0.0, + "max_wait_time": 0.0, + "max_travel_time": 0.0, + "min_perimeter": 0.0, + "min_dist_from_target": 0.0, + "timer_ratio": 0.0, + "dist_from_boundary": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/find_cover copy.json b/source/behavior/entities/format/behaviors/find_cover copy.json index f33e3da4..2a7bc812 100644 --- a/source/behavior/entities/format/behaviors/find_cover copy.json +++ b/source/behavior/entities/format/behaviors/find_cover copy.json @@ -5,13 +5,22 @@ "description": "Allows the mob to seek shade.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "cooldown_time": { "type": "number", "default": 0, "description": "Time in seconds the mob has to wait before using the goal again", "title": "Cooldown Time" } - } -} + }, + "examples": [ + { + "cooldown_time": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/find_cover.json b/source/behavior/entities/format/behaviors/find_cover.json index f33e3da4..2a7bc812 100644 --- a/source/behavior/entities/format/behaviors/find_cover.json +++ b/source/behavior/entities/format/behaviors/find_cover.json @@ -5,13 +5,22 @@ "description": "Allows the mob to seek shade.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "cooldown_time": { "type": "number", "default": 0, "description": "Time in seconds the mob has to wait before using the goal again", "title": "Cooldown Time" } - } -} + }, + "examples": [ + { + "cooldown_time": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/find_mount.json b/source/behavior/entities/format/behaviors/find_mount.json index bbd2275a..9c407810 100644 --- a/source/behavior/entities/format/behaviors/find_mount.json +++ b/source/behavior/entities/format/behaviors/find_mount.json @@ -5,7 +5,9 @@ "title": "Find Mount", "type": "object", "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "avoid_water": { "type": "boolean", "default": false, @@ -42,5 +44,15 @@ "$comment": "UNDOCUMENTED", "title": "Maximum Failed Attempts" } - } -} + }, + "examples": [ + { + "avoid_water": false, + "mount_distance": -1, + "start_delay": 0, + "target_needed": false, + "within_radius": 0, + "max_failed_attempts": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/find_underwater_treasure.json b/source/behavior/entities/format/behaviors/find_underwater_treasure.json index f1334466..3ede2aff 100644 --- a/source/behavior/entities/format/behaviors/find_underwater_treasure.json +++ b/source/behavior/entities/format/behaviors/find_underwater_treasure.json @@ -6,14 +6,29 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "search_range": { "type": "integer", "default": 0, "description": "The range that the mob will search for a treasure chest within a ruin or shipwreck to move towards.", "title": "Search Range" }, - "stop_distance": { "type": "number", "default": 2.0, "description": "The distance the mob will move before stopping.", "title": "Stop Distance" } - } -} + "stop_distance": { + "type": "number", + "default": 2.0, + "description": "The distance the mob will move before stopping.", + "title": "Stop Distance" + } + }, + "examples": [ + { + "search_range": 0, + "stop_distance": 2.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/flee_sun.json b/source/behavior/entities/format/behaviors/flee_sun.json index d39778d7..ff547c09 100644 --- a/source/behavior/entities/format/behaviors/flee_sun.json +++ b/source/behavior/entities/format/behaviors/flee_sun.json @@ -5,5 +5,12 @@ "description": "Allows the mob to run away from direct sunlight and seek shade.", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/float.json b/source/behavior/entities/format/behaviors/float.json index 68a306e6..679167dc 100644 --- a/source/behavior/entities/format/behaviors/float.json +++ b/source/behavior/entities/format/behaviors/float.json @@ -5,5 +5,9 @@ "description": "Allows the mob to stay afloat while swimming.", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/float_wander.json b/source/behavior/entities/format/behaviors/float_wander.json index d9f34704..7592cc15 100644 --- a/source/behavior/entities/format/behaviors/float_wander.json +++ b/source/behavior/entities/format/behaviors/float_wander.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "xz_dist": { "type": "integer", "default": 10, @@ -19,7 +21,12 @@ "description": "Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1", "title": "Y Dist" }, - "y_offset": { "type": "number", "default": 0.0, "description": "Height in blocks to add to the selected target position", "title": "Y Offset" }, + "y_offset": { + "type": "number", + "default": 0.0, + "description": "Height in blocks to add to the selected target position", + "title": "Y Offset" + }, "must_reach": { "type": "boolean", "default": false, @@ -34,9 +41,21 @@ }, "float_duration": { "$ref": "../types/range_number_type.json", - "default": [0.0, 0.0], + "default": [ + 0.0, + 0.0 + ], "description": "Range of time in seconds the mob will float around before landing and choosing to do something else", "title": "Float Duration" } - } -} + }, + "examples": [ + { + "xz_dist": 10, + "y_dist": 7, + "y_offset": 0.0, + "must_reach": false, + "random_reselect": false + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/follow_caravan.json b/source/behavior/entities/format/behaviors/follow_caravan.json index b72568cd..17d06f1c 100644 --- a/source/behavior/entities/format/behaviors/follow_caravan.json +++ b/source/behavior/entities/format/behaviors/follow_caravan.json @@ -6,13 +6,27 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entity types that this mob can follow in a caravan", "title": "Entity Types" }, - "entity_count": { "type": "integer", "description": "Number of entities that can be in the caravan", "default": 1, "title": "Entity Count" } - } -} + "entity_count": { + "type": "integer", + "description": "Number of entities that can be in the caravan", + "default": 1, + "title": "Entity Count" + } + }, + "examples": [ + { + "entity_count": 1 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/follow_mob.json b/source/behavior/entities/format/behaviors/follow_mob.json index 068eb460..4220ee42 100644 --- a/source/behavior/entities/format/behaviors/follow_mob.json +++ b/source/behavior/entities/format/behaviors/follow_mob.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "search_range": { "type": "integer", "default": 0, @@ -20,5 +24,11 @@ "description": "The distance in blocks this mob stops from the mob it is following", "title": "Stop Distance" } - } -} + }, + "examples": [ + { + "search_range": 0, + "stop_distance": 2 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/follow_owner.json b/source/behavior/entities/format/behaviors/follow_owner.json index 90df783d..8f5c57d6 100644 --- a/source/behavior/entities/format/behaviors/follow_owner.json +++ b/source/behavior/entities/format/behaviors/follow_owner.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "start_distance": { "type": "number", "default": 10, @@ -20,5 +24,11 @@ "description": "The distance in blocks this mob will stop from its owner while following it", "title": "Stop Distance" } - } -} + }, + "examples": [ + { + "start_distance": 10, + "stop_distance": 2 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/follow_parent.json b/source/behavior/entities/format/behaviors/follow_parent.json index bb9282cd..7b4af5d8 100644 --- a/source/behavior/entities/format/behaviors/follow_parent.json +++ b/source/behavior/entities/format/behaviors/follow_parent.json @@ -5,5 +5,12 @@ "description": "Allows the mob to follow their parent around.", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "./types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/follow_target_captain.json b/source/behavior/entities/format/behaviors/follow_target_captain.json index 96510f90..eab226d7 100644 --- a/source/behavior/entities/format/behaviors/follow_target_captain.json +++ b/source/behavior/entities/format/behaviors/follow_target_captain.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "follow_distance": { "type": "number", "default": 0, @@ -20,5 +24,11 @@ "description": "Defines the maximum distance in blocks a mob can get from its target captain before giving up trying to follow it.", "title": "Within Radius" } - } -} + }, + "examples": [ + { + "follow_distance": 0, + "within_radius": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/go_home.json b/source/behavior/entities/format/behaviors/go_home.json index 2c81c6d7..df9016a7 100644 --- a/source/behavior/entities/format/behaviors/go_home.json +++ b/source/behavior/entities/format/behaviors/go_home.json @@ -5,8 +5,12 @@ "title": "Go Home", "type": "object", "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, @@ -22,7 +26,17 @@ "on_home": { "description": "Event to run when this mob gets home.", "title": "On Home", - "oneOf": [{ "$ref": "../types/trigger.json" }, { "type": "array", "items": { "$ref": "../types/trigger.json" } }] + "oneOf": [ + { + "$ref": "../types/trigger.json" + }, + { + "type": "array", + "items": { + "$ref": "../types/trigger.json" + } + } + ] }, "on_failed": { "$ref": "../types/event.json", @@ -30,5 +44,11 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } -} + }, + "examples": [ + { + "goal_radius": 0.5, + "interval": 120 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/guardian_attack.json b/source/behavior/entities/format/behaviors/guardian_attack.json index 8977ca57..7fb108a6 100644 --- a/source/behavior/entities/format/behaviors/guardian_attack.json +++ b/source/behavior/entities/format/behaviors/guardian_attack.json @@ -5,5 +5,9 @@ "description": "Allows the guardian to use its laser beam attack. Can only be used by Guardians and Elder Guardians.", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/harvest_farm_block.json b/source/behavior/entities/format/behaviors/harvest_farm_block.json index 10beab8f..c3eee1f1 100644 --- a/source/behavior/entities/format/behaviors/harvest_farm_block.json +++ b/source/behavior/entities/format/behaviors/harvest_farm_block.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "max_seconds_before_search": { "title": "Maximum Seconds Before Search", "description": "UNDOCUMENTED", @@ -20,6 +24,18 @@ "$comment": "UNDOCUMENTED", "type": "number" }, - "seconds_until_new_task": { "title": "Seconds Until New Task", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "number" } - } -} + "seconds_until_new_task": { + "title": "Seconds Until New Task", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "number" + } + }, + "examples": [ + { + "max_seconds_before_search": 0.0, + "search_cooldown_max_seconds": 0.0, + "seconds_until_new_task": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/hide.json b/source/behavior/entities/format/behaviors/hide.json index 20cc3b52..6a52eaa1 100644 --- a/source/behavior/entities/format/behaviors/hide.json +++ b/source/behavior/entities/format/behaviors/hide.json @@ -6,15 +6,26 @@ "description": "Allows a mob with the hide component to attempt to move to - and hide at - an owned or nearby POI.", "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, - "duration": { "type": "number", "default": 1, "description": "Amount of time in seconds that the mob reacts.", "title": "Duration" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, + "duration": { + "type": "number", + "default": 1, + "description": "Amount of time in seconds that the mob reacts.", + "title": "Duration" + }, "poi_type": { "type": "string", "default": "", "description": "Defines what POI type to hide at.", "title": "Point Of Interest Type", - "examples": ["bed"] + "examples": [ + "bed" + ] }, "timeout_cooldown": { "type": "number", @@ -22,5 +33,12 @@ "description": "The cooldown time in seconds before the goal can be reused after a internal failure or timeout condition.", "title": "Timeout Cooldown" } - } -} + }, + "examples": [ + { + "duration": 1, + "poi_type": "", + "timeout_cooldown": 8 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/hold_ground.json b/source/behavior/entities/format/behaviors/hold_ground.json index fbe57317..df813a40 100644 --- a/source/behavior/entities/format/behaviors/hold_ground.json +++ b/source/behavior/entities/format/behaviors/hold_ground.json @@ -5,14 +5,21 @@ "description": "The mob freezes and looks at the mob they are targeting.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "broadcast": { "type": "boolean", "default": false, "description": "Whether to broadcast out the mob's target to other mobs of the same type.", "title": "Broadcast" }, - "broadcast_range": { "type": "number", "default": 0.0, "description": "Range in blocks for how far to broadcast.", "title": "Broadcast Range" }, + "broadcast_range": { + "type": "number", + "default": 0.0, + "description": "Range in blocks for how far to broadcast.", + "title": "Broadcast Range" + }, "min_radius": { "type": "number", "default": 10.0, @@ -24,5 +31,12 @@ "description": "Event to run when target is within the radius. This event is broadcasted if broadcast is true.", "title": "Within Radius Event" } - } -} + }, + "examples": [ + { + "broadcast": false, + "broadcast_range": 0.0, + "min_radius": 10.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/hurt_by_target.json b/source/behavior/entities/format/behaviors/hurt_by_target.json index ed7964e9..af2a0d74 100644 --- a/source/behavior/entities/format/behaviors/hurt_by_target.json +++ b/source/behavior/entities/format/behaviors/hurt_by_target.json @@ -6,7 +6,9 @@ "description": "Allows the mob to target another mob that hurts them.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entity types that this mob can target if they hurt their owner", @@ -24,5 +26,11 @@ "description": "If true, the mob will hurt its owner and other mobs with the same owner as itself", "title": "Hurt Owner" } - } -} + }, + "examples": [ + { + "alert_same_type": false, + "hurt_owner": false + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/inspect_bookshelf.json b/source/behavior/entities/format/behaviors/inspect_bookshelf.json index ceb5e088..df53ccb4 100644 --- a/source/behavior/entities/format/behaviors/inspect_bookshelf.json +++ b/source/behavior/entities/format/behaviors/inspect_bookshelf.json @@ -6,8 +6,12 @@ "description": "Allows the mob to inspect bookshelves.", "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, @@ -32,5 +36,13 @@ "description": "Distance in blocks the mob will look for books to inspect", "title": "Search Range" } - } -} + }, + "examples": [ + { + "goal_radius": 0.5, + "search_count": 10, + "search_height": 1, + "search_range": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/jump_to_block.json b/source/behavior/entities/format/behaviors/jump_to_block.json index 96038dbf..7797da57 100644 --- a/source/behavior/entities/format/behaviors/jump_to_block.json +++ b/source/behavior/entities/format/behaviors/jump_to_block.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "search_width": { "type": "integer", "title": "Search Width", @@ -42,9 +44,29 @@ "description": "The minimum and maximum cooldown time-range in seconds between each attempted jump.", "type": "array", "items": [ - { "title": "Minimum", "description": "Minimum", "type": "integer", "minimum": 0 }, - { "title": "Maximum", "description": "Maximum", "type": "integer", "minimum": 0 } + { + "title": "Minimum", + "description": "Minimum", + "type": "integer", + "minimum": 0 + }, + { + "title": "Maximum", + "description": "Maximum", + "type": "integer", + "minimum": 0 + } ] } - } -} + }, + "examples": [ + { + "search_width": 8, + "search_height": 10, + "minimum_path_length": 5, + "minimum_distance": 5, + "scale_factor": 0.7, + "cooldown_range": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/knockback_roar.json b/source/behavior/entities/format/behaviors/knockback_roar.json index d3d6daf2..dd4cd70c 100644 --- a/source/behavior/entities/format/behaviors/knockback_roar.json +++ b/source/behavior/entities/format/behaviors/knockback_roar.json @@ -4,9 +4,10 @@ "type": "object", "title": "Knockback Roar", "additionalProperties": false, - "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "attack_time": { "type": "number", "default": 0.5, @@ -55,7 +56,12 @@ "description": "If true, this mob will chase after the target as long as it's a valid target", "title": "Track Target" }, - "knockback_strength": { "type": "integer", "default": 4, "description": "The strength of the knockback.", "title": "Knockback Strength" }, + "knockback_strength": { + "type": "integer", + "default": 4, + "description": "The strength of the knockback.", + "title": "Knockback Strength" + }, "knockback_filters": { "$ref": "../../filters/filters.json", "description": "filters to use to decide what is affected by knockback roar.", @@ -71,5 +77,18 @@ "description": "Event to run when knockback roar has finished.", "title": "On Roar End" } - } -} + }, + "examples": [ + { + "attack_time": 0.5, + "cooldown_time": 0, + "duration": 1, + "knockback_damage": 6, + "knockback_horizontal_strength": 4, + "knockback_range": 4, + "knockback_vertical_strength": 4, + "track_target": false, + "knockback_strength": 4 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/lay_down.json b/source/behavior/entities/format/behaviors/lay_down.json index 0bc42a72..ad419ee0 100644 --- a/source/behavior/entities/format/behaviors/lay_down.json +++ b/source/behavior/entities/format/behaviors/lay_down.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "interval": { "type": "integer", "default": 120, @@ -19,5 +21,11 @@ "description": "A random value in which the goal can use to pull out of the behavior. This is a 1/interval chance to play the sound", "title": "Random Stop Interval" } - } -} + }, + "examples": [ + { + "interval": 120, + "random_stop_interval": 120 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/lay_egg.json b/source/behavior/entities/format/behaviors/lay_egg.json index 59acf8af..e225b9c4 100644 --- a/source/behavior/entities/format/behaviors/lay_egg.json +++ b/source/behavior/entities/format/behaviors/lay_egg.json @@ -6,15 +6,23 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, "description": "Distance in blocks within the mob considers it has reached the goal. This is the `wiggle room` to stop the AI from bouncing back and forth trying to reach a specific spot", "title": "Goal Radius" }, - "on_lay": { "$ref": "../types/event.json", "description": "Event to run when this mob lays the egg.", "title": "On Lay" }, + "on_lay": { + "$ref": "../types/event.json", + "description": "Event to run when this mob lays the egg.", + "title": "On Lay" + }, "search_height": { "type": "integer", "default": 1, @@ -27,5 +35,12 @@ "description": "The distance in blocks it will look for a sand block to move towards", "title": "Search Range" } - } -} + }, + "examples": [ + { + "goal_radius": 0.5, + "search_height": 1, + "search_range": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/leap_at_target.json b/source/behavior/entities/format/behaviors/leap_at_target.json index 217aac4c..85fea79a 100644 --- a/source/behavior/entities/format/behaviors/leap_at_target.json +++ b/source/behavior/entities/format/behaviors/leap_at_target.json @@ -4,9 +4,10 @@ "type": "object", "title": "Leap At Target", "additionalProperties": false, - "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "must_be_on_ground": { "type": "boolean", "default": true, @@ -19,7 +20,26 @@ "description": "Allows the actor to be set to persist upon targeting a player", "title": "Set Persistent" }, - "yd": { "type": "number", "default": 0, "description": "The height in blocks the mob jumps when leaping at its target", "title": "Yd" }, - "target_dist": { "type": "number", "default": 0, "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Target Dist" } - } -} + "yd": { + "type": "number", + "default": 0, + "description": "The height in blocks the mob jumps when leaping at its target", + "title": "Yd" + }, + "target_dist": { + "type": "number", + "default": 0, + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Target Dist" + } + }, + "examples": [ + { + "must_be_on_ground": true, + "set_persistent": false, + "yd": 0, + "target_dist": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/look_at_entity.json b/source/behavior/entities/format/behaviors/look_at_entity.json index b6279a06..347c6cc2 100644 --- a/source/behavior/entities/format/behaviors/look_at_entity.json +++ b/source/behavior/entities/format/behaviors/look_at_entity.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "look_distance": { "type": "number", "default": 8.0, @@ -21,7 +23,10 @@ }, "look_time": { "$ref": "../types/range_number_type.json", - "default": [2, 4], + "default": [ + 2, + 4 + ], "description": "Time range to look at the entity", "title": "Look Time" }, @@ -41,5 +46,13 @@ "description": "Filter to determine the conditions for this mob to look at the entity", "$ref": "../../filters/filters.json" } - } -} + }, + "examples": [ + { + "look_distance": 8.0, + "probability": 0.02, + "angle_of_view_vertical": 360, + "angle_of_view_horizontal": 360 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/look_at_player.json b/source/behavior/entities/format/behaviors/look_at_player.json index c3ddf9e6..2ae2aa7e 100644 --- a/source/behavior/entities/format/behaviors/look_at_player.json +++ b/source/behavior/entities/format/behaviors/look_at_player.json @@ -4,9 +4,10 @@ "title": "Look At Player", "description": "Allows the mob to look at the player when the player is nearby.", "additionalProperties": false, - "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "angle_of_view_vertical": { "type": "integer", "default": 360, @@ -34,11 +35,36 @@ }, "look_time": { "type": "array", - "default": [2, 4], + "default": [ + 2, + 4 + ], "description": "Time range to look at the entity", "title": "Look Time", - "items": [{ "type": "number" }, { "type": "number" }] + "items": [ + { + "type": "number" + }, + { + "type": "number" + } + ] }, - "target_distance": { "type": "number", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Target Distance" } - } -} + "target_distance": { + "type": "number", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Target Distance" + } + }, + "examples": [ + { + "angle_of_view_vertical": 360, + "angle_of_view_horizontal": 360, + "look_distance": 8.0, + "probability": 0.02, + "look_time": [], + "target_distance": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/look_at_target.json b/source/behavior/entities/format/behaviors/look_at_target.json index a8bdb155..ce84d2b0 100644 --- a/source/behavior/entities/format/behaviors/look_at_target.json +++ b/source/behavior/entities/format/behaviors/look_at_target.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "look_distance": { "type": "number", "default": 8.0, @@ -21,7 +23,10 @@ }, "look_time": { "$ref": "../types/range_number_type.json", - "default": [2, 4], + "default": [ + 2, + 4 + ], "description": "Time range to look at the entity", "title": "Look Time" }, @@ -37,5 +42,13 @@ "description": "The angle in degrees that the mob can see in the Y-axis (up-down)", "title": "Angle Of View Horizontal" } - } -} + }, + "examples": [ + { + "look_distance": 8.0, + "probability": 0.02, + "angle_of_view_vertical": 360, + "angle_of_view_horizontal": 360 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/look_at_trading_player.json b/source/behavior/entities/format/behaviors/look_at_trading_player.json index e3523fc2..8153e1bb 100644 --- a/source/behavior/entities/format/behaviors/look_at_trading_player.json +++ b/source/behavior/entities/format/behaviors/look_at_trading_player.json @@ -6,7 +6,9 @@ "description": "Allows the mob to look at the player they are trading with.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "look_distance": { "type": "number", "default": 8.0, @@ -21,7 +23,10 @@ }, "look_time": { "$ref": "../types/range_number_type.json", - "default": [2, 4], + "default": [ + 2, + 4 + ], "description": "Time range to look at the entity", "title": "Look Time" }, @@ -37,5 +42,13 @@ "description": "The angle in degrees that the mob can see in the Y-axis (up-down)", "title": "Angle Of View Horizontal" } - } -} + }, + "examples": [ + { + "look_distance": 8.0, + "probability": 0.02, + "angle_of_view_vertical": 360, + "angle_of_view_horizontal": 360 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/make_love.json b/source/behavior/entities/format/behaviors/make_love.json index 74bef1e7..81626576 100644 --- a/source/behavior/entities/format/behaviors/make_love.json +++ b/source/behavior/entities/format/behaviors/make_love.json @@ -5,5 +5,9 @@ "title": "Make Love", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/melee_attack.json b/source/behavior/entities/format/behaviors/melee_attack.json index 56b39435..6ca6d89a 100644 --- a/source/behavior/entities/format/behaviors/melee_attack.json +++ b/source/behavior/entities/format/behaviors/melee_attack.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "melee_fov": { "type": "number", "default": 90.0, @@ -20,7 +24,11 @@ "description": "If true, this mob will chase after the target as long as it's a valid target", "title": "Track Target" }, - "attack_types": { "type": "string", "description": "Defines the entity types this mob will attack", "title": "Attack Types" }, + "attack_types": { + "type": "string", + "description": "Defines the entity types this mob will attack", + "title": "Attack Types" + }, "random_stop_interval": { "type": "integer", "default": 0, @@ -33,7 +41,12 @@ "description": "Multiplier for how far outside its box the mob can reach its target (this can be used to simulate a mob with longer arms by making this bigger)", "title": "Reach Multiplier" }, - "attack_once": { "type": "boolean", "default": false, "description": "If true, this mob will attack only one time.", "title": "Attack Once" }, + "attack_once": { + "type": "boolean", + "default": false, + "description": "If true, this mob will attack only one time.", + "title": "Attack Once" + }, "require_complete_path": { "type": "boolean", "default": false, @@ -58,5 +71,17 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } -} + }, + "examples": [ + { + "melee_fov": 90.0, + "track_target": false, + "attack_types": "example", + "random_stop_interval": 0, + "reach_multiplier": 2.0, + "attack_once": false, + "require_complete_path": false, + "cooldown_time": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/mingle.json b/source/behavior/entities/format/behaviors/mingle.json index 1e2117d1..20bb2640 100644 --- a/source/behavior/entities/format/behaviors/mingle.json +++ b/source/behavior/entities/format/behaviors/mingle.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "cooldown_time": { "type": "number", "default": 0, @@ -30,9 +34,24 @@ "description": "The entity type that this entity is allowed to mingle with", "title": "Mingle Partner Type", "oneOf": [ - { "type": "array", "items": { "description": "The entity type that this entity is allowed to mingle with", "type": "string" } }, - { "type": "string" } + { + "type": "array", + "items": { + "description": "The entity type that this entity is allowed to mingle with", + "type": "string" + } + }, + { + "type": "string" + } ] } - } -} + }, + "examples": [ + { + "cooldown_time": 0, + "duration": 1, + "mingle_distance": 2.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/mount_pathing.json b/source/behavior/entities/format/behaviors/mount_pathing.json index 86dbc1e1..31885762 100644 --- a/source/behavior/entities/format/behaviors/mount_pathing.json +++ b/source/behavior/entities/format/behaviors/mount_pathing.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "target_dist": { "type": "number", "default": 0.0, @@ -20,5 +24,11 @@ "description": "If true, this mob will chase after the target as long as it's a valid target", "title": "Track Target" } - } -} + }, + "examples": [ + { + "target_dist": 0.0, + "track_target": false + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_indoors.json b/source/behavior/entities/format/behaviors/move_indoors.json index 216457d8..ae7b0cdc 100644 --- a/source/behavior/entities/format/behaviors/move_indoors.json +++ b/source/behavior/entities/format/behaviors/move_indoors.json @@ -6,13 +6,22 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "timeout_cooldown": { "type": "number", "default": 8, "description": "The cooldown time in seconds before the goal can be reused after a internal failure or timeout condition", "title": "Timeout Cooldown" } - } -} + }, + "examples": [ + { + "timeout_cooldown": 8 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_through_village.json b/source/behavior/entities/format/behaviors/move_through_village.json index 0b37d604..da5fc1ce 100644 --- a/source/behavior/entities/format/behaviors/move_through_village.json +++ b/source/behavior/entities/format/behaviors/move_through_village.json @@ -6,13 +6,22 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "only_at_night": { "type": "boolean", "default": false, "description": "If true, the mob will only move through the village during night time", "title": "Only At Night" } - } -} + }, + "examples": [ + { + "only_at_night": false + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_block.json b/source/behavior/entities/format/behaviors/move_to_block.json index 4d143b3c..156e7457 100644 --- a/source/behavior/entities/format/behaviors/move_to_block.json +++ b/source/behavior/entities/format/behaviors/move_to_block.json @@ -7,7 +7,9 @@ "$comment": "UNDOCUMENTED", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "tick_interval": { "type": "number", "title": "Tick Interval", @@ -55,28 +57,59 @@ "title": "Target Offset", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "items": [{ "type": "number" }, { "type": "number" }, { "type": "number" }] + "items": [ + { + "type": "number" + }, + { + "type": "number" + }, + { + "type": "number" + } + ] }, "target_blocks": { "type": "array", "title": "Target Blocks", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "items": { "type": "string" } + "items": { + "type": "string" + } }, "on_stay_completed": { "type": "array", "title": "On Stay Completed", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "items": { "$ref": "../types/event.json" } + "items": { + "$ref": "../types/event.json" + } }, "on_reach": { "type": "array", "title": "On Reach", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "items": { "$ref": "../types/event.json" } + "items": { + "$ref": "../types/event.json" + } } - } -} + }, + "examples": [ + { + "tick_interval": 0.0, + "start_chance": 0.0, + "search_range": 0.0, + "search_height": 0.0, + "goal_radius": 0.0, + "stay_duration": 0.0, + "target_selection_method": "example", + "target_offset": [], + "target_blocks": [], + "on_stay_completed": [], + "on_reach": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_land.json b/source/behavior/entities/format/behaviors/move_to_land.json index 4e5fa806..f727a6d0 100644 --- a/source/behavior/entities/format/behaviors/move_to_land.json +++ b/source/behavior/entities/format/behaviors/move_to_land.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, @@ -32,5 +36,13 @@ "description": "The distance in blocks it will look for land to move towards", "title": "Search Range" } - } -} + }, + "examples": [ + { + "goal_radius": 0.5, + "search_count": 10, + "search_height": 1, + "search_range": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_lava.json b/source/behavior/entities/format/behaviors/move_to_lava.json index e2700378..66b88761 100644 --- a/source/behavior/entities/format/behaviors/move_to_lava.json +++ b/source/behavior/entities/format/behaviors/move_to_lava.json @@ -5,8 +5,12 @@ "description": "Allows the mob to move back into lava when on land.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, @@ -31,5 +35,13 @@ "description": "The distance in blocks it will look for lava to move towards", "title": "Search Range" } - } -} + }, + "examples": [ + { + "goal_radius": 0.5, + "search_count": 10, + "search_height": 1, + "search_range": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_liquid.json b/source/behavior/entities/format/behaviors/move_to_liquid.json index 858d94d2..2064ecfb 100644 --- a/source/behavior/entities/format/behaviors/move_to_liquid.json +++ b/source/behavior/entities/format/behaviors/move_to_liquid.json @@ -5,8 +5,12 @@ "description": "Allows the mob to move back into lava when on land.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, @@ -31,6 +35,19 @@ "description": "The distance in blocks it will look for lava to move towards", "title": "Search Range" }, - "material_type": { "title": "Material Type", "description": "UNDOCUMENTAED, examples are : Lava", "type": "string" } - } -} + "material_type": { + "title": "Material Type", + "description": "UNDOCUMENTAED, examples are : Lava", + "type": "string" + } + }, + "examples": [ + { + "goal_radius": 0.5, + "search_count": 10, + "search_height": 1, + "search_range": 0, + "material_type": "example" + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_poi.json b/source/behavior/entities/format/behaviors/move_to_poi.json index 36b56908..b7f84b14 100644 --- a/source/behavior/entities/format/behaviors/move_to_poi.json +++ b/source/behavior/entities/format/behaviors/move_to_poi.json @@ -6,8 +6,21 @@ "description": "Allows the mob to move to a POI if able to", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, - "poi_type": { "type": "string", "description": "Tells the goal what POI type it should be looking for", "title": "Point Of Interest Type" } - } -} + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, + "poi_type": { + "type": "string", + "description": "Tells the goal what POI type it should be looking for", + "title": "Point Of Interest Type" + } + }, + "examples": [ + { + "poi_type": "example" + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_random_block.json b/source/behavior/entities/format/behaviors/move_to_random_block.json index a6b4fd63..13222d0e 100644 --- a/source/behavior/entities/format/behaviors/move_to_random_block.json +++ b/source/behavior/entities/format/behaviors/move_to_random_block.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "block_distance": { "type": "number", "default": 16, @@ -20,5 +24,11 @@ "description": "Defines the distance in blocks the mob has to be from the block for the movement to be finished.", "title": "Within Radius" } - } -} + }, + "examples": [ + { + "block_distance": 16, + "within_radius": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_village.json b/source/behavior/entities/format/behaviors/move_to_village.json index bf4fac4d..26f1b7ff 100644 --- a/source/behavior/entities/format/behaviors/move_to_village.json +++ b/source/behavior/entities/format/behaviors/move_to_village.json @@ -6,8 +6,12 @@ "description": "Allows the mob to move into a random location within a village.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "cooldown_time": { "type": "number", "default": 0, @@ -26,5 +30,12 @@ "description": "The distance in blocks to search for villages. If <= 0, find the closest village regardless of distance.", "title": "Search Range" } - } -} + }, + "examples": [ + { + "cooldown_time": 0, + "goal_radius": 0.5, + "search_range": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_to_water.json b/source/behavior/entities/format/behaviors/move_to_water.json index 50950e67..42ba9774 100644 --- a/source/behavior/entities/format/behaviors/move_to_water.json +++ b/source/behavior/entities/format/behaviors/move_to_water.json @@ -6,8 +6,12 @@ "description": "Allows the mob to move back into water when on land.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "search_range": { "type": "integer", "default": 0, @@ -32,5 +36,13 @@ "description": "Distance in blocks within the mob considers it has reached the goal. This is the `wiggle room` to stop the AI from bouncing back and forth trying to reach a specific spot", "title": "Goal Radius" } - } -} + }, + "examples": [ + { + "search_range": 0, + "search_height": 1, + "search_count": 10, + "goal_radius": 0.5 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_towards_dwelling_restriction.json b/source/behavior/entities/format/behaviors/move_towards_dwelling_restriction.json index 4f355b5d..56d9c06e 100644 --- a/source/behavior/entities/format/behaviors/move_towards_dwelling_restriction.json +++ b/source/behavior/entities/format/behaviors/move_towards_dwelling_restriction.json @@ -5,5 +5,12 @@ "additionalProperties": false, "description": "UNDOCUMENTED, comes from cat", "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/move_towards_home_restriction.json b/source/behavior/entities/format/behaviors/move_towards_home_restriction.json index 01c35249..f3042355 100644 --- a/source/behavior/entities/format/behaviors/move_towards_home_restriction.json +++ b/source/behavior/entities/format/behaviors/move_towards_home_restriction.json @@ -5,5 +5,12 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "additionalProperties": false, - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/move_towards_restriction.json b/source/behavior/entities/format/behaviors/move_towards_restriction.json index 0894b512..2e98bbbd 100644 --- a/source/behavior/entities/format/behaviors/move_towards_restriction.json +++ b/source/behavior/entities/format/behaviors/move_towards_restriction.json @@ -6,13 +6,30 @@ "description": "Allows Guardians, Iron Golems and Villagers to move within their pre-defined area that the mob should be restricted to. Other mobs don't have a restriction defined.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "control_flags": { "type": "array", - "items": { "type": "string", "enum": ["move", "look"], "description": "UNDOCUMENTED: control flags", "title": "Control Flags" }, + "items": { + "type": "string", + "enum": [ + "move", + "look" + ], + "description": "UNDOCUMENTED: control flags", + "title": "Control Flags" + }, "description": "UNDOCUMENTED: control flags", "title": "Control Flags" } - } -} + }, + "examples": [ + { + "control_flags": [] + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/move_towards_target.json b/source/behavior/entities/format/behaviors/move_towards_target.json index c80c0077..49abb809 100644 --- a/source/behavior/entities/format/behaviors/move_towards_target.json +++ b/source/behavior/entities/format/behaviors/move_towards_target.json @@ -6,13 +6,22 @@ "description": "Allows mob to move towards its current target.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "within_radius": { "type": "number", "default": 0.0, "description": "Defines the radius in blocks that the mob tries to be from the target. A value of 0 means it tries to occupy the same block as the target", "title": "Within Radius" } - } -} + }, + "examples": [ + { + "within_radius": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/nap.json b/source/behavior/entities/format/behaviors/nap.json index b8cb3f42..0e02a25f 100644 --- a/source/behavior/entities/format/behaviors/nap.json +++ b/source/behavior/entities/format/behaviors/nap.json @@ -5,8 +5,12 @@ "description": "Allows the mob to move back into lava when on land.", "additionalProperties": false, "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "cooldown_max": { "type": "number", "default": 0, @@ -43,5 +47,13 @@ "$comment": "UNDOCUMENTED", "title": "Wake Mob Exceptions" } - } -} + }, + "examples": [ + { + "cooldown_max": 0, + "cooldown_min": 0, + "mob_detect_dist": 6, + "mob_detect_height": 6 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/nearest_attackable_target.json b/source/behavior/entities/format/behaviors/nearest_attackable_target.json index 4f458b71..26e1e7ee 100644 --- a/source/behavior/entities/format/behaviors/nearest_attackable_target.json +++ b/source/behavior/entities/format/behaviors/nearest_attackable_target.json @@ -4,13 +4,16 @@ "title": "Nearest Attackable Target", "description": "Allows the mob to check for and pursue the nearest valid target.", "additionalProperties": false, - "definitions": { "entity_type": { "type": "object", "description": "A entity type", "properties": { - "filters": { "$ref": "../../filters/filters.json", "description": "Conditions that make this target a valid type.", "title": "Filters" }, + "filters": { + "$ref": "../../filters/filters.json", + "description": "Conditions that make this target a valid type.", + "title": "Filters" + }, "max_dist": { "type": "number", "default": 16, @@ -33,11 +36,23 @@ } }, "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "description": "Filters which types of targets are valid for this entity.", "title": "Entity Types", - "oneOf": [{ "$ref": "#/definitions/entity_type" }, { "type": "array", "items": { "$ref": "#/definitions/entity_type" } }] + "oneOf": [ + { + "$ref": "#/definitions/entity_type" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/entity_type" + } + } + ] }, "attack_interval": { "type": "integer", @@ -51,7 +66,12 @@ "description": "Alias for `attack_interval`; provides the same functionality as `attack_interval`.", "title": "Attack Interval Min" }, - "attack_owner": { "type": "boolean", "default": false, "description": "If true, this entity can attack its owner.", "title": "Attack Owner" }, + "attack_owner": { + "type": "boolean", + "default": false, + "description": "If true, this entity can attack its owner.", + "title": "Attack Owner" + }, "must_reach": { "type": "boolean", "default": false, @@ -118,5 +138,23 @@ "description": "Maximum distance this entity can be from the target when following it, otherwise the target becomes invalid. This value is only used if the entity doesn't declare `minecraft:follow_range`.", "title": "Within Radius" } - } -} + }, + "examples": [ + { + "attack_interval": 0, + "attack_interval_min": 0, + "attack_owner": false, + "must_reach": false, + "must_see": false, + "must_see_forget_duration": 3, + "persist_time": 0, + "reselect_targets": false, + "scan_interval": 10, + "set_persistent": false, + "target_invisible_multiplier": 0.7, + "target_search_height": -1, + "target_sneak_visibility_multiplier": 0.8, + "within_radius": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/nearest_prioritized_attackable_target.json b/source/behavior/entities/format/behaviors/nearest_prioritized_attackable_target.json index f410bcf0..0fa35a8c 100644 --- a/source/behavior/entities/format/behaviors/nearest_prioritized_attackable_target.json +++ b/source/behavior/entities/format/behaviors/nearest_prioritized_attackable_target.json @@ -4,15 +4,21 @@ "title": "Nearest Prioritized Attackable Target", "description": "Allows the mob to check for and pursue the nearest valid target.", "additionalProperties": false, - "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "description": "List of entity types that this mob considers valid targets", "title": "Entity Types", "$ref": "../types/entity_types.json" }, - "attack_interval": { "type": "integer", "default": 0, "description": "Time in seconds before selecting a target", "title": "Attack Interval" }, + "attack_interval": { + "type": "integer", + "default": 0, + "description": "Time in seconds before selecting a target", + "title": "Attack Interval" + }, "must_reach": { "type": "boolean", "default": false, @@ -67,5 +73,19 @@ "description": "Distance in blocks that the target can be within to launch an attack", "title": "Within Radius" } - } -} + }, + "examples": [ + { + "attack_interval": 0, + "must_reach": false, + "must_see": false, + "must_see_forget_duration": 3, + "persist_time": 0.0, + "reselect_targets": false, + "scan_interval": 10, + "set_persistent": false, + "target_search_height": -1.0, + "within_radius": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/ocelot_sit_on_block.json b/source/behavior/entities/format/behaviors/ocelot_sit_on_block.json index 785731b9..f8c2e672 100644 --- a/source/behavior/entities/format/behaviors/ocelot_sit_on_block.json +++ b/source/behavior/entities/format/behaviors/ocelot_sit_on_block.json @@ -5,5 +5,12 @@ "type": "object", "title": "Ocelot Sit On Block", "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "./types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/ocelotattack.json b/source/behavior/entities/format/behaviors/ocelotattack.json index efdebf4f..7d8a42f1 100644 --- a/source/behavior/entities/format/behaviors/ocelotattack.json +++ b/source/behavior/entities/format/behaviors/ocelotattack.json @@ -6,7 +6,9 @@ "description": "Can only be used by the Ocelot. Allows it to perform the sneak and pounce attack.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "walk_speed_multiplier": { "type": "number", "default": 1.0, @@ -67,5 +69,19 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } -} + }, + "examples": [ + { + "walk_speed_multiplier": 1.0, + "sprint_speed_multiplier": 1.0, + "sneak_speed_multiplier": 1.0, + "cooldown_time": 0.0, + "x_max_rotation": 0.0, + "y_max_head_rotation": 0.0, + "max_distance": 0.0, + "max_sneak_range": 0.0, + "max_sprint_range": 0.0, + "reach_multiplier": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/offer_flower.json b/source/behavior/entities/format/behaviors/offer_flower.json index 54c9cc17..8bb92fd6 100644 --- a/source/behavior/entities/format/behaviors/offer_flower.json +++ b/source/behavior/entities/format/behaviors/offer_flower.json @@ -5,5 +5,9 @@ "additionalProperties": false, "description": "Allows the mob to offer the player a flower like the Iron Golem does.", "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/open_door.json b/source/behavior/entities/format/behaviors/open_door.json index c76fc4b9..6d9beb15 100644 --- a/source/behavior/entities/format/behaviors/open_door.json +++ b/source/behavior/entities/format/behaviors/open_door.json @@ -6,12 +6,19 @@ "description": "Allows the mob to open doors. Requires the mob to be able to path through doors, otherwise the mob won't even want to try opening them.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "close_door_after": { "type": "boolean", "default": true, "description": "If true, the mob will close the door after opening it and going through it", "title": "Close Door After" } - } -} + }, + "examples": [ + { + "close_door_after": true + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/owner_hurt_by_target.json b/source/behavior/entities/format/behaviors/owner_hurt_by_target.json index 04eab63b..86c13e7a 100644 --- a/source/behavior/entities/format/behaviors/owner_hurt_by_target.json +++ b/source/behavior/entities/format/behaviors/owner_hurt_by_target.json @@ -6,7 +6,9 @@ "description": "Allows the mob to target another mob that hurts their owner.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entity types that this mob can target if they hurt their owner", diff --git a/source/behavior/entities/format/behaviors/owner_hurt_target.json b/source/behavior/entities/format/behaviors/owner_hurt_target.json index 02e6ff6c..af74ab4e 100644 --- a/source/behavior/entities/format/behaviors/owner_hurt_target.json +++ b/source/behavior/entities/format/behaviors/owner_hurt_target.json @@ -6,7 +6,9 @@ "description": "Allows the mob to target a mob that is hurt by their owner.", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entity types that this entity can target if the potential target is hurt by this mob's owner", diff --git a/source/behavior/entities/format/behaviors/panic.json b/source/behavior/entities/format/behaviors/panic.json index 66119533..6460f486 100644 --- a/source/behavior/entities/format/behaviors/panic.json +++ b/source/behavior/entities/format/behaviors/panic.json @@ -6,12 +6,22 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "damage_sources": { "type": "array", - "items": { "$ref": "../../../../general/entity/damage_source.json" }, - "default": [["all"]], + "items": { + "$ref": "../../../../general/entity/damage_source.json" + }, + "default": [ + [ + "all" + ] + ], "description": "The list of Entity Damage Sources that will cause this mob to panic", "title": "Damage Sources" }, @@ -27,7 +37,12 @@ "description": "If true, the mob will not panic in response to damage from other mobs. This overrides the damage types in `damage_sources`", "title": "Ignore Mob Damage" }, - "prefer_water": { "type": "boolean", "default": false, "description": "If true, the mob will prefer water over land", "title": "Prefer Water" }, + "prefer_water": { + "type": "boolean", + "default": false, + "description": "If true, the mob will prefer water over land", + "title": "Prefer Water" + }, "panic_sound": { "type": "string", "description": "UNDOCUMENTED", @@ -55,5 +70,15 @@ }, "additionalProperties": false } - } -} + }, + "examples": [ + { + "damage_sources": [], + "force": false, + "ignore_mob_damage": false, + "prefer_water": false, + "panic_sound": "example", + "sound_interval": {} + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/peek.json b/source/behavior/entities/format/behaviors/peek.json index 178673c0..0386bf40 100644 --- a/source/behavior/entities/format/behaviors/peek.json +++ b/source/behavior/entities/format/behaviors/peek.json @@ -5,5 +5,9 @@ "title": "Peek", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/pet_sleep_with_owner.json b/source/behavior/entities/format/behaviors/pet_sleep_with_owner.json index 610963b3..fda6371b 100644 --- a/source/behavior/entities/format/behaviors/pet_sleep_with_owner.json +++ b/source/behavior/entities/format/behaviors/pet_sleep_with_owner.json @@ -4,10 +4,13 @@ "type": "object", "title": "Tempt", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, @@ -26,6 +29,20 @@ "description": "The distance in blocks from the owner the pet can be to sleep with owner.", "title": "Search Range" }, - "search_radius": { "type": "integer", "default": 0, "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Search Radius" } - } -} + "search_radius": { + "type": "integer", + "default": 0, + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Search Radius" + } + }, + "examples": [ + { + "goal_radius": 0.5, + "search_height": 1, + "search_range": 0, + "search_radius": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/pickup_items.json b/source/behavior/entities/format/behaviors/pickup_items.json index 53d3593d..1ca33d0e 100644 --- a/source/behavior/entities/format/behaviors/pickup_items.json +++ b/source/behavior/entities/format/behaviors/pickup_items.json @@ -5,8 +5,12 @@ "type": "object", "title": "Pickup Items", "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "can_pickup_any_item": { "type": "boolean", "default": false, @@ -50,5 +54,16 @@ "description": "If true, this mob will chase after the target as long as it's a valid target", "title": "Track Target" } - } -} + }, + "examples": [ + { + "can_pickup_any_item": false, + "can_pickup_to_hand_or_equipment": true, + "cooldown_after_being_attacked": true, + "goal_radius": 0.5, + "max_dist": 0, + "pickup_based_on_chance": false, + "track_target": false + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/play.json b/source/behavior/entities/format/behaviors/play.json index c5426b18..61c65ff4 100644 --- a/source/behavior/entities/format/behaviors/play.json +++ b/source/behavior/entities/format/behaviors/play.json @@ -5,5 +5,12 @@ "title": "Play", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/play_dead.json b/source/behavior/entities/format/behaviors/play_dead.json index 541a1fcd..7317708e 100644 --- a/source/behavior/entities/format/behaviors/play_dead.json +++ b/source/behavior/entities/format/behaviors/play_dead.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "duration": { "title": "Duration", "description": "The amount of time in seconds that the mob will remain playing dead.", @@ -30,15 +32,28 @@ "description": "The range of damage that may cause the mob to start playing dead. Damage taken below the minimum value will never cause the mob to start playing dead. Damage taken above the maximum value will always cause the mob to start playing dead.", "type": "array", "items": [ - { "title": "Minimum", "description": "Minimum", "type": "integer", "minimum": 0 }, - { "title": "Maximum", "description": "Maximum", "type": "integer", "minimum": 0 } + { + "title": "Minimum", + "description": "Minimum", + "type": "integer", + "minimum": 0 + }, + { + "title": "Maximum", + "description": "Maximum", + "type": "integer", + "minimum": 0 + } ] }, "damage_sources": { "title": "Damage Sources", "description": "The list of Entity Damage Sources that will cause this mob to start playing dead.", "oneOf": [ - { "type": "string", "$ref": "../../../../general/entity/damage_source.json" }, + { + "type": "string", + "$ref": "../../../../general/entity/damage_source.json" + }, { "type": "array", "items": { @@ -53,6 +68,17 @@ "description": "Whether the mob will receive the effect of CombatRegeneration while playing dead.", "type": "boolean" }, - "filters": { "$ref": "../../filters/filters.json" } - } -} + "filters": { + "$ref": "../../filters/filters.json" + } + }, + "examples": [ + { + "duration": 0.0, + "force_below_health": 0.0, + "random_start_chance": 0.0, + "random_damage_range": [], + "apply_regeneration": true + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/player_ride_tamed.json b/source/behavior/entities/format/behaviors/player_ride_tamed.json index cfa1b341..9ddbe105 100644 --- a/source/behavior/entities/format/behaviors/player_ride_tamed.json +++ b/source/behavior/entities/format/behaviors/player_ride_tamed.json @@ -5,5 +5,9 @@ "title": "Player Ride Tamed", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/raid_garden.json b/source/behavior/entities/format/behaviors/raid_garden.json index 2023b6b7..9d9bcf57 100644 --- a/source/behavior/entities/format/behaviors/raid_garden.json +++ b/source/behavior/entities/format/behaviors/raid_garden.json @@ -6,15 +6,29 @@ "title": "Raid Garden", "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "blocks": { "type": "array", "description": "Blocks that the mob is looking for to eat", - "items": { "type": "string", "title": "Block Id", "description": "A block identifier", "$ref": "../../../../general/block/identifier.json" }, + "items": { + "type": "string", + "title": "Block Id", + "description": "A block identifier", + "$ref": "../../../../general/block/identifier.json" + }, "title": "Blocks" }, - "eat_delay": { "type": "integer", "default": 2, "description": "Time in seconds between each time it eats", "title": "Eat Delay" }, + "eat_delay": { + "type": "integer", + "default": 2, + "description": "Time in seconds between each time it eats", + "title": "Eat Delay" + }, "full_delay": { "type": "integer", "default": 100, @@ -33,7 +47,12 @@ "description": "Distance in blocks within the mob considers it has reached the goal. This is the `wiggle room` to stop the AI from bouncing back and forth trying to reach a specific spot", "title": "Goal Radius" }, - "max_to_eat": { "type": "integer", "default": 6, "description": "Maximum number of things this entity wants to eat", "title": "Maximum To Eat" }, + "max_to_eat": { + "type": "integer", + "default": 6, + "description": "Maximum number of things this entity wants to eat", + "title": "Maximum To Eat" + }, "search_range": { "type": "integer", "default": 0, @@ -47,5 +66,17 @@ "$comment": "UNDOCUMENTED", "title": "Search Height" } - } -} + }, + "examples": [ + { + "blocks": [], + "eat_delay": 2, + "full_delay": 100, + "initial_eat_delay": 0, + "goal_radius": 0.5, + "max_to_eat": 6, + "search_range": 0, + "search_height": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/ram_attack.json b/source/behavior/entities/format/behaviors/ram_attack.json index f9bd2e90..189537c3 100644 --- a/source/behavior/entities/format/behaviors/ram_attack.json +++ b/source/behavior/entities/format/behaviors/ram_attack.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "baby_knockback_modifier": { "type": "integer", "default": 4, @@ -15,12 +17,25 @@ }, "cooldown_range": { "type": "array", - "default": [10.0, 20.0], + "default": [ + 10.0, + 20.0 + ], "description": "The minimum and maximum cooldown time-range in seconds between each attempted ram attack.", "title": "Cooldown Range", "items": [ - { "title": "Minimum", "description": "Minimum", "type": "number", "minimum": 0 }, - { "title": "Maximum", "description": "Maximum", "type": "number", "minimum": 0 } + { + "title": "Minimum", + "description": "Minimum", + "type": "number", + "minimum": 0 + }, + { + "title": "Maximum", + "description": "Maximum", + "type": "number", + "minimum": 0 + } ] }, "knockback_force": { @@ -78,7 +93,31 @@ "title": "On Start", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "oneOf": [{ "$ref": "../types/event.json" }, { "type": "array", "items": { "$ref": "../types/event.json" } }] + "oneOf": [ + { + "$ref": "../types/event.json" + }, + { + "type": "array", + "items": { + "$ref": "../types/event.json" + } + } + ] } - } -} + }, + "examples": [ + { + "baby_knockback_modifier": 4, + "cooldown_range": [], + "knockback_force": 5, + "knockback_height": 0.1, + "min_ram_distance": 4, + "pre_ram_sound": "example", + "ram_distance": 7, + "ram_impact_sound": "example", + "ram_speed": 2, + "run_speed": 1 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_breach.json b/source/behavior/entities/format/behaviors/random_breach.json index 9dba5706..51033325 100644 --- a/source/behavior/entities/format/behaviors/random_breach.json +++ b/source/behavior/entities/format/behaviors/random_breach.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "cooldown_time": { "type": "number", "default": 0, @@ -32,5 +36,13 @@ "description": "Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1", "title": "Y Distance" } - } -} + }, + "examples": [ + { + "cooldown_time": 0, + "interval": 120, + "xz_dist": 10, + "y_dist": 7 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_fly.json b/source/behavior/entities/format/behaviors/random_fly.json index 47fe9c87..e34961a0 100644 --- a/source/behavior/entities/format/behaviors/random_fly.json +++ b/source/behavior/entities/format/behaviors/random_fly.json @@ -4,11 +4,19 @@ "type": "object", "title": "Random Fly", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, - "avoid_damage_blocks": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Avoid Damage Blocks" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, + "avoid_damage_blocks": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Avoid Damage Blocks" + }, "can_land_on_trees": { "type": "boolean", "default": true, @@ -27,6 +35,20 @@ "description": "Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1", "title": "Y Dist" }, - "y_offset": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Y Offset" } - } -} + "y_offset": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Y Offset" + } + }, + "examples": [ + { + "avoid_damage_blocks": true, + "can_land_on_trees": true, + "xz_dist": 10, + "y_dist": 7, + "y_offset": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_hover.json b/source/behavior/entities/format/behaviors/random_hover.json index c214eca1..05fce57d 100644 --- a/source/behavior/entities/format/behaviors/random_hover.json +++ b/source/behavior/entities/format/behaviors/random_hover.json @@ -4,16 +4,26 @@ "type": "object", "title": "Random Hover", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "hover_height": { "type": "array", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Hover Height", - "items": [{ "type": "number" }, { "type": "number" }] + "items": [ + { + "type": "number" + }, + { + "type": "number" + } + ] }, "interval": { "type": "integer", @@ -33,6 +43,20 @@ "description": "Distance in blocks that the mob will look up or down for a new spot to move to. Must be at least 1", "title": "Y Dist" }, - "y_offset": { "type": "number", "default": 0, "description": "Height in blocks to add to the selected target position", "title": "Y Offset" } - } -} + "y_offset": { + "type": "number", + "default": 0, + "description": "Height in blocks to add to the selected target position", + "title": "Y Offset" + } + }, + "examples": [ + { + "hover_height": [], + "interval": 120, + "xz_dist": 10, + "y_dist": 7, + "y_offset": 0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_look_around.json b/source/behavior/entities/format/behaviors/random_look_around.json index d69d1678..46d4893c 100644 --- a/source/behavior/entities/format/behaviors/random_look_around.json +++ b/source/behavior/entities/format/behaviors/random_look_around.json @@ -6,17 +6,29 @@ "title": "Random Look Around", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "look_time": { "title": "Look Time", "description": "The range of time in seconds the mob will stay looking in a random direction before looking elsewhere", "oneOf": [ - { "type": "number" }, + { + "type": "number" + }, { "type": "array", "items": [ - { "type": "number", "title": "Minimum", "description": "Minimum" }, - { "type": "number", "title": "Maximum", "description": "Maximum" } + { + "type": "number", + "title": "Minimum", + "description": "Minimum" + }, + { + "type": "number", + "title": "Maximum", + "description": "Maximum" + } ] } ] @@ -27,5 +39,10 @@ "title": "Look Distance", "type": "number" } - } -} + }, + "examples": [ + { + "look_distance": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_look_around_and_sit.json b/source/behavior/entities/format/behaviors/random_look_around_and_sit.json index fa7aa085..fdb7573a 100644 --- a/source/behavior/entities/format/behaviors/random_look_around_and_sit.json +++ b/source/behavior/entities/format/behaviors/random_look_around_and_sit.json @@ -4,9 +4,10 @@ "type": "object", "title": "Random Look Around And Sit", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "max_look_count": { "type": "integer", "default": 2, @@ -31,6 +32,20 @@ "description": "The Minimum amount of time (in ticks) a mob will stay looking at a direction while looking around.", "title": "Minimum Look Time" }, - "probability": { "type": "number", "default": 0.02, "description": "The probability of randomly looking around/sitting.", "title": "Probability" } - } -} + "probability": { + "type": "number", + "default": 0.02, + "description": "The probability of randomly looking around/sitting.", + "title": "Probability" + } + }, + "examples": [ + { + "max_look_count": 2, + "max_look_time": 40, + "min_look_count": 1, + "min_look_time": 20, + "probability": 0.02 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_sitting.json b/source/behavior/entities/format/behaviors/random_sitting.json index 1a437c8f..4c83bc64 100644 --- a/source/behavior/entities/format/behaviors/random_sitting.json +++ b/source/behavior/entities/format/behaviors/random_sitting.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "cooldown": { "type": "number", "default": 0, @@ -38,5 +42,14 @@ "description": "This is the chance that the mob will stop this goal, from 0 to 1", "title": "Stop Chance" } - } -} + }, + "examples": [ + { + "cooldown": 0, + "cooldown_time": 0, + "min_sit_time": 10, + "start_chance": 0.1, + "stop_chance": 0.3 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_stroll.json b/source/behavior/entities/format/behaviors/random_stroll.json index e28aaad2..478076a2 100644 --- a/source/behavior/entities/format/behaviors/random_stroll.json +++ b/source/behavior/entities/format/behaviors/random_stroll.json @@ -5,8 +5,12 @@ "title": "Random Stroll", "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "interval": { "type": "integer", "default": 120, @@ -26,5 +30,12 @@ "title": "Y Distance" } }, - "additionalProperties": false -} + "additionalProperties": false, + "examples": [ + { + "interval": 120, + "xz_dist": 10, + "y_dist": 7 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/random_swim.json b/source/behavior/entities/format/behaviors/random_swim.json index 562244ab..55b8b354 100644 --- a/source/behavior/entities/format/behaviors/random_swim.json +++ b/source/behavior/entities/format/behaviors/random_swim.json @@ -5,8 +5,12 @@ "description": "Allows an entity to randomly move through water", "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "avoid_surface": { "type": "boolean", "default": true, @@ -32,5 +36,13 @@ "title": "Y Distance" } }, - "additionalProperties": false -} + "additionalProperties": false, + "examples": [ + { + "avoid_surface": true, + "interval": 120, + "xz_dist": 10, + "y_dist": 7 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/ranged_attack.json b/source/behavior/entities/format/behaviors/ranged_attack.json index f991c217..24d729ae 100644 --- a/source/behavior/entities/format/behaviors/ranged_attack.json +++ b/source/behavior/entities/format/behaviors/ranged_attack.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "attack_interval": { "type": "number", "default": 0, @@ -75,5 +79,20 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } -} + }, + "examples": [ + { + "attack_interval": 0, + "attack_interval_max": 0, + "attack_interval_min": 0, + "attack_radius": 0, + "burst_interval": 0, + "burst_shots": 1, + "charge_charged_trigger": 0, + "charge_shoot_trigger": 0, + "ranged_fov": 90, + "target_in_sight_time": 0.0, + "attack_radius_min": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/receive_love.json b/source/behavior/entities/format/behaviors/receive_love.json index 8c0c8723..d9fb92e1 100644 --- a/source/behavior/entities/format/behaviors/receive_love.json +++ b/source/behavior/entities/format/behaviors/receive_love.json @@ -5,5 +5,9 @@ "title": "Receive Love", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "types/priority.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/restrict_open_door.json b/source/behavior/entities/format/behaviors/restrict_open_door.json index 660e9a48..7623a980 100644 --- a/source/behavior/entities/format/behaviors/restrict_open_door.json +++ b/source/behavior/entities/format/behaviors/restrict_open_door.json @@ -5,5 +5,9 @@ "title": "Restrict Open Door", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "types/priority.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/restrict_sun.json b/source/behavior/entities/format/behaviors/restrict_sun.json index c825f206..2ea24d45 100644 --- a/source/behavior/entities/format/behaviors/restrict_sun.json +++ b/source/behavior/entities/format/behaviors/restrict_sun.json @@ -5,5 +5,9 @@ "title": "Restrict Sun", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "types/priority.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/rise_to_liquid_level.json b/source/behavior/entities/format/behaviors/rise_to_liquid_level.json index 7a0ee7a1..103cfa0e 100644 --- a/source/behavior/entities/format/behaviors/rise_to_liquid_level.json +++ b/source/behavior/entities/format/behaviors/rise_to_liquid_level.json @@ -4,9 +4,10 @@ "type": "object", "title": "Rise To Liquid Level", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "liquid_y_offset": { "type": "number", "title": "Liquid Y Offset", @@ -22,5 +23,12 @@ "title": "Sink Delta", "description": "Displacement for how much the entity will move down in the vertical axis" } - } -} + }, + "examples": [ + { + "liquid_y_offset": 0.0, + "rise_delta": 0.0, + "sink_delta": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/roll.json b/source/behavior/entities/format/behaviors/roll.json index 6c2eb079..04e503d7 100644 --- a/source/behavior/entities/format/behaviors/roll.json +++ b/source/behavior/entities/format/behaviors/roll.json @@ -6,7 +6,19 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "probability": { "type": "number", "minimum": 0, "description": "The probability that the mob will use the goal.", "title": "Probability" } - } -} + "priority": { + "$ref": "types/priority.json" + }, + "probability": { + "type": "number", + "minimum": 0, + "description": "The probability that the mob will use the goal.", + "title": "Probability" + } + }, + "examples": [ + { + "probability": 0.0 + } + ] +} \ No newline at end of file diff --git a/source/behavior/entities/format/behaviors/run_around_like_crazy.json b/source/behavior/entities/format/behaviors/run_around_like_crazy.json index 9db057fb..ae07039f 100644 --- a/source/behavior/entities/format/behaviors/run_around_like_crazy.json +++ b/source/behavior/entities/format/behaviors/run_around_like_crazy.json @@ -5,5 +5,12 @@ "title": "Restrict Open Door", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/scared.json b/source/behavior/entities/format/behaviors/scared.json index c9f1fca0..e11bdb9b 100644 --- a/source/behavior/entities/format/behaviors/scared.json +++ b/source/behavior/entities/format/behaviors/scared.json @@ -6,12 +6,19 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "sound_interval": { "type": "integer", "default": 0, "description": "The interval in which a sound will play when active in a 1/delay chance to kick off", "title": "Sound Interval" } - } + }, + "examples": [ + { + "sound_interval": 0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/send_event.json b/source/behavior/entities/format/behaviors/send_event.json index e4dfe1b4..b3a9c75c 100644 --- a/source/behavior/entities/format/behaviors/send_event.json +++ b/source/behavior/entities/format/behaviors/send_event.json @@ -4,7 +4,6 @@ "type": "object", "title": "Send Event", "additionalProperties": false, - "definitions": { "sequence": { "type": "array", @@ -13,16 +12,34 @@ "type": "object", "additionalProperties": false, "properties": { - "delay": { "type": "number", "default": 0, "description": "Amount of time in seconds before starting this step" }, - "event": { "type": "string", "default": "", "description": "The event to send to the entity" }, - "sound_event": { "type": "string", "default": "", "description": "The sound event to play when this step happens" } + "delay": { + "type": "number", + "default": 0, + "description": "Amount of time in seconds before starting this step" + }, + "event": { + "type": "string", + "default": "", + "description": "The event to send to the entity" + }, + "sound_event": { + "type": "string", + "default": "", + "description": "The sound event to play when this step happens" + } } } } }, "properties": { - "priority": { "$ref": "./types/priority.json" }, - "cast_duration": { "type": "number", "description": "Time in seconds for the entire event sending process", "title": "Cast Duration" }, + "priority": { + "$ref": "./types/priority.json" + }, + "cast_duration": { + "type": "number", + "description": "Time in seconds for the entire event sending process", + "title": "Cast Duration" + }, "event_choices": { "type": "array", "title": "Event Choices", @@ -59,7 +76,9 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "filters": { "$ref": "../../filters/filters.json" }, + "filters": { + "$ref": "../../filters/filters.json" + }, "particle_color": { "type": "string", "format": "color-hex", @@ -67,17 +86,35 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "weight": { "type": "integer", "title": "Weight", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, + "weight": { + "type": "integer", + "title": "Weight", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + }, "start_sound_event": { "type": "string", "title": "Start Sound Event", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "sequence": { "$ref": "#/definitions/sequence" } + "sequence": { + "$ref": "#/definitions/sequence" + } } } }, - "sequence": { "$ref": "#/definitions/sequence", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Sequence" } - } + "sequence": { + "$ref": "#/definitions/sequence", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Sequence" + } + }, + "examples": [ + { + "cast_duration": 0.0, + "event_choices": [] + } + ] } diff --git a/source/behavior/entities/format/behaviors/share_items.json b/source/behavior/entities/format/behaviors/share_items.json index 995147b2..82e70ed1 100644 --- a/source/behavior/entities/format/behaviors/share_items.json +++ b/source/behavior/entities/format/behaviors/share_items.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entities this mob will share items with", @@ -25,5 +29,11 @@ "description": "Maximum distance in blocks this mob will look for entities to share items with", "title": "Maximum Distance" } - } + }, + "examples": [ + { + "goal_radius": 0.5, + "max_dist": 0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/silverfish_merge_with_stone.json b/source/behavior/entities/format/behaviors/silverfish_merge_with_stone.json index 2e388238..128b0f0d 100644 --- a/source/behavior/entities/format/behaviors/silverfish_merge_with_stone.json +++ b/source/behavior/entities/format/behaviors/silverfish_merge_with_stone.json @@ -5,5 +5,9 @@ "title": "Silverfish Merge With Stone", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/silverfish_wake_up_friends.json b/source/behavior/entities/format/behaviors/silverfish_wake_up_friends.json index 7fec89a4..875433a3 100644 --- a/source/behavior/entities/format/behaviors/silverfish_wake_up_friends.json +++ b/source/behavior/entities/format/behaviors/silverfish_wake_up_friends.json @@ -5,5 +5,9 @@ "title": "Silverfish Wake Up Friends", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/skeleton_horse_trap.json b/source/behavior/entities/format/behaviors/skeleton_horse_trap.json index f3276803..c95dd7a2 100644 --- a/source/behavior/entities/format/behaviors/skeleton_horse_trap.json +++ b/source/behavior/entities/format/behaviors/skeleton_horse_trap.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "duration": { "type": "number", "default": 1, @@ -19,5 +21,11 @@ "description": "Distance in blocks that the player has to be within to trigger the horse trap", "title": "Within Radius" } - } + }, + "examples": [ + { + "duration": 1, + "within_radius": 0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/sleep.json b/source/behavior/entities/format/behaviors/sleep.json index d1d1a671..a56f9a8d 100644 --- a/source/behavior/entities/format/behaviors/sleep.json +++ b/source/behavior/entities/format/behaviors/sleep.json @@ -6,15 +6,25 @@ "title": "Sleep", "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "cooldown_time": { "type": "number", "default": 0, "description": "Time in seconds the mob has to wait before using the goal again", "title": "Cooldown Time" }, - "goal_radius": { "type": "number", "default": 0, "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Goal Radius" }, + "goal_radius": { + "type": "number", + "default": 0, + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Goal Radius" + }, "sleep_collider_height": { "type": "number", "default": 1, @@ -39,5 +49,15 @@ "description": "The cooldown time in seconds before the goal can be reused after a internal failure or timeout condition", "title": "Timeout Cooldown" } - } + }, + "examples": [ + { + "cooldown_time": 0, + "goal_radius": 0, + "sleep_collider_height": 1, + "sleep_collider_width": 1, + "sleep_y_offset": 1, + "timeout_cooldown": 8 + } + ] } diff --git a/source/behavior/entities/format/behaviors/slime_attack.json b/source/behavior/entities/format/behaviors/slime_attack.json index 6208c1fc..88e64c26 100644 --- a/source/behavior/entities/format/behaviors/slime_attack.json +++ b/source/behavior/entities/format/behaviors/slime_attack.json @@ -5,12 +5,19 @@ "type": "object", "title": "Slime Attack", "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "set_persistent": { "type": "boolean", "default": false, "description": "Allows the actor to be set to persist upon targeting a player", "title": "Set Persistent" } - } + }, + "examples": [ + { + "set_persistent": false + } + ] } diff --git a/source/behavior/entities/format/behaviors/slime_float.json b/source/behavior/entities/format/behaviors/slime_float.json index 6249b715..59b71170 100644 --- a/source/behavior/entities/format/behaviors/slime_float.json +++ b/source/behavior/entities/format/behaviors/slime_float.json @@ -6,13 +6,22 @@ "title": "Slime Float", "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "jump_chance_percentage": { "type": "number", "title": "Sink Delta", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "jump_chance_percentage": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/slime_keep_on_jumping.json b/source/behavior/entities/format/behaviors/slime_keep_on_jumping.json index dd8a43e6..fe3690e0 100644 --- a/source/behavior/entities/format/behaviors/slime_keep_on_jumping.json +++ b/source/behavior/entities/format/behaviors/slime_keep_on_jumping.json @@ -5,5 +5,12 @@ "type": "object", "title": "Slime Keep On Jumping", "required": [], - "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" } } + "properties": { + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/slime_random_direction.json b/source/behavior/entities/format/behaviors/slime_random_direction.json index b60354de..09c38378 100644 --- a/source/behavior/entities/format/behaviors/slime_random_direction.json +++ b/source/behavior/entities/format/behaviors/slime_random_direction.json @@ -6,19 +6,33 @@ "title": "Slime Random Direction", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "add_random_time_range": { "type": "number", "title": "Add Random Time Range", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "turn_range": { "type": "number", "title": "Turn Range", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, + "turn_range": { + "type": "number", + "title": "Turn Range", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + }, "min_change_direction_time": { "type": "number", "title": "Minimum Change Direction Time", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "add_random_time_range": 0.0, + "turn_range": 0.0, + "min_change_direction_time": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/snacking.json b/source/behavior/entities/format/behaviors/snacking.json index a0ff0403..acd98aa6 100644 --- a/source/behavior/entities/format/behaviors/snacking.json +++ b/source/behavior/entities/format/behaviors/snacking.json @@ -6,13 +6,23 @@ "title": "Snacking", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "items": { "title": "Items", "description": "Items that we are interested in snacking on", "oneOf": [ - { "type": "array", "items": { "$ref": "../../../../general/item/identifier.json", "title": "Item" } }, - { "$ref": "../../../../general/item/identifier.json" } + { + "type": "array", + "items": { + "$ref": "../../../../general/item/identifier.json", + "title": "Item" + } + }, + { + "$ref": "../../../../general/item/identifier.json" + } ] }, "snacking_cooldown": { @@ -29,9 +39,15 @@ }, "snacking_stop_chance": { "type": "number", - "description": "This is the chance that the mob will stop snacking, from 0 to 1", "title": "Snacking Stop Chance" } - } + }, + "examples": [ + { + "snacking_cooldown": 7.5, + "snacking_cooldown_min": 0.5, + "snacking_stop_chance": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/sneeze.json b/source/behavior/entities/format/behaviors/sneeze.json index 49883302..3020d941 100644 --- a/source/behavior/entities/format/behaviors/sneeze.json +++ b/source/behavior/entities/format/behaviors/sneeze.json @@ -6,7 +6,9 @@ "title": "Sneeze", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "cooldown_time": { "type": "number", "default": 0, @@ -51,7 +53,29 @@ "description": "The probability of sneezing. A value of 1.00 is 100%", "title": "Probability" }, - "sound": { "type": "string", "default": "", "description": "Sound to play when the sneeze occurs.", "title": "Sound" }, - "within_radius": { "type": "number", "default": 0, "description": "Distance in blocks that mobs will be startled.", "title": "Within Radius" } - } + "sound": { + "type": "string", + "default": "", + "description": "Sound to play when the sneeze occurs.", + "title": "Sound" + }, + "within_radius": { + "type": "number", + "default": 0, + "description": "Distance in blocks that mobs will be startled.", + "title": "Within Radius" + } + }, + "examples": [ + { + "cooldown_time": 0, + "drop_item_chance": 1, + "loot_table": "loot_tables/empty.json", + "prepare_sound": "", + "prepare_time": 1, + "probability": 0.02, + "sound": "", + "within_radius": 0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/squid_dive.json b/source/behavior/entities/format/behaviors/squid_dive.json index 8c40bca2..04da24f5 100644 --- a/source/behavior/entities/format/behaviors/squid_dive.json +++ b/source/behavior/entities/format/behaviors/squid_dive.json @@ -5,5 +5,9 @@ "title": "Squid Dive", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/squid_flee.json b/source/behavior/entities/format/behaviors/squid_flee.json index 5917cc32..574d7e6c 100644 --- a/source/behavior/entities/format/behaviors/squid_flee.json +++ b/source/behavior/entities/format/behaviors/squid_flee.json @@ -5,5 +5,9 @@ "title": "Squid Flee", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/squid_idle.json b/source/behavior/entities/format/behaviors/squid_idle.json index 2be58ac0..6e75317f 100644 --- a/source/behavior/entities/format/behaviors/squid_idle.json +++ b/source/behavior/entities/format/behaviors/squid_idle.json @@ -5,5 +5,9 @@ "title": "Squid Idle", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/squid_move_away_from_ground.json b/source/behavior/entities/format/behaviors/squid_move_away_from_ground.json index 6554125f..f99af765 100644 --- a/source/behavior/entities/format/behaviors/squid_move_away_from_ground.json +++ b/source/behavior/entities/format/behaviors/squid_move_away_from_ground.json @@ -5,5 +5,9 @@ "title": "Squid Move Away From Ground", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/squid_out_of_water.json b/source/behavior/entities/format/behaviors/squid_out_of_water.json index 530aaef1..00d35da2 100644 --- a/source/behavior/entities/format/behaviors/squid_out_of_water.json +++ b/source/behavior/entities/format/behaviors/squid_out_of_water.json @@ -5,5 +5,9 @@ "title": "Squid Out Of Water", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json b/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json index 296ec708..3fdc6e2b 100644 --- a/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json +++ b/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json @@ -4,9 +4,10 @@ "type": "object", "title": "Stalk And Pounce On Target", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "interest_time": { "type": "number", "default": 2, @@ -43,7 +44,12 @@ "description": "Allows the actor to be set to persist upon targeting a player", "title": "Set Persistent" }, - "stalk_speed": { "type": "number", "default": 1.2, "description": "The movement speed in which you stalk your target", "title": "Stalk Speed" }, + "stalk_speed": { + "type": "number", + "default": 1.2, + "description": "The movement speed in which you stalk your target", + "title": "Stalk Speed" + }, "strike_dist": { "type": "number", "default": 2, @@ -56,7 +62,31 @@ "description": "The amount of time the mob will be stuck if they fail and land on a block they can be stuck on", "title": "Stuck Time" }, - "leap_dist": { "type": "number", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Leap Dist" }, - "stuck_blocks": { "$ref": "../../filters/filters.json", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Stuck Block" } - } + "leap_dist": { + "type": "number", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Leap Dist" + }, + "stuck_blocks": { + "$ref": "../../filters/filters.json", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Stuck Block" + } + }, + "examples": [ + { + "interest_time": 2, + "leap_distance": 0.8, + "leap_height": 0.9, + "max_stalk_dist": 10, + "pounce_max_dist": 5, + "set_persistent": false, + "stalk_speed": 1.2, + "strike_dist": 2, + "stuck_time": 2, + "leap_dist": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/stay_while_sitting.json b/source/behavior/entities/format/behaviors/stay_while_sitting.json index 2a45cb45..f41c84d5 100644 --- a/source/behavior/entities/format/behaviors/stay_while_sitting.json +++ b/source/behavior/entities/format/behaviors/stay_while_sitting.json @@ -5,5 +5,9 @@ "title": "Stay While Sitting", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/stomp_attack.json b/source/behavior/entities/format/behaviors/stomp_attack.json index 4240d95e..f7f550b2 100644 --- a/source/behavior/entities/format/behaviors/stomp_attack.json +++ b/source/behavior/entities/format/behaviors/stomp_attack.json @@ -6,10 +6,24 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, - "attack_once": { "type": "boolean", "default": false, "description": "If true, this mob will attack only one time.", "title": "Attack Once" }, - "attack_types": { "type": "string", "default": "", "description": "Defines the entity types this mob will attack", "title": "Attack Types" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, + "attack_once": { + "type": "boolean", + "default": false, + "description": "If true, this mob will attack only one time.", + "title": "Attack Once" + }, + "attack_types": { + "type": "string", + "default": "", + "description": "Defines the entity types this mob will attack", + "title": "Attack Types" + }, "probability": { "type": "number", "default": 0.02, @@ -34,7 +48,11 @@ "description": "If true, this goal will only trigger if the mob can reach its target.", "title": "Require Complete Path" }, - "sound": { "type": "string", "description": "Sound to play when the sneeze occurs.", "title": "Sound" }, + "sound": { + "type": "string", + "description": "Sound to play when the sneeze occurs.", + "title": "Sound" + }, "track_target": { "type": "boolean", "default": false, @@ -53,5 +71,19 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "attack_once": false, + "attack_types": "", + "probability": 0.02, + "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 + } + ] } diff --git a/source/behavior/entities/format/behaviors/stomp_turtle_egg.json b/source/behavior/entities/format/behaviors/stomp_turtle_egg.json index ea2f85b5..0a718e2c 100644 --- a/source/behavior/entities/format/behaviors/stomp_turtle_egg.json +++ b/source/behavior/entities/format/behaviors/stomp_turtle_egg.json @@ -4,10 +4,13 @@ "type": "object", "title": "Stomp Turtle Egg", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "goal_radius": { "type": "number", "default": 0.5, @@ -38,5 +41,14 @@ "description": "The distance in blocks it will look for turtle eggs to move towards", "title": "Search Range" } - } + }, + "examples": [ + { + "goal_radius": 0.5, + "interval": 120, + "search_count": 10, + "search_height": 1, + "search_range": 0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/stroll_towards_village.json b/source/behavior/entities/format/behaviors/stroll_towards_village.json index 675e4804..c02a3012 100644 --- a/source/behavior/entities/format/behaviors/stroll_towards_village.json +++ b/source/behavior/entities/format/behaviors/stroll_towards_village.json @@ -4,9 +4,10 @@ "type": "object", "title": "Stroll Towards Village", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "cooldown_time": { "type": "number", "default": 0, @@ -37,5 +38,14 @@ "description": "This is the chance that the mob will start this goal, from 0 to 1", "title": "Start Chance" } - } + }, + "examples": [ + { + "cooldown_time": 0, + "goal_radius": 0.5, + "search_range": 0, + "speed_multiplier": 1, + "start_chance": 0.1 + } + ] } diff --git a/source/behavior/entities/format/behaviors/summon_entity.json b/source/behavior/entities/format/behaviors/summon_entity.json index 2be84b91..c91bc481 100644 --- a/source/behavior/entities/format/behaviors/summon_entity.json +++ b/source/behavior/entities/format/behaviors/summon_entity.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "summon_choices": { "type": "array", "description": "List of spells for the mob to use to summon entities", @@ -32,7 +34,9 @@ "description": "If true, the mob will do the casting animations and render spell particles", "title": "Do Casting" }, - "filters": { "$ref": "../../filters/filters.json" }, + "filters": { + "$ref": "../../filters/filters.json" + }, "max_activation_range": { "type": "number", "default": -1, @@ -49,8 +53,14 @@ "description": "The color of the particles for this spell", "title": "Particle Color", "oneOf": [ - { "type": "integer", "default": 0 }, - { "type": "string", "format": "color-hex" } + { + "type": "integer", + "default": 0 + }, + { + "type": "string", + "format": "color-hex" + } ] }, "sequence": { @@ -103,8 +113,17 @@ "description": "The base shape of this step. Valid values are circle and line", "title": "Shape" }, - "size": { "type": "number", "default": 1, "description": "The base size of the entity", "title": "Size" }, - "sound_event": { "type": "string", "description": "The sound event to play for this step", "title": "Sound Event" }, + "size": { + "type": "number", + "default": 1, + "description": "The base size of the entity", + "title": "Size" + }, + "sound_event": { + "type": "string", + "description": "The sound event to play for this step", + "title": "Sound Event" + }, "summon_cap": { "type": "integer", "default": 0, @@ -126,7 +145,11 @@ } } }, - "start_sound_event": { "type": "string", "description": "The sound event to play when using this spell", "title": "Start Sound Event" }, + "start_sound_event": { + "type": "string", + "description": "The sound event to play when using this spell", + "title": "Start Sound Event" + }, "weight": { "type": "number", "title": "Weight", @@ -136,5 +159,10 @@ } } } - } + }, + "examples": [ + { + "summon_choices": [] + } + ] } diff --git a/source/behavior/entities/format/behaviors/swell.json b/source/behavior/entities/format/behaviors/swell.json index f76b3186..82c7107c 100644 --- a/source/behavior/entities/format/behaviors/swell.json +++ b/source/behavior/entities/format/behaviors/swell.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "start_distance": { "type": "number", "default": 10, @@ -19,5 +21,11 @@ "description": "This mob stops swelling when a target has moved away at least this many blocks", "title": "Stop Distance" } - } + }, + "examples": [ + { + "start_distance": 10, + "stop_distance": 2 + } + ] } diff --git a/source/behavior/entities/format/behaviors/swim_idle.json b/source/behavior/entities/format/behaviors/swim_idle.json index 3fa12364..cc3cac81 100644 --- a/source/behavior/entities/format/behaviors/swim_idle.json +++ b/source/behavior/entities/format/behaviors/swim_idle.json @@ -5,15 +5,27 @@ "type": "object", "title": "Swim Idle", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, - "idle_time": { "type": "number", "title": "Idle Time", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, + "priority": { + "$ref": "types/priority.json" + }, + "idle_time": { + "type": "number", + "title": "Idle Time", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + }, "success_rate": { "type": "number", "title": "Succes Rate", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "idle_time": 0.0, + "success_rate": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/swim_wander.json b/source/behavior/entities/format/behaviors/swim_wander.json index 113bdf85..ad518f98 100644 --- a/source/behavior/entities/format/behaviors/swim_wander.json +++ b/source/behavior/entities/format/behaviors/swim_wander.json @@ -6,10 +6,36 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, - "interval": { "type": "number", "title": "Interval", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "look_ahead": { "type": "number", "title": "Look Ahead", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "wander_time": { "type": "number", "title": "Wander Time", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, + "interval": { + "type": "number", + "title": "Interval", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + }, + "look_ahead": { + "type": "number", + "title": "Look Ahead", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + }, + "wander_time": { + "type": "number", + "title": "Wander Time", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + } + }, + "examples": [ + { + "interval": 0.0, + "look_ahead": 0.0, + "wander_time": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/swim_with_entity.json b/source/behavior/entities/format/behaviors/swim_with_entity.json index b425e4e8..978e1bcc 100644 --- a/source/behavior/entities/format/behaviors/swim_with_entity.json +++ b/source/behavior/entities/format/behaviors/swim_with_entity.json @@ -7,8 +7,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "success_rate": { "type": "number", "title": "Success Rate", @@ -63,5 +67,17 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "success_rate": 0.0, + "chance_to_stop": 0.0, + "state_check_interval": 0.0, + "catch_up_threshold": 0.0, + "match_direction_threshold": 0.0, + "catch_up_multiplier": 0.0, + "search_range": 0.0, + "stop_distance": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/swoop_attack.json b/source/behavior/entities/format/behaviors/swoop_attack.json index 177578d8..8a71bc1d 100644 --- a/source/behavior/entities/format/behaviors/swoop_attack.json +++ b/source/behavior/entities/format/behaviors/swoop_attack.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "damage_reach": { "type": "number", "title": "Damage Reach", @@ -20,5 +24,10 @@ "description": "Range of time in seconds between uses of this goal.", "title": "Delay Range" } - } + }, + "examples": [ + { + "damage_reach": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/take_flower.json b/source/behavior/entities/format/behaviors/take_flower.json index b79254d6..1c8ef8e4 100644 --- a/source/behavior/entities/format/behaviors/take_flower.json +++ b/source/behavior/entities/format/behaviors/take_flower.json @@ -5,5 +5,9 @@ "title": "Take Flower", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/target_when_pushed.json b/source/behavior/entities/format/behaviors/target_when_pushed.json index ef1babe5..22de4f4d 100644 --- a/source/behavior/entities/format/behaviors/target_when_pushed.json +++ b/source/behavior/entities/format/behaviors/target_when_pushed.json @@ -7,7 +7,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "types/priority.json" }, + "priority": { + "$ref": "types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "title": "Entity Types", @@ -20,5 +22,10 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "percent_chance": 0.0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/tempt.json b/source/behavior/entities/format/behaviors/tempt.json index 083700a7..1d94e3ef 100644 --- a/source/behavior/entities/format/behaviors/tempt.json +++ b/source/behavior/entities/format/behaviors/tempt.json @@ -4,10 +4,13 @@ "type": "object", "title": "Tempt", "additionalProperties": false, - "properties": { - "priority": { "$ref": "types/priority.json" }, - "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, + "priority": { + "$ref": "types/priority.json" + }, + "speed_multiplier": { + "$ref": "types/speed_multiplier.json" + }, "can_get_scared": { "type": "boolean", "default": false, @@ -29,7 +32,9 @@ "items": { "type": "array", "description": "List of items this mob is tempted by", - "items": { "$ref": "../../../../general/item/identifier.json" }, + "items": { + "$ref": "../../../../general/item/identifier.json" + }, "title": "Items" }, "within_radius": { @@ -38,5 +43,14 @@ "description": "Distance in blocks this mob can get tempted by a player holding an item they like", "title": "Within Radius" } - } + }, + "examples": [ + { + "can_get_scared": false, + "can_tempt_while_ridden": true, + "can_tempt_vertically": true, + "items": [], + "within_radius": 0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/trade_interest.json b/source/behavior/entities/format/behaviors/trade_interest.json index adacb364..75742a0d 100644 --- a/source/behavior/entities/format/behaviors/trade_interest.json +++ b/source/behavior/entities/format/behaviors/trade_interest.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "carried_item_switch_time": { "type": "number", "default": 2, @@ -37,5 +39,14 @@ "description": "Distance in blocks this mob can be interested by a player holding an item they like", "title": "Within Radius" } - } + }, + "examples": [ + { + "carried_item_switch_time": 2, + "cooldown": 2, + "interest_time": 45, + "remove_item_time": 1, + "within_radius": 0 + } + ] } diff --git a/source/behavior/entities/format/behaviors/trade_with_player.json b/source/behavior/entities/format/behaviors/trade_with_player.json index 4b31bf65..5d6e9d80 100644 --- a/source/behavior/entities/format/behaviors/trade_with_player.json +++ b/source/behavior/entities/format/behaviors/trade_with_player.json @@ -5,5 +5,9 @@ "title": "Trade With Player", "additionalProperties": false, "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/vex_copy_owner_target.json b/source/behavior/entities/format/behaviors/vex_copy_owner_target.json index bcd6c86d..939f3e7d 100644 --- a/source/behavior/entities/format/behaviors/vex_copy_owner_target.json +++ b/source/behavior/entities/format/behaviors/vex_copy_owner_target.json @@ -6,7 +6,9 @@ "title": "Vex Copy Owner Target", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entities this mob can copy the owner from.", diff --git a/source/behavior/entities/format/behaviors/vex_random_move.json b/source/behavior/entities/format/behaviors/vex_random_move.json index f0458716..36e87b56 100644 --- a/source/behavior/entities/format/behaviors/vex_random_move.json +++ b/source/behavior/entities/format/behaviors/vex_random_move.json @@ -6,7 +6,9 @@ "title": "Vex Random Move", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entities this mob can copy the owner from.", diff --git a/source/behavior/entities/format/behaviors/wither_random_attack_pos_goal.json b/source/behavior/entities/format/behaviors/wither_random_attack_pos_goal.json index 80bdd459..ce7d8a69 100644 --- a/source/behavior/entities/format/behaviors/wither_random_attack_pos_goal.json +++ b/source/behavior/entities/format/behaviors/wither_random_attack_pos_goal.json @@ -5,5 +5,9 @@ "type": "object", "title": "Wither Random Attack Pos Goal", "required": [], - "properties": { "priority": { "$ref": "./types/priority.json" } } + "properties": { + "priority": { + "$ref": "./types/priority.json" + } + } } diff --git a/source/behavior/entities/format/behaviors/wither_target_highest_damage.json b/source/behavior/entities/format/behaviors/wither_target_highest_damage.json index e5bfe6d1..a4204bdf 100644 --- a/source/behavior/entities/format/behaviors/wither_target_highest_damage.json +++ b/source/behavior/entities/format/behaviors/wither_target_highest_damage.json @@ -6,7 +6,9 @@ "title": "Wither Target Highest Damage", "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, + "priority": { + "$ref": "./types/priority.json" + }, "entity_types": { "$ref": "../types/entity_types.json", "description": "List of entity types the wither takes into account to find who dealt the most damage to it", diff --git a/source/behavior/entities/format/behaviors/work.json b/source/behavior/entities/format/behaviors/work.json index c0f0f4d2..bacd30c6 100644 --- a/source/behavior/entities/format/behaviors/work.json +++ b/source/behavior/entities/format/behaviors/work.json @@ -6,8 +6,12 @@ "additionalProperties": false, "required": [], "properties": { - "priority": { "$ref": "./types/priority.json" }, - "speed_multiplier": { "$ref": "./types/speed_multiplier.json" }, + "priority": { + "$ref": "./types/priority.json" + }, + "speed_multiplier": { + "$ref": "./types/speed_multiplier.json" + }, "active_time": { "type": "integer", "default": 0, @@ -49,5 +53,15 @@ "description": "If `can_work_in_rain` is false, this is the maximum number of ticks left in the goal where rain will not interrupt the goal", "title": "Work In Rain Tolerance" } - } + }, + "examples": [ + { + "active_time": 0, + "can_work_in_rain": false, + "goal_cooldown": 0, + "sound_delay_max": 0, + "sound_delay_min": 0, + "work_in_rain_tolerance": -1 + } + ] }