diff --git a/README.md b/README.md index fdd8e4e..011f72d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,19 @@ A wrapper for more easily managing Minetest HUDs # API You can add this mod as a dependency in your mod.conf, or you can copy the `mhud.lua` file into your mod and use it that way +Example usage: +```lua +local hud = mhud.init() +hud:add(player, "test_hud", { + hud_elem_type = "text", + position = {x = 1, y = 0}, + offset = {x = -6, y = 6}, + alignment = {x = "left", y = "down"}, + text = "Hello there", + color = 0x00FF00, +}) +``` + ## Mod-Specific Functions * `mhud.init()` diff --git a/mhud.lua b/mhud.lua index d235f13..bf96f7a 100644 --- a/mhud.lua +++ b/mhud.lua @@ -2,7 +2,7 @@ local hud = { huds = {} } -local function Obj(player) +local function get_playerobj(player) if type(player) == "string" then return minetest.get_player_by_name(player) else @@ -76,7 +76,7 @@ local function convert_def(def, type) end function hud.add(self, player, name, def) - player = Obj(player) + player = get_playerobj(player) local pname = player:get_player_name() if not def then @@ -101,7 +101,7 @@ function hud.add(self, player, name, def) end function hud.get(self, player, name) - player = Obj(player) + player = get_playerobj(player) local pname = player:get_player_name() if self.huds[pname] then @@ -111,7 +111,7 @@ end hud.exists = hud.get function hud.change(self, player, name, def) - player = Obj(player) + player = get_playerobj(player) local pname = player:get_player_name() assert(self.huds[pname][name], "Attempt to change hud that doesn't exist!") @@ -125,7 +125,7 @@ function hud.change(self, player, name, def) end function hud.remove(self, player, name) - player = Obj(player) + player = get_playerobj(player) local pname = player:get_player_name() if name then diff --git a/mod.conf b/mod.conf new file mode 100644 index 0000000..a3ec8fe --- /dev/null +++ b/mod.conf @@ -0,0 +1 @@ +name = mhud