From 720cc5440d49a46773256e8403164eae62b19921 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikita=20Wi=C5=9Bniewski?= Date: Mon, 24 Jun 2024 12:56:34 +0700 Subject: [PATCH] Add an introduction text to API.md --- mods/ITEMS/mcl_chests/API.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/mods/ITEMS/mcl_chests/API.md b/mods/ITEMS/mcl_chests/API.md index 4eba2ee51..9d28b3de6 100644 --- a/mods/ITEMS/mcl_chests/API.md +++ b/mods/ITEMS/mcl_chests/API.md @@ -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