Minetest/VoxeLibre
2
0
Fork 0
mirror of https://git.minetest.land/VoxeLibre/VoxeLibre.git synced 2024-11-22 02:21:06 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add an introduction text to API.md

Browse source
This commit is contained in:
Mikita Wiśniewski 2024-06-24 12:56:34 +07:00 committed by the-real-herowl
parent 49b6d09985
commit 76cff76d91
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
mods/ITEMS/mcl_chests/API.md
View file

@ -1,5 +1,16 @@
# `mcl_chests` API
When reading through this documentation, please keep in mind that the chest
animations are achieved by giving each chest node an entity, as Minetest (as of
5.8.1) doesn't support giving nodes animated meshes, only static ones.
Because of that, a lot of parameters passed through the exposed functions are
be related to nodes and entities.
Please refer to [Minetest documentation](http://api.minetest.net/) and the code
comments in `api.lua`.
## `mcl_chests.register_chest(basename, definition)`
This function allows for simple chest registration, used by both regular and