From cb294a5cadc77fe4da3495389a05aa5fed7023af Mon Sep 17 00:00:00 2001 From: AFCMS Date: Sat, 27 Mar 2021 15:27:34 +0100 Subject: [PATCH] Add documentation to mcl_wip (pretty useless...) --- mods/MISC/mcl_wip/API.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 mods/MISC/mcl_wip/API.md diff --git a/mods/MISC/mcl_wip/API.md b/mods/MISC/mcl_wip/API.md new file mode 100644 index 0000000000..e3439af775 --- /dev/null +++ b/mods/MISC/mcl_wip/API.md @@ -0,0 +1,16 @@ +# mcl_wip +Used to mark items or nodes as WIP. + +## mcl_wip.register_wip_item(itemname) +Register as a WIP item. +If isn't a valid itemname, an error will be shown after mods loaded. + +## mcl_wip.register_experimental_item(itemname) +Register as a experimental item. +If isn't a valid itemname, an error will be shown after mods loaded. + +## mcl_wip.registered_wip_items +Table containing WIP items names. + +## mcl_wip.registered_experimental_items +Table containing experimental items names. \ No newline at end of file