Added documentation

This commit is contained in:
Daan Verstraten
2022-03-14 12:55:47 +01:00
parent 97887e43bb
commit 7b526f0aee
11 changed files with 43 additions and 68 deletions

View File

@@ -35,24 +35,17 @@
},
"look_time": {
"type": "array",
"default": [
2,
4
],
"default": [2, 4],
"description": "Time range to look at the entity",
"title": "Look Time",
"items": [
{
"type": "number"
},
{
"type": "number"
}
{ "type": "number", "title": "Minimum", "description": "The minimum amount of time to look" },
{ "type": "number", "title": "Maximum", "description": "The maximum amount of time to look" }
]
},
"target_distance": {
"type": "number",
"description": "UNDOCUMENTED",
"description": "The distance to the target or less to be considered",
"$comment": "UNDOCUMENTED",
"title": "Target Distance"
}
@@ -67,4 +60,4 @@
"target_distance": 0.0
}
]
}
}

View File

@@ -4,7 +4,7 @@
"type": "object",
"title": "Move Outdoors",
"$comment": "UNDOCUMENTED",
"description": "UNDOCUMENTED",
"description": "Forces the entity to move `outside`, whatever that means",
"properties": {
"priority": { "$ref": "types/priority.json" },
"speed_multiplier": { "$ref": "./types/speed_multiplier.json" },

View File

@@ -3,47 +3,45 @@
"type": "object",
"title": "Move To Block",
"additionalProperties": false,
"description": "UNDOCUMENTED",
"description": "Makes the entity move towards specified blocks",
"$comment": "UNDOCUMENTED",
"required": [],
"properties": {
"priority": {
"$ref": "./types/priority.json"
},
"priority": { "$ref": "./types/priority.json" },
"tick_interval": {
"type": "number",
"title": "Tick Interval",
"description": "UNDOCUMENTED",
"description": "The amount ticks between each search",
"$comment": "UNDOCUMENTED"
},
"start_chance": {
"type": "number",
"title": "Start Chance",
"description": "UNDOCUMENTED",
"description": "The chance that the entity starts on this block search",
"$comment": "UNDOCUMENTED"
},
"search_range": {
"type": "number",
"title": "Search Range",
"description": "UNDOCUMENTED",
"description": "The range of blocks to search",
"$comment": "UNDOCUMENTED"
},
"search_height": {
"type": "number",
"title": "Search Height",
"description": "UNDOCUMENTED",
"description": "How heigh the search can be, (or low)",
"$comment": "UNDOCUMENTED"
},
"goal_radius": {
"type": "number",
"title": "Goal Radius",
"description": "UNDOCUMENTED",
"description": "The radius when the entity must be within of the block to be considered 'there'",
"$comment": "UNDOCUMENTED"
},
"stay_duration": {
"type": "number",
"title": "Stay Duration",
"description": "UNDOCUMENTED",
"description": "The amount of time the entity stays near the block",
"$comment": "UNDOCUMENTED"
},
"target_selection_method": {
@@ -58,15 +56,9 @@
"description": "UNDOCUMENTED",
"$comment": "UNDOCUMENTED",
"items": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
{ "type": "number", "title": "X" },
{ "type": "number", "title": "Y" },
{ "type": "number", "title": "Z" }
]
},
"target_blocks": {
@@ -75,13 +67,14 @@
"description": "UNDOCUMENTED",
"$comment": "UNDOCUMENTED",
"items": {
"$ref": "../../../../general/block/identifier.json",
"type": "string"
}
},
"on_stay_completed": {
"type": "array",
"title": "On Stay Completed",
"description": "UNDOCUMENTED",
"description": "The events to call whenever this entity has completed it staying duration",
"$comment": "UNDOCUMENTED",
"items": {
"$ref": "../types/event.json"
@@ -90,7 +83,7 @@
"on_reach": {
"type": "array",
"title": "On Reach",
"description": "UNDOCUMENTED",
"description": "The events to call whenever this entity has reached it goal, but is possibly still staying here",
"$comment": "UNDOCUMENTED",
"items": {
"$ref": "../types/event.json"
@@ -99,17 +92,11 @@
},
"examples": [
{
"tick_interval": 0.0,
"start_chance": 0.0,
"search_range": 0.0,
"search_height": 0.0,
"goal_radius": 0.0,
"stay_duration": 0.0,
"target_selection_method": "example",
"target_offset": [],
"target_blocks": [],
"on_stay_completed": [],
"on_reach": []
"start_chance": 1,
"search_range": 32,
"goal_radius": 3,
"stay_duration": 2,
"target_blocks": ["minecraft:chest"]
}
]
}

View File

@@ -37,13 +37,13 @@
},
"can_nap_filters": {
"$ref": "../../filters/filters.json",
"description": "UNDOCUMENTED",
"description": "The filters that need to be met for the nap to take place",
"$comment": "UNDOCUMENTED",
"title": "Can Nap Filters"
},
"wake_mob_exceptions": {
"$ref": "../../filters/filters.json",
"description": "UNDOCUMENTED",
"description": "Filters that can trigger the entity to wake up from it nap",
"$comment": "UNDOCUMENTED",
"title": "Wake Mob Exceptions"
}
@@ -56,4 +56,4 @@
"mob_detect_height": 6
}
]
}
}

View File

@@ -32,7 +32,7 @@
"search_radius": {
"type": "integer",
"default": 0,
"description": "UNDOCUMENTED",
"description": "The search radius for the mob to consider",
"$comment": "UNDOCUMENTED",
"title": "Search Radius"
}
@@ -45,4 +45,4 @@
"search_radius": 0
}
]
}
}

View File

@@ -15,14 +15,8 @@
{
"type": "array",
"items": [
{
"type": "number",
"title": "Maximum"
},
{
"type": "number",
"title": "Maximum"
}
{ "type": "number", "title": "Maximum" },
{ "type": "number", "title": "Maximum" }
]
},
{

View File

@@ -27,7 +27,7 @@
"npc_data": {
"type": "object",
"title": "Npc Data",
"description": "UNDOCUMENTED",
"description": "The data belonging to this npc",
"$comment": "UNDOCUMENTED",
"additionalProperties": false,
"properties": {

View File

@@ -3,9 +3,10 @@
"$id": "blockception.minecraft.materials",
"type": "object",
"title": "Material",
"description": "UNDOCUMENTED",
"description": "A collection of material specifications for the render engine of minecraft",
"$comment": "UNDOCUMENTED",
"additionalProperties": false,
"required": ["materials"],
"definitions": {
"DefinesSpecification": {
"type": "array",
@@ -266,7 +267,7 @@
"materials": {
"type": "object",
"title": "Materials",
"description": "UNDOCUMENTED",
"description": "The collection of materials, each property key is the identification key of the material, and what it implements if : are used",
"$comment": "UNDOCUMENTED",
"required": ["version"],
"properties": {

View File

@@ -65,7 +65,7 @@
"type": "object",
"additionalProperties": false,
"title": "Curve",
"description": "UNDOCUMENTED",
"description": "The curve definitions, conists out of a couple of nodes",
"$comment": "UNDOCUMENTED",
"properties": {
"input": { "$ref": "../../molang/number.json", "title": "Input", "description": "What is the input value to use" },

View File

@@ -3,8 +3,8 @@
"$id": "blockception.minecraft.sound_definition",
"type": "object",
"additionalProperties": false,
"title": "Sound File For ",
"description": "UNDOCUMENTED",
"title": "Sound Definitions",
"description": "The collection of sound definitions this resourcepack has defined",
"$comment": "UNDOCUMENTED",
"definitions": {
"SoundPath": {
@@ -26,17 +26,17 @@
"__use_legacy_max_distance": {
"type": "boolean",
"title": "Use Legacy Max Distance",
"description": "UNDOCUMENTED"
"description": "Whenever or not use legacy distance checking"
},
"category": {
"type": "string",
"title": "Sound Category",
"enum": ["ambient", "block", "music", "weather", "ui", "bucket", "neutral", "player", "hostile", "record", "bottle"],
"description": "UNDOCUMENTED: category"
"description": "The category this sound belongs to, for the user to control the volume on"
},
"sounds": {
"title": "Sounds",
"description": "UNDOCUMENTED: sounds",
"description": "The collection of sounds minecraft can choice from",
"items": {
"title": "Sounds",
"description": "UNDOCUMENTED: sounds",

View File

@@ -4,7 +4,7 @@
"additionalProperties": false,
"type": "object",
"title": "Terrain Texture File",
"description": "UNDOCUMENTED",
"description": "An collection of texture definitions",
"$comment": "UNDOCUMENTED",
"definitions": {
"texture": {