From d424d4f10e8b37bf4181cfb3c18c09c95994bae0 Mon Sep 17 00:00:00 2001 From: kabou Date: Wed, 2 Mar 2022 16:39:27 +0100 Subject: [PATCH] Add comments to mcl_burning.update_hud(). --- mods/ENTITIES/mcl_burning/api.lua | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/mods/ENTITIES/mcl_burning/api.lua b/mods/ENTITIES/mcl_burning/api.lua index 8cfdded7ef..8093d45f98 100644 --- a/mods/ENTITIES/mcl_burning/api.lua +++ b/mods/ENTITIES/mcl_burning/api.lua @@ -35,6 +35,14 @@ function mcl_burning.get_touching_nodes(obj, nodenames, storage) return nodes end +-- Manages the fire animation on a burning player's HUD +-- +-- Parameters: +-- player - a valid player object; +-- +-- If the player already has a fire HUD, updates the burning animation. +-- If the fire does not have a fire HUD, initializes the HUD. +-- function mcl_burning.update_hud(player) local animation_frames = tonumber(minetest.settings:get("fire_animation_frames")) or 8 local hud_flame_animated = "mcl_burning_hud_flame_animated.png^[opacity:180^[verticalframe:" .. animation_frames .. ":"