Updated documentation with the microsoft documentation

This commit is contained in:
DaanV2
2021-07-02 13:00:02 +02:00
parent f9ecdb79e8
commit dd28b6a467
29 changed files with 152 additions and 127 deletions

View File

@@ -5,10 +5,16 @@
"description": "Fires off a specified event when a block in the block list is broken within the sensor range.",
"additionalProperties": false,
"properties": {
"sensor_radius": { "type": "integer", "description": "UNDOCUMENTED", "$comment": "UNDOCUMENTED", "title": "Sensor Radius", "minimum": 0 },
"sensor_radius": {
"type": "integer",
"description": "radius from entity in order to check for when block is broken",
"title": "Sensor Radius",
"minimum": 0
},
"on_break": {
"type": "array",
"title": "On Break",
"description": "blocks that will trigger the component when broken and what event will trigger.",
"items": {
"type": "object",
"title": "On Block Broken",
@@ -17,15 +23,17 @@
"block_list": {
"type": "array",
"title": "Block List",
"description": "UNDOCUMENTED",
"$comment": "UNDOCUMENTED",
"items": { "type": "string", "title": "Block ID" }
"description": "list of blocks that will trigger the senor.",
"items": {
"type": "string",
"title": "Block ID",
"description": "A block that will trigger the senor.",
"$ref": "../../../../general/block/identifier.json"
}
},
"on_block_broken": { "type": "string", "title": "On Block Broken", "description": "On block broken" }
"on_block_broken": { "type": "string", "title": "On Block Broken", "description": "Event to run when a block breaks" }
}
},
"description": "UNDOCUMENTED",
"$comment": "UNDOCUMENTED"
}
}
}
}