awards/api.lua

530 lines
14 KiB
Lua
Raw Normal View History

2014-09-26 21:36:40 +02:00
-- AWARDS
2015-06-10 19:48:20 +02:00
--
-- Copyright (C) 2013-2015 rubenwardy
-- This program is free software; you can redistribute it and/or modify
-- it under the terms of the GNU Lesser General Public License as published by
-- the Free Software Foundation; either version 2.1 of the License, or
-- (at your option) any later version.
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Lesser General Public License for more details.
-- You should have received a copy of the GNU Lesser General Public License along
-- with this program; if not, write to the Free Software Foundation, Inc.,
-- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
--
2013-02-27 13:39:17 +01:00
local S, NS = awards.gettext, awards.ngettext
2017-02-21 08:45:45 +01:00
awards.def = {}
awards.on = {}
awards.on_unlock = {}
2013-11-06 20:36:49 +01:00
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
awards.players = table
2013-02-22 21:43:40 +01:00
end
end
awards.players = {}
2013-02-22 21:43:40 +01:00
end
--
-- local function make_on_reg_wrapper()
-- return function(def)
-- local tmp = {
-- award = def.name,
-- key = def.trigger.node,
-- target = def.trigger.target,
-- }
-- table.insert(awards.on.dig, tmp)
--
-- function def:getProgress(data)
-- local itemcount
-- if tmp.key then
-- itemcount = data["dig"][tmp.key] or 0
-- else
-- itemcount = awards.get_total_keyed_count(data, "dig")
-- end
-- return {
-- perc = itemcount / tmp.target,
-- label = S("@1/@2 dug", itemcount, tmp.target),
-- }
-- end
--
-- function def:getDefaultDescription()
-- local n = self.trigger.target
-- if self.trigger.node then
-- local nname = minetest.registered_nodes[self.trigger.node].description
-- if nname == nil then
-- nname = self.trigger.node
-- end
-- -- Translators: @1 is count, @2 is description.
-- return NS("Mine: @2", "Mine: @1×@2", n, n, nname)
-- else
-- return NS("Mine @1 block.", "Mine @1 blocks.", n, n)
-- end
-- end
-- end
-- end
local function run_trigger_callbacks(self, 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
tdef.run_callbacks = run_trigger_callbacks
if tdef.type == "counted" then
local datakey = tname .. "s"
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[datakey] or 0
return {
perc = done / tmp.target,
label = S(tdef.progress, done, tmp.target),
}
end
function def.getDefaultDescription(_)
local n = self.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
2018-04-04 18:23:46 +02:00
local currentVal = (data[datakey] or 0) + 1
data[datakey] = 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
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
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
2015-06-10 19:39:22 +02:00
awards.def[name] = def
local tdef = awards.def[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)
2015-06-10 20:15:16 +02:00
local awdef = awards.def[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:23:46 +02:00
local lastsound = awards.player(name).lastsound
if lastsound == nil or os.difftime(os.time(), lastsound) >= 1 then
minetest.sound_play(sound, {to_player=name})
2018-04-04 18:23:46 +02:00
awards.player(name).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
2015-06-11 18:35:32 +02:00
-- Backwards compatibility
awards.give_achievement = awards.unlock
2014-05-02 19:35:11 +02:00
--[[minetest.register_chatcommand("gawd", {
2014-05-02 19:19:42 +02:00
params = "award name",
description = "gawd: give award to self",
func = function(name, param)
2015-06-11 18:35:32 +02:00
awards.unlock(name,param)
2014-05-02 19:19:42 +02:00
end
2014-05-02 19:35:11 +02:00
})]]--
2014-05-02 19:19:42 +02:00
2016-07-29 17:23:34 +02:00
function awards.getFormspec(name, to, sid)
2016-08-01 23:39:32 +02:00
local formspec = ""
2016-07-29 17:23:34 +02:00
local listofawards = awards._order_awards(name)
2018-04-04 18:23:46 +02:00
local playerdata = awards.player(name)
2016-07-29 17:23:34 +02:00
if #listofawards == 0 then
formspec = formspec .. "label[3.9,1.5;"..minetest.formspec_escape(S("Error: No awards available.")).."]"
formspec = formspec .. "button_exit[4.2,2.3;3,1;close;"..minetest.formspec_escape(S("OK")).."]"
return formspec
end
2016-07-29 17:23:34 +02:00
-- Sidebar
if sid then
local item = listofawards[sid+0]
local def = awards.def[item.name]
2016-07-29 17:23:34 +02:00
if def and def.secret and not item.got then
formspec = formspec .. "label[1,2.75;"..minetest.formspec_escape(S("(Secret Award)")).."]"..
"image[1,0;3,3;awards_unknown.png]"
2016-07-29 17:23:34 +02:00
if def and def.description then
formspec = formspec .. "textarea[0.25,3.25;4.8,1.7;;"..minetest.formspec_escape(S("Unlock this award to find out what it is."))..";]"
2016-07-29 17:23:34 +02:00
end
else
local title = item.name
if def and def.title then
title = def.title
end
local status = "%s"
2016-07-29 17:23:34 +02:00
if item.got then
status = S("%s (got)")
2016-07-29 17:23:34 +02:00
end
formspec = formspec .. "textarea[0.5,2.7;4.8,1.45;;" ..
string.format(status, minetest.formspec_escape(title)) ..
";]"
2018-04-04 16:35:56 +02:00
2016-07-29 17:23:34 +02:00
if def and def.icon then
formspec = formspec .. "image[1,0;3,3;" .. def.icon .. "]"
end
2016-08-01 21:27:12 +02:00
local barwidth = 4.6
local perc = nil
local label = nil
if def.getProgress and playerdata then
local res = def:getProgress(playerdata)
perc = res.perc
label = res.label
end
if perc then
if perc > 1 then
perc = 1
end
2016-08-01 23:39:32 +02:00
formspec = formspec .. "background[0,4.80;" .. barwidth ..",0.25;awards_progress_gray.png;false]"
formspec = formspec .. "background[0,4.80;" .. (barwidth * perc) ..",0.25;awards_progress_green.png;false]"
2016-08-01 21:27:12 +02:00
if label then
formspec = formspec .. "label[1.75,4.63;" .. minetest.formspec_escape(label) .. "]"
2016-08-01 21:27:12 +02:00
end
end
2016-07-29 17:23:34 +02:00
if def and def.description then
formspec = formspec .. "textarea[0.25,3.75;4.8,1.7;;"..minetest.formspec_escape(def.description)..";]"
2016-07-29 17:23:34 +02:00
end
end
end
-- Create list box
formspec = formspec .. "textlist[4.75,0;6,5;awards;"
local first = true
for _,award in pairs(listofawards) do
local def = awards.def[award.name]
if def then
if not first then
formspec = formspec .. ","
end
first = false
if def.secret and not award.got then
formspec = formspec .. "#707070"..minetest.formspec_escape(S("(Secret Award)"))
2016-07-29 17:23:34 +02:00
else
local title = award.name
if def and def.title then
title = def.title
end
if award.got then
formspec = formspec .. minetest.formspec_escape(title)
else
formspec = formspec .. "#ACACAC".. minetest.formspec_escape(title)
end
end
end
end
return formspec .. ";"..sid.."]"
end
2015-06-11 18:51:36 +02:00
function awards.show_to(name, to, sid, text)
2014-05-02 21:09:54 +02:00
if name == "" or name == nil then
name = to
end
2015-06-11 18:51:36 +02:00
if name == to and awards.player(to).disabled then
minetest.chat_send_player(S("You've disabled awards. Type /awards enable to reenable."))
2015-06-11 18:51:36 +02:00
return
end
2014-05-02 19:19:42 +02:00
if text then
local listofawards = awards._order_awards(name)
if #listofawards == 0 then
minetest.chat_send_player(to, S("Error: No awards available."))
return
2018-04-04 18:23:46 +02:00
elseif not awards.player(name) or not awards.player(name).unlocked then
minetest.chat_send_player(to, S("You have not unlocked any awards."))
2013-11-07 09:58:40 +01:00
return
2013-11-06 19:33:01 +01:00
end
minetest.chat_send_player(to, string.format(S("%ss awards:"), name))
2013-02-22 21:43:40 +01:00
2018-04-04 18:23:46 +02:00
for _, str in pairs(awards.player(name).unlocked) do
2014-05-02 21:09:54 +02:00
local def = awards.def[str]
if def then
if def.title then
if def.description then
minetest.chat_send_player(to, string.format(S("%s: %s"), def.title, def.description))
else
minetest.chat_send_player(to, def.title)
end
2014-05-02 21:09:54 +02:00
else
minetest.chat_send_player(to, str)
2014-05-02 21:09:54 +02:00
end
end
2013-02-22 21:43:40 +01:00
end
2014-05-02 19:19:42 +02:00
else
if sid == nil or sid < 1 then
sid = 1
end
local deco = ""
if minetest.global_exists("default") then
deco = default.gui_bg .. default.gui_bg_img
end
2014-05-02 19:35:11 +02:00
-- Show formspec to user
2016-08-01 23:39:32 +02:00
minetest.show_formspec(to,"awards:awards",
"size[11,5]" .. deco ..
awards.getFormspec(name, to, sid))
2014-05-02 19:19:42 +02:00
end
end
2015-06-11 18:51:36 +02:00
awards.showto = awards.show_to
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)