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] 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",