awards/api.lua

483 lines
11 KiB
Lua
Raw Normal View History

2018-04-04 23:57:27 +02:00
-- Copyright (c) 2013-18 rubenwardy. MIT.
2013-02-27 13:39:17 +01:00
local S, NS = awards.gettext, awards.ngettext
2017-02-21 08:45:45 +01:00
awards.registered_awards = {}
awards.on = {}
awards.on_unlock = {}
2013-11-06 20:36:49 +01:00
local storage = minetest.get_mod_storage()
2013-02-22 21:43:40 +01:00
-- Table Save Load Functions
2013-11-06 20:36:49 +01:00
function awards.save()
storage:set_string("player_data", minetest.write_json(awards.players))
end
local function convert_data()
minetest.log("warning", "Importing awards data from previous version")
2018-04-04 22:04:54 +02:00
local old_players = awards.players
awards.players = {}
for name, data in pairs(old_players) do
while name.name do
name = name.name
end
data.name = name
print("Converting data for " .. name)
-- Just rename counted
local counted = {
chats = "chat",
deaths = "death",
joins = "join",
}
for from, to in pairs(counted) do
data[to] = data[from]
data[from] = nil
end
2018-04-04 21:55:33 +02:00
data.death = {
unknown = data.death,
__total = data.death,
}
-- Convert item db to new format
local counted_items = {
count = "dig",
place = "place",
craft = "craft",
}
for from, to in pairs(counted_items) do
local ret = {}
local count = 0
for modname, items in pairs(data[from]) do
for itemname, value in pairs(items) do
itemname = modname .. ":" .. itemname
local key = minetest.registered_aliases[itemname] or itemname
ret[key] = value
count = count + value
end
end
ret.__total = count
data[from] = nil
data[to] = ret
end
2018-04-04 22:04:54 +02:00
awards.players[name] = data
2013-02-22 21:43:40 +01:00
end
2018-04-04 22:04:54 +02:00
print(dump(awards.players))
2013-02-22 21:43:40 +01:00
end
2013-11-06 20:36:49 +01:00
function awards.load()
local old_save_path = minetest.get_worldpath().."/awards.txt"
local file = io.open(old_save_path, "r")
2013-02-22 21:43:40 +01:00
if file then
local table = minetest.deserialize(file:read("*all"))
if type(table) == "table" then
awards.players = table
convert_data()
else
awards.players = {}
2013-02-22 21:43:40 +01:00
end
file:close()
os.rename(old_save_path, minetest.get_worldpath().."/awards.bk.txt")
2018-04-04 22:04:54 +02:00
awards.save()
else
awards.players = minetest.parse_json(storage:get_string("player_data")) or {}
2013-02-22 21:43:40 +01:00
end
end
2018-04-04 18:42:12 +02:00
function awards.player(name)
2018-04-05 14:06:09 +02:00
assert(type(name) == "string")
2018-04-04 18:42:12 +02:00
local data = awards.players[name] or {}
awards.players[name] = data
data.name = data.name or name
data.unlocked = data.unlocked or {}
return data
end
function awards.player_or_nil(name)
return awards.players[name]
end
2018-04-04 19:39:06 +02:00
local default_def = {}
function default_def:run_callbacks(player, data, table_func)
for i = 1, #self.on do
2016-07-29 18:14:57 +02:00
local res = nil
local entry = self.on[i]
2016-07-29 18:14:57 +02:00
if type(entry) == "function" then
res = entry(player, data)
elseif type(entry) == "table" and entry.award then
res = table_func(entry)
end
if res then
awards.unlock(player:get_player_name(), res)
end
end
end
function awards.register_trigger(tname, tdef)
2018-04-04 18:23:46 +02:00
assert(type(tdef) == "table",
"Passing a callback to register_trigger is not supported in 3.0")
tdef.name = tname
2018-04-04 19:39:06 +02:00
for key, value in pairs(default_def) do
tdef[key] = value
end
if tdef.type == "counted" then
local old_reg = tdef.on_register
function tdef:on_register(def)
local tmp = {
award = def.name,
target = def.trigger.target,
}
tdef.register(tmp)
function def.getProgress(_, data)
local done = data[tname] or 0
return {
perc = done / tmp.target,
label = S(tdef.progress, done, tmp.target),
}
end
function def.getDefaultDescription(_)
2018-04-04 22:11:40 +02:00
local n = def.trigger.target
return NS(tdef.auto_description[1], tdef.auto_description[2], n, n)
end
if old_reg then
return old_reg(tdef, def)
end
end
function tdef.notify(player)
assert(player and player.is_player and player:is_player())
local name = player:get_player_name()
local data = awards.player(name)
print(dump(data))
-- Increment counter
local currentVal = (data[tname] or 0) + 1
data[tname] = currentVal
tdef:run_callbacks(player, data, function(entry)
if entry.target and entry.award and currentVal and
currentVal >= entry.target then
return entry.award
end
end)
end
awards["notify_" .. tname] = tdef.notify
2018-04-04 19:30:47 +02:00
elseif tdef.type == "counted_key" then
local old_reg = tdef.on_register
function tdef:on_register(def)
local tmp = {
award = def.name,
key = tdef:get_key(def),
target = def.trigger.target,
}
tdef.register(tmp)
function def.getProgress(_, data)
local done
data[tname] = data[tname] or {}
2018-04-04 19:30:47 +02:00
if tmp.key then
done = data[tname][tmp.key] or 0
2018-04-04 19:30:47 +02:00
else
done = data[tname].__total or 0
2018-04-04 19:30:47 +02:00
end
return {
perc = done / tmp.target,
label = S(tdef.progress, done, tmp.target),
}
end
function def.getDefaultDescription(_)
2018-04-04 22:11:40 +02:00
local n = def.trigger.target
2018-04-04 19:30:47 +02:00
if tmp.key then
local nname = tmp.key
return NS(tdef.auto_description[1],
tdef.auto_description[2], n, n, nname)
else
return NS(tdef.auto_description_total[1],
tdef.auto_description_total[2], n, n)
end
end
if old_reg then
return old_reg(tdef, def)
end
end
function tdef.notify(player, key, n)
n = n or 1
assert(player and player.is_player and player:is_player() and key)
local name = player:get_player_name()
local data = awards.player(name)
print(dump(data))
-- Increment counter
data[tname] = data[tname] or {}
local currentVal = (data[tname][key] or 0) + n
data[tname][key] = currentVal
data[tname].__total = (data[tname].__total or 0) + n
2018-04-04 19:30:47 +02:00
tdef:run_callbacks(player, data, function(entry)
local current
if entry.key == key then
current = currentVal
elseif entry.key == nil then
current = data[tname].__total
2018-04-04 19:30:47 +02:00
else
return
end
if current >= entry.target then
2018-04-04 19:30:47 +02:00
return entry.award
end
end)
end
awards["notify_" .. tname] = tdef.notify
elseif tdef.type and tdef.type ~= "custom" then
error("Unrecognised trigger type " .. tdef.type)
end
awards.registered_triggers[tname] = tdef
tdef.on = {}
tdef.register = function(func)
table.insert(tdef.on, func)
end
-- Backwards compat
awards.on[tname] = tdef.on
awards['register_on_' .. tname] = tdef.register
2018-04-04 19:02:43 +02:00
return tdef
end
function awards.increment_item_counter(data, field, itemname, count)
itemname = minetest.registered_aliases[itemname] or itemname
data[field][itemname] = (data[field][itemname] or 0) + 1
end
2016-08-01 21:27:12 +02:00
function awards.get_item_count(data, field, itemname)
itemname = minetest.registered_aliases[itemname] or itemname
return data[field][itemname] or 0
end
2016-08-01 21:27:12 +02:00
function awards.get_total_keyed_count(data, field)
return data[field].__total or 0
2016-08-01 21:27:12 +02:00
end
2015-06-10 20:15:16 +02:00
function awards.register_on_unlock(func)
table.insert(awards.on_unlock, func)
end
2015-06-10 19:39:22 +02:00
function awards.register_achievement(name, def)
2015-06-10 20:15:16 +02:00
def.name = name
2015-06-10 19:39:22 +02:00
-- Add Triggers
if def.trigger and def.trigger.type then
local tdef = awards.registered_triggers[def.trigger.type]
assert(tdef, "Trigger not found: " .. def.trigger.type)
tdef:on_register(def)
end
2013-02-23 13:02:02 +01:00
2015-06-11 18:35:32 +02:00
-- Add Award
awards.registered_awards[name] = def
local tdef = awards.registered_awards[name]
if def.description == nil and tdef.getDefaultDescription then
def.description = tdef:getDefaultDescription()
end
end
2015-06-11 18:51:36 +02:00
function awards.enable(name)
local data = awards.player(name)
if data then
data.disabled = nil
end
end
function awards.disable(name)
local data = awards.player(name)
if data then
data.disabled = true
end
end
function awards.clear_player(name)
awards.players[name] = {}
2015-06-11 18:51:36 +02:00
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
----------------------------------------------
2015-06-11 18:51:36 +02:00
--awards.unlock(name, award)
2013-02-27 13:34:38 +01:00
-- name - the name of the player
-- award - the name of the award to give
2015-06-11 18:35:32 +02:00
function awards.unlock(name, award)
2013-11-06 19:33:01 +01:00
-- Access Player Data
2018-04-04 18:23:46 +02:00
local data = awards.player(name)
local awdef = awards.registered_awards[award]
2018-04-04 18:23:46 +02:00
assert(awdef, "Unable to unlock an award which doesn't exist!")
2018-04-04 18:23:46 +02:00
if data.disabled or
(data.unlocked[award] and data.unlocked[award] == award) then
2015-06-10 20:15:16 +02:00
return
end
2014-09-26 21:55:44 +02:00
2015-06-11 18:35:32 +02:00
-- Unlock Award
minetest.log("action", name.." has unlocked award "..name)
2015-06-10 20:15:16 +02:00
data.unlocked[award] = award
2015-06-11 18:35:32 +02:00
awards.save()
2013-02-22 21:43:40 +01:00
2015-06-10 20:15:16 +02:00
-- Give Prizes
if awdef and awdef.prizes then
for i = 1, #awdef.prizes do
local itemstack = ItemStack(awdef.prizes[i])
2016-07-29 18:30:59 +02:00
if not itemstack:is_empty() then
local receiverref = minetest.get_player_by_name(name)
if receiverref then
receiverref:get_inventory():add_item("main", itemstack)
end
end
2013-02-22 21:43:40 +01:00
end
2015-06-10 20:15:16 +02:00
end
-- Run callbacks
if awdef.on_unlock and awdef.on_unlock(name, awdef) then
return
end
for _, callback in pairs(awards.on_unlock) do
if callback(name, awdef) then
return
end
end
2015-06-11 18:35:32 +02:00
-- Get Notification Settings
local title = awdef.title or award
local desc = awdef.description or ""
local background = awdef.background or "awards_bg_default.png"
local icon = awdef.icon or "awards_unknown.png"
local sound = awdef.sound
if sound == nil then
-- Explicit check for nil because sound could be `false` to disable it
sound = {name="awards_got_generic", gain=0.25}
end
2015-06-11 18:35:32 +02:00
-- Do Notification
if sound then
-- Enforce sound delay to prevent sound spamming
2018-04-04 18:32:37 +02:00
local lastsound = data.lastsound
if lastsound == nil or os.difftime(os.time(), lastsound) >= 1 then
minetest.sound_play(sound, {to_player=name})
2018-04-04 18:32:37 +02:00
data.lastsound = os.time()
end
end
2018-04-04 16:46:11 +02:00
if awards.show_mode == "chat" then
local chat_announce
if awdef.secret == true then
chat_announce = S("Secret Achievement Unlocked: %s")
else
chat_announce = S("Achievement Unlocked: %s")
end
2015-06-10 20:15:16 +02:00
-- use the chat console to send it
minetest.chat_send_player(name, string.format(chat_announce, title))
2015-06-10 20:15:16 +02:00
if desc~="" then
minetest.chat_send_player(name, desc)
end
else
local player = minetest.get_player_by_name(name)
local one = player:hud_add({
hud_elem_type = "image",
name = "award_bg",
scale = {x = 2, y = 1},
2015-06-10 20:15:16 +02:00
text = background,
position = {x = 0.5, y = 0},
offset = {x = 0, y = 138},
alignment = {x = 0, y = -1}
})
local hud_announce
if awdef.secret == true then
hud_announce = S("Secret Achievement Unlocked!")
else
hud_announce = S("Achievement Unlocked!")
end
2015-06-10 20:15:16 +02:00
local two = player:hud_add({
hud_elem_type = "text",
name = "award_au",
number = 0xFFFFFF,
scale = {x = 100, y = 20},
text = hud_announce,
2015-06-10 20:15:16 +02:00
position = {x = 0.5, y = 0},
offset = {x = 0, y = 40},
alignment = {x = 0, y = -1}
})
local three = player:hud_add({
hud_elem_type = "text",
name = "award_title",
number = 0xFFFFFF,
scale = {x = 100, y = 20},
text = title,
position = {x = 0.5, y = 0},
offset = {x = 30, y = 100},
alignment = {x = 0, y = -1}
})
local four = player:hud_add({
hud_elem_type = "image",
name = "award_icon",
scale = {x = 4, y = 4},
text = icon,
position = {x = 0.4, y = 0},
2015-06-10 20:15:16 +02:00
offset = {x = -81.5, y = 126},
alignment = {x = 0, y = -1}
})
minetest.after(4, function()
2015-06-10 20:15:16 +02:00
player:hud_remove(one)
player:hud_remove(two)
player:hud_remove(three)
player:hud_remove(four)
end)
2013-02-22 21:43:40 +01:00
end
end
2014-05-02 19:19:42 +02:00
minetest.register_on_player_receive_fields(function(player, formname, fields)
2015-06-11 18:51:36 +02:00
if formname ~= "awards:awards" then
2014-05-02 19:19:42 +02:00
return false
end
if fields.quit then
return true
end
local name = player:get_player_name()
if fields.awards then
local event = minetest.explode_textlist_event(fields.awards)
if event.type == "CHG" then
2015-06-11 18:51:36 +02:00
awards.show_to(name, name, event.index, false)
end
2014-05-02 19:19:42 +02:00
end
2014-05-02 19:19:42 +02:00
return true
end)
2015-06-10 19:39:22 +02:00
awards.load()
2016-07-29 18:14:57 +02:00
minetest.register_on_shutdown(function()
awards.save()
end)