1
0
Fork 0

Add comments to "storage" table.

* Document attributes of the "storage" table.
This commit is contained in:
kabou 2022-03-02 15:40:29 +01:00
parent 86a4ece7d2
commit b17776699e
1 changed files with 12 additions and 0 deletions

View File

@ -1,6 +1,18 @@
local modpath = minetest.get_modpath(minetest.get_current_modname()) local modpath = minetest.get_modpath(minetest.get_current_modname())
mcl_burning = { 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 = {} storage = {}
} }