blank038/minecraft-bedrock-json-schemas
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add many missing documentation to components

Browse Source
This commit is contained in:
Ben Dodd
2022-06-23 20:48:19 +01:00
parent feb600d21b
commit 3df9e495bd
27 changed files with 123 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
source/behavior/entities/format/behaviors/admire_item.json
View File

@@ -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": {

8
source/behavior/entities/format/behaviors/defend_trusted_target.json
View File

@@ -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": [

2
source/behavior/entities/format/behaviors/defend_village_target.json
View File

@@ -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"
},

6
source/behavior/entities/format/behaviors/eat_block.json
View File

@@ -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"
}

2
source/behavior/entities/format/behaviors/find_mount.json
View File

@@ -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"
}

6
source/behavior/entities/format/behaviors/harvest_farm_block.json
View File

@@ -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"
}

2
source/behavior/entities/format/behaviors/move_to_block.json
View File

@@ -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"
},

8
source/behavior/entities/format/behaviors/panic.json
View File

@@ -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"
}

2
source/behavior/entities/format/behaviors/pickup_items.json
View File

@@ -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"
},

2
source/behavior/entities/format/behaviors/raid_garden.json
View File

@@ -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"
}

4
source/behavior/entities/format/behaviors/random_fly.json
View File

@@ -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"
}

2
source/behavior/entities/format/behaviors/random_hover.json
View File

@@ -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": [

2
source/behavior/entities/format/behaviors/random_look_around.json
View File

@@ -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"

26
source/behavior/entities/format/behaviors/send_event.json
View File

@@ -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"
}

4
source/behavior/entities/format/behaviors/stalk_and_pounce_on_target.json
View File

@@ -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"
}

20
source/behavior/entities/format/behaviors/swim_with_entity.json
View File

@@ -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"
}
},

2
source/behavior/entities/format/behaviors/swoop_attack.json
View File

@@ -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": {

6
source/behavior/entities/format/behaviors/target_when_pushed.json
View File

@@ -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"
}
},

4
source/behavior/entities/format/behaviors/tempt.json
View File

@@ -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": {