From 41e99999f598a941aa3f0089e651ed5baeca18d3 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:08:21 +0100 Subject: [PATCH 01/20] Update block_sensor.json Removed undocumented comment --- .../format/components/block_sensor.json | 20 +++++++++---------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/source/behavior/entities/format/components/block_sensor.json b/source/behavior/entities/format/components/block_sensor.json index 758b410e..f9097325 100644 --- a/source/behavior/entities/format/components/block_sensor.json +++ b/source/behavior/entities/format/components/block_sensor.json @@ -6,35 +6,34 @@ "additionalProperties": false, "properties": { "sensor_radius": { - "type": "integer", - "description": "The maximum radius in blocks in which a specified block can be detected.", - "$comment": "UNDOCUMENTED", "title": "Sensor Radius", + "type": "integer", + "description": "The maximum radial distance in which a specified block can be detected. The biggest radius is 32.0.", "minimum": 0, "maximum": 32 }, "on_break": { - "type": "array", "title": "On Break", + "type": "array", "description": "Blocks that will trigger the component when broken and what event will trigger.", "items": { - "type": "object", "title": "On Block Broken", - "description": "", + "type": "object", + "description": "Event to run when a block breaks", "additionalProperties": false, "properties": { "block_list": { - "type": "array", "title": "Block List", - "description": "Blocks that will trigger the component when broken and what event will trigger.", + "type": "array", + "description": "List of blocks that will trigger the sensor.", "items": { "$ref": "../../../../general/block/identifier.json", "title": "Block ID" } }, "on_block_broken": { - "type": "string", "title": "On Block Broken", + "type": "string", "description": "Event to run when a block breaks" } } @@ -42,8 +41,7 @@ }, "sources": { "title": "Sources", - "description": "List of sources that break the block to listen for. If none are specified, then all block breaks will be detected", - "$comment": "UNDOCUMENTED", + "description": "List of sources that break the block to listen for. If none are specified, all block breaks will be detected.", "type": "array", "items": { "$ref": "../../filters/filters.json" From 0dada3bc489882f952576d002f354f8d5454423c Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:08:48 +0100 Subject: [PATCH 02/20] Update dweller.json Added descriptions & values --- .../entities/format/components/dweller.json | 59 +++++++++---------- 1 file changed, 29 insertions(+), 30 deletions(-) diff --git a/source/behavior/entities/format/components/dweller.json b/source/behavior/entities/format/components/dweller.json index 8a82f631..b8eae34d 100644 --- a/source/behavior/entities/format/components/dweller.json +++ b/source/behavior/entities/format/components/dweller.json @@ -2,63 +2,62 @@ "$id": "blockception.minecraft.behavior.entities.minecraft.dweller", "type": "object", "title": "Dweller", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED", + "description": "Allows a mob to join and migrate between villages and other dwellings.", "additionalProperties": false, "properties": { "dwelling_type": { "type": "string", "title": "Dwelling Type", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "The type of dwelling the mob wishes to join. Current Types: village", + "enum": ["village"] }, "dweller_role": { "type": "string", "title": "Dwelling Role", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "The role of which the mob plays in the dwelling. Current Roles: inhabitant, defender, hostile, passive.", + "enum": ["inhabitant", "defender", "hostile", "passive"] }, "update_interval_base": { - "type": "integer", + "type": "number", "title": "Update Interval Base", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "How often the mob checks on their dwelling status in ticks. Positive values only.", + "minimum": 0 }, "update_interval_variant": { - "type": "integer", + "type": "number", "title": "Update Interval Variant", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" - }, - "preferred_profession": { - "type": "string", - "title": "Preferred Profession", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "The variant value in ticks that will be added to the update_interval_base." }, "can_find_poi": { "type": "boolean", "title": "Can Find Poi", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" - }, - "can_migrate": { - "type": "boolean", - "title": "Can Migrate", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "Whether or not the mob can find and add POI's to the dwelling." }, "first_founding_reward": { "type": "integer", "title": "First Founding Reward", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED" + "description": "How much reputation should the players be rewarded on first founding?" + }, + "can_migrate": { + "type": "boolean", + "title": "Can Migrate", + "description": "Can this mob migrate between dwellings? Or does it only have its initial dwelling?" + }, + "dwelling_bounds_tolerance": { + "title": "Dwelling Bounds Tolerance", + "type": "number", + "description": "A padding distance for checking if the mob is within the dwelling." + }, + "preferred_profession": { + "type": "string", + "title": "Preferred Profession", + "description": "Allows the user to define a starting profession for this particular Dweller, instead of letting them choose organically. (They still need to gain experience from trading before this takes effect.)" } }, "examples": [ { - "dwelling_type": "example", - "dweller_role": "example", + "dwelling_type": "village", + "dweller_role": "inhabitant", "update_interval_base": 0, "update_interval_variant": 0, "preferred_profession": "example", From c3ace0e25efe45a484274d92ad79f72071c89667 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:09:39 +0100 Subject: [PATCH 03/20] Update interact.json Added properties Updated titles --- .../entities/format/components/interact.json | 54 ++++++++++++------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/source/behavior/entities/format/components/interact.json b/source/behavior/entities/format/components/interact.json index 7d829e51..0163ac39 100644 --- a/source/behavior/entities/format/components/interact.json +++ b/source/behavior/entities/format/components/interact.json @@ -11,9 +11,9 @@ "additionalProperties": false, "properties": { "add_items": { + "title": "Add Items", "type": "object", "description": "Loot table with items to add to the player's inventory upon successful interaction.", - "title": "Add Items", "additionalProperties": false, "properties": { "table": { @@ -25,44 +25,58 @@ } }, "cooldown": { - "title": "cooldown", + "title": "Cooldown", "type": "number", "default": 0, "description": "Time in seconds before this entity can be interacted with again." }, + "admire": { + "title": "Admire", + "type": "boolean", + "default": false, + "description": "Allows entity to admire the item. Requires \"minecraft:admire_item\" and \"minecraft:behavior.admire_item\" to work.", + "$comment": "UNDOCUMENTED" + }, + "barter": { + "title": "Barter", + "type": "boolean", + "default": false, + "description": "Allows entity to barter with the item. Requires \"minecraft:barter\" to work.", + "$comment": "UNDOCUMENTED" + }, "cooldown_after_being_attacked": { - "title": "cooldown after being attacked", + "title": "Cooldown After Being Attacked", "type": "number", "default": 0, "description": "Time in seconds before this entity can be interacted with after being attacked." }, "health_amount": { - "title": "health amount", + "title": "Health Amount", "type": "integer", "default": 0, "description": "The amount of health this entity will recover or hurt when interacting with this item. Negative values will harm the entity." }, "hurt_item": { - "title": "hurt item", + "title": "Hurt Item", "type": "integer", "default": 0, "description": "The amount of damage the item will take when used to interact with this entity. A value of 0 means the item won't lose durability." }, "interact_text": { - "title": "interact text", + "title": "Interact Text", "type": "string", "default": "", "description": "Text to show when the player is able to interact in this way with this entity when playing with Touch-screen controls." }, "on_interact": { + "title": "On Interact", "$ref": "../types/trigger.json", - "description": "Event to fire when the interaction occurs.", - "title": "On Interact" + "description": "Event to fire when the interaction occurs." }, "particle_on_start": { + "title": "Particle On Start", "type": "object", "description": "Particle effect that will be triggered at the start of the interaction.", - "title": "Particle On Start", "properties": { "particle_offset_towards_interactor": { "type": "boolean", @@ -82,16 +96,16 @@ } }, "play_sounds": { + "title": "Play Sounds", "type": "string", "default": "", - "description": "List of sounds to play when the interaction occurs.", - "title": "Play Sounds" + "description": "List of sounds to play when the interaction occurs." }, "spawn_entities": { + "title": "Spawn Entities", "type": "string", "default": "", - "description": "List of entities to spawn when the interaction occurs.", - "title": "Spawn Entities" + "description": "List of entities to spawn when the interaction occurs." }, "spawn_items": { "type": "object", @@ -108,21 +122,21 @@ } }, "swing": { + "title": "Swing", "type": "boolean", "default": false, - "description": "If true, the player will do the `swing` animation when interacting with this entity.", - "title": "Swing" + "description": "If true, the player will do the \"swing\" animation when interacting with this entity." }, "transform_to_item": { - "type": "string", "title": "Transform To Item", + "type": "string", "description": "The feed item used will transform to this item upon successful interaction. Format: itemName:auxValue" }, "use_item": { + "title": "Use Item", "type": "boolean", "default": false, - "description": "If true, the interaction will use an item.", - "title": "Use Item" + "description": "If true, the interaction will use an item." }, "vibration": { "title": "Vibration", @@ -130,14 +144,14 @@ "description": "Vibration to emit when the interaction occurs. Admitted values are entity_interact (used by default), shear, and none (no vibration emitted)." }, "give_item": { - "type": "boolean", "title": "Give Item", + "type": "boolean", "$comment": "UNDOCUMENTED", "description": "UNDOCUMENTED Item to give to the player upon successful interaction." }, "take_item": { - "type": "boolean", "title": "Take Item", + "type": "boolean", "$comment": "UNDOCUMENTED", "description": "UNDOCUMENTED Takes an item from the player" } From 43da1557be5fa991fbfd2f2c28cc735650217acf Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:10:02 +0100 Subject: [PATCH 04/20] Update knockback_resistance.json Added descriptions Removed undocumented comment --- .../components/knockback_resistance.json | 20 ++++++------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/source/behavior/entities/format/components/knockback_resistance.json b/source/behavior/entities/format/components/knockback_resistance.json index 219ea27c..12207428 100644 --- a/source/behavior/entities/format/components/knockback_resistance.json +++ b/source/behavior/entities/format/components/knockback_resistance.json @@ -3,27 +3,19 @@ "type": "object", "title": "Knockback Resistance", "additionalProperties": false, - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED", + "description": "Sets the knockback resistance item component. Determines the amount of knockback resistance that the item has.", "required": [], "properties": { - "value": { + "protection": { + "title": "Protection", "type": "number", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED", - "title": "Value" - }, - "max": { - "type": "number", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED", - "title": "Maximum" + "description": "Amount of knockback resistance provided with the total maximum protection being 1.0", + "maximum": 1 } }, "examples": [ { - "value": 0.0, - "max": 0.0 + "protection": 0.5 } ] } From 17e1628e8c3d26360aad9bb78ccc82a3afbfc211 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:10:30 +0100 Subject: [PATCH 05/20] Update movement.glide.json Added property --- .../entities/format/components/movement.glide.json | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/source/behavior/entities/format/components/movement.glide.json b/source/behavior/entities/format/components/movement.glide.json index 36ba96a2..77f9e1dd 100644 --- a/source/behavior/entities/format/components/movement.glide.json +++ b/source/behavior/entities/format/components/movement.glide.json @@ -2,11 +2,16 @@ "$id": "blockception.minecraft.behavior.entities.minecraft.movement.glide", "type": "object", "title": "Movement.glide", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED", + "description": "This is the move control for a flying mob that has a gliding movement.", "additionalProperties": false, "required": [], "properties": { + "max_turn": { + "type": "number", + "default": 30, + "description": "The maximum number in degrees the mob can turn per tick.", + "title": "Maximum Turn" + }, "start_speed": { "type": "number", "title": "Start Speed", @@ -22,8 +27,8 @@ }, "examples": [ { - "start_speed": 0.0, - "speed_when_turning": 0.0 + "start_speed": 1.0, + "speed_when_turning": 2.0 } ] } From ec61c62606371e7b3d597470c0b023cf11014d08 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:11:02 +0100 Subject: [PATCH 06/20] Update projectile.json Removed undocumented comment --- source/behavior/entities/format/components/projectile.json | 1 - 1 file changed, 1 deletion(-) diff --git a/source/behavior/entities/format/components/projectile.json b/source/behavior/entities/format/components/projectile.json index 8a10b888..498cacac 100644 --- a/source/behavior/entities/format/components/projectile.json +++ b/source/behavior/entities/format/components/projectile.json @@ -448,7 +448,6 @@ "type": "object", "description": "Removes the projectile.", "additionalProperties": true, - "$comment": "UNDOCUMENTED", "properties": {} }, "spawn_aoe_cloud": { From 8319308b6231a4cb39b8f49b70cfde355ebf4ded Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:11:15 +0100 Subject: [PATCH 07/20] Update trade_resupply.json Added description Removed undocumented comment --- source/behavior/entities/format/components/trade_resupply.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/behavior/entities/format/components/trade_resupply.json b/source/behavior/entities/format/components/trade_resupply.json index 9e3e85dc..90188e8a 100644 --- a/source/behavior/entities/format/components/trade_resupply.json +++ b/source/behavior/entities/format/components/trade_resupply.json @@ -1,7 +1,6 @@ { "$id": "blockception.minecraft.behavior.entities.minecraft.trade_resupply", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED", + "description": "Resupplies an entity's trade.", "type": "object", "title": "Trade Resupply", "additionalProperties": false, From 939b58c0068585484c7c203c5aa9ca70e0a9e39f Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:11:25 +0100 Subject: [PATCH 08/20] Update trust.json Added description Removed undocumented commend --- source/behavior/entities/format/components/trust.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/behavior/entities/format/components/trust.json b/source/behavior/entities/format/components/trust.json index d689c33a..2b222ea0 100644 --- a/source/behavior/entities/format/components/trust.json +++ b/source/behavior/entities/format/components/trust.json @@ -2,8 +2,7 @@ "$id": "blockception.minecraft.behavior.entities.minecraft.trust", "type": "object", "title": "Trust", - "description": "UNDOCUMENTED", - "$comment": "UNDOCUMENTED", + "description": "Allows this entity to trust multiple players.", "required": [], "additionalProperties": false, "properties": {} From 3579380462ddecfd1a966b71d5fd941893ef36c1 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:38:20 +0100 Subject: [PATCH 09/20] Update defend_village_target.json Added descriptions Removed undocumented comment Updated example --- .../entities/format/behaviors/defend_village_target.json | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/behavior/entities/format/behaviors/defend_village_target.json b/source/behavior/entities/format/behaviors/defend_village_target.json index 05faab3f..ff1eae58 100644 --- a/source/behavior/entities/format/behaviors/defend_village_target.json +++ b/source/behavior/entities/format/behaviors/defend_village_target.json @@ -7,15 +7,14 @@ "properties": { "priority": { "$ref": "./types/priority.json" }, "entity_types": { + "title": "Entity Types", "$ref": "../types/entity_types.json", "description": "List of entity types this mob considers a threat to the village", - "$comment": "UNDOCUMENTED", - "title": "Entity Types" + "$comment": "UNDOCUMENTED" }, "must_reach": { "title": "Must Reach", - "description": "If true, the entities considered a threat must be reachable to be a valid target.", - "$comment": "UNDOCUMENTED", + "description": "The entity must be able to reach attacker.", "type": "boolean" }, "attack_chance": { From e62f891464c0a779f948bac57f08b1280d219b15 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:38:34 +0100 Subject: [PATCH 10/20] Update eat_block.json Reorganised --- .../entities/format/behaviors/eat_block.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/source/behavior/entities/format/behaviors/eat_block.json b/source/behavior/entities/format/behaviors/eat_block.json index 1674402a..d0c21cfd 100644 --- a/source/behavior/entities/format/behaviors/eat_block.json +++ b/source/behavior/entities/format/behaviors/eat_block.json @@ -8,25 +8,25 @@ "properties": { "priority": { "$ref": "./types/priority.json" }, "on_eat": { + "title": "On Eat", "$ref": "../types/trigger.json", - "description": "The event to trigger when the block eating animation has completed.", - "title": "On Eat" + "description": "The event to trigger when the block eating animation has completed." }, "success_chance": { "title": "Succes Chance", - "description": "A molang expression defining the success chance the entity has to consume a block.", + "$ref": "../../../../molang/number.json", "default": 0.02, - "$ref": "../../../../molang/number.json" + "description": "A molang expression defining the success chance the entity has to consume a block." }, "time_until_eat": { "title": "Time Until Eat", - "description": "The amount of time (in seconds) it takes for the block to be eaten upon a successful eat attempt.", + "type": "number", "default": 1.8, - "type": "number" + "description": "The amount of time (in seconds) it takes for the block to be eaten upon a successful eat attempt." }, "eat_and_replace_block_pairs": { - "type": "array", "title": "Eat And Replace Block Pairs", + "type": "array", "description": "A collection of pairs of blocks; the first (\"eat_block\")is the block the entity should eat, the second (\"replace_block\") is the block that should replace the eaten block.", "items": { "type": "object", From ff20f5aad7951e92d8556119d7a6424342dabd61 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:38:54 +0100 Subject: [PATCH 11/20] Update find_mount.json Removed undocumented comment --- .../entities/format/behaviors/find_mount.json | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/source/behavior/entities/format/behaviors/find_mount.json b/source/behavior/entities/format/behaviors/find_mount.json index 9fcb5a5a..92d8b350 100644 --- a/source/behavior/entities/format/behaviors/find_mount.json +++ b/source/behavior/entities/format/behaviors/find_mount.json @@ -9,40 +9,40 @@ "$ref": "types/priority.json" }, "avoid_water": { + "title": "Avoid Water", "type": "boolean", "default": false, - "description": "If true, the mob will not go into water blocks when going towards a mount", - "title": "Avoid Water" + "description": "If true, the mob will not go into water blocks when going towards a mount" }, "mount_distance": { "type": "number", + "title": "Mount Distance", "default": -1, - "description": "This is the distance the mob needs to be, in blocks, from the desired mount to mount it. If the value is below 0, the mob will use its default attack distance", - "title": "Mount Distance" + "description": "This is the distance the mob needs to be, in blocks, from the desired mount to mount it. If the value is below 0, the mob will use its default attack distance" }, "start_delay": { + "title": "Start Delay", "type": "integer", "default": 0, - "description": "Time the mob will wait before starting to move towards the mount", - "title": "Start Delay" + "description": "Time the mob will wait before starting to move towards the mount" }, "target_needed": { + "title": "Target Needed", "type": "boolean", "default": false, - "description": "If true, the mob will only look for a mount if it has a target", - "title": "Target Needed" + "description": "If true, the mob will only look for a mount if it has a target" }, "within_radius": { + "title": "Within Radius", "type": "number", "default": 0, - "description": "Distance in blocks within which the mob will look for a mount", - "title": "Within Radius" + "description": "Distance in blocks within which the mob will look for a mount" }, "max_failed_attempts": { + "title": "Maximum Failed Attempts", "type": "integer", "description": "The number of failed attempts to make before this goal is no longer used.", - "$comment": "UNDOCUMENTED", - "title": "Maximum Failed Attempts" + "$comment": "UNDOCUMENTED" } }, "examples": [ From 3008b99eae6d03d21e0ecd48ba54df862b0c88ce Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:39:23 +0100 Subject: [PATCH 12/20] Update harvest_farm_block.json Added properties Updated descriptions Removed undocumented comment --- .../format/behaviors/harvest_farm_block.json | 38 ++++++++++++++----- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/source/behavior/entities/format/behaviors/harvest_farm_block.json b/source/behavior/entities/format/behaviors/harvest_farm_block.json index 5c66486b..3e7a8325 100644 --- a/source/behavior/entities/format/behaviors/harvest_farm_block.json +++ b/source/behavior/entities/format/behaviors/harvest_farm_block.json @@ -2,7 +2,7 @@ "$id": "blockception.minecraft.behavior.entities.minecraft.behavior.harvest_farm_block", "type": "object", "title": "Harvest Farm Block", - "description": "Allows the villager to harvest nearby farms. Can only be used by Villagers.", + "description": "Allows the entity to search within an area for farmland with air above it. If found, the entity will replace the air block by planting a seed item from its inventory on the farmland block. This goal requires \"minecraft:inventory\" and \"minecraft:navigation\" to execute. This goal will not execute if the entity does not have an item in its inventory.", "additionalProperties": false, "required": [], "properties": { @@ -10,21 +10,39 @@ "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "max_seconds_before_search": { "title": "Maximum Seconds Before Search", - "description": "The maximum amount of time in seconds that the goal can take before searching for the first harvest block.", - "$comment": "UNDOCUMENTED", - "type": "number" + "type": "number", + "default": 1.0, + "description": "The maximum amount of time in seconds that the goal can take before searching for the first harvest block. The time is chosen between 0 and this number." }, "search_cooldown_max_seconds": { "title": "Search Cooldown Maximum Seconds", - "description": "The maximum amount of time in seconds that the goal can take before searching again, after failing to find a block to harvest.", - "$comment": "UNDOCUMENTED", - "type": "number" + "type": "number", + "default": 8.0, + "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. The time is chosen between 0 and this number." + }, + "search_count": { + "title": "Search Count", + "type": "integer", + "default": 0, + "description": "The number of randomly selected blocks each tick that the entity will check within its search range and height for a valid block to move to. A value of 0 will have the mob check every block within range in one tick." + }, + "search_height": { + "title": "Search Height", + "type": "integer", + "default": 1, + "description": "The height in blocks the entity will search within to find a valid target position." + }, + "search_range": { + "title": "Search Range", + "type": "integer", + "default": 16, + "description": "The distance in blocks the entity will search within to find a valid target position." }, "seconds_until_new_task": { "title": "Seconds Until New Task", - "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" + "type": "number", + "default": 0.5, + "description": "The amount of time in seconds that the goal will cooldown after a successful reap/sow, before it can start again." } }, "examples": [ From 1a6cd072b0496d5f35fd6653f4e482d8034a1fd2 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:39:38 +0100 Subject: [PATCH 13/20] Update move_to_block.json Added enum Reorganised --- source/behavior/entities/format/behaviors/move_to_block.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/behavior/entities/format/behaviors/move_to_block.json b/source/behavior/entities/format/behaviors/move_to_block.json index 08f6c3fe..a5bc5e20 100644 --- a/source/behavior/entities/format/behaviors/move_to_block.json +++ b/source/behavior/entities/format/behaviors/move_to_block.json @@ -52,11 +52,12 @@ "title": "Target Selection Method", "type": "string", "default": "nearest", - "description": "Kind of block to find fitting the specification. Valid values are \"random\" and \"nearest\"." + "description": "Kind of block to find fitting the specification. Valid values are \"random\" and \"nearest\".", + "enum": ["random","nearest"] }, "target_offset": { - "type": "array", "title": "Target Offset", + "type": "array", "default": [0, 0, 0], "description": "Offset to add to the selected target position.", "items": [ From 36e75f0d70b366e21840eeeffc7edabfe19453a6 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:39:45 +0100 Subject: [PATCH 14/20] Update nap.json Reorganised --- .../entities/format/behaviors/nap.json | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/source/behavior/entities/format/behaviors/nap.json b/source/behavior/entities/format/behaviors/nap.json index 0d0366c1..e45cf9b9 100644 --- a/source/behavior/entities/format/behaviors/nap.json +++ b/source/behavior/entities/format/behaviors/nap.json @@ -8,40 +8,40 @@ "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "cooldown_max": { + "title": "Cooldown Max", "type": "number", "default": 0, - "description": "Maximum time in seconds the mob has to wait before using the goal again", - "title": "Cooldown Max" + "description": "Maximum time in seconds the mob has to wait before using the goal again" }, "cooldown_min": { + "title": "Cooldown Min", "type": "number", "default": 0, - "description": "Minimum time in seconds the mob has to wait before using the goal again", - "title": "Cooldown Min" + "description": "Minimum time in seconds the mob has to wait before using the goal again" }, "mob_detect_dist": { + "title": "Mob Detect Dist", "type": "number", "default": 6, - "description": "The block distance in x and z that will be checked for mobs that this mob detects", - "title": "Mob Detect Dist" + "description": "The block distance in x and z that will be checked for mobs that this mob detects" }, "mob_detect_height": { + "title": "Mob Detect Height", "type": "number", "default": 6, - "description": "The block distance in y that will be checked for mobs that this mob detects", - "title": "Mob Detect Height" + "description": "The block distance in y that will be checked for mobs that this mob detects" }, "can_nap_filters": { + "title": "Can Nap Filters", "$ref": "../../filters/filters.json", "description": "The filters that need to be met for the nap to take place", - "$comment": "UNDOCUMENTED", - "title": "Can Nap Filters" + "$comment": "UNDOCUMENTED" }, "wake_mob_exceptions": { + "title": "Wake Mob Exceptions", "$ref": "../../filters/filters.json", "description": "Filters that can trigger the entity to wake up from it nap", - "$comment": "UNDOCUMENTED", - "title": "Wake Mob Exceptions" + "$comment": "UNDOCUMENTED" } }, "examples": [ From 8a73c301ff7613a5fd1b36aed354830cb947f150 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:39:59 +0100 Subject: [PATCH 15/20] Update random_hover.json Updated description Removed undocumented comment --- source/behavior/entities/format/behaviors/random_hover.json | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/source/behavior/entities/format/behaviors/random_hover.json b/source/behavior/entities/format/behaviors/random_hover.json index 7963304a..0e63c96d 100644 --- a/source/behavior/entities/format/behaviors/random_hover.json +++ b/source/behavior/entities/format/behaviors/random_hover.json @@ -8,10 +8,9 @@ "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "hover_height": { - "type": "array", - "description": "The range of height in blocks above the surface which the mob will try to hover.", - "$comment": "UNDOCUMENTED", "title": "Hover Height", + "type": "array", + "description": "The height above the surface which the mob will try to maintain", "items": [ { "type": "number" From 6930195dc226dca6b65287fa1dbdad8b4467915c Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:40:15 +0100 Subject: [PATCH 16/20] Update send_event.json Added property --- source/behavior/entities/format/behaviors/send_event.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/behavior/entities/format/behaviors/send_event.json b/source/behavior/entities/format/behaviors/send_event.json index 7a987ae8..0994cd15 100644 --- a/source/behavior/entities/format/behaviors/send_event.json +++ b/source/behavior/entities/format/behaviors/send_event.json @@ -40,6 +40,12 @@ "description": "Time in seconds for the entire event sending process", "title": "Cast Duration" }, + "look_at_target": { + "title": "Look At Target", + "type": "boolean", + "default": true, + "description": "If true, the mob will face the entity it sends an event to" + }, "event_choices": { "type": "array", "title": "Event Choices", From 45cecef821981d139ff0f6cda6a2ccc07bdb717b Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:40:35 +0100 Subject: [PATCH 17/20] Update stalk_and_pounce_on_target.json Updated description --- .../entities/format/behaviors/stalk_and_pounce_on_target.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 175885a7..c154b334 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 @@ -1,6 +1,6 @@ { "$id": "blockception.minecraft.behavior.entities.minecraft.behavior.stalk_and_pounce_on_target", - "description": "Allows the mob to stay at a certain level when in liquid.", + "description": "Allows an entity to stalk a specific target. Once within range of the target, the entity will then leap at the target and deal damage based upon its attack attribute.", "type": "object", "title": "Stalk And Pounce On Target", "additionalProperties": false, From fa373d4d881e8639131e5f8e1f512a885005375e Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:40:52 +0100 Subject: [PATCH 18/20] Update swim_with_entity.json Updated descriptions Removed undocumented comments --- .../format/behaviors/swim_with_entity.json | 70 +++++++++---------- 1 file changed, 34 insertions(+), 36 deletions(-) diff --git a/source/behavior/entities/format/behaviors/swim_with_entity.json b/source/behavior/entities/format/behaviors/swim_with_entity.json index 1acf31b5..e312c96e 100644 --- a/source/behavior/entities/format/behaviors/swim_with_entity.json +++ b/source/behavior/entities/format/behaviors/swim_with_entity.json @@ -2,78 +2,76 @@ "$id": "blockception.minecraft.behavior.entities.minecraft.behavior.swim_with_entity", "type": "object", "title": "Swim With Entity", - "description": "Allows this mob to follow another entity, as long as both entities are in water (swimming)", - "$comment": "UNDOCUMENTED", + "description": "Allows the entity follow another entity. Both entities must be swimming and in water.", "additionalProperties": false, "required": [], "properties": { "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "success_rate": { - "type": "number", "title": "Success Rate", - "description": "Chance to start following another entity, if not already doing so", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 0.1, + "description": "Percent chance to start following another entity, if not already doing so. 1.0 = 100%" }, "chance_to_stop": { - "type": "number", "title": "Chance To Stop", - "description": "Chance to stop following the current entity", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 0.0333, + "description": "Percent chance to stop following the current entity, if they're riding another entity or they're not swimming. 1.0 = 100%" }, "state_check_interval": { - "type": "number", "title": "State Check Interval", - "description": "Time in seconds between checks to determine if this mob should catch up to the entity being followed", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 0.5, + "description": "Time (in seconds) between checks to determine if this entity should catch up to the entity being followed or match the direction of the entity being followed." }, "catch_up_threshold": { - "type": "number", "title": "Catch Up Threshold", - "description": "Distance in blocks from the entity being followed at which this mob will speed up to catch up", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 12, + "description": "Distance, from the entity being followed, at which this entity will speed up to reach that entity." }, "match_direction_threshold": { - "type": "number", "title": "Match Direction Threshold", - "description": "Distance in blocks from the entity being followed at which this mob will match that entity's direction", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 2, + "description": "Distance, from the entity being followed, at which this entity will try to match that entity's direction" }, "catch_up_multiplier": { - "type": "number", "title": "Catch Up Multiplier", - "description": "The multiplier applied to the speed of this mob when trying to catch up", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 2.5, + "description": "The multiplier this entity's speed is modified by when matching another entity's direction." }, "search_range": { - "type": "number", "title": "Search Range", - "description": "Radius in blocks around this mob to search for another entity to follow", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 20, + "description": "Radius around this entity to search for another entity to follow." }, "stop_distance": { - "type": "number", "title": "Stop Distance", - "description": "Distance in blocks from the entity being followed at which this entity will stop following", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 5, + "description": "Distance, from the entity being followed, at which this entity will stop following that entity." }, "entity_types": { "$ref": "../types/entity_types.json", "title": "Entity Types", - "description": "Filters which determine what entites are valid to follow", - "$comment": "UNDOCUMENTED" + "description": "Filters which determine what entites are valid to follow" } }, "examples": [ { - "success_rate": 0.0, - "chance_to_stop": 0.0, - "state_check_interval": 0.0, - "catch_up_threshold": 0.0, - "match_direction_threshold": 0.0, - "catch_up_multiplier": 0.0, - "search_range": 0.0, - "stop_distance": 0.0 + "success_rate": 0.1, + "chance_to_stop": 0.0333, + "state_check_interval": 0.5, + "catch_up_threshold": 12, + "match_direction_threshold": 2, + "catch_up_multiplier": 2.5, + "search_range": 20, + "stop_distance": 5 } ] } From 5b237833b98347c3895a23fd47aed0ea096c0a03 Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:41:17 +0100 Subject: [PATCH 19/20] Update swoop_attack.json Updated descriptions Removed undocumented comments Updated example --- .../entities/format/behaviors/swoop_attack.json | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/source/behavior/entities/format/behaviors/swoop_attack.json b/source/behavior/entities/format/behaviors/swoop_attack.json index a3c1cce9..6d0bf2c9 100644 --- a/source/behavior/entities/format/behaviors/swoop_attack.json +++ b/source/behavior/entities/format/behaviors/swoop_attack.json @@ -9,21 +9,22 @@ "priority": { "$ref": "types/priority.json" }, "speed_multiplier": { "$ref": "types/speed_multiplier.json" }, "damage_reach": { - "type": "number", "title": "Damage Reach", - "description": "Added onto the base size of this mob to determine the maximum distance this mob can deal damage", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 0.2, + "description": "Added to the base size of the entity, to determine the target's maximum allowable distance, when trying to deal attack damage." }, "delay_range": { "$ref": "../types/range_number_type.json", "default": [[10.0, 20.0]], - "description": "Range of time in seconds between uses of this goal.", + "description": "Minimum and maximum cooldown time-range (in seconds) between each attempted swoop attack.", "title": "Delay Range" } }, "examples": [ { - "damage_reach": 0.0 + "damage_reach": 0.2, + "delay_range": [10.0, 20.0] } ] } From 86af037f017139076cfc91b8b5e13d613681575f Mon Sep 17 00:00:00 2001 From: ChibiMango <32205345+ChibiMango@users.noreply.github.com> Date: Wed, 13 Jul 2022 22:41:33 +0100 Subject: [PATCH 20/20] Update target_when_pushed.json Updated description Removed undocumented comments Updated example --- .../format/behaviors/target_when_pushed.json | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/source/behavior/entities/format/behaviors/target_when_pushed.json b/source/behavior/entities/format/behaviors/target_when_pushed.json index 2ad26d14..ea69c090 100644 --- a/source/behavior/entities/format/behaviors/target_when_pushed.json +++ b/source/behavior/entities/format/behaviors/target_when_pushed.json @@ -1,7 +1,6 @@ { "$id": "blockception.minecraft.behavior.entities.minecraft.behavior.target_when_pushed", - "description": "Allows this mob to target an entity that pushed it", - "$comment": "UNDOCUMENTED", + "description": "Allows an entity to select a valid target entity that pushed it.", "type": "object", "title": "Target When Pushed", "additionalProperties": false, @@ -11,21 +10,21 @@ "$ref": "types/priority.json" }, "entity_types": { - "$ref": "../types/entity_types.json", "title": "Entity Types", - "description": "The list of conditions the other entity must meet to be a valid target", - "$comment": "UNDOCUMENTED" + "$ref": "../types/entity_types.json", + "description": "The list of conditions the other entity must meet to be a valid target" }, "percent_chance": { - "type": "number", "title": "Percent Chance", - "description": "The chance that the entity becomes a target when this mob is pushed", - "$comment": "UNDOCUMENTED" + "type": "number", + "default": 5.0, + "description": "Probability that the entity will target the entity that pushed it." } }, "examples": [ { - "percent_chance": 0.0 + "percent_chance": 5.0, + "entity_types": [] } ] }