From b17776699e1edd8a12483d29a3e5535735b3dc57 Mon Sep 17 00:00:00 2001 From: kabou Date: Wed, 2 Mar 2022 15:40:29 +0100 Subject: [PATCH] Add comments to "storage" table. * Document attributes of the "storage" table. --- mods/ENTITIES/mcl_burning/init.lua | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/mods/ENTITIES/mcl_burning/init.lua b/mods/ENTITIES/mcl_burning/init.lua index 3f3d08af15..3496d7af90 100644 --- a/mods/ENTITIES/mcl_burning/init.lua +++ b/mods/ENTITIES/mcl_burning/init.lua @@ -1,6 +1,18 @@ local modpath = minetest.get_modpath(minetest.get_current_modname()) mcl_burning = { + -- the storage table holds a list of objects (players,luaentities) and tables + -- associated with these objects. These tables have the following attributes: + -- burn_time: + -- Remaining time that object will burn. + -- fire_damage_timer: + -- Timer for dealing damage every second while burning. + -- fire_hud_id: + -- HUD id of the flames animation on a burning player's HUD. + -- animation_frame: + -- The HUD's current animation frame, used by update_hud(). + -- collisionbox_cache: + -- Used by mcl_burning.get_collisionbox() to avoid recalculations. storage = {} }