diff --git a/source/behavior/entities/format/behaviors/admire_item.json b/source/behavior/entities/format/behaviors/admire_item.json index 0a2d81ae..83f42e5e 100644 --- a/source/behavior/entities/format/behaviors/admire_item.json +++ b/source/behavior/entities/format/behaviors/admire_item.json @@ -16,13 +16,13 @@ "on_admire_item_start": { "$ref": "../types/event.json", "title": "On Admire Item Start", - "description": "UNDOCUMENTED", + "description": "The event to run when admiring the item", "$comment": "UNDOCUMENTED" }, "on_admire_item_stop": { "$ref": "../types/event.json", "title": "On Admire Item Stop", - "description": "UNDOCUMENTED", + "description": "The event to run when no longer admiring the item", "$comment": "UNDOCUMENTED" }, "sound_interval": { diff --git a/source/behavior/entities/format/behaviors/defend_trusted_target.json b/source/behavior/entities/format/behaviors/defend_trusted_target.json index c2859ade..ef670577 100644 --- a/source/behavior/entities/format/behaviors/defend_trusted_target.json +++ b/source/behavior/entities/format/behaviors/defend_trusted_target.json @@ -35,7 +35,7 @@ "on_defend_start": { "$ref": "../types/event.json", "title": "On Defend Start", - "description": "UNDOCUMENTED", + "description": "The event to run when this mob starts to defend the entity it trusts.", "$comment": "UNDOCUMENTED" }, "within_radius": { @@ -52,9 +52,11 @@ }, "sound_chance": { "title": "Sound Chance", - "description": "UNDOCUMENTED", + "description": "The chance that the `aggro_sound` will play", "$comment": "UNDOCUMENTED", - "type": "number" + "type": "number", + "minimum": 0, + "maximum": 1 } }, "examples": [ diff --git a/source/behavior/entities/format/behaviors/defend_village_target.json b/source/behavior/entities/format/behaviors/defend_village_target.json index 76cc622d..05faab3f 100644 --- a/source/behavior/entities/format/behaviors/defend_village_target.json +++ b/source/behavior/entities/format/behaviors/defend_village_target.json @@ -14,7 +14,7 @@ }, "must_reach": { "title": "Must Reach", - "description": "UNDOCUMENTED", + "description": "If true, the entities considered a threat must be reachable to be a valid target.", "$comment": "UNDOCUMENTED", "type": "boolean" }, diff --git a/source/behavior/entities/format/behaviors/eat_block.json b/source/behavior/entities/format/behaviors/eat_block.json index d6298701..1674402a 100644 --- a/source/behavior/entities/format/behaviors/eat_block.json +++ b/source/behavior/entities/format/behaviors/eat_block.json @@ -31,20 +31,20 @@ "items": { "type": "object", "title": "Eat And Replace Block Pair", - "description": "UNDOCUMENTED", + "description": "The block to eat and the block to replace it with.", "$comment": "UNDOCUMENTED", "properties": { "eat_block": { "type": "string", "title": "Block", - "description": "UNDOCUMENTED", + "description": "The block to eat.", "$comment": "UNDOCUMENTED", "$ref": "../../../../general/block/identifier.json" }, "replace_block": { "type": "string", "title": "Replace Block", - "description": "UNDOCUMENTED", + "description": "The block to replace the eaten block with.", "$comment": "UNDOCUMENTED", "$ref": "../../../../general/block/identifier.json" } diff --git a/source/behavior/entities/format/behaviors/find_mount.json b/source/behavior/entities/format/behaviors/find_mount.json index 9c407810..9fcb5a5a 100644 --- a/source/behavior/entities/format/behaviors/find_mount.json +++ b/source/behavior/entities/format/behaviors/find_mount.json @@ -40,7 +40,7 @@ }, "max_failed_attempts": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "The number of failed attempts to make before this goal is no longer used.", "$comment": "UNDOCUMENTED", "title": "Maximum Failed Attempts" } diff --git a/source/behavior/entities/format/behaviors/harvest_farm_block.json b/source/behavior/entities/format/behaviors/harvest_farm_block.json index 4a75cd64..d3b98875 100644 --- a/source/behavior/entities/format/behaviors/harvest_farm_block.json +++ b/source/behavior/entities/format/behaviors/harvest_farm_block.json @@ -10,19 +10,19 @@ "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "max_seconds_before_search": { "title": "Maximum Seconds Before Search", - "description": "UNDOCUMENTED", + "description": "The maximum amount of time in seconds that the goal can take before searching for the first harvest block.", "$comment": "UNDOCUMENTED", "type": "number" }, "search_cooldown_max_seconds": { "title": "Search Cooldown Maximum Seconds", - "description": "UNDOCUMENTED", + "description": "The maximum amount of time in seconds that the goal can take before searching again, after failing to find a a harvest block already.", "$comment": "UNDOCUMENTED", "type": "number" }, "seconds_until_new_task": { "title": "Seconds Until New Task", - "description": "UNDOCUMENTED", + "description": "The amount of time in seconds that the goal will cooldown after a successful reap/sow, before it can start again.", "$comment": "UNDOCUMENTED", "type": "number" } diff --git a/source/behavior/entities/format/behaviors/move_to_block.json b/source/behavior/entities/format/behaviors/move_to_block.json index b4d11856..fb651710 100644 --- a/source/behavior/entities/format/behaviors/move_to_block.json +++ b/source/behavior/entities/format/behaviors/move_to_block.json @@ -77,7 +77,7 @@ }, "target_block_filters": { "title": "Target Block Filters", - "description": "UNDOCUMENTED", + "description": "Filters to apply on the target blocks. Target blocks are only valid if the filters are true.", "$comment": "UNDOCUMENTED", "$ref": "../../filters/filters.json" }, diff --git a/source/behavior/entities/format/behaviors/panic.json b/source/behavior/entities/format/behaviors/panic.json index 6460f486..faa0eb1a 100644 --- a/source/behavior/entities/format/behaviors/panic.json +++ b/source/behavior/entities/format/behaviors/panic.json @@ -45,25 +45,25 @@ }, "panic_sound": { "type": "string", - "description": "UNDOCUMENTED", + "description": "The sound event to play when this mob is in panic", "$comment": "UNDOCUMENTED", "title": "Panic Sound" }, "sound_interval": { "type": "object", - "description": "UNDOCUMENTED", + "description": "Determines how often the `panic_sound` will play", "$comment": "UNDOCUMENTED", "title": "Sound Interval", "properties": { "range_min": { "type": "number", - "description": "UNDOCUMENTED", + "description": "The minimum time in seconds before the `panic_sound` plays", "$comment": "UNDOCUMENTED", "title": "Range Minimum" }, "range_max": { "type": "number", - "description": "UNDOCUMENTED", + "description": "The maximum time in seconds before the `panic_sound` plays", "$comment": "UNDOCUMENTED", "title": "Range Maximum" } diff --git a/source/behavior/entities/format/behaviors/pickup_items.json b/source/behavior/entities/format/behaviors/pickup_items.json index c0b69016..93510192 100644 --- a/source/behavior/entities/format/behaviors/pickup_items.json +++ b/source/behavior/entities/format/behaviors/pickup_items.json @@ -22,7 +22,7 @@ "cooldown_after_being_attacked": { "type": "number", "default": true, - "description": "UNDOCUMENTED", + "description": "Duration, in seconds, for which the mob won't pickup items if it was hurt", "$comment": "UNDOCUMENTED", "title": "Cooldown After Being Attacked" }, diff --git a/source/behavior/entities/format/behaviors/raid_garden.json b/source/behavior/entities/format/behaviors/raid_garden.json index dd928fed..999bea8f 100644 --- a/source/behavior/entities/format/behaviors/raid_garden.json +++ b/source/behavior/entities/format/behaviors/raid_garden.json @@ -58,7 +58,7 @@ "search_height": { "type": "integer", "default": 0, - "description": "UNDOCUMENTED", + "description": "Height in blocks the mob will look for crops to eat", "$comment": "UNDOCUMENTED", "title": "Search Height" } diff --git a/source/behavior/entities/format/behaviors/random_fly.json b/source/behavior/entities/format/behaviors/random_fly.json index 88e17b13..511c3309 100644 --- a/source/behavior/entities/format/behaviors/random_fly.json +++ b/source/behavior/entities/format/behaviors/random_fly.json @@ -9,7 +9,7 @@ "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "avoid_damage_blocks": { "type": "boolean", - "description": "UNDOCUMENTED", + "description": "If true, the mob will avoid blocks that cause damage", "$comment": "UNDOCUMENTED", "title": "Avoid Damage Blocks" }, @@ -33,7 +33,7 @@ }, "y_offset": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "Height in blocks to add to the selected target position", "$comment": "UNDOCUMENTED", "title": "Y Offset" } diff --git a/source/behavior/entities/format/behaviors/random_hover.json b/source/behavior/entities/format/behaviors/random_hover.json index ef6b3e98..7963304a 100644 --- a/source/behavior/entities/format/behaviors/random_hover.json +++ b/source/behavior/entities/format/behaviors/random_hover.json @@ -9,7 +9,7 @@ "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "hover_height": { "type": "array", - "description": "UNDOCUMENTED", + "description": "The range of height in blocks above the surface which the mob will try to hover.", "$comment": "UNDOCUMENTED", "title": "Hover Height", "items": [ diff --git a/source/behavior/entities/format/behaviors/random_look_around.json b/source/behavior/entities/format/behaviors/random_look_around.json index 46d4893c..28316a34 100644 --- a/source/behavior/entities/format/behaviors/random_look_around.json +++ b/source/behavior/entities/format/behaviors/random_look_around.json @@ -34,7 +34,7 @@ ] }, "look_distance": { - "description": "UNDOCUMENTED", + "description": "The distance in blocks from which the mob will look at", "$comment": "UNDOCUMENTED", "title": "Look Distance", "type": "number" diff --git a/source/behavior/entities/format/behaviors/send_event.json b/source/behavior/entities/format/behaviors/send_event.json index d65bd780..7a987ae8 100644 --- a/source/behavior/entities/format/behaviors/send_event.json +++ b/source/behavior/entities/format/behaviors/send_event.json @@ -43,37 +43,39 @@ "event_choices": { "type": "array", "title": "Event Choices", - "description": "UNDOCUMENTED", + "description": "List of spells for the mob to use", "$comment": "UNDOCUMENTED", "items": { "type": "object", "additionalProperties": false, "title": "Event Choice", - "description": "UNDOCUMENTED", + "description": "A spell that the mob can cast", "$comment": "UNDOCUMENTED", "properties": { "min_activation_range": { "type": "number", "title": "Minimum Activation Range", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "The minimum distance in blocks the target must be for this spell to be cast", + "$comment": "UNDOCUMENTED", + "minimum": 0 }, "max_activation_range": { "type": "number", "title": "Maxmimum Activation Range", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "The maxmimum distance in blocks the target must be for this spell to be cast", + "$comment": "UNDOCUMENTED", + "minimum": 0 }, "cooldown_time": { "type": "number", "title": "Cooldown Time", - "description": "UNDOCUMENTED", + "description": "Time in seconds before the mob can use this spell again", "$comment": "UNDOCUMENTED" }, "cast_duration": { "type": "number", "title": "Cast Duration", - "description": "UNDOCUMENTED", + "description": "Time in seconds the spell casting will take", "$comment": "UNDOCUMENTED" }, "filters": { @@ -83,19 +85,19 @@ "type": "string", "format": "color-hex", "title": "Particle Color", - "description": "UNDOCUMENTED", + "description": "The color of the particles for this spell", "$comment": "UNDOCUMENTED" }, "weight": { "type": "integer", "title": "Weight", - "description": "UNDOCUMENTED", + "description": "The weight of this spell. Controls how likely this spell will be picked", "$comment": "UNDOCUMENTED" }, "start_sound_event": { "type": "string", "title": "Start Sound Event", - "description": "UNDOCUMENTED", + "description": "The sound event to play when using this spell", "$comment": "UNDOCUMENTED" }, "sequence": { @@ -106,7 +108,7 @@ }, "sequence": { "$ref": "#/definitions/sequence", - "description": "UNDOCUMENTED", + "description": "List of steps for the spell", "$comment": "UNDOCUMENTED", "title": "Sequence" } diff --git a/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json b/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json index 3fdc6e2b..175885a7 100644 --- a/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json +++ b/source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json @@ -64,13 +64,13 @@ }, "leap_dist": { "type": "number", - "description": "UNDOCUMENTED", + "description": "The distance in blocks the mob jumps in the direction of their target", "$comment": "UNDOCUMENTED", "title": "Leap Dist" }, "stuck_blocks": { "$ref": "../../filters/filters.json", - "description": "UNDOCUMENTED", + "description": "Filters to apply on the block the mob lands on to determine if it is valid for getting stuck", "$comment": "UNDOCUMENTED", "title": "Stuck Block" } diff --git a/source/behavior/entities/format/behaviors/swim_with_entity.json b/source/behavior/entities/format/behaviors/swim_with_entity.json index e878b51f..1acf31b5 100644 --- a/source/behavior/entities/format/behaviors/swim_with_entity.json +++ b/source/behavior/entities/format/behaviors/swim_with_entity.json @@ -2,7 +2,7 @@ "$id": "blockception.minecraft.behavior.entities.minecraft.behavior.swim_with_entity", "type": "object", "title": "Swim With Entity", - "description": "UNDOCUMENTED", + "description": "Allows this mob to follow another entity, as long as both entities are in water (swimming)", "$comment": "UNDOCUMENTED", "additionalProperties": false, "required": [], @@ -12,55 +12,55 @@ "success_rate": { "type": "number", "title": "Success Rate", - "description": "UNDOCUMENTED", + "description": "Chance to start following another entity, if not already doing so", "$comment": "UNDOCUMENTED" }, "chance_to_stop": { "type": "number", "title": "Chance To Stop", - "description": "UNDOCUMENTED", + "description": "Chance to stop following the current entity", "$comment": "UNDOCUMENTED" }, "state_check_interval": { "type": "number", "title": "State Check Interval", - "description": "UNDOCUMENTED", + "description": "Time in seconds between checks to determine if this mob should catch up to the entity being followed", "$comment": "UNDOCUMENTED" }, "catch_up_threshold": { "type": "number", "title": "Catch Up Threshold", - "description": "UNDOCUMENTED", + "description": "Distance in blocks from the entity being followed at which this mob will speed up to catch up", "$comment": "UNDOCUMENTED" }, "match_direction_threshold": { "type": "number", "title": "Match Direction Threshold", - "description": "UNDOCUMENTED", + "description": "Distance in blocks from the entity being followed at which this mob will match that entity's direction", "$comment": "UNDOCUMENTED" }, "catch_up_multiplier": { "type": "number", "title": "Catch Up Multiplier", - "description": "UNDOCUMENTED", + "description": "The multiplier applied to the speed of this mob when trying to catch up", "$comment": "UNDOCUMENTED" }, "search_range": { "type": "number", "title": "Search Range", - "description": "UNDOCUMENTED", + "description": "Radius in blocks around this mob to search for another entity to follow", "$comment": "UNDOCUMENTED" }, "stop_distance": { "type": "number", "title": "Stop Distance", - "description": "UNDOCUMENTED", + "description": "Distance in blocks from the entity being followed at which this entity will stop following", "$comment": "UNDOCUMENTED" }, "entity_types": { "$ref": "../types/entity_types.json", "title": "Entity Types", - "description": "UNDOCUMENTED", + "description": "Filters which determine what entites are valid to follow", "$comment": "UNDOCUMENTED" } }, diff --git a/source/behavior/entities/format/behaviors/swoop_attack.json b/source/behavior/entities/format/behaviors/swoop_attack.json index 26715cfb..a3c1cce9 100644 --- a/source/behavior/entities/format/behaviors/swoop_attack.json +++ b/source/behavior/entities/format/behaviors/swoop_attack.json @@ -11,7 +11,7 @@ "damage_reach": { "type": "number", "title": "Damage Reach", - "description": "UNDOCUMENTED", + "description": "Added onto the base size of this mob to determine the maximum distance this mob can deal damage", "$comment": "UNDOCUMENTED" }, "delay_range": { diff --git a/source/behavior/entities/format/behaviors/target_when_pushed.json b/source/behavior/entities/format/behaviors/target_when_pushed.json index 22de4f4d..2ad26d14 100644 --- a/source/behavior/entities/format/behaviors/target_when_pushed.json +++ b/source/behavior/entities/format/behaviors/target_when_pushed.json @@ -1,6 +1,6 @@ { "$id": "blockception.minecraft.behavior.entities.minecraft.behavior.target_when_pushed", - "description": "UNDOCUMENTED", + "description": "Allows this mob to target an entity that pushed it", "$comment": "UNDOCUMENTED", "type": "object", "title": "Target When Pushed", @@ -13,13 +13,13 @@ "entity_types": { "$ref": "../types/entity_types.json", "title": "Entity Types", - "description": "UNDOCUMENTED", + "description": "The list of conditions the other entity must meet to be a valid target", "$comment": "UNDOCUMENTED" }, "percent_chance": { "type": "number", "title": "Percent Chance", - "description": "UNDOCUMENTED", + "description": "The chance that the entity becomes a target when this mob is pushed", "$comment": "UNDOCUMENTED" } }, diff --git a/source/behavior/entities/format/behaviors/tempt.json b/source/behavior/entities/format/behaviors/tempt.json index a9f1624d..003a0694 100644 --- a/source/behavior/entities/format/behaviors/tempt.json +++ b/source/behavior/entities/format/behaviors/tempt.json @@ -16,13 +16,13 @@ "can_tempt_while_ridden": { "type": "boolean", "title": "Can Tempt While Ridden", - "description": "UNDOCUMENTED", + "description": "If true, this mob can be tempted while it has a passenger", "$comment": "UNDOCUMENTED" }, "can_tempt_vertically": { "type": "boolean", "title": "Can Tempt Vertically", - "description": "UNDOCUMENTED", + "description": "If true, vertical distance will be considered when being tempted", "$comment": "UNDOCUMENTED" }, "items": { diff --git a/source/behavior/entities/format/components/block_sensor.json b/source/behavior/entities/format/components/block_sensor.json index 019e1b56..758b410e 100644 --- a/source/behavior/entities/format/components/block_sensor.json +++ b/source/behavior/entities/format/components/block_sensor.json @@ -7,10 +7,11 @@ "properties": { "sensor_radius": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "The maximum radius in blocks in which a specified block can be detected.", "$comment": "UNDOCUMENTED", "title": "Sensor Radius", - "minimum": 0 + "minimum": 0, + "maximum": 32 }, "on_break": { "type": "array", @@ -41,12 +42,19 @@ }, "sources": { "title": "Sources", - "description": "UNDOCUMENTED", + "description": "List of sources that break the block to listen for. If none are specified, then all block breaks will be detected", "$comment": "UNDOCUMENTED", "type": "array", "items": { "$ref": "../../filters/filters.json" - } + }, + "examples": [ + { + "test": "has_silk_touch", + "subject": "other", + "value": false + } + ] } }, "examples": [ diff --git a/source/behavior/entities/format/components/equipment.json b/source/behavior/entities/format/components/equipment.json index 44e43039..0bcc4fc5 100644 --- a/source/behavior/entities/format/components/equipment.json +++ b/source/behavior/entities/format/components/equipment.json @@ -18,14 +18,17 @@ "drop_chance": { "type": "number", "title": "Drop Chance", - "description": "UNDOCUMENTED", + "description": "The chance that the item in this slot will drop", "$comment": "UNDOCUMENTED" }, "slot": { "type": "string", "title": "Slot", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "The slot in which the item will drop from", + "$comment": "UNDOCUMENTED", + "examples": [ + "slot.weapon.mainhand" + ] } } } diff --git a/source/behavior/entities/format/components/health.json b/source/behavior/entities/format/components/health.json index 01313465..5927b70c 100644 --- a/source/behavior/entities/format/components/health.json +++ b/source/behavior/entities/format/components/health.json @@ -1,6 +1,6 @@ { "$id": "blockception.minecraft.behavior.entities.minecraft.health", - "description": "UNDOCUMENTED", + "description": "Sets the amount of health this mob has", "$comment": "UNDOCUMENTED", "type": "object", "title": "Health", @@ -24,13 +24,13 @@ "properties": { "range_min": { "title": "Range Minimum", - "description": "UNDOCUMENTED", + "description": "The minimum amount of health this mob could have", "$comment": "UNDOCUMENTED", "type": "number" }, "range_max": { "title": "Range Maximum", - "description": "UNDOCUMENTED", + "description": "The maximum amount of health this mob could have", "$comment": "UNDOCUMENTED", "type": "number" } diff --git a/source/behavior/entities/format/components/horse.jump_strength.json b/source/behavior/entities/format/components/horse.jump_strength.json index 8b2a14e8..89758dcb 100644 --- a/source/behavior/entities/format/components/horse.jump_strength.json +++ b/source/behavior/entities/format/components/horse.jump_strength.json @@ -3,11 +3,11 @@ "type": "object", "title": "Horse.jump Strength", "additionalProperties": false, - "description": "UNDOCUMENTED", + "description": "Allows this mob to jump higher when being ridden by a player", "$comment": "UNDOCUMENTED", "properties": { "value": { - "description": "UNDOCUMENTED", + "description": "The multiplier to apply to the jumping height", "$comment": "UNDOCUMENTED", "title": "Value", "oneOf": [ diff --git a/source/behavior/entities/format/components/inside_block_notifier.json b/source/behavior/entities/format/components/inside_block_notifier.json index 29b550de..cc97acc8 100644 --- a/source/behavior/entities/format/components/inside_block_notifier.json +++ b/source/behavior/entities/format/components/inside_block_notifier.json @@ -21,13 +21,13 @@ }, "entered_block_event": { "title": "Entered Block Event", - "description": "UNDOCUMENTED", + "description": "Event to run when this mob enters a valid block", "$comment": "UNDOCUMENTED", "$ref": "../types/event.json" }, "exited_block_event": { "title": "Exited Block Event", - "description": "UNDOCUMENTED", + "description": "Event to run when this mob leaves a valid block", "$comment": "UNDOCUMENTED", "$ref": "../types/event.json" } diff --git a/source/behavior/entities/format/components/projectile.json b/source/behavior/entities/format/components/projectile.json index dea8ae76..6df20382 100644 --- a/source/behavior/entities/format/components/projectile.json +++ b/source/behavior/entities/format/components/projectile.json @@ -110,32 +110,32 @@ "mob_effect": { "type": "object", "default": true, - "description": "UNDOCUMENTED", + "description": "Effect to apply on the entity hit by this projectile", "title": "Mob Effects", "properties": { "effect": { "title": "Effect", - "description": "UNDOCUMENTED", + "description": "The name of the effect to apply", "type": "string" }, "durationeasy": { "title": "Duration Easy", - "description": "UNDOCUMENTED", + "description": "Duration in seconds of the effect when on Easy difficulty", "type": "number" }, "durationnormal": { "title": "Duration Normal", - "description": "UNDOCUMENTED", + "description": "Duration in seconds of the effect when on Normal difficulty", "type": "number" }, "durationhard": { "title": "Duration Hard", - "description": "UNDOCUMENTED", + "description": "Duration in seconds of the effect when on Hard difficulty", "type": "number" }, "amplifier": { "title": "Amplifier", - "description": "UNDOCUMENTED", + "description": "Amplifier level of the effect", "type": "number" } } @@ -160,7 +160,7 @@ "on_hit": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "Performs different behaviours when this projectile hits something", "$comment": "UNDOCUMENTED", "title": "On Hit", "properties": { @@ -187,14 +187,14 @@ }, "definition_event": { "additionalProperties": false, - "description": "UNDOCUMENTED", + "description": "Calls an event on hit", "$comment": "UNDOCUMENTED", "title": "Event", "type": "object", "properties": { "affect_projectile": { "type": "boolean", - "description": "UNDOCUMENTED", + "description": "Event will be triggered for this projectile entity", "$comment": "UNDOCUMENTED", "title": "Affect Projectile" }, @@ -212,7 +212,7 @@ "impact_damage": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "Deals damage on hit", "$comment": "UNDOCUMENTED", "title": "Impact Damage", "properties": { @@ -237,18 +237,18 @@ "filter": { "type": "string", - "description": "UNDOCUMENTED", + "description": "Entity to affect. Note: cannot test for anything other than the identifier", "$comment": "UNDOCUMENTED", "title": "Filter" }, "catch_fire": { "type": "boolean", - "description": "UNDOCUMENTED", + "description": "If true, sets the target on fire", "$comment": "UNDOCUMENTED", "title": "Catch Fire" }, "damage": { - "description": "UNDOCUMENTED", + "description": "Damage dealt to entity on hit", "$comment": "UNDOCUMENTED", "title": "Damage", "oneOf": [{ "type": "integer" }, { "type": "array", "items": [{ "type": "integer" }, { "type": "integer" }] }] @@ -315,31 +315,31 @@ "particle_on_hit": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "Spawns particles on hit", "$comment": "UNDOCUMENTED", "title": "Particle On Hit", "properties": { "particle_type": { "type": "string", - "description": "UNDOCUMENTED", + "description": "The vanilla particle to use", "$comment": "UNDOCUMENTED", "title": "Particle Type" }, "num_particles": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "Number of particles to spawn", "$comment": "UNDOCUMENTED", "title": "Num Particles" }, "on_entity_hit": { "type": "boolean", - "description": "UNDOCUMENTED", + "description": "If true, spawns particles when this projectile hits an entity", "$comment": "UNDOCUMENTED", "title": "On Entity Hit" }, "on_other_hit": { "type": "boolean", - "description": "UNDOCUMENTED", + "description": "If true, spawns particles when this projectile hits something other than an entity", "$comment": "UNDOCUMENTED", "title": "On Other Hit" } @@ -348,14 +348,14 @@ "remove_on_hit": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "Removes this projectile if it hits something", "$comment": "UNDOCUMENTED", "title": "Remove On Hit" }, "spawn_chance": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "Spawns an entity on hit", "$comment": "UNDOCUMENTED", "title": "Spawn Chance", "properties": { @@ -391,25 +391,27 @@ }, "spawn_definition": { "type": "string", - "description": "UNDOCUMENTED", + "description": "Identifier of the entity to spawn", "$comment": "UNDOCUMENTED", "title": "Spawn Definition" }, "spawn_baby": { "type": "boolean", - "description": "UNDOCUMENTED", + "description": "If true, the `minecraft:entity_born` event will be run on the entity.", "$comment": "UNDOCUMENTED", "title": "Spawn Baby" } } }, "spawn_aoe_cloud": { + "description": "Spawns an area of effect cloud", + "$comment": "UNDOCUMENTED", "additionalProperties": false, "type": "object", "properties": { "radius": { "type": "number", - "description": "UNDOCUMENTED", + "description": "Radius of the cloud", "$comment": "UNDOCUMENTED", "title": "Radius" }, @@ -421,24 +423,24 @@ }, "potion": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "The lingering potion ID to use", "$comment": "UNDOCUMENTED", "title": "Potion" }, "particle": { "type": "string", - "description": "UNDOCUMENTED", + "description": "Vanilla particle that is used for the cloud", "$comment": "UNDOCUMENTED", "title": "Particle" }, "duration": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "Duration in seconds of the cloud existing", "$comment": "UNDOCUMENTED", "title": "Duration" }, "color": { - "description": "UNDOCUMENTED", + "description": "Color of the cloud particles", "$comment": "UNDOCUMENTED", "title": "Color", "type": "array", @@ -469,13 +471,13 @@ }, "affect_owner": { "type": "boolean", - "description": "UNDOCUMENTED", + "description": "If true, the potion effect of the cloud will affect the shooter", "$comment": "UNDOCUMENTED", "title": "Affect Owner" }, "reapplication_delay": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "Delay in ticks between application of the potion effect", "$comment": "UNDOCUMENTED", "title": "Reapplication Delay" } @@ -484,7 +486,7 @@ "stick_in_ground": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "Sticks this projectile into the ground on hit", "$comment": "UNDOCUMENTED", "title": "Stick In Ground", "properties": { @@ -500,7 +502,7 @@ "teleport_owner": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "Teleports the shooter to the hit location", "$comment": "UNDOCUMENTED", "title": "Teleport Owner" }, @@ -513,7 +515,7 @@ "additionalProperties": false, "type": "object", "title": "Grant XP", - "description": "UNDOCUMENTED", + "description": "Spawns a number of experience orbs, which total the amount stated when gathered", "$comment": "UNDOCUMENTED", "properties": { "minXP": { @@ -595,7 +597,7 @@ "stop_on_hurt": { "title": "Splash Range", "type": "boolean", - "description": "UNDOCUMENTED", + "description": "Radius in blocks of the 'splash' effect", "$comment": "UNDOCUMENTED" }, "uncertainty_base": { diff --git a/source/behavior/entities/format/components/ravager_blocked.json b/source/behavior/entities/format/components/ravager_blocked.json index 2fe6e923..6fd6d6f4 100644 --- a/source/behavior/entities/format/components/ravager_blocked.json +++ b/source/behavior/entities/format/components/ravager_blocked.json @@ -23,12 +23,12 @@ "weight": { "type": "integer", "title": "Weight", - "description": "UNDOCUMENTED", + "description": "The chance of this reaction being picked", "$comment": "UNDOCUMENTED" }, "value": { "title": "Value", - "description": "UNDOCUMENTED", + "description": "An event that runs when this reaction is picked", "$comment": "UNDOCUMENTED", "$ref": "../types/event.json" } diff --git a/source/behavior/entities/format/components/scheduler.json b/source/behavior/entities/format/components/scheduler.json index a413cbaf..0a5650c2 100644 --- a/source/behavior/entities/format/components/scheduler.json +++ b/source/behavior/entities/format/components/scheduler.json @@ -7,14 +7,14 @@ "properties": { "min_delay_secs": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "The minimum time in seconds before a scheduled event occurs", "$comment": "UNDOCUMENTED", "title": "Minimum Delay Secs", "minimum": 0 }, "max_delay_secs": { "type": "integer", - "description": "UNDOCUMENTED", + "description": "The maximum time in seconds before a scheduled event occurs", "$comment": "UNDOCUMENTED", "title": "Maximum Delay Secs", "minimum": 0 @@ -26,7 +26,7 @@ "items": { "additionalProperties": false, "type": "object", - "description": "UNDOCUMENTED", + "description": "A filter and event pair. The event runs when the filter criteria succeeds", "$comment": "UNDOCUMENTED", "title": "Scheduled Events", "properties": {