awards/api.lua

210 lines
5.5 KiB
Lua
Raw Normal View History

2013-02-27 13:39:17 +01:00
-- AWARDS
-- by Rubenwardy, CC-BY-SA
-------------------------------------------------------
-- this is api function file
-------------------------------------------------------
2013-11-06 20:36:49 +01:00
-- The global award namespace
awards = {}
2013-02-22 21:43:40 +01:00
-- Table Save Load Functions
2013-11-06 20:36:49 +01:00
function awards.save()
2013-02-22 21:43:40 +01:00
local file = io.open(minetest.get_worldpath().."/awards.txt", "w")
if file then
2013-11-06 19:38:55 +01:00
file:write(minetest.serialize(awards.players))
2013-02-22 21:43:40 +01:00
file:close()
end
end
2013-11-06 20:36:49 +01:00
function awards.load()
2013-02-22 21:43:40 +01:00
local file = io.open(minetest.get_worldpath().."/awards.txt", "r")
if file then
local table = minetest.deserialize(file:read("*all"))
if type(table) == "table" then
return table
end
end
return {}
end
2013-11-06 20:36:49 +01:00
awards.players = awards.load()
2013-11-06 19:38:55 +01:00
function awards.player(name)
return awards.players[player]
end
2013-02-22 21:43:40 +01:00
-- A table of award definitions
2013-11-06 20:36:49 +01:00
awards.def = {}
2013-02-22 21:43:40 +01:00
2013-11-06 19:33:01 +01:00
function awards.tbv(tb,value,default)
if not default then
default = {}
end
2013-11-07 10:02:05 +01:00
if not tb or type(tb) ~= "table" then
2013-11-07 10:05:24 +01:00
if not value then
value = "[NULL]"
end
2013-11-12 09:51:55 +01:00
print("[ERROR] awards.tbv - table '"..value.."' is null, or not a table! Dump: "..dump(tb))
return
end
if not value then
print("[ERROR] awards.tbv was not used correctly!")
print("Value: '"..dump(value).."'")
print("Dump:"..dump(tb))
2013-11-06 19:33:01 +01:00
return
end
if not tb[value] then
tb[value] = default
end
end
2013-02-22 21:43:40 +01:00
-- Load files
dofile(minetest.get_modpath("awards").."/triggers.lua")
dofile(minetest.get_modpath("awards").."/config.txt")
2013-02-22 21:43:40 +01:00
-- API Functions
function awards.register_achievement(name,data_table)
2013-02-27 13:34:38 +01:00
-- see if a trigger is defined in the achievement definition
2013-11-06 19:33:01 +01:00
if data_table.trigger and data_table.trigger.type then
if data_table.trigger.type=="dig" then
2013-02-23 13:02:02 +01:00
local tmp={
award=name,
2013-11-06 19:33:01 +01:00
node=data_table.trigger.node,
target=data_table.trigger.target,
2013-02-23 13:02:02 +01:00
}
table.insert(awards.onDig,tmp)
2013-11-06 19:33:01 +01:00
elseif data_table.trigger.type=="place" then
2013-02-23 13:02:02 +01:00
local tmp={
award=name,
2013-11-06 19:33:01 +01:00
node=data_table.trigger.node,
target=data_table.trigger.target,
2013-02-23 13:02:02 +01:00
}
table.insert(awards.onPlace,tmp)
2013-11-06 19:33:01 +01:00
elseif data_table.trigger.type=="death" then
2013-02-23 16:13:21 +01:00
local tmp={
award=name,
2013-11-06 19:33:01 +01:00
target=data_table.trigger.target,
2013-02-23 16:13:21 +01:00
}
table.insert(awards.onDeath,tmp)
2013-02-23 13:02:02 +01:00
end
end
2013-02-23 13:02:02 +01:00
2013-02-27 13:34:38 +01:00
-- check icon, background and custom_announce data
2013-11-06 19:33:01 +01:00
if data_table.icon == nil or data_table.icon == "" then
data_table.icon = "unknown.png"
end
2013-11-06 19:33:01 +01:00
if data_table.background == nil or data_table.background == "" then
data_table.background = "bg_default.png"
end
2013-11-06 19:33:01 +01:00
if data_table.custom_announce == nil or data_table.custom_announce == "" then
data_table.custom_announce = "Achievement Unlocked:"
end
2013-02-27 13:34:38 +01:00
-- add the achievement to the definition table
2013-11-06 19:33:01 +01:00
awards.def[name] = data_table
2013-02-22 21:43:40 +01:00
end
2013-02-27 13:34:38 +01:00
-- this function adds a trigger function or table to the ondig table
2013-02-22 21:43:40 +01:00
function awards.register_onDig(func)
table.insert(awards.onDig,func);
end
2013-02-27 13:34:38 +01:00
-- this function adds a trigger function or table to the ondig table
2013-02-22 21:43:40 +01:00
function awards.register_onPlace(func)
table.insert(awards.onPlace,func);
end
2013-02-27 13:34:38 +01:00
-- this function adds a trigger function or table to the ondeath table
2013-02-23 16:13:21 +01:00
function awards.register_onDeath(func)
table.insert(awards.onDeath,func);
end
2013-02-27 13:34:38 +01:00
-- This function is called whenever a target condition is met.
-- It checks if a player already has that achievement, and if they do not,
-- it gives it to them
----------------------------------------------
--awards.give_achievement(name,award)
-- name - the name of the player
-- award - the name of the award to give
2013-02-22 21:43:40 +01:00
function awards.give_achievement(name,award)
2013-11-06 19:33:01 +01:00
-- Access Player Data
2013-11-06 19:38:55 +01:00
local data=awards.players[name]
2013-02-22 21:43:40 +01:00
2013-11-06 19:33:01 +01:00
-- Perform checks
if not data then
return
end
if not awards.def[award] then
return
end
awards.tbv(data,"unlocked")
2013-02-27 13:34:38 +01:00
-- check to see if the player does not already have that achievement
2013-11-06 19:33:01 +01:00
if not data.unlocked[award] or data.unlocked[award]~=award then
-- Set award flag
data.unlocked[award]=award
2013-02-22 21:43:40 +01:00
2013-11-06 19:33:01 +01:00
-- Get data from definition tables
2013-02-22 21:43:40 +01:00
local title = award
local desc = ""
2013-11-06 19:33:01 +01:00
local background = ""
local icon = ""
local custom_announce = ""
if awards.def[award].title then
title = awards.def[award].title
2013-02-22 21:43:40 +01:00
end
2013-11-06 19:33:01 +01:00
if awards.def[award].custom_announce then
custom_announce = awards.def[award].custom_announce
end
if awards.def[award].background then
background = awards.def[award].background
end
if awards.def[award].icon then
icon = awards.def[award].icon
end
if awards.def[award] and awards.def[award].description then
desc = awards.def[award].description
2013-02-22 21:43:40 +01:00
end
2013-02-27 13:34:38 +01:00
-- send the won award message to the player
if Use_Formspec == true then
2013-02-27 13:34:38 +01:00
-- use a formspec to send it
minetest.show_formspec(name, "achievements:unlocked", "size[4,2]"..
"image_button_exit[0,0;4,2;"..background..";close1; ]"..
"image_button_exit[0.2,0.8;1,1;"..icon..";close2; ]"..
"label[1.1,1;"..title.."]"..
"label[0.3,0.1;"..custom_announce.."]")
else
2013-02-27 13:34:38 +01:00
-- use the chat console to send it
minetest.chat_send_player(name, "Achievement Unlocked: "..title)
if desc~="" then
minetest.chat_send_player(name, desc)
end
2013-02-22 21:43:40 +01:00
end
2013-02-27 13:34:38 +01:00
-- record this in the log
print(name.." Has unlocked"..title..".")
2013-02-27 13:34:38 +01:00
2013-02-22 21:43:40 +01:00
-- save playertable
2013-11-06 20:36:49 +01:00
awards.save()
2013-02-22 21:43:40 +01:00
end
end
-- List a player's achievements
minetest.register_chatcommand("list_awards", {
params = "",
description = "list_awards: list your awards",
func = function(name, param)
2013-11-07 09:58:40 +01:00
if not awards.players[name] or not awards.players[name].unlocked then
minetest.chat_send_player(name, "You do not have any awards")
return
2013-11-06 19:33:01 +01:00
end
minetest.chat_send_player(name, name.."'s awards:")
2013-02-22 21:43:40 +01:00
2013-11-06 19:38:55 +01:00
for _, str in pairs(awards.players[name].unlocked) do
2013-02-22 21:43:40 +01:00
minetest.chat_send_player(name, str);
end
end,
})