summaryrefslogtreecommitdiff
path: root/areas
diff options
context:
space:
mode:
authorVanessa Ezekowitz <vanessaezekowitz@gmail.com>2017-01-31 19:39:31 -0500
committerVanessa Ezekowitz <vanessaezekowitz@gmail.com>2017-01-31 19:39:31 -0500
commit39f5cba27eef35877c91291f518974f34130fcb6 (patch)
tree117a9d1b7d4ee5f78f73e1216e982c366ed9ecc6 /areas
parent2922421f4a88e56a0a1c819f62bf2bc287835388 (diff)
downloaddreambuilder_modpack-39f5cba27eef35877c91291f518974f34130fcb6.tar
dreambuilder_modpack-39f5cba27eef35877c91291f518974f34130fcb6.tar.gz
dreambuilder_modpack-39f5cba27eef35877c91291f518974f34130fcb6.tar.bz2
dreambuilder_modpack-39f5cba27eef35877c91291f518974f34130fcb6.tar.xz
dreambuilder_modpack-39f5cba27eef35877c91291f518974f34130fcb6.zip
Huge update - lots of mods:
areas, biome_lib, blox, bobblocks, boost_cart, homedecor, mobs, coloredwood, ilights, inbox, item_tweaks, moreblocks, moreores, pipeworks, plasticbox, signs_lib, stainedglass, roads, unifieddyes, vines, worldedit, xban2, maybe some others I didn't think about ;-)
Diffstat (limited to 'areas')
-rw-r--r--areas/api.lua16
-rw-r--r--areas/api.md45
-rw-r--r--areas/hud.lua10
-rw-r--r--areas/mod.conf1
4 files changed, 72 insertions, 0 deletions
diff --git a/areas/api.lua b/areas/api.lua
index e8b9c7a..730e96d 100644
--- a/areas/api.lua
+++ b/areas/api.lua
@@ -1,7 +1,23 @@
+local hudHandlers = {}
+
+--- Adds a function as a HUD handler, it will be able to add items to the Areas HUD element.
+function areas:registerHudHandler(handler)
+ table.insert(hudHandlers, handler)
+end
+
+
+function areas:getExternalHudEntries(pos)
+ local areas = {}
+ for _, func in pairs(hudHandlers) do
+ func(pos, areas)
+ end
+ return areas
+end
--- Returns a list of areas that include the provided position.
function areas:getAreasAtPos(pos)
local res = {}
+
if self.store then
local a = self.store:get_areas_for_pos(pos, false, true)
for store_id, store_area in pairs(a) do
diff --git a/areas/api.md b/areas/api.md
new file mode 100644
index 0000000..c74b4c7
--- /dev/null
+++ b/areas/api.md
@@ -0,0 +1,45 @@
+Areas mod API
+===
+
+API list
+---
+
+ * `areas.registerHudHandler(handler)` - Registers a handler to add items to the Areas HUD. See [HUD](#hud).
+
+
+HUD
+---
+
+If you are making a protection mod or a similar mod that adds invisible regions
+to the world, and you would like then to show up in the areas HUD element, you
+can register a callback to show your areas.
+
+HUD handler specification:
+
+ * `handler(pos, list)`
+ * `pos` - The position to check.
+ * `list` - The list of area HUD elements, this should be modified in-place.
+
+The area list item is a table containing a list of tables with the following fields:
+
+ * `id` - An identifier for the area. This should be a unique string in the format `mod:id`.
+ * `name` - The name of the area.
+ * `owner` - The player name of the region owner, if any.
+
+All of the fields are optional but at least one of them must be set.
+
+### Example
+
+ local function areas_hud_handler(pos, areas)
+ local val = find_my_protection(pos)
+
+ if val then
+ table.insert(areas, {
+ id = "mod:"..val.id,
+ name = val.name,
+ owner = val.owner,
+ })
+ end
+ end
+
+ areas:registerHudHandler(areas_hud_handler)
diff --git a/areas/hud.lua b/areas/hud.lua
index 4908b92..0b7931f 100644
--- a/areas/hud.lua
+++ b/areas/hud.lua
@@ -7,11 +7,21 @@ minetest.register_globalstep(function(dtime)
local name = player:get_player_name()
local pos = vector.round(player:getpos())
local areaStrings = {}
+
for id, area in pairs(areas:getAreasAtPos(pos)) do
table.insert(areaStrings, ("%s [%u] (%s%s)")
:format(area.name, id, area.owner,
area.open and ":open" or ""))
end
+
+ for i, area in pairs(areas:getExternalHudEntries(pos)) do
+ local str = ""
+ if area.name then str = area.name .. " " end
+ if area.id then str = str.."["..area.id.."] " end
+ if area.owner then str = str.."("..area.owner..")" end
+ table.insert(areaStrings, str)
+ end
+
local areaString = "Areas:"
if #areaStrings > 0 then
areaString = areaString.."\n"..
diff --git a/areas/mod.conf b/areas/mod.conf
new file mode 100644
index 0000000..0ca8ec1
--- /dev/null
+++ b/areas/mod.conf
@@ -0,0 +1 @@
+name = areas