Add documentation to mcl_wip (pretty useless...)

This commit is contained in:
AFCMS 2021-03-27 15:27:34 +01:00
parent 9bb5e748b9
commit cb294a5cad
1 changed files with 16 additions and 0 deletions

16
mods/MISC/mcl_wip/API.md Normal file
View File

@ -0,0 +1,16 @@
# mcl_wip
Used to mark items or nodes as WIP.
## mcl_wip.register_wip_item(itemname)
Register <itemname> as a WIP item.
If <itemname> isn't a valid itemname, an error will be shown after mods loaded.
## mcl_wip.register_experimental_item(itemname)
Register <itemname> as a experimental item.
If <itemname> 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.