diff --git a/source/behavior/entities/format/components/addrider.json b/source/behavior/entities/format/components/addrider.json index 5fb9c520..d499c1c6 100644 --- a/source/behavior/entities/format/components/addrider.json +++ b/source/behavior/entities/format/components/addrider.json @@ -8,5 +8,11 @@ "properties": { "entity_type": { "type": "string", "description": "The entity type that will be riding this entity", "title": "Entity Type" }, "spawn_event": { "type": "string", "description": "The spawn event that will be used when the riding entity is created", "title": "Spawn Event" } - } + }, + "examples": [ + { + "entity_type": "example", + "spawn_event": "example" + } + ] } diff --git a/source/behavior/entities/format/components/admire_item.json b/source/behavior/entities/format/components/admire_item.json index 96798440..83c52484 100644 --- a/source/behavior/entities/format/components/admire_item.json +++ b/source/behavior/entities/format/components/admire_item.json @@ -11,6 +11,17 @@ "description": "Duration, in seconds, for which mob won't admire items if it was hurt", "title": "Cooldown After Being Attacked" }, - "duration": { "type": "integer", "default": 10, "description": "Duration, in seconds, that the mob is pacified.", "title": "Duration" } - } + "duration": { + "type": "integer", + "default": 10, + "description": "Duration, in seconds, that the mob is pacified.", + "title": "Duration" + } + }, + "examples": [ + { + "cooldown_after_being_attacked": 0, + "duration": 10 + } + ] } diff --git a/source/behavior/entities/format/components/ageable.json b/source/behavior/entities/format/components/ageable.json index d808376e..85c4e645 100644 --- a/source/behavior/entities/format/components/ageable.json +++ b/source/behavior/entities/format/components/ageable.json @@ -8,8 +8,16 @@ "drop_items": { "description": "List of items that the entity drops when it grows up.", "oneOf": [ - { "type": "array", "items": { "$ref": "../../../../general/item/identifier.json" } }, - { "type": "string", "$ref": "../../../../general/item/identifier.json" } + { + "type": "array", + "items": { + "$ref": "../../../../general/item/identifier.json" + } + }, + { + "type": "string", + "$ref": "../../../../general/item/identifier.json" + } ], "title": "Drop Items" }, @@ -22,23 +30,48 @@ "feed_items": { "description": "List of items that can be fed to the entity. Includes `item` for the item name and `growth` to define how much time it grows up by", "oneOf": [ - { "type": "array", "items": { "$ref": "../../../../general/item/identifier.json" } }, + { + "type": "array", + "items": { + "$ref": "../../../../general/item/identifier.json" + } + }, { "type": "array", "items": { "type": "object", - "properties": { "growth": { "type": "number" }, "item": { "$ref": "../../../../general/item/identifier.json" } } + "properties": { + "growth": { + "type": "number" + }, + "item": { + "$ref": "../../../../general/item/identifier.json" + } + } } }, - { "type": "string", "$ref": "../../../../general/item/identifier.json" } + { + "type": "string", + "$ref": "../../../../general/item/identifier.json" + } ], "title": "Feed Items" }, - "grow_up": { "$ref": "../types/event.json", "description": "Event to run when this entity grows up.", "title": "Grow up" }, + "grow_up": { + "$ref": "../types/event.json", + "description": "Event to run when this entity grows up.", + "title": "Grow Up" + }, "transform_to_item": { "type": "string", - "title": "Transform to item", + "title": "Transform To Item", "description": "The feed item used will transform to this item upon successful interaction. Format: itemName:auxValue" } - } + }, + "examples": [ + { + "duration": 1200, + "transform_to_item": "example" + } + ] } diff --git a/source/behavior/entities/format/components/ambient_sound_interval.json b/source/behavior/entities/format/components/ambient_sound_interval.json index 71a632c9..45bf2ad6 100644 --- a/source/behavior/entities/format/components/ambient_sound_interval.json +++ b/source/behavior/entities/format/components/ambient_sound_interval.json @@ -4,7 +4,6 @@ "type": "object", "title": "Ambient Sound Interval", "description": "Sets the entity's delay between playing its ambient sound.", - "properties": { "event_name": { "type": "string", @@ -24,5 +23,12 @@ "description": "Minimum time in seconds before the entity plays its ambient sound again", "title": "Value" } - } + }, + "examples": [ + { + "event_name": "ambient", + "range": 16, + "value": 8 + } + ] } diff --git a/source/behavior/entities/format/components/angry.json b/source/behavior/entities/format/components/angry.json index 25a65c29..ee58fc64 100644 --- a/source/behavior/entities/format/components/angry.json +++ b/source/behavior/entities/format/components/angry.json @@ -30,7 +30,12 @@ "broadcast_targets": { "type": "array", "description": "A list of entity families to broadcast anger to", - "items": { "type": "string", "description": "An entity family", "pattern": "^.+$", "title": "Broadcast Targets" }, + "items": { + "type": "string", + "description": "An entity family", + "pattern": "^.+$", + "title": "Broadcast Targets" + }, "title": "Broadcast Targets" }, "calm_event": { @@ -38,7 +43,12 @@ "description": "Event to run after the number of seconds specified in duration expires (when the entity stops being `angry')", "title": "Calm Event" }, - "angry_sound": { "type": "string", "default": "", "description": "The sound event to play when the mob is angry", "title": "Angry Sound" }, + "angry_sound": { + "type": "string", + "default": "", + "description": "The sound event to play when the mob is angry", + "title": "Angry Sound" + }, "broadcast_anger_on_attack": { "type": "boolean", "default": false, @@ -71,19 +81,53 @@ "type": "array", "default": [0, 0], "items": [ - { "type": "integer", "minimum": 0, "description": "The minimum interval", "$comment": "UNDOCUMENTED", "title": "Minimum" }, - { "type": "integer", "minimum": 0, "description": "The maximum interval", "$comment": "UNDOCUMENTED", "title": "Maximum" } + { + "type": "integer", + "minimum": 0, + "description": "The minimum interval", + "$comment": "UNDOCUMENTED", + "title": "Minimum" + }, + { + "type": "integer", + "minimum": 0, + "description": "The maximum interval", + "$comment": "UNDOCUMENTED", + "title": "Maximum" + } ] }, { "type": "object", "additionalProperties": false, "properties": { - "range_min": { "type": "number", "description": "The minimum interval", "$comment": "UNDOCUMENTED", "title": "Range Minimum" }, - "range_max": { "type": "number", "description": "The maximum interval", "$comment": "UNDOCUMENTED", "title": "Range Maximum" } + "range_min": { + "type": "number", + "description": "The minimum interval", + "$comment": "UNDOCUMENTED", + "title": "Range Minimum" + }, + "range_max": { + "type": "number", + "description": "The maximum interval", + "$comment": "UNDOCUMENTED", + "title": "Range Maximum" + } } } ] } - } + }, + "examples": [ + { + "broadcast_anger": false, + "broadcast_range": 20, + "broadcast_targets": [], + "angry_sound": "", + "broadcast_anger_on_attack": false, + "broadcast_anger_on_being_attacked": false, + "duration": 25, + "duration_delta": 0 + } + ] } diff --git a/source/behavior/entities/format/components/annotation.break_door.json b/source/behavior/entities/format/components/annotation.break_door.json index 59ee6633..440d0d5a 100644 --- a/source/behavior/entities/format/components/annotation.break_door.json +++ b/source/behavior/entities/format/components/annotation.break_door.json @@ -7,12 +7,23 @@ "required": [], "$comment": "Caution No longe rin use", "properties": { - "break_time": { "type": "number", "default": 12, "description": "The time in seconds required to break through doors.", "title": "Break Time" }, + "break_time": { + "type": "number", + "default": 12, + "description": "The time in seconds required to break through doors.", + "title": "Break Time" + }, "min_difficulty": { "type": "string", "default": "hard", "description": "The minimum difficulty that the world must be on for this entity to break doors.", "title": "Minimum Difficulty" } - } + }, + "examples": [ + { + "break_time": 12, + "min_difficulty": "hard" + } + ] } diff --git a/source/behavior/entities/format/components/area_attack.json b/source/behavior/entities/format/components/area_attack.json index 3420fef3..df2012c9 100644 --- a/source/behavior/entities/format/components/area_attack.json +++ b/source/behavior/entities/format/components/area_attack.json @@ -28,5 +28,12 @@ "title": "Cause", "$ref": "../../../../general/entity/damage_source.json" } - } + }, + "examples": [ + { + "damage_per_tick": 2, + "damage_range": 0.2, + "cause": "example" + } + ] } diff --git a/source/behavior/entities/format/components/attack.json b/source/behavior/entities/format/components/attack.json index 6c288d8c..4aef8731 100644 --- a/source/behavior/entities/format/components/attack.json +++ b/source/behavior/entities/format/components/attack.json @@ -23,5 +23,11 @@ "description": "Duration in seconds of the status ailment applied to the damaged entity.", "title": "Effect Duration" } - } + }, + "examples": [ + { + "effect_name": "example", + "effect_duration": 1 + } + ] } diff --git a/source/behavior/entities/format/components/attack_cooldown.json b/source/behavior/entities/format/components/attack_cooldown.json index b41658fc..7ede9b98 100644 --- a/source/behavior/entities/format/components/attack_cooldown.json +++ b/source/behavior/entities/format/components/attack_cooldown.json @@ -18,11 +18,19 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" } + { + "type": "number" + } ] } } diff --git a/source/behavior/entities/format/components/attack_damage.json b/source/behavior/entities/format/components/attack_damage.json index b4749935..122eba1c 100644 --- a/source/behavior/entities/format/components/attack_damage.json +++ b/source/behavior/entities/format/components/attack_damage.json @@ -4,6 +4,17 @@ "title": "Attack Damage", "additionalProperties": false, "required": ["value"], - "properties": { "value": { "type": "number", "description": "UNDOCUMENTED: value", "title": "Value" } }, - "description": "UNDOCUMENTED: " + "properties": { + "value": { + "type": "number", + "description": "UNDOCUMENTED: value", + "title": "Value" + } + }, + "description": "UNDOCUMENTED: ", + "examples": [ + { + "value": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/balloonable.json b/source/behavior/entities/format/components/balloonable.json index 12b99c40..f7929379 100644 --- a/source/behavior/entities/format/components/balloonable.json +++ b/source/behavior/entities/format/components/balloonable.json @@ -4,6 +4,17 @@ "type": "object", "title": "Balloonable", "required": [], - "properties": { "mass": { "type": "number", "description": "UNDOCUMENTED: mass", "title": "Mass" } }, - "description": "UNDOCUMENTED: " + "properties": { + "mass": { + "type": "number", + "description": "UNDOCUMENTED: mass", + "title": "Mass" + } + }, + "description": "UNDOCUMENTED: ", + "examples": [ + { + "mass": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/barter.json b/source/behavior/entities/format/components/barter.json index 833d7313..aa1938ec 100644 --- a/source/behavior/entities/format/components/barter.json +++ b/source/behavior/entities/format/components/barter.json @@ -5,12 +5,22 @@ "description": "Enables the component to drop an item as a barter exchange.", "additionalProperties": false, "properties": { - "barter_table": { "type": "string", "description": "Loot table that's used to drop a random item.", "title": "Barter Table" }, + "barter_table": { + "type": "string", + "description": "Loot table that's used to drop a random item.", + "title": "Barter Table" + }, "cooldown_after_being_attacked": { "type": "integer", "default": 0, "description": "Duration, in seconds, for which mob won't barter items if it was hurt", "title": "Cooldown After Being Attacked" } - } + }, + "examples": [ + { + "barter_table": "example", + "cooldown_after_being_attacked": 0 + } + ] } diff --git a/source/behavior/entities/format/components/block_sensor.json b/source/behavior/entities/format/components/block_sensor.json index 8205bde6..721bc2d0 100644 --- a/source/behavior/entities/format/components/block_sensor.json +++ b/source/behavior/entities/format/components/block_sensor.json @@ -5,7 +5,13 @@ "description": "Fires off a specified event when a block in the block list is broken within the sensor range.", "additionalProperties": false, "properties": { - "sensor_radius": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Sensor Radius", "minimum": 0 }, + "sensor_radius": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Sensor Radius", + "minimum": 0 + }, "on_break": { "type": "array", "title": "On Break", @@ -20,11 +26,24 @@ "type": "array", "title": "Block List", "description": "Blocks that will trigger the component when broken and what event will trigger.", - "items": { "$ref": "../../../../general/block/identifier.json", "title": "Block ID" } + "items": { + "$ref": "../../../../general/block/identifier.json", + "title": "Block ID" + } }, - "on_block_broken": { "type": "string", "title": "On Block Broken", "description": "Event to run when a block breaks" } + "on_block_broken": { + "type": "string", + "title": "On Block Broken", + "description": "Event to run when a block breaks" + } } } } - } + }, + "examples": [ + { + "sensor_radius": 0, + "on_break": [] + } + ] } diff --git a/source/behavior/entities/format/components/boostable.json b/source/behavior/entities/format/components/boostable.json index a87d1800..7aa08119 100644 --- a/source/behavior/entities/format/components/boostable.json +++ b/source/behavior/entities/format/components/boostable.json @@ -4,9 +4,13 @@ "title": "Boostable", "additionalProperties": false, "description": "Defines the conditions and behavior of a rideable entity's boost", - "properties": { - "duration": { "type": "number", "default": 3, "description": "Time in seconds for the boost.", "title": "Duration" }, + "duration": { + "type": "number", + "default": 3, + "description": "Time in seconds for the boost.", + "title": "Duration" + }, "speed_multiplier": { "type": "number", "default": 1, @@ -28,7 +32,12 @@ "description": "This is the damage that the item will take each time it is used.", "title": "Damage" }, - "item": { "type": "string", "default": "", "description": "Name of the item that can be used to boost.", "title": "Item" }, + "item": { + "type": "string", + "default": "", + "description": "Name of the item that can be used to boost.", + "title": "Item" + }, "replace_item": { "type": "string", "default": "", @@ -38,5 +47,12 @@ } } } - } + }, + "examples": [ + { + "duration": 3, + "speed_multiplier": 1, + "boost_items": [] + } + ] } diff --git a/source/behavior/entities/format/components/boss.json b/source/behavior/entities/format/components/boss.json index 52883e6e..b35ce7cb 100644 --- a/source/behavior/entities/format/components/boss.json +++ b/source/behavior/entities/format/components/boss.json @@ -12,12 +12,24 @@ "description": "The Maximum distance from the boss at which the boss's health bar is present on the players screen.", "title": "Hud Range" }, - "name": { "type": "string", "default": "", "description": "The name that will be displayed above the boss's health bar.", "title": "Name" }, + "name": { + "type": "string", + "default": "", + "description": "The name that will be displayed above the boss's health bar.", + "title": "Name" + }, "should_darken_sky": { "type": "boolean", "default": false, "description": "Whether the sky should darken in the presence of the boss.", "title": "Should Darken Sky" } - } + }, + "examples": [ + { + "hud_range": 55, + "name": "", + "should_darken_sky": false + } + ] } diff --git a/source/behavior/entities/format/components/break_blocks.json b/source/behavior/entities/format/components/break_blocks.json index 4bac6193..4e4d2e9f 100644 --- a/source/behavior/entities/format/components/break_blocks.json +++ b/source/behavior/entities/format/components/break_blocks.json @@ -10,7 +10,14 @@ "type": "array", "title": "Breakable Blocks", "description": "A list of the blocks that can be broken as this entity moves around", - "items": { "$ref": "../../../../general/blocks_item.json" } + "items": { + "$ref": "../../../../general/blocks_item.json" + } } - } + }, + "examples": [ + { + "breakable_blocks": [] + } + ] } diff --git a/source/behavior/entities/format/components/breathable.json b/source/behavior/entities/format/components/breathable.json index dd946540..3e39e551 100644 --- a/source/behavior/entities/format/components/breathable.json +++ b/source/behavior/entities/format/components/breathable.json @@ -6,12 +6,42 @@ "description": "Defines what blocks this entity can breathe in and gives them the ability to suffocate.", "required": [], "properties": { - "total_supply": { "type": "integer", "default": 15, "description": "Time in seconds the entity can hold its breath", "title": "Total Supply" }, - "suffocate_time": { "type": "integer", "default": -20, "description": "Time in seconds between suffocation damage", "title": "Suffocate Time" }, - "inhale_time": { "type": "number", "default": 0, "description": "Time in seconds to recover breath to maximum", "title": "Inhale Time" }, - "breathes_air": { "type": "boolean", "default": true, "description": "If true, this entity can breathe in air", "title": "Breathes Air" }, - "breathes_water": { "type": "boolean", "default": false, "description": "If true, this entity can breathe in water", "title": "Breathes Water" }, - "breathes_lava": { "type": "boolean", "default": false, "description": "If true, this entity can breathe in lava", "title": "Breathes Lava" }, + "total_supply": { + "type": "integer", + "default": 15, + "description": "Time in seconds the entity can hold its breath", + "title": "Total Supply" + }, + "suffocate_time": { + "type": "integer", + "default": -20, + "description": "Time in seconds between suffocation damage", + "title": "Suffocate Time" + }, + "inhale_time": { + "type": "number", + "default": 0, + "description": "Time in seconds to recover breath to maximum", + "title": "Inhale Time" + }, + "breathes_air": { + "type": "boolean", + "default": true, + "description": "If true, this entity can breathe in air", + "title": "Breathes Air" + }, + "breathes_water": { + "type": "boolean", + "default": false, + "description": "If true, this entity can breathe in water", + "title": "Breathes Water" + }, + "breathes_lava": { + "type": "boolean", + "default": false, + "description": "If true, this entity can breathe in lava", + "title": "Breathes Lava" + }, "breathes_solids": { "type": "boolean", "default": false, @@ -27,14 +57,32 @@ "breathe_blocks": { "type": "array", "description": "List of blocks this entity can breathe in, in addition to the above", - "items": { "$ref": "../../../../general/block/identifier.json" }, + "items": { + "$ref": "../../../../general/block/identifier.json" + }, "title": "Breathe Blocks" }, "non_breathe_blocks": { "type": "array", "description": "List of blocks this entity can't breathe in, in addition to the above", - "items": { "$ref": "../../../../general/block/identifier.json" }, + "items": { + "$ref": "../../../../general/block/identifier.json" + }, "title": "Non Breathes Blocks" } - } + }, + "examples": [ + { + "total_supply": 15, + "suffocate_time": -20, + "inhale_time": 0, + "breathes_air": true, + "breathes_water": false, + "breathes_lava": false, + "breathes_solids": false, + "generates_bubbles": true, + "breathe_blocks": [], + "non_breathe_blocks": [] + } + ] } diff --git a/source/behavior/entities/format/components/breedable.json b/source/behavior/entities/format/components/breedable.json index dff7a7e8..54f3d8a1 100644 --- a/source/behavior/entities/format/components/breedable.json +++ b/source/behavior/entities/format/components/breedable.json @@ -9,11 +9,22 @@ "type": "object", "description": "An entity definitions that this entity can breed with.", "additionalItems": false, - "properties": { - "baby_type": { "type": "string", "description": "The entity definition of this entity's babies.", "title": "Baby Type" }, - "breed_event": { "$ref": "../types/event.json", "description": "Event to run when this entity breeds.", "title": "Breed Event" }, - "mate_type": { "type": "string", "description": "The entity definition of this entity's mate.", "title": "Mate Type" } + "baby_type": { + "type": "string", + "description": "The entity definition of this entity's babies.", + "title": "Baby Type" + }, + "breed_event": { + "$ref": "../types/event.json", + "description": "Event to run when this entity breeds.", + "title": "Breed Event" + }, + "mate_type": { + "type": "string", + "description": "The entity definition of this entity's mate.", + "title": "Mate Type" + } } }, "enviroment_requirements": { @@ -41,7 +52,11 @@ } ] }, - "count": { "type": "number", "description": "The number of the required block types nearby for the entity to breed.", "title": "Count" }, + "count": { + "type": "number", + "description": "The number of the required block types nearby for the entity to breed.", + "title": "Count" + }, "radius": { "type": "number", "description": "How many blocks radius from the mob's center to search in for the required blocks. Bounded between 0 and 16.", @@ -52,9 +67,13 @@ "title": "Environment Requirements" } }, - "properties": { - "allow_sitting": { "description": "If true, entities can breed while sitting.", "type": "boolean", "default": false, "title": "Allow Sitting" }, + "allow_sitting": { + "description": "If true, entities can breed while sitting.", + "type": "boolean", + "default": false, + "title": "Allow Sitting" + }, "blend_attributes": { "description": "If true, the entities will blend their attributes in the offspring after they breed. For example, horses blend their health, movement, and jump_strength in their offspring.", "type": "boolean", @@ -80,15 +99,28 @@ "title": "Breed Item" } }, - { "type": "string", "$ref": "../../../../general/item/identifier.json" } + { + "type": "string", + "$ref": "../../../../general/item/identifier.json" + } ] }, "breeds_with": { "description": "The list of entity definitions that this entity can breed with.", "title": "Breeds With", "oneOf": [ - { "type": "object", "$ref": "#/definitions/breeds_with_spec" }, - { "uniqueItems": true, "type": "array", "items": { "type": "object", "$ref": "#/definitions/breeds_with_spec" } } + { + "type": "object", + "$ref": "#/definitions/breeds_with_spec" + }, + { + "uniqueItems": true, + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/breeds_with_spec" + } + } ] }, "deny_parents_variant": { @@ -96,17 +128,40 @@ "description": "Determines how likely the baby of parents with the same variant will deny that variant and take a random variant within the given range instead.", "additionalProperties": false, "properties": { - "chance": { "type": "number", "default": 0, "description": "The percentage chance of denying the parents` variant.", "title": "Chance" }, - "max_variant": { "type": "integer", "default": 0, "description": "The inclusive maximum of the variant range.", "title": "Maximum Variant" }, - "min_variant": { "type": "integer", "default": 0, "description": "The inclusive minimum of the variant range.", "title": "Minimum Variant" } + "chance": { + "type": "number", + "default": 0, + "description": "The percentage chance of denying the parents` variant.", + "title": "Chance" + }, + "max_variant": { + "type": "integer", + "default": 0, + "description": "The inclusive maximum of the variant range.", + "title": "Maximum Variant" + }, + "min_variant": { + "type": "integer", + "default": 0, + "description": "The inclusive minimum of the variant range.", + "title": "Minimum Variant" + } }, "title": "Deny Parents Variant" }, "environment_requirements": { "description": "The list of nearby block requirements to get the entity into the `love` state.", "oneOf": [ - { "type": "object", "$ref": "#/definitions/enviroment_requirements" }, - { "type": "array", "items": { "$ref": "#/definitions/enviroment_requirements" } } + { + "type": "object", + "$ref": "#/definitions/enviroment_requirements" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/enviroment_requirements" + } + } ], "title": "Environment Requirements" }, @@ -184,5 +239,20 @@ "title": "Transform To Item", "description": "The feed item used will transform to this item upon successful interaction. Format: itemName:auxValue" } - } + }, + "examples": [ + { + "allow_sitting": false, + "blend_attributes": true, + "breed_cooldown": 60.0, + "deny_parents_variant": {}, + "extra_baby_chance": 0.0, + "mutation_factor": {}, + "causes_pregnancy": false, + "inherit_tamed": true, + "require_full_health": false, + "require_tame": true, + "transform_to_item": "example" + } + ] } diff --git a/source/behavior/entities/format/components/bribeable.json b/source/behavior/entities/format/components/bribeable.json index bfc1750d..2f7b0b5a 100644 --- a/source/behavior/entities/format/components/bribeable.json +++ b/source/behavior/entities/format/components/bribeable.json @@ -22,5 +22,11 @@ }, "title": "Bribe Items" } - } + }, + "examples": [ + { + "bribe_cooldown": 2, + "bribe_items": [] + } + ] } diff --git a/source/behavior/entities/format/components/buoyant.json b/source/behavior/entities/format/components/buoyant.json index 670f800b..ddf75e48 100644 --- a/source/behavior/entities/format/components/buoyant.json +++ b/source/behavior/entities/format/components/buoyant.json @@ -45,7 +45,10 @@ "type": "array", "description": "List of blocks this entity can float on. Must be a liquid block.", "title": "Liquid Blocks", - "items": { "type": "string", "title": "Block ID" } + "items": { + "type": "string", + "title": "Block ID" + } }, "simulate_waves": { "type": "boolean", @@ -53,5 +56,17 @@ "description": "Should the movement simulate waves going through.", "title": "Simulate Waves" } - } + }, + "examples": [ + { + "base_buoyancy": 0, + "apply_gravity": true, + "buoyancy": 1, + "big_wave_probability": 0.03, + "big_wave_speed": 10, + "drag_down_on_buoyancy_removed": 0, + "liquid_blocks": [], + "simulate_waves": true + } + ] } diff --git a/source/behavior/entities/format/components/burns_in_daylight.json b/source/behavior/entities/format/components/burns_in_daylight.json index 0bdc3947..fb2184a4 100644 --- a/source/behavior/entities/format/components/burns_in_daylight.json +++ b/source/behavior/entities/format/components/burns_in_daylight.json @@ -5,5 +5,12 @@ "description": "Specifies if/how a mob burns in daylight.", "required": [], "properties": {}, - "oneOf": [{ "type": "boolean" }, { "type": "object" }] + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "object" + } + ] } diff --git a/source/behavior/entities/format/components/can_fly.json b/source/behavior/entities/format/components/can_fly.json index 63b970c8..d5b5cf74 100644 --- a/source/behavior/entities/format/components/can_fly.json +++ b/source/behavior/entities/format/components/can_fly.json @@ -12,5 +12,10 @@ "description": "Marks the entity as being able to fly, the pathfinder won't be restricted to paths where a solid block is required underneath it.", "title": "Value" } - } + }, + "examples": [ + { + "value": true + } + ] } diff --git a/source/behavior/entities/format/components/celebrate_hunt.json b/source/behavior/entities/format/components/celebrate_hunt.json index ba1ce6af..7d43b31d 100644 --- a/source/behavior/entities/format/components/celebrate_hunt.json +++ b/source/behavior/entities/format/components/celebrate_hunt.json @@ -22,7 +22,12 @@ "description": "The sound event to play when the mob is celebrating", "title": "Celebrate Sound" }, - "duration": { "type": "integer", "default": 4, "description": "Duration, in seconds, of celebration", "title": "Duration" }, + "duration": { + "type": "integer", + "default": 4, + "description": "Duration, in seconds, of celebration", + "title": "Duration" + }, "radius": { "type": "number", "default": 16, @@ -37,11 +42,19 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" }, + { + "type": "number" + }, { "type": "object", "additionalProperties": false, @@ -60,5 +73,13 @@ } ] } - } + }, + "examples": [ + { + "broadcast": true, + "celebrate_sound": "", + "duration": 4, + "radius": 16 + } + ] } diff --git a/source/behavior/entities/format/components/collision_box.json b/source/behavior/entities/format/components/collision_box.json index 02f69633..564b54f8 100644 --- a/source/behavior/entities/format/components/collision_box.json +++ b/source/behavior/entities/format/components/collision_box.json @@ -18,5 +18,11 @@ "description": "Width and Depth of the collision box in blocks. A negative value will be assumed to be 0", "title": "Width" } - } + }, + "examples": [ + { + "height": 1, + "width": 1 + } + ] } diff --git a/source/behavior/entities/format/components/color.json b/source/behavior/entities/format/components/color.json index 1e820005..f1357030 100644 --- a/source/behavior/entities/format/components/color.json +++ b/source/behavior/entities/format/components/color.json @@ -5,5 +5,17 @@ "additionalProperties": false, "description": "Defines the entity's color. Only works on vanilla entities that have predefined color values (sheep, llama, shulker).", "required": [], - "properties": { "value": { "type": "integer", "default": 0, "description": "The Palette Color value of the entity", "title": "Value" } } + "properties": { + "value": { + "type": "integer", + "default": 0, + "description": "The Palette Color value of the entity", + "title": "Value" + } + }, + "examples": [ + { + "value": 0 + } + ] } diff --git a/source/behavior/entities/format/components/color2.json b/source/behavior/entities/format/components/color2.json index fc0d55b7..19690c62 100644 --- a/source/behavior/entities/format/components/color2.json +++ b/source/behavior/entities/format/components/color2.json @@ -5,5 +5,17 @@ "additionalProperties": false, "description": "Defines the entity's second texture color. Only works on vanilla entities that have a second predefined color values (tropical fish).", "required": [], - "properties": { "value": { "type": "integer", "default": 0, "description": "The second Palette Color value of the entity", "title": "Value" } } + "properties": { + "value": { + "type": "integer", + "default": 0, + "description": "The second Palette Color value of the entity", + "title": "Value" + } + }, + "examples": [ + { + "value": 0 + } + ] } diff --git a/source/behavior/entities/format/components/combat_regeneration.json b/source/behavior/entities/format/components/combat_regeneration.json index 50565606..7ee4b507 100644 --- a/source/behavior/entities/format/components/combat_regeneration.json +++ b/source/behavior/entities/format/components/combat_regeneration.json @@ -23,5 +23,12 @@ "description": "The duration in seconds of Regeneration I added to the mob.", "title": "Regeneration Duration" } - } + }, + "examples": [ + { + "apply_to_family": false, + "apply_to_self": false, + "regeneration_duration": 5 + } + ] } diff --git a/source/behavior/entities/format/components/conditional_bandwidth_optimization.json b/source/behavior/entities/format/components/conditional_bandwidth_optimization.json index b9e81116..e208d948 100644 --- a/source/behavior/entities/format/components/conditional_bandwidth_optimization.json +++ b/source/behavior/entities/format/components/conditional_bandwidth_optimization.json @@ -33,7 +33,9 @@ "title": "Conditional Values", "description": "Conditions that must be met for these optimization values to be used.", "type": "array", - "items": { "$ref": "../../filters/filters.json" } + "items": { + "$ref": "../../filters/filters.json" + } } } } @@ -61,5 +63,11 @@ } } } - } + }, + "examples": [ + { + "conditional_values": [], + "default_values": {} + } + ] } diff --git a/source/behavior/entities/format/components/custom_hit_test.json b/source/behavior/entities/format/components/custom_hit_test.json index fd4ad587..cc36facf 100644 --- a/source/behavior/entities/format/components/custom_hit_test.json +++ b/source/behavior/entities/format/components/custom_hit_test.json @@ -30,13 +30,27 @@ "title": "Pivot", "description": "The offset from the entity's anchor where the hitbox will spawn", "items": [ - { "type": "number", "title": "X" }, - { "type": "number", "title": "Y" }, - { "type": "number", "title": "Z" } + { + "type": "number", + "title": "X" + }, + { + "type": "number", + "title": "Y" + }, + { + "type": "number", + "title": "Z" + } ] } } } } - } + }, + "examples": [ + { + "hitboxes": [] + } + ] } diff --git a/source/behavior/entities/format/components/damage_over_time.json b/source/behavior/entities/format/components/damage_over_time.json index 1c4ca744..cbc6f3ba 100644 --- a/source/behavior/entities/format/components/damage_over_time.json +++ b/source/behavior/entities/format/components/damage_over_time.json @@ -6,7 +6,23 @@ "description": "Applies defined amount of damage to the entity at specified intervals.", "required": [], "properties": { - "damage_per_hurt": { "type": "integer", "default": 1, "description": "Amount of damage caused each hurt.", "title": "Damage Per Hurt" }, - "time_between_hurt": { "type": "number", "default": 0, "description": "Time in seconds between damage.", "title": "Time Between Hurt" } - } + "damage_per_hurt": { + "type": "integer", + "default": 1, + "description": "Amount of damage caused each hurt.", + "title": "Damage Per Hurt" + }, + "time_between_hurt": { + "type": "number", + "default": 0, + "description": "Time in seconds between damage.", + "title": "Time Between Hurt" + } + }, + "examples": [ + { + "damage_per_hurt": 1, + "time_between_hurt": 0 + } + ] } diff --git a/source/behavior/entities/format/components/damage_sensor.json b/source/behavior/entities/format/components/damage_sensor.json index c12df9f7..a3bb9f1a 100644 --- a/source/behavior/entities/format/components/damage_sensor.json +++ b/source/behavior/entities/format/components/damage_sensor.json @@ -44,10 +44,25 @@ "triggers": { "title": "Triggers", "description": "The list of triggers that fire when the environment conditions match the given filter criteria.", - "examples": [[{ "cause": "all", "deals_damage": false }]], + "examples": [ + [ + { + "cause": "all", + "deals_damage": false + } + ] + ], "oneOf": [ - { "type": "array", "items": { "$ref": "#/definitions/trigger" } }, - { "type": "object", "$ref": "#/definitions/trigger" } + { + "type": "array", + "items": { + "$ref": "#/definitions/trigger" + } + }, + { + "type": "object", + "$ref": "#/definitions/trigger" + } ] } } diff --git a/source/behavior/entities/format/components/default_look_angle.json b/source/behavior/entities/format/components/default_look_angle.json index 7e55a4b2..ba468276 100644 --- a/source/behavior/entities/format/components/default_look_angle.json +++ b/source/behavior/entities/format/components/default_look_angle.json @@ -5,5 +5,17 @@ "additionalProperties": false, "description": "Sets this entity's default head rotation angle.", "required": [], - "properties": { "value": { "type": "number", "default": 0.0, "description": "Angle in degrees", "title": "Value" } } + "properties": { + "value": { + "type": "number", + "default": 0.0, + "description": "Angle in degrees", + "title": "Value" + } + }, + "examples": [ + { + "value": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/despawn.json b/source/behavior/entities/format/components/despawn.json index 70be7aeb..aac6f65b 100644 --- a/source/behavior/entities/format/components/despawn.json +++ b/source/behavior/entities/format/components/despawn.json @@ -65,5 +65,16 @@ "description": "If true, all entities linked to this entity in a child relationship (eg. leashed) will also be despawned.", "title": "Remove Child Entities" } - } + }, + "examples": [ + { + "despawn_from_chance": true, + "despawn_from_distance": {}, + "despawn_from_inactivity": true, + "despawn_from_simulation_edge": true, + "min_range_inactivity_timer": 30, + "min_range_random_chance": 800, + "remove_child_entities": false + } + ] } diff --git a/source/behavior/entities/format/components/drying_out_timer.json b/source/behavior/entities/format/components/drying_out_timer.json index aca016bd..2cd96508 100644 --- a/source/behavior/entities/format/components/drying_out_timer.json +++ b/source/behavior/entities/format/components/drying_out_timer.json @@ -32,5 +32,11 @@ "description": "Optional amount of additional time in seconds given by using splash water bottle on entity.", "title": "Water Bottle Refill Time" } - } + }, + "examples": [ + { + "total_time": 0, + "water_bottle_refill_time": 0 + } + ] } diff --git a/source/behavior/entities/format/components/dweller.json b/source/behavior/entities/format/components/dweller.json index 314787b4..8a82f631 100644 --- a/source/behavior/entities/format/components/dweller.json +++ b/source/behavior/entities/format/components/dweller.json @@ -54,5 +54,17 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "dwelling_type": "example", + "dweller_role": "example", + "update_interval_base": 0, + "update_interval_variant": 0, + "preferred_profession": "example", + "can_find_poi": true, + "can_migrate": true, + "first_founding_reward": 0 + } + ] } diff --git a/source/behavior/entities/format/components/economy_trade_table.json b/source/behavior/entities/format/components/economy_trade_table.json index 09404721..fcf791cf 100644 --- a/source/behavior/entities/format/components/economy_trade_table.json +++ b/source/behavior/entities/format/components/economy_trade_table.json @@ -18,8 +18,16 @@ "description": "How much should the discount be modified by when the player has cured the Zombie Villager. Can be specified as a pair of numbers (low-tier trade discount and high-tier trade discount)", "title": "Cured Discount", "items": [ - { "type": "integer", "title": "A", "description": "Minimum" }, - { "type": "integer", "title": "B", "description": "Maximum" } + { + "type": "integer", + "title": "A", + "description": "Minimum" + }, + { + "type": "integer", + "title": "B", + "description": "Maximum" + } ] }, "display_name": { @@ -40,8 +48,16 @@ "description": "The Maximum the discount can be modified by when the player has cured the Zombie Villager. Can be specified as a pair of numbers (low-tier trade discount and high-tier trade discount)", "title": "Maximum Cured Discount", "items": [ - { "type": "integer", "title": "A", "description": "Minimum" }, - { "type": "integer", "title": "B", "description": "Maximum" } + { + "type": "integer", + "title": "A", + "description": "Minimum" + }, + { + "type": "integer", + "title": "B", + "description": "Maximum" + } ] }, "max_nearby_cured_discount": { @@ -86,5 +102,21 @@ "description": "Determines whether the legacy formula is used to determines the trade prices.", "title": "Use Legacy Price Formula" } - } + }, + "examples": [ + { + "convert_trades_economy": false, + "cured_discount": [], + "display_name": "", + "hero_demand_discount": -4, + "max_cured_discount": [], + "max_nearby_cured_discount": -200, + "nearby_cured_discount": -25, + "new_screen": false, + "persist_trades": false, + "show_trade_screen": true, + "table": "", + "use_legacy_price_formula": false + } + ] } diff --git a/source/behavior/entities/format/components/entity_sensor.json b/source/behavior/entities/format/components/entity_sensor.json index 76f94e0b..47d46519 100644 --- a/source/behavior/entities/format/components/entity_sensor.json +++ b/source/behavior/entities/format/components/entity_sensor.json @@ -35,7 +35,23 @@ "description": "The maximum distance another entity can be from this and have the filters checked against it.", "title": "Sensor Range" }, - "event_filters": { "$ref": "../../filters/filters.json" }, - "event": { "title": "Event", "description": "event", "type": "string" } - } + "event_filters": { + "$ref": "../../filters/filters.json" + }, + "event": { + "title": "Event", + "description": "event", + "type": "string" + } + }, + "examples": [ + { + "maximum_count": -1, + "minimum_count": 1, + "relative_range": true, + "require_all": false, + "sensor_range": 10, + "event": "example" + } + ] } diff --git a/source/behavior/entities/format/components/environment_sensor.json b/source/behavior/entities/format/components/environment_sensor.json index cc482c7e..c16eb9b0 100644 --- a/source/behavior/entities/format/components/environment_sensor.json +++ b/source/behavior/entities/format/components/environment_sensor.json @@ -4,14 +4,26 @@ "description": "Creates a trigger based on environment conditions.", "type": "object", "additionalProperties": false, - "definitions": { "trigger": { "$ref": "../types/trigger.json" } }, + "definitions": { + "trigger": { + "$ref": "../types/trigger.json" + } + }, "properties": { "triggers": { "description": "The list of triggers that fire when the environment conditions match the given filter criteria.", "title": "Triggers", "oneOf": [ - { "type": "array", "items": { "$ref": "#/definitions/trigger" } }, - { "type": "object", "$ref": "#/definitions/trigger" } + { + "type": "array", + "items": { + "$ref": "#/definitions/trigger" + } + }, + { + "type": "object", + "$ref": "#/definitions/trigger" + } ] } } diff --git a/source/behavior/entities/format/components/equipment.json b/source/behavior/entities/format/components/equipment.json index 0591db35..44e43039 100644 --- a/source/behavior/entities/format/components/equipment.json +++ b/source/behavior/entities/format/components/equipment.json @@ -4,7 +4,6 @@ "title": "Equipment", "description": "Sets the equipment table to use for the entity.", "additionalProperties": false, - "properties": { "slot_drop_chance": { "type": "array", @@ -22,7 +21,12 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, - "slot": { "type": "string", "title": "Slot", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } + "slot": { + "type": "string", + "title": "Slot", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + } } } }, @@ -31,5 +35,10 @@ "description": "The file path to the equipment table, relative to the behavior pack's root.", "$ref": "../../../../general/loot_table/identifier.json" } - } + }, + "examples": [ + { + "slot_drop_chance": [] + } + ] } diff --git a/source/behavior/entities/format/components/equippable.json b/source/behavior/entities/format/components/equippable.json index 23879866..8d190a44 100644 --- a/source/behavior/entities/format/components/equippable.json +++ b/source/behavior/entities/format/components/equippable.json @@ -14,7 +14,12 @@ "title": "Slots", "type": "object", "properties": { - "slot": { "type": "integer", "default": 0, "description": "The slot number of this slot.", "title": "Slot" }, + "slot": { + "type": "integer", + "default": 0, + "description": "The slot number of this slot.", + "title": "Slot" + }, "accepted_items": { "type": "array", "description": "The list of items that can go in this slot.", @@ -49,5 +54,10 @@ } } } - } + }, + "examples": [ + { + "slots": [] + } + ] } diff --git a/source/behavior/entities/format/components/experience_reward.json b/source/behavior/entities/format/components/experience_reward.json index cad2a37a..ca51b414 100644 --- a/source/behavior/entities/format/components/experience_reward.json +++ b/source/behavior/entities/format/components/experience_reward.json @@ -17,5 +17,11 @@ "description": "A molang expression defining the amount of experience rewarded when this entity dies. An array of expressions adds each expression's result together for a final total.", "title": "On Death" } - } + }, + "examples": [ + { + "on_bred": 0, + "on_death": 0 + } + ] } diff --git a/source/behavior/entities/format/components/explode.json b/source/behavior/entities/format/components/explode.json index 41428aa0..48eced44 100644 --- a/source/behavior/entities/format/components/explode.json +++ b/source/behavior/entities/format/components/explode.json @@ -33,7 +33,22 @@ "default": [0.0, 0.0], "description": "The range for the random amount of time the fuse will be lit before exploding, a negative value means the explosion will be immediate.", "title": "Fuse Length", - "oneOf": [{ "type": "array", "items": [{ "type": "number" }, { "type": "number" }] }, { "type": "number" }] + "oneOf": [ + { + "type": "array", + "items": [ + { + "type": "number" + }, + { + "type": "number" + } + ] + }, + { + "type": "number" + } + ] }, "fuse_lit": { "type": "boolean", @@ -52,5 +67,16 @@ "description": "The radius of the explosion in blocks and the amount of damage the explosion deals.", "title": "Power" } - } + }, + "examples": [ + { + "breaks_blocks": true, + "causes_fire": false, + "destroy_affected_by_griefing": false, + "fire_affected_by_griefing": false, + "fuse_lit": false, + "max_resistance": 0.0, + "power": 3 + } + ] } diff --git a/source/behavior/entities/format/components/fall_damage.json b/source/behavior/entities/format/components/fall_damage.json index e3f2de2e..874a6102 100644 --- a/source/behavior/entities/format/components/fall_damage.json +++ b/source/behavior/entities/format/components/fall_damage.json @@ -6,5 +6,17 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "required": [], - "properties": { "value": { "type": "number", "default": 1, "description": "UNDOCUMENTED: value", "title": "Value" } } + "properties": { + "value": { + "type": "number", + "default": 1, + "description": "UNDOCUMENTED: value", + "title": "Value" + } + }, + "examples": [ + { + "value": 1 + } + ] } diff --git a/source/behavior/entities/format/components/fire_immune.json b/source/behavior/entities/format/components/fire_immune.json index 3e8e6599..4540f479 100644 --- a/source/behavior/entities/format/components/fire_immune.json +++ b/source/behavior/entities/format/components/fire_immune.json @@ -3,6 +3,7 @@ "title": "Fire Immune", "additionalProperties": false, "description": "Sets that this entity doesn't take damage from fire.", + "type": "object", "required": [], "properties": {} } diff --git a/source/behavior/entities/format/components/flocking.json b/source/behavior/entities/format/components/flocking.json index 7336f659..6a3cbdfa 100644 --- a/source/behavior/entities/format/components/flocking.json +++ b/source/behavior/entities/format/components/flocking.json @@ -11,7 +11,12 @@ "description": "The amount of blocks away the entity will look at to push away from.", "title": "Block Distance" }, - "block_weight": { "type": "number", "default": 0, "description": "The weight of the push back away from blocks.", "title": "Block Weight" }, + "block_weight": { + "type": "number", + "default": 0, + "description": "The weight of the push back away from blocks.", + "title": "Block Weight" + }, "breach_influence": { "type": "number", "default": 0, @@ -30,7 +35,12 @@ "description": "The weight applied for the cohesion steering of the flock.", "title": "Cohesion Weight" }, - "goal_weight": { "type": "number", "default": 0, "description": "The weight on which to apply on the goal output.", "title": "Goal Weight" }, + "goal_weight": { + "type": "number", + "default": 0, + "description": "The weight on which to apply on the goal output.", + "title": "Goal Weight" + }, "high_flock_limit": { "type": "integer", "default": 0, @@ -73,8 +83,18 @@ "description": "Tells the flockers that they can only match similar entities that also match the variant, mark variants, and color data of the other potential flockers.", "title": "Match Variants" }, - "max_height": { "type": "number", "default": 0, "description": "The Maximum height allowable in the air or water.", "title": "Maximum Height" }, - "min_height": { "type": "number", "default": 0, "description": "The Minimum height allowable in the air or water.", "title": "Minimum Height" }, + "max_height": { + "type": "number", + "default": 0, + "description": "The Maximum height allowable in the air or water.", + "title": "Maximum Height" + }, + "min_height": { + "type": "number", + "default": 0, + "description": "The Minimum height allowable in the air or water.", + "title": "Minimum Height" + }, "separation_threshold": { "type": "number", "default": 2, @@ -93,5 +113,27 @@ "description": "Tells the flockers that they will follow flocks based on the center of mass.", "title": "Use Center Of Mass" } - } + }, + "examples": [ + { + "block_distance": 0, + "block_weight": 0, + "breach_influence": 0, + "cohesion_threshold": 1, + "cohesion_weight": 1, + "goal_weight": 0, + "high_flock_limit": 0, + "in_water": false, + "influence_radius": 0, + "innner_cohesion_threshold": 0, + "loner_chance": 0, + "low_flock_limit": 0, + "match_variants": false, + "max_height": 0, + "min_height": 0, + "separation_threshold": 2, + "separation_weight": 1, + "use_center_of_mass": false + } + ] } diff --git a/source/behavior/entities/format/components/flying_speed.json b/source/behavior/entities/format/components/flying_speed.json index 9865597a..cc858363 100644 --- a/source/behavior/entities/format/components/flying_speed.json +++ b/source/behavior/entities/format/components/flying_speed.json @@ -5,5 +5,17 @@ "additionalProperties": false, "description": "Speed in Blocks that this entity flies at.", "required": [], - "properties": { "value": { "type": "number", "default": 0.02, "description": "Flying speed in blocks per tick", "title": "Value" } } + "properties": { + "value": { + "type": "number", + "default": 0.02, + "description": "Flying speed in blocks per tick", + "title": "Value" + } + }, + "examples": [ + { + "value": 0.02 + } + ] } diff --git a/source/behavior/entities/format/components/follow_range.json b/source/behavior/entities/format/components/follow_range.json index d09131e9..3c30dd59 100644 --- a/source/behavior/entities/format/components/follow_range.json +++ b/source/behavior/entities/format/components/follow_range.json @@ -5,8 +5,24 @@ "additionalProperties": false, "required": [], "properties": { - "value": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Value" }, - "max": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Max" } + "value": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Value" + }, + "max": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Max" + } }, - "description": "UNDOCUMENTED: " + "description": "UNDOCUMENTED: ", + "examples": [ + { + "value": 0, + "max": 0 + } + ] } diff --git a/source/behavior/entities/format/components/foot_size.json b/source/behavior/entities/format/components/foot_size.json index 134470ca..27882790 100644 --- a/source/behavior/entities/format/components/foot_size.json +++ b/source/behavior/entities/format/components/foot_size.json @@ -5,5 +5,17 @@ "additionalProperties": false, "description": "Sets the number of blocks the entity can step without jumping.", "required": [], - "properties": { "value": { "type": "number", "default": 0.5, "description": "The value of the size of the entity's step", "title": "Value" } } + "properties": { + "value": { + "type": "number", + "default": 0.5, + "description": "The value of the size of the entity's step", + "title": "Value" + } + }, + "examples": [ + { + "value": 0.5 + } + ] } diff --git a/source/behavior/entities/format/components/friction_modifier.json b/source/behavior/entities/format/components/friction_modifier.json index 0890de73..ba0c3159 100644 --- a/source/behavior/entities/format/components/friction_modifier.json +++ b/source/behavior/entities/format/components/friction_modifier.json @@ -12,5 +12,10 @@ "description": "The higher the number, the more the friction affects this entity. A value of 1.0 means regular friction, while 2.0 means twice as much", "title": "Value" } - } + }, + "examples": [ + { + "value": 1.0 + } + ] } diff --git a/source/behavior/entities/format/components/genetics.json b/source/behavior/entities/format/components/genetics.json index 6a4c566c..60037225 100644 --- a/source/behavior/entities/format/components/genetics.json +++ b/source/behavior/entities/format/components/genetics.json @@ -8,9 +8,17 @@ "definitions": { "integer_range": { "title": "Range", - "examples": [-1, { "range_min": 4, "range_max": 7 }], + "examples": [ + -1, + { + "range_min": 4, + "range_max": 7 + } + ], "oneOf": [ - { "type": "integer" }, + { + "type": "integer" + }, { "type": "object", "properties": { @@ -34,7 +42,6 @@ "properties": { "mutation_rate": { "type": "number", - "description": "Chance that an allele will be replaced with a random one instead of the parent's allele during birth.", "title": "Mutation Rate" }, @@ -92,5 +99,11 @@ } } } - } + }, + "examples": [ + { + "mutation_rate": 0.0, + "genes": [] + } + ] } diff --git a/source/behavior/entities/format/components/giveable.json b/source/behavior/entities/format/components/giveable.json index 8a2f40c8..bb54fadd 100644 --- a/source/behavior/entities/format/components/giveable.json +++ b/source/behavior/entities/format/components/giveable.json @@ -4,7 +4,6 @@ "description": "Defines sets of items that can be used to trigger events when used on this entity. The item will also be taken and placed in the entity's inventory.", "type": "object", "title": "Giveable", - "properties": { "triggers": { "description": "Defines sets of items that can be used to trigger events when used on this entity. The item will also be taken and placed in the entity's inventory.", @@ -28,8 +27,17 @@ "title": "Properties" } }, - "on_give": { "$ref": "../types/event.json", "description": "Event to fire when the correct item is given.", "title": "On Give" } + "on_give": { + "$ref": "../types/event.json", + "description": "Event to fire when the correct item is given.", + "title": "On Give" + } } } - } + }, + "examples": [ + { + "triggers": {} + } + ] } diff --git a/source/behavior/entities/format/components/ground_offset.json b/source/behavior/entities/format/components/ground_offset.json index c5f085de..9f60e380 100644 --- a/source/behavior/entities/format/components/ground_offset.json +++ b/source/behavior/entities/format/components/ground_offset.json @@ -12,5 +12,10 @@ "description": "The value of the entity's offset from the terrain, in blocks", "title": "Value" } - } + }, + "examples": [ + { + "value": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/group_size.json b/source/behavior/entities/format/components/group_size.json index 4bd2224b..70f6b0e0 100644 --- a/source/behavior/entities/format/components/group_size.json +++ b/source/behavior/entities/format/components/group_size.json @@ -9,6 +9,16 @@ "$ref": "../../filters/filters.json", "description": "The list of conditions that must be satisfied for other entities to be counted towards group size." }, - "radius": { "type": "number", "default": 16, "description": "Radius from center of entity.", "title": "Radius" } - } + "radius": { + "type": "number", + "default": 16, + "description": "Radius from center of entity.", + "title": "Radius" + } + }, + "examples": [ + { + "radius": 16 + } + ] } diff --git a/source/behavior/entities/format/components/grows_crop.json b/source/behavior/entities/format/components/grows_crop.json index 3e7431ef..150ad9a6 100644 --- a/source/behavior/entities/format/components/grows_crop.json +++ b/source/behavior/entities/format/components/grows_crop.json @@ -13,6 +13,17 @@ "maximum": 1, "title": "Chance" }, - "charges": { "type": "integer", "default": 10, "description": "Number of charges", "title": "Charges" } - } + "charges": { + "type": "integer", + "default": 10, + "description": "Number of charges", + "title": "Charges" + } + }, + "examples": [ + { + "chance": 0, + "charges": 10 + } + ] } diff --git a/source/behavior/entities/format/components/healable.json b/source/behavior/entities/format/components/healable.json index 68386e2b..a7ea37e8 100644 --- a/source/behavior/entities/format/components/healable.json +++ b/source/behavior/entities/format/components/healable.json @@ -6,7 +6,9 @@ "additionalProperties": false, "required": [], "properties": { - "filters": { "$ref": "../../filters/filters.json" }, + "filters": { + "$ref": "../../filters/filters.json" + }, "force_use": { "type": "boolean", "default": false, @@ -30,9 +32,19 @@ "description": "The amount of health this entity gains when fed this item", "title": "Heal Amount" }, - "item": { "type": "string", "description": "Item identifier that can be used to heal this entity", "title": "Item" } + "item": { + "type": "string", + "description": "Item identifier that can be used to heal this entity", + "title": "Item" + } } } } - } + }, + "examples": [ + { + "force_use": false, + "items": [] + } + ] } diff --git a/source/behavior/entities/format/components/health.json b/source/behavior/entities/format/components/health.json index da6f554c..d9792955 100644 --- a/source/behavior/entities/format/components/health.json +++ b/source/behavior/entities/format/components/health.json @@ -6,14 +6,22 @@ "title": "Health", "additionalProperties": false, "required": [], - "dependencies": { "max": ["value"] }, + "dependencies": { + "max": ["value"] + }, "properties": { - "max": { "type": "integer", "description": "The maximum health the entity can heal", "title": "Maximum" }, + "max": { + "type": "integer", + "description": "The maximum health the entity can heal", + "title": "Maximum" + }, "value": { "description": "Current health of the entity", "title": "Value", "oneOf": [ - { "type": "integer" }, + { + "type": "integer" + }, { "type": "object", "additionalProperties": false, @@ -35,5 +43,10 @@ } ] } - } + }, + "examples": [ + { + "max": 0 + } + ] } diff --git a/source/behavior/entities/format/components/home.json b/source/behavior/entities/format/components/home.json index a814aecc..75887473 100644 --- a/source/behavior/entities/format/components/home.json +++ b/source/behavior/entities/format/components/home.json @@ -22,5 +22,11 @@ "$ref": "../../../../general/item/identifier.json" } } - } + }, + "examples": [ + { + "restriction_radius": -1, + "home_block_list": [] + } + ] } diff --git a/source/behavior/entities/format/components/horse.jump_strength.json b/source/behavior/entities/format/components/horse.jump_strength.json index 8b2c0ddf..8b2a14e8 100644 --- a/source/behavior/entities/format/components/horse.jump_strength.json +++ b/source/behavior/entities/format/components/horse.jump_strength.json @@ -5,15 +5,27 @@ "additionalProperties": false, "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", - "properties": { "value": { "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Value", "oneOf": [ - { "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" + } + } + }, + { + "type": "number" + } ] } } diff --git a/source/behavior/entities/format/components/hurt_on_condition.json b/source/behavior/entities/format/components/hurt_on_condition.json index 2b1fdb20..95f4dc2b 100644 --- a/source/behavior/entities/format/components/hurt_on_condition.json +++ b/source/behavior/entities/format/components/hurt_on_condition.json @@ -15,8 +15,15 @@ "description": "A condition used to compare the event to.", "additionalProperties": false, "properties": { - "filters": { "$ref": "../../filters/filters.json" }, - "cause": { "type": "string", "title": "Cause", "description": "Damage cause", "$ref": "../../../../general/entity/damage_source.json" }, + "filters": { + "$ref": "../../filters/filters.json" + }, + "cause": { + "type": "string", + "title": "Cause", + "description": "Damage cause", + "$ref": "../../../../general/entity/damage_source.json" + }, "damage_per_tick": { "type": "integer", "title": "Damage Per Tick", @@ -25,5 +32,10 @@ } } } - } + }, + "examples": [ + { + "damage_conditions": [] + } + ] } diff --git a/source/behavior/entities/format/components/inside_block_notifier.json b/source/behavior/entities/format/components/inside_block_notifier.json index 765ebf14..29b550de 100644 --- a/source/behavior/entities/format/components/inside_block_notifier.json +++ b/source/behavior/entities/format/components/inside_block_notifier.json @@ -16,7 +16,9 @@ "type": "object", "additionalProperties": false, "properties": { - "block": { "$ref": "../../../../general/block_definition.json" }, + "block": { + "$ref": "../../../../general/block_definition.json" + }, "entered_block_event": { "title": "Entered Block Event", "description": "UNDOCUMENTED", @@ -32,5 +34,10 @@ } } } - } + }, + "examples": [ + { + "block_list": [] + } + ] } diff --git a/source/behavior/entities/format/components/insomnia.json b/source/behavior/entities/format/components/insomnia.json index 785564e1..a0ffa087 100644 --- a/source/behavior/entities/format/components/insomnia.json +++ b/source/behavior/entities/format/components/insomnia.json @@ -12,5 +12,10 @@ "description": "Number of days the mob has to stay up until the insomnia effect begins.", "title": "Days Until Insomnia" } - } + }, + "examples": [ + { + "days_until_insomnia": 3 + } + ] } diff --git a/source/behavior/entities/format/components/instant_despawn.json b/source/behavior/entities/format/components/instant_despawn.json index 26ce18a2..0c4ecd2d 100644 --- a/source/behavior/entities/format/components/instant_despawn.json +++ b/source/behavior/entities/format/components/instant_despawn.json @@ -11,5 +11,10 @@ "description": "If true, all entities linked to this entity in a child relationship (eg. leashed) will also be despawned.", "title": "Remove Child Entities" } - } + }, + "examples": [ + { + "remove_child_entities": false + } + ] } diff --git a/source/behavior/entities/format/components/interact.json b/source/behavior/entities/format/components/interact.json index 1ba69272..1a4ae115 100644 --- a/source/behavior/entities/format/components/interact.json +++ b/source/behavior/entities/format/components/interact.json @@ -40,7 +40,11 @@ "description": "Text to show when the player is able to interact in this way with this entity when playing with Touch-screen controls.", "title": "Interact Text" }, - "on_interact": { "$ref": "../types/trigger.json", "description": "Event to fire when the interaction occurs.", "title": "On Interact" }, + "on_interact": { + "$ref": "../types/trigger.json", + "description": "Event to fire when the interaction occurs.", + "title": "On Interact" + }, "particle_on_start": { "type": "object", "description": "Particle effect that will be triggered at the start of the interaction.", @@ -51,7 +55,11 @@ "description": "Whether or not the particle will appear closer to who performed the interaction.", "title": "Particle Offset Towards Interactor" }, - "particle_type": { "type": "string", "description": "The type of particle that will be spawned.", "title": "Particle Type" }, + "particle_type": { + "type": "string", + "description": "The type of particle that will be spawned.", + "title": "Particle Type" + }, "particle_y_offset": { "type": "number", "description": "Will offset the particle this amount in the y direction.", @@ -96,7 +104,12 @@ "title": "Transform To Item", "description": "The feed item used will transform to this item upon successful interaction. Format: itemName:auxValue" }, - "use_item": { "type": "boolean", "default": false, "description": "If true, the interaction will use an item.", "title": "Use Item" } + "use_item": { + "type": "boolean", + "default": false, + "description": "If true, the interaction will use an item.", + "title": "Use Item" + } } } }, @@ -105,8 +118,16 @@ "description": "The interactions", "title": "Interactions", "oneOf": [ - { "type": "object", "$ref": "#/definitions/interaction_spec" }, - { "type": "array", "items": { "$ref": "#/definitions/interaction_spec" } } + { + "type": "object", + "$ref": "#/definitions/interaction_spec" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/interaction_spec" + } + } ] } } diff --git a/source/behavior/entities/format/components/inventory.json b/source/behavior/entities/format/components/inventory.json index 9dc6bc43..22023ad3 100644 --- a/source/behavior/entities/format/components/inventory.json +++ b/source/behavior/entities/format/components/inventory.json @@ -4,7 +4,6 @@ "type": "object", "title": "Inventory", "additionalProperties": false, - "properties": { "additional_slots_per_strength": { "type": "integer", @@ -25,13 +24,33 @@ "title": "Container Type", "enum": ["horse", "minecart_chest", "minecart_hopper", "inventory", "container", "hopper"] }, - "inventory_size": { "type": "integer", "default": 5, "description": "Number of slots the container has", "title": "Inventory Size" }, - "private": { "type": "boolean", "default": false, "description": "If true, only the entity can access the inventory", "title": "Private" }, + "inventory_size": { + "type": "integer", + "default": 5, + "description": "Number of slots the container has", + "title": "Inventory Size" + }, + "private": { + "type": "boolean", + "default": false, + "description": "If true, only the entity can access the inventory", + "title": "Private" + }, "restrict_to_owner": { "type": "boolean", "default": false, "description": "If true, the entity's inventory can only be accessed by its owner or itself", "title": "Restrict To Owner" } - } + }, + "examples": [ + { + "additional_slots_per_strength": 0, + "can_be_siphoned_from": false, + "container_type": "none", + "inventory_size": 5, + "private": false, + "restrict_to_owner": false + } + ] } diff --git a/source/behavior/entities/format/components/is_dyeable.json b/source/behavior/entities/format/components/is_dyeable.json index 201f557d..e3b1be7f 100644 --- a/source/behavior/entities/format/components/is_dyeable.json +++ b/source/behavior/entities/format/components/is_dyeable.json @@ -11,5 +11,10 @@ "description": "The text that will display when interacting with this entity with a dye when playing with Touch-screen controls", "title": "Interact Text" } - } + }, + "examples": [ + { + "interact_text": "example" + } + ] } diff --git a/source/behavior/entities/format/components/item_controllable.json b/source/behavior/entities/format/components/item_controllable.json index e4228dd3..9722039b 100644 --- a/source/behavior/entities/format/components/item_controllable.json +++ b/source/behavior/entities/format/components/item_controllable.json @@ -9,8 +9,17 @@ "control_items": { "description": "List of items that can be used to control this entity", "oneOf": [ - { "type": "array", "items": { "type": "string", "description": "An item that can be used to control this entity", "title": "Item" } }, - { "type": "string" } + { + "type": "array", + "items": { + "type": "string", + "description": "An item that can be used to control this entity", + "title": "Item" + } + }, + { + "type": "string" + } ], "title": "Control Items" } diff --git a/source/behavior/entities/format/components/jump.static.json b/source/behavior/entities/format/components/jump.static.json index 0a9ee3bd..ae956056 100644 --- a/source/behavior/entities/format/components/jump.static.json +++ b/source/behavior/entities/format/components/jump.static.json @@ -6,6 +6,16 @@ "additionalProperties": false, "required": [], "properties": { - "jump_power": { "type": "number", "default": 0.42, "description": "The initial vertical velocity for the jump", "title": "Jump Power" } - } + "jump_power": { + "type": "number", + "default": 0.42, + "description": "The initial vertical velocity for the jump", + "title": "Jump Power" + } + }, + "examples": [ + { + "jump_power": 0.42 + } + ] } diff --git a/source/behavior/entities/format/components/knockback_resistance.json b/source/behavior/entities/format/components/knockback_resistance.json index e24cda81..219ea27c 100644 --- a/source/behavior/entities/format/components/knockback_resistance.json +++ b/source/behavior/entities/format/components/knockback_resistance.json @@ -7,7 +7,23 @@ "$comment": "UNDOCUMENTED", "required": [], "properties": { - "value": { "type": "number", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Value" }, - "max": { "type": "number", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Maximum" } - } + "value": { + "type": "number", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Value" + }, + "max": { + "type": "number", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Maximum" + } + }, + "examples": [ + { + "value": 0.0, + "max": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/lava_movement.json b/source/behavior/entities/format/components/lava_movement.json index 33a6d586..0b919dc7 100644 --- a/source/behavior/entities/format/components/lava_movement.json +++ b/source/behavior/entities/format/components/lava_movement.json @@ -7,6 +7,16 @@ "additionalProperties": false, "required": [], "properties": { - "value": { "type": "number", "title": "Value", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + "value": { + "type": "number", + "title": "Value", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + } + }, + "examples": [ + { + "value": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/leashable.json b/source/behavior/entities/format/components/leashable.json index 0bb141ed..a88208c8 100644 --- a/source/behavior/entities/format/components/leashable.json +++ b/source/behavior/entities/format/components/leashable.json @@ -17,14 +17,35 @@ "description": "Distance in blocks at which the leash stiffens, restricting movement.", "title": "Hard Distance" }, - "max_distance": { "type": "number", "default": 10, "description": "Distance in blocks at which the leash breaks.", "title": "Maximum Distance" }, - "on_leash": { "$ref": "../types/event.json", "description": "Event to call when this entity is leashed.", "title": "On Leash" }, - "on_unleash": { "$ref": "../types/event.json", "description": "Event to call when this entity is unleashed.", "title": "On Unleash" }, + "max_distance": { + "type": "number", + "default": 10, + "description": "Distance in blocks at which the leash breaks.", + "title": "Maximum Distance" + }, + "on_leash": { + "$ref": "../types/event.json", + "description": "Event to call when this entity is leashed.", + "title": "On Leash" + }, + "on_unleash": { + "$ref": "../types/event.json", + "description": "Event to call when this entity is unleashed.", + "title": "On Unleash" + }, "soft_distance": { "type": "number", "default": 4, "description": "Distance in blocks at which the `spring` effect starts acting to keep this entity close to the entity that leashed it.", "title": "Soft Distance" } - } + }, + "examples": [ + { + "can_be_stolen": false, + "hard_distance": 6, + "max_distance": 10, + "soft_distance": 4 + } + ] } diff --git a/source/behavior/entities/format/components/lookat.json b/source/behavior/entities/format/components/lookat.json index 500f6522..51b08425 100644 --- a/source/behavior/entities/format/components/lookat.json +++ b/source/behavior/entities/format/components/lookat.json @@ -4,7 +4,6 @@ "type": "object", "title": "Lookat", "additionalProperties": false, - "properties": { "allow_invulnerable": { "type": "boolean", @@ -12,7 +11,11 @@ "description": "If true, invulnerable entities (e.g. Players in creative mode) are considered valid targets.", "title": "Allow Invulnerable" }, - "filters": { "$ref": "../../filters/filters.json", "description": "Defines the entities that can trigger this component", "title": "Filters" }, + "filters": { + "$ref": "../../filters/filters.json", + "description": "Defines the entities that can trigger this component", + "title": "Filters" + }, "look_cooldown": { "$ref": "../types/range_number_type.json", "default": [0.0, 0.0], @@ -36,5 +39,12 @@ "description": "If true, this entity will set the attack target as the entity that looked at it.", "title": "Set Target" } - } + }, + "examples": [ + { + "allow_invulnerable": false, + "search_radius": 10, + "set_target": true + } + ] } diff --git a/source/behavior/entities/format/components/mark_variant.json b/source/behavior/entities/format/components/mark_variant.json index 9123976a..ff6c9c55 100644 --- a/source/behavior/entities/format/components/mark_variant.json +++ b/source/behavior/entities/format/components/mark_variant.json @@ -12,5 +12,10 @@ "title": "Value" } }, - "additionalProperties": false + "additionalProperties": false, + "examples": [ + { + "value": 0 + } + ] } diff --git a/source/behavior/entities/format/components/mob_effect.json b/source/behavior/entities/format/components/mob_effect.json index 90fdd430..2ab851b2 100644 --- a/source/behavior/entities/format/components/mob_effect.json +++ b/source/behavior/entities/format/components/mob_effect.json @@ -11,7 +11,12 @@ "description": "How close a hostile entity must be to have the mob effect applied.", "title": "Effect Range" }, - "effect_time": { "type": "integer", "default": 10, "description": "How long the applied mob effect lasts in seconds.", "title": "Effect Time" }, + "effect_time": { + "type": "integer", + "default": 10, + "description": "How long the applied mob effect lasts in seconds.", + "title": "Effect Time" + }, "mob_effect": { "type": "string", "default": "", @@ -23,5 +28,12 @@ "title": "Entity Filter", "description": "Filter to use for conditions" } - } + }, + "examples": [ + { + "effect_range": 0.2, + "effect_time": 10, + "mob_effect": "" + } + ] } diff --git a/source/behavior/entities/format/components/movement.amphibious.json b/source/behavior/entities/format/components/movement.amphibious.json index 1f40befd..1768e2cc 100644 --- a/source/behavior/entities/format/components/movement.amphibious.json +++ b/source/behavior/entities/format/components/movement.amphibious.json @@ -12,5 +12,10 @@ "title": "Maximum Turn" } }, - "description": "This move control allows the mob to swim in water and walk on land." + "description": "This move control allows the mob to swim in water and walk on land.", + "examples": [ + { + "max_turn": 30 + } + ] } diff --git a/source/behavior/entities/format/components/movement.basic.json b/source/behavior/entities/format/components/movement.basic.json index 070c26c4..25def120 100644 --- a/source/behavior/entities/format/components/movement.basic.json +++ b/source/behavior/entities/format/components/movement.basic.json @@ -12,5 +12,10 @@ "description": "The maximum number in degrees the mob can turn per tick.", "title": "Maximum Turn" } - } + }, + "examples": [ + { + "max_turn": 30 + } + ] } diff --git a/source/behavior/entities/format/components/movement.fly.json b/source/behavior/entities/format/components/movement.fly.json index 50cfcf8b..7685a109 100644 --- a/source/behavior/entities/format/components/movement.fly.json +++ b/source/behavior/entities/format/components/movement.fly.json @@ -12,5 +12,10 @@ "description": "The maximum number in degrees the mob can turn per tick.", "title": "Maximum Turn" } - } + }, + "examples": [ + { + "max_turn": 30 + } + ] } diff --git a/source/behavior/entities/format/components/movement.generic.json b/source/behavior/entities/format/components/movement.generic.json index 8c1b8299..8b41b943 100644 --- a/source/behavior/entities/format/components/movement.generic.json +++ b/source/behavior/entities/format/components/movement.generic.json @@ -12,5 +12,10 @@ "description": "The maximum number in degrees the mob can turn per tick.", "title": "Maximum Turn" } - } + }, + "examples": [ + { + "max_turn": 30 + } + ] } diff --git a/source/behavior/entities/format/components/movement.glide.json b/source/behavior/entities/format/components/movement.glide.json index 19893c03..36ba96a2 100644 --- a/source/behavior/entities/format/components/movement.glide.json +++ b/source/behavior/entities/format/components/movement.glide.json @@ -19,5 +19,11 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "start_speed": 0.0, + "speed_when_turning": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/movement.hover.json b/source/behavior/entities/format/components/movement.hover.json index 93c45c35..5380f4f0 100644 --- a/source/behavior/entities/format/components/movement.hover.json +++ b/source/behavior/entities/format/components/movement.hover.json @@ -11,5 +11,10 @@ "description": "The maximum number in degrees the mob can turn per tick.", "title": "Maximum Turn" } - } + }, + "examples": [ + { + "max_turn": 30 + } + ] } diff --git a/source/behavior/entities/format/components/movement.json b/source/behavior/entities/format/components/movement.json index b1e1d842..9c620388 100644 --- a/source/behavior/entities/format/components/movement.json +++ b/source/behavior/entities/format/components/movement.json @@ -15,19 +15,46 @@ { "type": "array", "items": [ - { "type": "number", "title": "Maximum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Maximum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, - { "type": "number" }, + { + "type": "number" + }, { "type": "object", "additionalProperties": false, "title": "Range", - "properties": { "range_min": { "type": "number", "title": "Range Minimum" }, "range_max": { "type": "number", "title": "Range Maximum" } } + "properties": { + "range_min": { + "type": "number", + "title": "Range Minimum" + }, + "range_max": { + "type": "number", + "title": "Range Maximum" + } + } } ] }, - "max": { "type": "number", "title": "Maximum", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + "max": { + "type": "number", + "title": "Maximum", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + } + }, + "examples": [ + { + "max": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/movement.jump.json b/source/behavior/entities/format/components/movement.jump.json index 87cf303d..12de2063 100644 --- a/source/behavior/entities/format/components/movement.jump.json +++ b/source/behavior/entities/format/components/movement.jump.json @@ -4,7 +4,6 @@ "title": "Movement.jump", "description": "Move control that causes the mob to jump as it moves with a specified delay between jumps.", "additionalProperties": false, - "properties": { "jump_delay": { "type": "array", @@ -12,8 +11,14 @@ "description": "Delay after landing when using the slime move control.", "title": "Jump Delay", "items": [ - { "type": "number", "title": "Minimum" }, - { "type": "number", "title": "Maximum" } + { + "type": "number", + "title": "Minimum" + }, + { + "type": "number", + "title": "Maximum" + } ] }, "max_turn": { @@ -22,5 +27,11 @@ "description": "The maximum number in degrees the mob can turn per tick.", "title": "Maximum Turn" } - } + }, + "examples": [ + { + "jump_delay": [], + "max_turn": 30 + } + ] } diff --git a/source/behavior/entities/format/components/movement.skip.json b/source/behavior/entities/format/components/movement.skip.json index 1792f03c..e52d0534 100644 --- a/source/behavior/entities/format/components/movement.skip.json +++ b/source/behavior/entities/format/components/movement.skip.json @@ -12,5 +12,10 @@ "description": "The maximum number in degrees the mob can turn per tick.", "title": "Maximum Turn" } - } + }, + "examples": [ + { + "max_turn": 30 + } + ] } diff --git a/source/behavior/entities/format/components/movement.sway.json b/source/behavior/entities/format/components/movement.sway.json index fcdd4f32..af063827 100644 --- a/source/behavior/entities/format/components/movement.sway.json +++ b/source/behavior/entities/format/components/movement.sway.json @@ -16,5 +16,11 @@ "description": "The amount of sway that is allowed for movement.", "title": "Sway Amplitude" } - } + }, + "examples": [ + { + "max_turn": 30, + "sway_amplitude": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/nameable.json b/source/behavior/entities/format/components/nameable.json index 5ab9de25..6c7eeb12 100644 --- a/source/behavior/entities/format/components/nameable.json +++ b/source/behavior/entities/format/components/nameable.json @@ -4,7 +4,6 @@ "title": "Nameable", "additionalProperties": false, "description": "Allows this entity to be named (e.g. using a name tag).", - "definitions": { "name_action": { "type": "object", @@ -33,15 +32,38 @@ "description": "If true, this entity can be renamed with name tags", "title": "Allow Name Tag Renaming" }, - "always_show": { "type": "boolean", "default": false, "description": "If true, the name will always be shown", "title": "Always Show" }, - "default_trigger": { "$ref": "../types/trigger.json", "description": "Trigger to run when the entity gets named", "title": "Default Trigger" }, + "always_show": { + "type": "boolean", + "default": false, + "description": "If true, the name will always be shown", + "title": "Always Show" + }, + "default_trigger": { + "$ref": "../types/trigger.json", + "description": "Trigger to run when the entity gets named", + "title": "Default Trigger" + }, "name_actions": { "title": "Name Actions", "description": "Describes the special names for this entity and the events to call when the entity acquires those names", "oneOf": [ - { "type": "array", "items": { "$ref": "#/definitions/name_action" } }, - { "type": "object", "$ref": "#/definitions/name_action" } + { + "type": "array", + "items": { + "$ref": "#/definitions/name_action" + } + }, + { + "type": "object", + "$ref": "#/definitions/name_action" + } ] } - } + }, + "examples": [ + { + "allow_name_tag_renaming": true, + "always_show": false + } + ] } diff --git a/source/behavior/entities/format/components/navigation.climb.json b/source/behavior/entities/format/components/navigation.climb.json index fb9b3e5d..fdc40178 100644 --- a/source/behavior/entities/format/components/navigation.climb.json +++ b/source/behavior/entities/format/components/navigation.climb.json @@ -123,5 +123,28 @@ "description": "Tells the pathfinder whether or not it can walk on the ground underwater", "title": "Is Amphibious" } - } + }, + "examples": [ + { + "avoid_damage_blocks": false, + "avoid_portals": false, + "avoid_sun": false, + "avoid_water": false, + "blocks_to_avoid": [], + "can_breach": false, + "can_break_doors": false, + "can_jump": true, + "can_open_doors": false, + "can_open_iron_doors": false, + "can_pass_doors": true, + "can_path_from_air": false, + "can_path_over_lava": false, + "can_path_over_water": false, + "can_sink": true, + "can_swim": false, + "can_walk": true, + "can_walk_in_lava": false, + "is_amphibious": false + } + ] } diff --git a/source/behavior/entities/format/components/navigation.float.json b/source/behavior/entities/format/components/navigation.float.json index 02d8ff37..f0bc72d6 100644 --- a/source/behavior/entities/format/components/navigation.float.json +++ b/source/behavior/entities/format/components/navigation.float.json @@ -123,5 +123,28 @@ "description": "Tells the pathfinder whether or not it can walk on the ground underwater", "title": "Is Amphibious" } - } + }, + "examples": [ + { + "avoid_damage_blocks": false, + "avoid_portals": false, + "avoid_sun": false, + "avoid_water": false, + "blocks_to_avoid": [], + "can_breach": false, + "can_break_doors": false, + "can_jump": true, + "can_open_doors": false, + "can_open_iron_doors": false, + "can_pass_doors": true, + "can_path_from_air": false, + "can_path_over_lava": false, + "can_path_over_water": false, + "can_sink": true, + "can_swim": false, + "can_walk": true, + "can_walk_in_lava": false, + "is_amphibious": false + } + ] } diff --git a/source/behavior/entities/format/components/navigation.fly.json b/source/behavior/entities/format/components/navigation.fly.json index fb503162..261017c2 100644 --- a/source/behavior/entities/format/components/navigation.fly.json +++ b/source/behavior/entities/format/components/navigation.fly.json @@ -123,5 +123,28 @@ "description": "Tells the pathfinder whether or not it can walk on the ground underwater", "title": "Is Amphibious" } - } + }, + "examples": [ + { + "avoid_damage_blocks": false, + "avoid_portals": false, + "avoid_sun": false, + "avoid_water": false, + "blocks_to_avoid": [], + "can_breach": false, + "can_break_doors": false, + "can_jump": true, + "can_open_doors": false, + "can_open_iron_doors": false, + "can_pass_doors": true, + "can_path_from_air": false, + "can_path_over_lava": false, + "can_path_over_water": false, + "can_sink": true, + "can_swim": false, + "can_walk": true, + "can_walk_in_lava": false, + "is_amphibious": false + } + ] } diff --git a/source/behavior/entities/format/components/navigation.generic.json b/source/behavior/entities/format/components/navigation.generic.json index 9de2a522..03692079 100644 --- a/source/behavior/entities/format/components/navigation.generic.json +++ b/source/behavior/entities/format/components/navigation.generic.json @@ -123,5 +123,28 @@ "description": "Tells the pathfinder whether or not it can walk on the ground underwater", "title": "Is Amphibious" } - } + }, + "examples": [ + { + "avoid_damage_blocks": false, + "avoid_portals": false, + "avoid_sun": false, + "avoid_water": false, + "blocks_to_avoid": [], + "can_breach": false, + "can_break_doors": false, + "can_jump": true, + "can_open_doors": false, + "can_open_iron_doors": false, + "can_pass_doors": true, + "can_path_from_air": false, + "can_path_over_lava": false, + "can_path_over_water": false, + "can_sink": true, + "can_swim": false, + "can_walk": true, + "can_walk_in_lava": false, + "is_amphibious": false + } + ] } diff --git a/source/behavior/entities/format/components/navigation.hover.json b/source/behavior/entities/format/components/navigation.hover.json index 584bbba0..6da5befa 100644 --- a/source/behavior/entities/format/components/navigation.hover.json +++ b/source/behavior/entities/format/components/navigation.hover.json @@ -123,5 +123,28 @@ "description": "Tells the pathfinder whether or not it can walk on the ground underwater", "title": "Is Amphibious" } - } + }, + "examples": [ + { + "avoid_damage_blocks": false, + "avoid_portals": false, + "avoid_sun": false, + "avoid_water": false, + "blocks_to_avoid": [], + "can_breach": false, + "can_break_doors": false, + "can_jump": true, + "can_open_doors": false, + "can_open_iron_doors": false, + "can_pass_doors": true, + "can_path_from_air": false, + "can_path_over_lava": false, + "can_path_over_water": false, + "can_sink": true, + "can_swim": false, + "can_walk": true, + "can_walk_in_lava": false, + "is_amphibious": false + } + ] } diff --git a/source/behavior/entities/format/components/navigation.swim.json b/source/behavior/entities/format/components/navigation.swim.json index f179afdb..39ecfb47 100644 --- a/source/behavior/entities/format/components/navigation.swim.json +++ b/source/behavior/entities/format/components/navigation.swim.json @@ -123,5 +123,28 @@ "description": "Tells the pathfinder whether or not it can walk on the ground underwater", "title": "Is Amphibious" } - } + }, + "examples": [ + { + "avoid_damage_blocks": false, + "avoid_portals": false, + "avoid_sun": false, + "avoid_water": false, + "blocks_to_avoid": [], + "can_breach": false, + "can_break_doors": false, + "can_jump": true, + "can_open_doors": false, + "can_open_iron_doors": false, + "can_pass_doors": true, + "can_path_from_air": false, + "can_path_over_lava": false, + "can_path_over_water": false, + "can_sink": true, + "can_swim": false, + "can_walk": true, + "can_walk_in_lava": false, + "is_amphibious": false + } + ] } diff --git a/source/behavior/entities/format/components/navigation.walk.json b/source/behavior/entities/format/components/navigation.walk.json index 735d65e0..935437d7 100644 --- a/source/behavior/entities/format/components/navigation.walk.json +++ b/source/behavior/entities/format/components/navigation.walk.json @@ -123,5 +123,28 @@ "description": "Tells the pathfinder whether or not it can walk on the ground underwater", "title": "Is Amphibious" } - } + }, + "examples": [ + { + "avoid_damage_blocks": false, + "avoid_portals": false, + "avoid_sun": false, + "avoid_water": false, + "blocks_to_avoid": [], + "can_breach": false, + "can_break_doors": false, + "can_jump": true, + "can_open_doors": false, + "can_open_iron_doors": false, + "can_pass_doors": true, + "can_path_from_air": false, + "can_path_over_lava": false, + "can_path_over_water": false, + "can_sink": true, + "can_swim": false, + "can_walk": true, + "can_walk_in_lava": false, + "is_amphibious": false + } + ] } diff --git a/source/behavior/entities/format/components/npc.json b/source/behavior/entities/format/components/npc.json index 61771603..4218f985 100644 --- a/source/behavior/entities/format/components/npc.json +++ b/source/behavior/entities/format/components/npc.json @@ -8,9 +8,18 @@ "rangeXYZ": { "type": "array", "items": [ - { "type": "number", "title": "X" }, - { "type": "number", "title": "Y" }, - { "type": "number", "title": "Z" } + { + "type": "number", + "title": "X" + }, + { + "type": "number", + "title": "Y" + }, + { + "type": "number", + "title": "Z" + } ] } }, @@ -76,11 +85,22 @@ "$comment": "UNDOCUMENTED", "additionalProperties": false, "properties": { - "variant": { "title": "Variant", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "type": "integer", "minimum": 0 } + "variant": { + "title": "Variant", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "type": "integer", + "minimum": 0 + } } } } } } - } + }, + "examples": [ + { + "npc_data": {} + } + ] } diff --git a/source/behavior/entities/format/components/peek.json b/source/behavior/entities/format/components/peek.json index 47a72115..61a85eb8 100644 --- a/source/behavior/entities/format/components/peek.json +++ b/source/behavior/entities/format/components/peek.json @@ -6,8 +6,16 @@ "additionalProperties": false, "required": [], "properties": { - "on_close": { "$ref": "../types/event.json", "description": "Event to call when the entity is done peeking", "title": "On Close" }, - "on_open": { "$ref": "../types/event.json", "description": "Event to call when the entity starts peeking", "title": "On Open" }, + "on_close": { + "$ref": "../types/event.json", + "description": "Event to call when the entity is done peeking", + "title": "On Close" + }, + "on_open": { + "$ref": "../types/event.json", + "description": "Event to call when the entity starts peeking", + "title": "On Open" + }, "on_target_open": { "$ref": "../types/event.json", "description": "Event to call when the entity's target entity starts peeking", diff --git a/source/behavior/entities/format/components/physics.json b/source/behavior/entities/format/components/physics.json index 901c33e4..89b282a9 100644 --- a/source/behavior/entities/format/components/physics.json +++ b/source/behavior/entities/format/components/physics.json @@ -12,6 +12,17 @@ "description": "Whether or not the object collides with things.", "title": "Has Collision" }, - "has_gravity": { "type": "boolean", "default": true, "description": "Whether or not the entity is affected by gravity.", "title": "Has Gravity" } - } + "has_gravity": { + "type": "boolean", + "default": true, + "description": "Whether or not the entity is affected by gravity.", + "title": "Has Gravity" + } + }, + "examples": [ + { + "has_collision": true, + "has_gravity": true + } + ] } diff --git a/source/behavior/entities/format/components/player.exhaustion.json b/source/behavior/entities/format/components/player.exhaustion.json index 482f84fb..cb4beccb 100644 --- a/source/behavior/entities/format/components/player.exhaustion.json +++ b/source/behavior/entities/format/components/player.exhaustion.json @@ -21,5 +21,11 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "value": true, + "max": true + } + ] } diff --git a/source/behavior/entities/format/components/player.experience.json b/source/behavior/entities/format/components/player.experience.json index 9af24180..90c087ae 100644 --- a/source/behavior/entities/format/components/player.experience.json +++ b/source/behavior/entities/format/components/player.experience.json @@ -21,5 +21,11 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "value": true, + "max": true + } + ] } diff --git a/source/behavior/entities/format/components/player.level.json b/source/behavior/entities/format/components/player.level.json index 67968da6..e90a878b 100644 --- a/source/behavior/entities/format/components/player.level.json +++ b/source/behavior/entities/format/components/player.level.json @@ -21,5 +21,11 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "value": true, + "max": true + } + ] } diff --git a/source/behavior/entities/format/components/player.saturation.json b/source/behavior/entities/format/components/player.saturation.json index 7df356d3..e68ba9c5 100644 --- a/source/behavior/entities/format/components/player.saturation.json +++ b/source/behavior/entities/format/components/player.saturation.json @@ -14,5 +14,10 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + }, + "examples": [ + { + "value": true + } + ] } diff --git a/source/behavior/entities/format/components/preferred_path.json b/source/behavior/entities/format/components/preferred_path.json index d8587858..fbe8925a 100644 --- a/source/behavior/entities/format/components/preferred_path.json +++ b/source/behavior/entities/format/components/preferred_path.json @@ -6,8 +6,18 @@ "additionalProperties": false, "required": ["preferred_path_blocks"], "properties": { - "default_block_cost": { "type": "number", "default": 0, "description": "Cost for non-preferred blocks", "title": "Default Block Cost" }, - "jump_cost": { "type": "integer", "default": 0, "description": "Added cost for jumping up a node", "title": "Jump Cost" }, + "default_block_cost": { + "type": "number", + "default": 0, + "description": "Cost for non-preferred blocks", + "title": "Default Block Cost" + }, + "jump_cost": { + "type": "integer", + "default": 0, + "description": "Added cost for jumping up a node", + "title": "Jump Cost" + }, "max_fall_blocks": { "type": "integer", "default": 3, @@ -22,8 +32,26 @@ "additionalProperties": false, "type": "object", "description": "Blocks cost", - "properties": { "cost": { "type": "number" }, "blocks": { "type": "array", "items": { "$ref": "../../../../general/blocks_item.json" } } } + "properties": { + "cost": { + "type": "number" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "../../../../general/blocks_item.json" + } + } + } } } - } + }, + "examples": [ + { + "default_block_cost": 0, + "jump_cost": 0, + "max_fall_blocks": 3, + "preferred_path_blocks": [] + } + ] } diff --git a/source/behavior/entities/format/components/projectile.json b/source/behavior/entities/format/components/projectile.json index 4c81bebf..6fdd192f 100644 --- a/source/behavior/entities/format/components/projectile.json +++ b/source/behavior/entities/format/components/projectile.json @@ -5,14 +5,24 @@ "description": "Allows the entity to be a thrown entity.", "additionalProperties": false, "properties": { - "anchor": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Anchor" }, + "anchor": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Anchor" + }, "angle_offset": { "type": "number", "default": 0, "description": "Determines the angle at which the projectile is thrown", "title": "Angle Offset" }, - "catch_fire": { "type": "boolean", "default": false, "description": "If true, the entity hit will be set on fire", "title": "Catch Fire" }, + "catch_fire": { + "type": "boolean", + "default": false, + "description": "If true, the entity hit will be set on fire", + "title": "Catch Fire" + }, "crit_particle_on_hurt": { "type": "boolean", "default": false, @@ -43,8 +53,18 @@ "description": "The gravity applied to this entity when thrown. The higher the value, the faster the entity falls", "title": "Gravity" }, - "hit_sound": { "type": "string", "default": "", "description": "The sound that plays when the projectile hits something", "title": "Hit Sound" }, - "homing": { "type": "boolean", "default": false, "description": "If true, the projectile homes in to the nearest entity", "title": "Homing" }, + "hit_sound": { + "type": "string", + "default": "", + "description": "The sound that plays when the projectile hits something", + "title": "Hit Sound" + }, + "homing": { + "type": "boolean", + "default": false, + "description": "If true, the projectile homes in to the nearest entity", + "title": "Homing" + }, "inertia": { "type": "number", "default": 0.99, @@ -63,7 +83,12 @@ "description": "If true, the projectile will knock back the entity it hits", "title": "Knockback" }, - "lightning": { "type": "boolean", "default": false, "description": "If true, the entity hit will be struck by lightning", "title": "Lightning" }, + "lightning": { + "type": "boolean", + "default": false, + "description": "If true, the entity hit will be struck by lightning", + "title": "Lightning" + }, "liquid_inertia": { "type": "number", "default": 0.6, @@ -82,9 +107,21 @@ "description": "The offset from the entity's anchor where the projectile will spawn", "title": "Offset", "items": [ - { "type": "number", "description": "X", "title": "X" }, - { "type": "number", "description": "Y", "title": "Y" }, - { "type": "number", "description": "Z", "title": "Z" } + { + "type": "number", + "description": "X", + "title": "X" + }, + { + "type": "number", + "description": "Y", + "title": "Y" + }, + { + "type": "number", + "description": "Z", + "title": "Z" + } ] }, "on_fire_time": { @@ -122,11 +159,23 @@ "title": "Event", "type": "object", "properties": { - "affect_projectile": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Affect Projectile" }, - "event_trigger": { "$ref": "../types/event.json" } + "affect_projectile": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Affect Projectile" + }, + "event_trigger": { + "$ref": "../types/event.json" + } } }, - "douse_fire": { "type": "object", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Douse Fire" }, + "douse_fire": { + "type": "object", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Douse Fire" + }, "impact_damage": { "additionalProperties": false, "type": "object", @@ -134,11 +183,36 @@ "$comment": "UNDOCUMENTED", "title": "Impact Damage", "properties": { - "filter": { "type": "string", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Filter" }, - "catch_fire": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Catch Fire" }, - "damage": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Damage" }, - "destroy_on_hit": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Destroy On Hit" }, - "knockback": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Knockback" }, + "filter": { + "type": "string", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Filter" + }, + "catch_fire": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Catch Fire" + }, + "damage": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Damage" + }, + "destroy_on_hit": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Destroy On Hit" + }, + "knockback": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Knockback" + }, "semi_random_diff_damage": { "type": "boolean", "description": "UNDOCUMENTED", @@ -154,10 +228,30 @@ "$comment": "UNDOCUMENTED", "title": "Particle On Hit", "properties": { - "particle_type": { "type": "string", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Particle Type" }, - "num_particles": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Num Particles" }, - "on_entity_hit": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "On Entity Hit" }, - "on_other_hit": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "On Other Hit" } + "particle_type": { + "type": "string", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Particle Type" + }, + "num_particles": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Num Particles" + }, + "on_entity_hit": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "On Entity Hit" + }, + "on_other_hit": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "On Other Hit" + } } }, "remove_on_hit": { @@ -180,23 +274,78 @@ "$comment": "UNDOCUMENTED", "title": "First Spawn Percent Chance" }, - "first_spawn_chance": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "First Spawn Chance" }, - "second_spawn_chance": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Second Spawn Chance" }, - "first_spawn_count": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "First Spawn Count" }, - "second_spawn_count": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Second Spawn Count" }, - "spawn_definition": { "type": "string", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Spawn Definition" }, - "spawn_baby": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Spawn Baby" } + "first_spawn_chance": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "First Spawn Chance" + }, + "second_spawn_chance": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Second Spawn Chance" + }, + "first_spawn_count": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "First Spawn Count" + }, + "second_spawn_count": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Second Spawn Count" + }, + "spawn_definition": { + "type": "string", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Spawn Definition" + }, + "spawn_baby": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Spawn Baby" + } } }, "spawn_aoe_cloud": { "additionalProperties": false, "type": "object", "properties": { - "radius": { "type": "number", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Radius" }, - "radius_on_use": { "type": "number", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Radius On Use" }, - "potion": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Potion" }, - "particle": { "type": "string", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Particle" }, - "duration": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Duration" }, + "radius": { + "type": "number", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Radius" + }, + "radius_on_use": { + "type": "number", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Radius On Use" + }, + "potion": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Potion" + }, + "particle": { + "type": "string", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Particle" + }, + "duration": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Duration" + }, "color": { "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", @@ -204,13 +353,41 @@ "type": "array", "format": "color-array", "items": [ - { "type": "integer", "minimum": 0, "maximum": 255, "description": "R", "title": "R" }, - { "type": "integer", "minimum": 0, "maximum": 255, "description": "G", "title": "G" }, - { "type": "integer", "minimum": 0, "maximum": 255, "description": "B", "title": "B" } + { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "R", + "title": "R" + }, + { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "G", + "title": "G" + }, + { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "B", + "title": "B" + } ] }, - "affect_owner": { "type": "boolean", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Affect Owner" }, - "reapplication_delay": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Reapplication Delay" } + "affect_owner": { + "type": "boolean", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Affect Owner" + }, + "reapplication_delay": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Reapplication Delay" + } } }, "stick_in_ground": { @@ -229,14 +406,24 @@ } } }, - "particle": { "type": "string", "default": "iconcrack", "description": "Particle to use upon collision", "title": "Particle" }, + "particle": { + "type": "string", + "default": "iconcrack", + "description": "Particle to use upon collision", + "title": "Particle" + }, "potion_effect": { "type": "integer", "default": -1, "description": "Defines the effect the arrow will apply to the entity it hits", "title": "Potion Effect" }, - "power": { "type": "number", "default": 1.3, "description": "Determines the velocity of the projectile", "title": "Power" }, + "power": { + "type": "number", + "default": 1.3, + "description": "Determines the velocity of the projectile", + "title": "Power" + }, "reflect_on_hurt": { "type": "boolean", "default": false, @@ -249,21 +436,36 @@ "description": "If true, damage will be randomized based on damage and speed", "title": "Semi Random Diff Damage" }, - "shoot_sound": { "type": "string", "default": "", "description": "The sound that plays when the projectile is shot", "title": "Shoot Sound" }, + "shoot_sound": { + "type": "string", + "default": "", + "description": "The sound that plays when the projectile is shot", + "title": "Shoot Sound" + }, "shoot_target": { "type": "boolean", "default": true, "description": "If true, the projectile will be shot towards the target of the entity firing it", "title": "Shoot Target" }, - "should_bounce": { "type": "boolean", "default": false, "description": "If true, the projectile will bounce upon hit", "title": "Should Bounce" }, + "should_bounce": { + "type": "boolean", + "default": false, + "description": "If true, the projectile will bounce upon hit", + "title": "Should Bounce" + }, "splash_potion": { "type": "boolean", "default": false, "description": "If true, the projectile will be treated like a splash potion", "title": "Splash Potion" }, - "splash_range": { "type": "number", "default": 4, "description": "Radius in blocks of the `splash` effect", "title": "Splash Range" }, + "splash_range": { + "type": "number", + "default": 4, + "description": "Radius in blocks of the `splash` effect", + "title": "Splash Range" + }, "uncertainty_base": { "type": "number", "default": 0, @@ -276,5 +478,40 @@ "description": "Determines how much difficulty affects accuracy. Accuracy is determined by the formula uncertaintyBase - difficultyLevel * uncertaintyMultiplier", "title": "Uncertainty Multiplier" } - } + }, + "examples": [ + { + "anchor": 0, + "angle_offset": 0, + "catch_fire": false, + "crit_particle_on_hurt": false, + "destroy_on_hurt": false, + "filter": "", + "fire_affected_by_griefing": false, + "gravity": 0.05, + "hit_sound": "", + "homing": false, + "inertia": 0.99, + "is_dangerous": false, + "knockback": true, + "lightning": false, + "liquid_inertia": 0.6, + "multiple_targets": true, + "offset": [], + "on_fire_time": 5, + "on_hit": {}, + "particle": "iconcrack", + "potion_effect": -1, + "power": 1.3, + "reflect_on_hurt": false, + "semi_random_diff_damage": false, + "shoot_sound": "", + "shoot_target": true, + "should_bounce": false, + "splash_potion": false, + "splash_range": 4, + "uncertainty_base": 0, + "uncertainty_multiplier": 0 + } + ] } diff --git a/source/behavior/entities/format/components/push_through.json b/source/behavior/entities/format/components/push_through.json index c7b09359..6c0af8e4 100644 --- a/source/behavior/entities/format/components/push_through.json +++ b/source/behavior/entities/format/components/push_through.json @@ -6,6 +6,16 @@ "description": "Sets the distance through which the entity can push through.", "required": [], "properties": { - "value": { "type": "number", "default": 0.0, "description": "The value of the entity's push-through, in blocks", "title": "Value" } - } + "value": { + "type": "number", + "default": 0.0, + "description": "The value of the entity's push-through, in blocks", + "title": "Value" + } + }, + "examples": [ + { + "value": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/pushable.json b/source/behavior/entities/format/components/pushable.json index dcc73638..c31b486f 100644 --- a/source/behavior/entities/format/components/pushable.json +++ b/source/behavior/entities/format/components/pushable.json @@ -18,5 +18,11 @@ "description": "Whether the entity can be pushed by pistons safely.", "title": "Is Pushable By Piston" } - } + }, + "examples": [ + { + "is_pushable": true, + "is_pushable_by_piston": true + } + ] } diff --git a/source/behavior/entities/format/components/rail_movement.json b/source/behavior/entities/format/components/rail_movement.json index f947c496..cae4e30c 100644 --- a/source/behavior/entities/format/components/rail_movement.json +++ b/source/behavior/entities/format/components/rail_movement.json @@ -12,5 +12,10 @@ "description": "Maximum speed that this entity will move at when on the rail", "title": "Maximum Speed" } - } + }, + "examples": [ + { + "max_speed": 0.4 + } + ] } diff --git a/source/behavior/entities/format/components/rail_sensor.json b/source/behavior/entities/format/components/rail_sensor.json index c97ce7b4..c1077f25 100644 --- a/source/behavior/entities/format/components/rail_sensor.json +++ b/source/behavior/entities/format/components/rail_sensor.json @@ -24,8 +24,16 @@ "description": "If true, this entity will eject all of its riders when it passes over a deactivated rail", "title": "Eject On Deactivate" }, - "on_activate": { "$ref": "../types/event.json", "description": "Event to call when the rail is activated", "title": "On Activate" }, - "on_deactivate": { "$ref": "../types/event.json", "description": "Event to call when the rail is deactivated", "title": "On Deactivate" }, + "on_activate": { + "$ref": "../types/event.json", + "description": "Event to call when the rail is activated", + "title": "On Activate" + }, + "on_deactivate": { + "$ref": "../types/event.json", + "description": "Event to call when the rail is deactivated", + "title": "On Deactivate" + }, "tick_command_block_on_activate": { "type": "boolean", "default": true, @@ -38,5 +46,14 @@ "description": "If false, command blocks will stop ticking when passing over a deactivated rail", "title": "Tick Command Block On Deactivate" } - } + }, + "examples": [ + { + "check_block_types": false, + "eject_on_activate": true, + "eject_on_deactivate": false, + "tick_command_block_on_activate": true, + "tick_command_block_on_deactivate": false + } + ] } diff --git a/source/behavior/entities/format/components/ravager_blocked.json b/source/behavior/entities/format/components/ravager_blocked.json index 543d231f..2fe6e923 100644 --- a/source/behavior/entities/format/components/ravager_blocked.json +++ b/source/behavior/entities/format/components/ravager_blocked.json @@ -20,7 +20,12 @@ "additionalProperties": false, "type": "object", "properties": { - "weight": { "type": "integer", "title": "Weight", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" }, + "weight": { + "type": "integer", + "title": "Weight", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + }, "value": { "title": "Value", "description": "UNDOCUMENTED", @@ -30,5 +35,11 @@ } } } - } + }, + "examples": [ + { + "knockback_strength": 3, + "reaction_choices": [] + } + ] } diff --git a/source/behavior/entities/format/components/rideable.json b/source/behavior/entities/format/components/rideable.json index b58be3ef..60d04aeb 100644 --- a/source/behavior/entities/format/components/rideable.json +++ b/source/behavior/entities/format/components/rideable.json @@ -29,11 +29,13 @@ "default": [0.0, 0.0, 0.0], "description": "Position of this seat relative to this entity's position" }, - "rotate_rider_by": { "$ref": "../../../../molang/number.json", "description": "Offset to rotate riders by" } + "rotate_rider_by": { + "$ref": "../../../../molang/number.json", + "description": "Offset to rotate riders by" + } } } }, - "properties": { "controlling_seat": { "type": "integer", @@ -49,7 +51,9 @@ }, "family_types": { "type": "array", - "items": { "type": "string" }, + "items": { + "type": "string" + }, "description": "List of entities that can ride this entity", "title": "Family Types" }, @@ -81,9 +85,28 @@ "description": "The list of positions and number of riders for each position for entities riding this entity", "title": "Seats", "oneOf": [ - { "type": "object", "$ref": "#/definitions/seats_spec" }, - { "type": "array", "items": { "$ref": "#/definitions/seats_spec" } } + { + "type": "object", + "$ref": "#/definitions/seats_spec" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/seats_spec" + } + } ] } - } + }, + "examples": [ + { + "controlling_seat": 0, + "crouching_skip_interact": true, + "family_types": [], + "interact_text": "", + "pull_in_entities": false, + "rider_can_interact": false, + "seat_count": 1 + } + ] } diff --git a/source/behavior/entities/format/components/scale.json b/source/behavior/entities/format/components/scale.json index 490c4bc3..87b57f2d 100644 --- a/source/behavior/entities/format/components/scale.json +++ b/source/behavior/entities/format/components/scale.json @@ -12,5 +12,10 @@ "description": "The value of the scale. 1.0 means the entity will appear at the scale they are defined in their model. Higher numbers make the entity bigger", "title": "Value" } - } + }, + "examples": [ + { + "value": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/scale_by_age.json b/source/behavior/entities/format/components/scale_by_age.json index eb9fdf65..3d9bf096 100644 --- a/source/behavior/entities/format/components/scale_by_age.json +++ b/source/behavior/entities/format/components/scale_by_age.json @@ -6,7 +6,23 @@ "description": "Defines the entity's size interpolation based on the entity's age.", "required": [], "properties": { - "end_scale": { "type": "number", "default": 1, "description": "Ending scale of the entity when it's fully grown", "title": "End Scale" }, - "start_scale": { "type": "number", "default": 1, "description": "Initial scale of the newborn entity", "title": "Start Scale" } - } + "end_scale": { + "type": "number", + "default": 1, + "description": "Ending scale of the entity when it's fully grown", + "title": "End Scale" + }, + "start_scale": { + "type": "number", + "default": 1, + "description": "Initial scale of the newborn entity", + "title": "Start Scale" + } + }, + "examples": [ + { + "end_scale": 1, + "start_scale": 1 + } + ] } diff --git a/source/behavior/entities/format/components/scheduler.json b/source/behavior/entities/format/components/scheduler.json index c9f6fcb3..a413cbaf 100644 --- a/source/behavior/entities/format/components/scheduler.json +++ b/source/behavior/entities/format/components/scheduler.json @@ -4,10 +4,21 @@ "type": "object", "title": "Scheduler", "additionalProperties": false, - "properties": { - "min_delay_secs": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Minimum Delay Secs", "minimum": 0 }, - "max_delay_secs": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Maximum Delay Secs", "minimum": 0 }, + "min_delay_secs": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Minimum Delay Secs", + "minimum": 0 + }, + "max_delay_secs": { + "type": "integer", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED", + "title": "Maximum Delay Secs", + "minimum": 0 + }, "scheduled_events": { "type": "array", "description": "The list of triggers that fire when the conditions match the given filter criteria. If any filter criteria overlap the first defined event will be picked.", @@ -18,8 +29,22 @@ "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Scheduled Events", - "properties": { "filters": { "$ref": "../../filters/filters.json" }, "event": { "$ref": "../types/event.json" } } + "properties": { + "filters": { + "$ref": "../../filters/filters.json" + }, + "event": { + "$ref": "../types/event.json" + } + } } } - } + }, + "examples": [ + { + "min_delay_secs": 0, + "max_delay_secs": 0, + "scheduled_events": [] + } + ] } diff --git a/source/behavior/entities/format/components/shareables.json b/source/behavior/entities/format/components/shareables.json index 057f74ab..279f0990 100644 --- a/source/behavior/entities/format/components/shareables.json +++ b/source/behavior/entities/format/components/shareables.json @@ -4,7 +4,6 @@ "type": "object", "title": "Shareables", "additionalProperties": false, - "properties": { "all_items": { "type": "boolean", @@ -49,15 +48,31 @@ "description": "Mob will barter for the item after picking it up. For this to work the mob needs to have a Barter component and a Barter goal.", "title": "Barter" }, - "consume_item": { "type": "boolean", "description": "Determines whether the mob will consume the item or not.", "title": "Consume Item" }, + "consume_item": { + "type": "boolean", + "description": "Determines whether the mob will consume the item or not.", + "title": "Consume Item" + }, "craft_into": { "type": "string", "description": "Defines the item this entity wants to craft with the item defined above. Should be an item name.", "title": "Craft Into" }, - "item": { "type": "string", "description": "The name of the item", "$ref": "../../../../general/item/identifier.json" }, - "item_aux": { "type": "integer", "description": "Aux value for the item.", "title": "Item Aux" }, - "max_amount": { "type": "integer", "description": "Maximum number of this item the mob will hold.", "title": "Maximum Amount" }, + "item": { + "type": "string", + "description": "The name of the item", + "$ref": "../../../../general/item/identifier.json" + }, + "item_aux": { + "type": "integer", + "description": "Aux value for the item.", + "title": "Item Aux" + }, + "max_amount": { + "type": "integer", + "description": "Maximum number of this item the mob will hold.", + "title": "Maximum Amount" + }, "pickup_limit": { "type": "integer", "description": "Maximum number of this item the mob will pick up during a single goal tick.", @@ -78,9 +93,22 @@ "description": "Number of this item considered extra that the entity wants to share.", "title": "Surplus Amount" }, - "want_amount": { "type": "integer", "description": "Number of this item this entity wants to have.", "title": "Want Amount" } + "want_amount": { + "type": "integer", + "description": "Number of this item this entity wants to have.", + "title": "Want Amount" + } } } } - } + }, + "examples": [ + { + "all_items": false, + "all_items_max_amount": -1, + "all_items_surplus_amount": -1, + "all_items_want_amount": -1, + "items": [] + } + ] } diff --git a/source/behavior/entities/format/components/shooter.json b/source/behavior/entities/format/components/shooter.json index 2dab522f..573bc49e 100644 --- a/source/behavior/entities/format/components/shooter.json +++ b/source/behavior/entities/format/components/shooter.json @@ -4,14 +4,30 @@ "type": "object", "title": "Shooter", "additionalProperties": false, - "properties": { - "aux_val": { "type": "integer", "title": "Aux Val", "default": -1, "description": "ID of the Potion effect to be applied on hit" }, + "aux_val": { + "type": "integer", + "title": "Aux Val", + "default": -1, + "description": "ID of the Potion effect to be applied on hit" + }, "def": { "title": "Def", "type": "string", "description": "Actor definition to use as projectile for the ranged attack. The actor definition must have the projectile component to be able to be shot as a projectile" }, - "type": { "title": "Type", "type": "string", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + "type": { + "title": "Type", + "type": "string", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + } + }, + "examples": [ + { + "aux_val": -1, + "def": "example", + "type": "example" + } + ] } diff --git a/source/behavior/entities/format/components/sittable.json b/source/behavior/entities/format/components/sittable.json index 7aaba913..b028b3b3 100644 --- a/source/behavior/entities/format/components/sittable.json +++ b/source/behavior/entities/format/components/sittable.json @@ -6,7 +6,15 @@ "additionalProperties": false, "required": [], "properties": { - "sit_event": { "$ref": "../types/event.json", "description": "Event to run when the entity enters the `sit` state", "title": "Sit Event" }, - "stand_event": { "$ref": "../types/event.json", "description": "Event to run when the entity exits the `sit` state", "title": "Stand Event" } + "sit_event": { + "$ref": "../types/event.json", + "description": "Event to run when the entity enters the `sit` state", + "title": "Sit Event" + }, + "stand_event": { + "$ref": "../types/event.json", + "description": "Event to run when the entity exits the `sit` state", + "title": "Stand Event" + } } } diff --git a/source/behavior/entities/format/components/skin_id.json b/source/behavior/entities/format/components/skin_id.json index e983bf87..8479384d 100644 --- a/source/behavior/entities/format/components/skin_id.json +++ b/source/behavior/entities/format/components/skin_id.json @@ -12,5 +12,10 @@ "description": "The ID of the skin. By convention, 0 is the ID of the base skin", "title": "Value" } - } + }, + "examples": [ + { + "value": 0 + } + ] } diff --git a/source/behavior/entities/format/components/sound_volume.json b/source/behavior/entities/format/components/sound_volume.json index 508bed0c..34eaba36 100644 --- a/source/behavior/entities/format/components/sound_volume.json +++ b/source/behavior/entities/format/components/sound_volume.json @@ -6,6 +6,16 @@ "description": "Sets the entity's base volume for sound effects.", "required": [], "properties": { - "value": { "type": "number", "default": 1.0, "description": "The value of the volume the entity uses for sound effects", "title": "Value" } - } + "value": { + "type": "number", + "default": 1.0, + "description": "The value of the volume the entity uses for sound effects", + "title": "Value" + } + }, + "examples": [ + { + "value": 1.0 + } + ] } diff --git a/source/behavior/entities/format/components/spawn_entity.json b/source/behavior/entities/format/components/spawn_entity.json index 9dca6e02..690dab46 100644 --- a/source/behavior/entities/format/components/spawn_entity.json +++ b/source/behavior/entities/format/components/spawn_entity.json @@ -4,7 +4,6 @@ "description": "Adds a timer after which this entity will spawn another entity or item (similar to vanilla's chicken's egg-laying behavior).", "title": "Spawn Entity", "additionalProperties": false, - "definitions": { "entity_spawn": { "additionalProperties": false, @@ -57,8 +56,18 @@ "description": "Event to call when the entity is spawned.", "title": "Spawn Event" }, - "spawn_item": { "type": "string", "default": "egg", "description": "Item identifier of the item to spawn.", "title": "Spawn Item" }, - "spawn_method": { "type": "string", "default": "born", "description": "Method to use to spawn the entity.", "title": "Spawn Method" }, + "spawn_item": { + "type": "string", + "default": "egg", + "description": "Item identifier of the item to spawn.", + "title": "Spawn Item" + }, + "spawn_method": { + "type": "string", + "default": "born", + "description": "Method to use to spawn the entity.", + "title": "Spawn Method" + }, "spawn_sound": { "type": "string", "default": "plop", @@ -74,8 +83,16 @@ "description": "The entities to spawn", "$comment": "UNDOCUMENTED", "oneOf": [ - { "type": "object", "$ref": "#/definitions/entity_spawn" }, - { "type": "array", "items": { "$ref": "#/definitions/entity_spawn" } } + { + "type": "object", + "$ref": "#/definitions/entity_spawn" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/entity_spawn" + } + } ] } } diff --git a/source/behavior/entities/format/components/spell_effects.json b/source/behavior/entities/format/components/spell_effects.json index 0b72eb8d..d5999ee7 100644 --- a/source/behavior/entities/format/components/spell_effects.json +++ b/source/behavior/entities/format/components/spell_effects.json @@ -11,10 +11,22 @@ "description": "List of effects to add to this entity after adding this component", "items": { "oneOf": [ - { "type": "string" }, + { + "type": "string" + }, { "type": "object", - "properties": { "effect": { "type": "string" }, "duration": { "type": "integer" }, "display_on_screen_animation": { "type": "boolean" } } + "properties": { + "effect": { + "type": "string" + }, + "duration": { + "type": "integer" + }, + "display_on_screen_animation": { + "type": "boolean" + } + } } ] }, @@ -32,8 +44,15 @@ "description": "identifier of the effect to be removed from this entity after adding this component" } }, - { "type": "string" } + { + "type": "string" + } ] } - } + }, + "examples": [ + { + "add_effects": [] + } + ] } diff --git a/source/behavior/entities/format/components/strength.json b/source/behavior/entities/format/components/strength.json index c854ac72..be170094 100644 --- a/source/behavior/entities/format/components/strength.json +++ b/source/behavior/entities/format/components/strength.json @@ -4,9 +4,24 @@ "type": "object", "title": "Strength", "additionalProperties": false, - "properties": { - "max": { "type": "integer", "default": 5, "description": "The maximum strength of this entity", "title": "Maximum" }, - "value": { "type": "integer", "default": 1, "description": "The initial value of the strength", "title": "Value" } - } + "max": { + "type": "integer", + "default": 5, + "description": "The maximum strength of this entity", + "title": "Maximum" + }, + "value": { + "type": "integer", + "default": 1, + "description": "The initial value of the strength", + "title": "Value" + } + }, + "examples": [ + { + "max": 5, + "value": 1 + } + ] } diff --git a/source/behavior/entities/format/components/tameable.json b/source/behavior/entities/format/components/tameable.json index cc5dbbc4..3b0e6894 100644 --- a/source/behavior/entities/format/components/tameable.json +++ b/source/behavior/entities/format/components/tameable.json @@ -14,14 +14,30 @@ "maximum": 1, "title": "Probability" }, - "tame_event": { "title": "Tame Event", "$ref": "../types/event.json", "description": "Event to run when this entity becomes tamed" }, + "tame_event": { + "title": "Tame Event", + "$ref": "../types/event.json", + "description": "Event to run when this entity becomes tamed" + }, "tame_items": { "title": "Tame Items", "description": "The list of items that can be used to tame this entity", "oneOf": [ - { "type": "array", "items": { "$ref": "../../../../general/item/identifier.json" } }, - { "$ref": "../../../../general/item/identifier.json" } + { + "type": "array", + "items": { + "$ref": "../../../../general/item/identifier.json" + } + }, + { + "$ref": "../../../../general/item/identifier.json" + } ] } - } + }, + "examples": [ + { + "probability": 1 + } + ] } diff --git a/source/behavior/entities/format/components/tamemount.json b/source/behavior/entities/format/components/tamemount.json index a576c626..12e85753 100644 --- a/source/behavior/entities/format/components/tamemount.json +++ b/source/behavior/entities/format/components/tamemount.json @@ -33,7 +33,6 @@ } } }, - "properties": { "attempt_temper_mod": { "type": "integer", @@ -45,17 +44,37 @@ "title": "Auto Reject Items", "description": "The list of items that, if carried while interacting with the entity, will anger it.", "oneOf": [ - { "type": "object", "$ref": "#/definitions/auto_reject_items" }, - { "type": "array", "items": { "$ref": "#/definitions/auto_reject_items" } } + { + "type": "object", + "$ref": "#/definitions/auto_reject_items" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/auto_reject_items" + } + } ] }, - "feed_text": { "type": "string", "description": "The text that shows in the feeding interact button", "title": "Feed Text" }, + "feed_text": { + "type": "string", + "description": "The text that shows in the feeding interact button", + "title": "Feed Text" + }, "feed_items": { "description": "The list of items that can be used to increase the entity's temper and speed up the taming process", "title": "Feed Items", "oneOf": [ - { "type": "object", "$ref": "#/definitions/feed_items" }, - { "type": "array", "items": { "$ref": "#/definitions/feed_items" } } + { + "type": "object", + "$ref": "#/definitions/feed_items" + }, + { + "type": "array", + "items": { + "$ref": "#/definitions/feed_items" + } + } ] }, "max_temper": { @@ -70,7 +89,24 @@ "description": "The minimum value for the entity's random starting temper", "title": "Minimum Temper" }, - "ride_text": { "type": "string", "description": "The text that shows in the riding interact button", "title": "Ride Text" }, - "tame_event": { "$ref": "../types/event.json", "description": "Event that triggers when the entity becomes tamed", "title": "Tame Event" } - } + "ride_text": { + "type": "string", + "description": "The text that shows in the riding interact button", + "title": "Ride Text" + }, + "tame_event": { + "$ref": "../types/event.json", + "description": "Event that triggers when the entity becomes tamed", + "title": "Tame Event" + } + }, + "examples": [ + { + "attempt_temper_mod": 5, + "feed_text": "example", + "max_temper": 100, + "min_temper": 0, + "ride_text": "example" + } + ] } diff --git a/source/behavior/entities/format/components/target_nearby_sensor.json b/source/behavior/entities/format/components/target_nearby_sensor.json index 12906924..a1116f35 100644 --- a/source/behavior/entities/format/components/target_nearby_sensor.json +++ b/source/behavior/entities/format/components/target_nearby_sensor.json @@ -39,5 +39,12 @@ "description": "Maximum distance in blocks that another entity will be considered in the `outside` range", "title": "Outside Range" } - } + }, + "examples": [ + { + "must_see": false, + "inside_range": 1, + "outside_range": 5 + } + ] } diff --git a/source/behavior/entities/format/components/teleport.json b/source/behavior/entities/format/components/teleport.json index f3657edf..e0b2fcf5 100644 --- a/source/behavior/entities/format/components/teleport.json +++ b/source/behavior/entities/format/components/teleport.json @@ -36,9 +36,18 @@ "type": "array", "default": [32.0, 16.0, 32.0], "items": [ - { "type": "number", "title": "A" }, - { "type": "number", "title": "B" }, - { "type": "number", "title": "C" } + { + "type": "number", + "title": "A" + }, + { + "type": "number", + "title": "B" + }, + { + "type": "number", + "title": "C" + } ] }, "random_teleports": { @@ -59,5 +68,17 @@ "description": "The chance that the entity will teleport between 0.0 and 1.0. 1.0 means 100%", "title": "Target Teleport Chance" } - } + }, + "examples": [ + { + "dark_teleport_chance": 0.01, + "light_teleport_chance": 0.01, + "max_random_teleport_time": 20, + "min_random_teleport_time": 0, + "random_teleport_cube": [], + "random_teleports": true, + "target_distance": 16, + "target_teleport_chance": 1 + } + ] } diff --git a/source/behavior/entities/format/components/tick_world.json b/source/behavior/entities/format/components/tick_world.json index 99dc13e6..33328f28 100644 --- a/source/behavior/entities/format/components/tick_world.json +++ b/source/behavior/entities/format/components/tick_world.json @@ -27,5 +27,12 @@ "maximum": 6, "title": "Radius" } - } + }, + "examples": [ + { + "distance_to_players": 128, + "never_despawn": true, + "radius": 2 + } + ] } diff --git a/source/behavior/entities/format/components/timer.json b/source/behavior/entities/format/components/timer.json index 038650cb..9bf7912d 100644 --- a/source/behavior/entities/format/components/timer.json +++ b/source/behavior/entities/format/components/timer.json @@ -6,7 +6,12 @@ "required": [], "additionalProperties": false, "properties": { - "looping": { "type": "boolean", "default": true, "description": "If true, the timer will restart every time after it fires", "title": "Looping" }, + "looping": { + "type": "boolean", + "default": true, + "description": "If true, the timer will restart every time after it fires", + "title": "Looping" + }, "randomInterval": { "type": "boolean", "default": true, @@ -21,11 +26,20 @@ "type": "array", "default": [0.0, 0.0], "items": [ - { "type": "number", "title": "A" }, - { "type": "number", "title": "B" } + { + "type": "number", + "title": "A" + }, + { + "type": "number", + "title": "B" + } ] }, - { "type": "number", "default": 0 } + { + "type": "number", + "default": 0 + } ] }, "time_down_event": { @@ -50,9 +64,20 @@ "$comment": "UNDOCUMENTED", "title": "Weight" }, - "value": { "type": "integer", "description": "UNDOCUMENTED: value", "title": "Value" } + "value": { + "type": "integer", + "description": "UNDOCUMENTED: value", + "title": "Value" + } } } } - } + }, + "examples": [ + { + "looping": true, + "randomInterval": true, + "random_time_choices": [] + } + ] } diff --git a/source/behavior/entities/format/components/trade_resupply.json b/source/behavior/entities/format/components/trade_resupply.json index 1339f4df..9e3e85dc 100644 --- a/source/behavior/entities/format/components/trade_resupply.json +++ b/source/behavior/entities/format/components/trade_resupply.json @@ -5,6 +5,5 @@ "type": "object", "title": "Trade Resupply", "additionalProperties": false, - "properties": {} } diff --git a/source/behavior/entities/format/components/trade_table.json b/source/behavior/entities/format/components/trade_table.json index 51b0cd30..2c1696ce 100644 --- a/source/behavior/entities/format/components/trade_table.json +++ b/source/behavior/entities/format/components/trade_table.json @@ -12,7 +12,11 @@ "description": "Determines when the mob transforms, if the trades should be converted when the new mob has a economy_trade_table. When the trades are converted, the mob will generate a new trade list with their new trade table, but then it will try to convert any of the same trades over to have the same enchantments and user data. For example, if the original has a Emerald to Enchanted Iron Sword (Sharpness 1), and the new trade also has an Emerald for Enchanted Iron Sword, then the enchantment will be Sharpness 1.", "title": "Convert Trades Economy" }, - "display_name": { "type": "string", "description": "Name to be displayed while trading with this entity.", "title": "Display Name" }, + "display_name": { + "type": "string", + "description": "Name to be displayed while trading with this entity.", + "title": "Display Name" + }, "new_screen": { "type": "boolean", "default": false, @@ -25,6 +29,19 @@ "description": "Determines if the trades should persist when the mob transforms. This makes it so that the next time the mob is transformed to something with a trade_table or economy_trade_table, then it keeps their trades.", "title": "Persist Trades" }, - "table": { "type": "string", "description": "File path relative to the resource pack root for this entity's trades.", "title": "Table" } - } + "table": { + "type": "string", + "description": "File path relative to the resource pack root for this entity's trades.", + "title": "Table" + } + }, + "examples": [ + { + "convert_trades_economy": false, + "display_name": "example", + "new_screen": false, + "persist_trades": false, + "table": "example" + } + ] } diff --git a/source/behavior/entities/format/components/trail.json b/source/behavior/entities/format/components/trail.json index e540a7fa..31a8c663 100644 --- a/source/behavior/entities/format/components/trail.json +++ b/source/behavior/entities/format/components/trail.json @@ -4,7 +4,6 @@ "type": "object", "title": "Trail", "additionalProperties": false, - "properties": { "block_type": { "type": "string", @@ -23,10 +22,25 @@ "description": "The distance from the entities current position to spawn the block. Capped at up to 16 blocks away. The X value is left/right(-/+), the Z value is backward/forward(-/+), the Y value is below/above(-/+).", "title": "Spawn Offset", "items": [ - { "type": "number", "title": "X" }, - { "type": "number", "title": "Y" }, - { "type": "number", "title": "Z" } + { + "type": "number", + "title": "X" + }, + { + "type": "number", + "title": "Y" + }, + { + "type": "number", + "title": "Z" + } ] } - } + }, + "examples": [ + { + "block_type": "air", + "spawn_offset": [0, 0, 0] + } + ] } diff --git a/source/behavior/entities/format/components/transformation.json b/source/behavior/entities/format/components/transformation.json index 2e54222c..336ef01c 100644 --- a/source/behavior/entities/format/components/transformation.json +++ b/source/behavior/entities/format/components/transformation.json @@ -4,16 +4,27 @@ "type": "object", "title": "Transformation", "additionalProperties": false, - "properties": { "add": { "type": "object", "description": "List of components to add to the entity after the transformation", - "properties": { "component_groups": { "type": "array", "description": "Names of component groups to add", "items": { "type": "string" } } }, "title": "Add", - "additionalProperties": false + "additionalProperties": false, + "properties": { + "component_groups": { + "type": "array", + "description": "Names of component groups to add", + "items": { + "type": "string" + } + } + } + }, + "begin_transform_sound": { + "type": "string", + "description": "Sound to play when the transformation starts", + "title": "Begin Transform Sound" }, - "begin_transform_sound": { "type": "string", "description": "Sound to play when the transformation starts", "title": "Begin Transform Sound" }, "delay": { "description": "Defines the properties of the delay for the transformation", "title": "Delay", @@ -45,9 +56,15 @@ "block_types": { "type": "array", "description": "List of blocks that can help the transformation of this entity", - "items": { "$ref": "../../../../general/block/identifier.json" } + "items": { + "$ref": "../../../../general/block/identifier.json" + } }, - "value": { "type": "number", "default": 0, "description": "Time in seconds before the entity transforms" } + "value": { + "type": "number", + "default": 0, + "description": "Time in seconds before the entity transforms" + } } } ] @@ -64,7 +81,12 @@ "description": "Cause the entity to drop all items in inventory upon transformation", "title": "Drop Inventory" }, - "into": { "type": "string", "default": "", "description": "Entity Definition that this entity will transform into", "title": "Into" }, + "into": { + "type": "string", + "default": "", + "description": "Entity Definition that this entity will transform into", + "title": "Into" + }, "keep_level": { "type": "boolean", "default": false, @@ -89,5 +111,18 @@ "description": "Sound to play when the entity is done transforming", "title": "Transformation Sound" } - } + }, + "examples": [ + { + "add": {}, + "begin_transform_sound": "example", + "drop_equipment": false, + "drop_inventory": false, + "into": "", + "keep_level": false, + "keep_owner": false, + "preserve_equipment": false, + "transformation_sound": "" + } + ] } diff --git a/source/behavior/entities/format/components/trusting.json b/source/behavior/entities/format/components/trusting.json index a2ef1e7d..396e13ba 100644 --- a/source/behavior/entities/format/components/trusting.json +++ b/source/behavior/entities/format/components/trusting.json @@ -12,12 +12,25 @@ "description": "The chance of the entity trusting with each item use between 0.0 and 1.0, where 1.0 is 100%", "title": "Probability" }, - "trust_event": { "$ref": "../types/event.json", "description": "Event to run when this entity becomes trusting", "title": "Trust Event" }, + "trust_event": { + "$ref": "../types/event.json", + "description": "Event to run when this entity becomes trusting", + "title": "Trust Event" + }, "trust_items": { "type": "array", "description": "The list of items that can be used to get the entity to trust players", - "items": { "$ref": "../../../../general/item/identifier.json", "title": "Trust Item" }, + "items": { + "$ref": "../../../../general/item/identifier.json", + "title": "Trust Item" + }, "title": "Trust Items" } - } + }, + "examples": [ + { + "probability": 1, + "trust_items": [] + } + ] } diff --git a/source/behavior/entities/format/components/type_family.json b/source/behavior/entities/format/components/type_family.json index e6f96242..74763fdb 100644 --- a/source/behavior/entities/format/components/type_family.json +++ b/source/behavior/entities/format/components/type_family.json @@ -9,7 +9,7 @@ "properties": { "family": { "type": "array", - "items": { "type": "string", "description": "Family name", "title": "Family" }, + "items": { "type": "string", "description": "Family name", "title": "Family", "examples": ["monster", "mob", "animal", "npc"] }, "description": "List of family names", "title": "Family" } diff --git a/source/behavior/entities/format/components/underwater_movement.json b/source/behavior/entities/format/components/underwater_movement.json index a222fd0b..fd0b97d0 100644 --- a/source/behavior/entities/format/components/underwater_movement.json +++ b/source/behavior/entities/format/components/underwater_movement.json @@ -7,6 +7,16 @@ "additionalProperties": false, "required": [], "properties": { - "value": { "type": "number", "title": "Value", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED" } - } + "value": { + "type": "number", + "title": "Value", + "description": "UNDOCUMENTED", + "$comment": "UNDOCUMENTED" + } + }, + "examples": [ + { + "value": 0.0 + } + ] } diff --git a/source/behavior/entities/format/components/variant.json b/source/behavior/entities/format/components/variant.json index ff677b03..c9be88af 100644 --- a/source/behavior/entities/format/components/variant.json +++ b/source/behavior/entities/format/components/variant.json @@ -12,5 +12,10 @@ "description": "The ID of the variant. By convention, 0 is the ID of the base entity", "title": "Value" } - } + }, + "examples": [ + { + "value": 0 + } + ] } diff --git a/source/behavior/entities/format/components/walk_animation_speed.json b/source/behavior/entities/format/components/walk_animation_speed.json index d58ea909..8d29de26 100644 --- a/source/behavior/entities/format/components/walk_animation_speed.json +++ b/source/behavior/entities/format/components/walk_animation_speed.json @@ -12,5 +12,10 @@ "description": "The higher the number, the faster the animation for walking plays. A value of 1.0 means normal speed, while 2.0 means twice as fast", "title": "Value" } - } + }, + "examples": [ + { + "value": 1 + } + ] } diff --git a/source/behavior/entities/format/components/wants_jockey.json b/source/behavior/entities/format/components/wants_jockey.json index 7bd7d5f4..8da66603 100644 --- a/source/behavior/entities/format/components/wants_jockey.json +++ b/source/behavior/entities/format/components/wants_jockey.json @@ -4,6 +4,5 @@ "type": "object", "title": "Wants Jockey", "additionalProperties": false, - "properties": {} } diff --git a/source/behavior/entities/format/components/water_movement.json b/source/behavior/entities/format/components/water_movement.json index c0886256..b13887a6 100644 --- a/source/behavior/entities/format/components/water_movement.json +++ b/source/behavior/entities/format/components/water_movement.json @@ -12,5 +12,10 @@ "description": "Drag factor to determine movement speed when in water.", "title": "Drag Factor" } - } + }, + "examples": [ + { + "drag_factor": 0.8 + } + ] }