forked from nalc/awards
424 lines
11 KiB
Lua
424 lines
11 KiB
Lua
-- AWARDS
|
|
-- by Rubenwardy, CC-BY-SA
|
|
-------------------------------------------------------
|
|
-- this is api function file
|
|
-------------------------------------------------------
|
|
|
|
-- The global award namespace
|
|
awards = {}
|
|
|
|
-- Table Save Load Functions
|
|
function awards.save()
|
|
local file = io.open(minetest.get_worldpath().."/awards.txt", "w")
|
|
if file then
|
|
file:write(minetest.serialize(awards.players))
|
|
file:close()
|
|
end
|
|
end
|
|
|
|
function awards.load()
|
|
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
|
|
|
|
awards.players = awards.load()
|
|
function awards.player(name)
|
|
return awards.players[name]
|
|
end
|
|
|
|
-- A table of award definitions
|
|
awards.def = {}
|
|
|
|
function awards.tbv(tb,value,default)
|
|
if not default then
|
|
default = {}
|
|
end
|
|
if not tb or type(tb) ~= "table" then
|
|
if not value then
|
|
value = "[NULL]"
|
|
end
|
|
minetest.log("error", "awards.tbv - table "..dump(value).." is null, or not a table! Dump: "..dump(tb))
|
|
return
|
|
end
|
|
if not value then
|
|
error("[ERROR] awards.tbv was not used correctly!\n"..
|
|
"Value: '"..dump(value).."'\n"..
|
|
"Dump:"..dump(tb))
|
|
return
|
|
end
|
|
if not tb[value] then
|
|
tb[value] = default
|
|
end
|
|
end
|
|
|
|
function awards.assertPlayer(playern)
|
|
awards.tbv(awards.players, playern)
|
|
awards.tbv(awards.players[playern], "name", playern)
|
|
awards.tbv(awards.players[playern], "unlocked")
|
|
awards.tbv(awards.players[playern], "place")
|
|
awards.tbv(awards.players[playern], "count")
|
|
awards.tbv(awards.players[playern], "deaths", 0)
|
|
awards.tbv(awards.players[playern], "joins", 0)
|
|
awards.tbv(awards.players[playern], "chats", 0)
|
|
end
|
|
|
|
-- Load files
|
|
dofile(minetest.get_modpath("awards").."/triggers.lua")
|
|
dofile(minetest.get_modpath("awards").."/config.txt")
|
|
|
|
-- API Functions
|
|
function awards._additional_triggers(name, data_table)
|
|
-- To add triggers in another mod, you should override this function
|
|
-- If the code can't handle the trigger passed, then call the last value of _additional_triggers
|
|
--[[
|
|
local add_trig = awards._additional_triggers
|
|
awards._additional_triggers = function(name, data_table)
|
|
if data_table.trigger.type == "trigger" then
|
|
local tmp = {
|
|
award = name,
|
|
node = data_table.trigger.node,
|
|
target = data_table.trigger.target,
|
|
}
|
|
table.insert(awards.onTrigger,tmp)
|
|
elseif data_table.trigger.type == "trigger2" then
|
|
local tmp = {
|
|
award = name,
|
|
node = data_table.trigger.node,
|
|
target = data_table.trigger.target,
|
|
}
|
|
table.insert(awards.onTrigger2,tmp)
|
|
else
|
|
add_trig(name, data_table)
|
|
end
|
|
end
|
|
]]--
|
|
end
|
|
function awards.register_achievement(name,data_table)
|
|
-- see if a trigger is defined in the achievement definition
|
|
if data_table.trigger and data_table.trigger.type then
|
|
if data_table.trigger.type == "dig" then
|
|
local tmp = {
|
|
award = name,
|
|
node = data_table.trigger.node,
|
|
target = data_table.trigger.target,
|
|
}
|
|
table.insert(awards.onDig,tmp)
|
|
elseif data_table.trigger.type == "place" then
|
|
local tmp = {
|
|
award = name,
|
|
node = data_table.trigger.node,
|
|
target = data_table.trigger.target,
|
|
}
|
|
table.insert(awards.onPlace,tmp)
|
|
elseif data_table.trigger.type == "death" then
|
|
local tmp = {
|
|
award = name,
|
|
target = data_table.trigger.target,
|
|
}
|
|
table.insert(awards.onDeath,tmp)
|
|
elseif data_table.trigger.type == "chat" then
|
|
local tmp = {
|
|
award = name,
|
|
target = data_table.trigger.target,
|
|
}
|
|
table.insert(awards.onChat,tmp)
|
|
elseif data_table.trigger.type == "join" then
|
|
local tmp = {
|
|
award = name,
|
|
target = data_table.trigger.target,
|
|
}
|
|
table.insert(awards.onJoin,tmp)
|
|
else
|
|
awards._additional_triggers(name, data_table)
|
|
end
|
|
end
|
|
|
|
-- check icon, background and custom_announce data
|
|
if data_table.icon == nil or data_table.icon == "" then
|
|
data_table.icon = "unknown.png"
|
|
end
|
|
if data_table.background == nil or data_table.background == "" then
|
|
data_table.background = "bg_default.png"
|
|
end
|
|
if data_table.custom_announce == nil or data_table.custom_announce == "" then
|
|
data_table.custom_announce = "Achievement Unlocked:"
|
|
end
|
|
|
|
-- add the achievement to the definition table
|
|
data_table.name = name
|
|
awards.def[name] = data_table
|
|
end
|
|
|
|
-- run a function when a node is dug
|
|
function awards.register_onDig(func)
|
|
table.insert(awards.onDig,func)
|
|
end
|
|
|
|
-- run a function when a node is placed
|
|
function awards.register_onPlace(func)
|
|
table.insert(awards.onPlace,func)
|
|
end
|
|
|
|
-- run a function when a player dies
|
|
function awards.register_onDeath(func)
|
|
table.insert(awards.onDeath,func)
|
|
end
|
|
|
|
-- run a function when a player chats
|
|
function awards.register_onChat(func)
|
|
table.insert(awards.onChat,func)
|
|
end
|
|
|
|
-- run a function when a player joins
|
|
function awards.register_onJoin(func)
|
|
table.insert(awards.onJoin,func)
|
|
end
|
|
|
|
-- 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
|
|
function awards.give_achievement(name,award)
|
|
-- Access Player Data
|
|
local data = awards.players[name]
|
|
|
|
-- Perform checks
|
|
if not data then
|
|
return
|
|
end
|
|
if not awards.def[award] then
|
|
return
|
|
end
|
|
awards.tbv(data,"unlocked")
|
|
|
|
-- check to see if the player does not already have that achievement
|
|
if not data.unlocked[award] or data.unlocked[award]~=award then
|
|
-- Set award flag
|
|
data.unlocked[award]=award
|
|
|
|
-- Get data from definition tables
|
|
local title = award
|
|
local desc = ""
|
|
local background = ""
|
|
local icon = ""
|
|
local custom_announce = ""
|
|
if awards.def[award].title then
|
|
title = awards.def[award].title
|
|
end
|
|
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
|
|
end
|
|
|
|
-- send the won award message to the player
|
|
if Use_Formspec == true then
|
|
-- 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
|
|
-- 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
|
|
end
|
|
|
|
-- record this in the log
|
|
minetest.log("action", name.." has unlocked award "..title)
|
|
|
|
-- save playertable
|
|
awards.save()
|
|
end
|
|
end
|
|
|
|
-- List a player's achievements
|
|
minetest.register_chatcommand("list_awards", {
|
|
params = "obsolete",
|
|
description = "list_awards: obsolete. Use /awards",
|
|
func = function(name, param)
|
|
minetest.chat_send_player(name, "This command has been made obsolete. Use /awards instead.")
|
|
awards.showto(name, name, nil, false)
|
|
end
|
|
})
|
|
minetest.register_chatcommand("awards", {
|
|
params = "",
|
|
description = "awards: list awards",
|
|
func = function(name, param)
|
|
awards.showto(name, name, nil, false)
|
|
end
|
|
})
|
|
minetest.register_chatcommand("cawards", {
|
|
params = "",
|
|
description = "awards: list awards in chat",
|
|
func = function(name, param)
|
|
awards.showto(name, name, nil, true)
|
|
end
|
|
})
|
|
minetest.register_chatcommand("awd", {
|
|
params = "award name",
|
|
description = "awd: Details of awd gotten",
|
|
func = function(name, param)
|
|
local def = awards.def[param]
|
|
if def then
|
|
minetest.chat_send_player(name,def.title..": "..def.description)
|
|
else
|
|
minetest.chat_send_player(name,"Award not found.")
|
|
end
|
|
end
|
|
})
|
|
--[[minetest.register_chatcommand("gawd", {
|
|
params = "award name",
|
|
description = "gawd: give award to self",
|
|
func = function(name, param)
|
|
awards.give_achievement(name,param)
|
|
end
|
|
})]]--
|
|
|
|
function awards._order_awards(name)
|
|
local done = {}
|
|
local retval = {}
|
|
local player = awards.player(name)
|
|
if player and player.unlocked then
|
|
for _,got in pairs(player.unlocked) do
|
|
done[got] = true
|
|
table.insert(retval,{name=got,got=true})
|
|
end
|
|
end
|
|
for _,def in pairs(awards.def) do
|
|
if not done[def.name] then
|
|
table.insert(retval,{name=def.name,got=false})
|
|
end
|
|
end
|
|
return retval
|
|
end
|
|
|
|
function awards.showto(name, to, sid, text)
|
|
if name == "" or name == nil then
|
|
name = to
|
|
end
|
|
if text then
|
|
if not awards.players[name] or not awards.players[name].unlocked then
|
|
minetest.chat_send_player(to, "You have not unlocked any awards")
|
|
return
|
|
end
|
|
minetest.chat_send_player(to, name.."'s awards:")
|
|
|
|
for _, str in pairs(awards.players[name].unlocked) do
|
|
local def = awards.def[str]
|
|
if def and def.title then
|
|
if def.description then
|
|
minetest.chat_send_player(to, def.title..": "..def.description)
|
|
else
|
|
minetest.chat_send_player(to, def.title)
|
|
end
|
|
else
|
|
minetest.chat_send_player(to, str)
|
|
end
|
|
end
|
|
else
|
|
if sid == nil or sid < 1 then
|
|
sid = 1
|
|
end
|
|
local formspec = "size[11,5]"
|
|
local listofawards = awards._order_awards(name)
|
|
|
|
-- Sidebar
|
|
if sid then
|
|
local item = listofawards[sid+0]
|
|
local def = awards.def[item.name]
|
|
if def and def.secret and not item.got then
|
|
formspec = formspec .. "label[1,2.75;Secret Award]"..
|
|
"image[1,0;3,3;unknown.png]"
|
|
if def and def.description then
|
|
formspec = formspec .. "label[0,3.25;Unlock this award to find out what it is]"
|
|
end
|
|
else
|
|
local title = item.name
|
|
if def and def.title then
|
|
title = def.title
|
|
end
|
|
local status = ""
|
|
if item.got then
|
|
status = " (got)"
|
|
end
|
|
if def and def.icon then
|
|
icon = def.icon
|
|
end
|
|
formspec = formspec .. "label[1,2.75;"..title..status.."]"..
|
|
"image[1,0;3,3;"..icon.."]"
|
|
if def and def.description then
|
|
formspec = formspec .. "label[0,3.25;"..def.description.."]"
|
|
end
|
|
end
|
|
end
|
|
|
|
-- Create list box
|
|
formspec = formspec .. "textlist[4.75,0;6,5;awards;"
|
|
local first = true
|
|
for _,award in pairs(listofawards) do
|
|
if not first then
|
|
formspec = formspec .. ","
|
|
end
|
|
first = false
|
|
local def = awards.def[award.name]
|
|
|
|
if def and def.secret and not award.got then
|
|
formspec = formspec .. "#ACACACSecret Award"
|
|
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
|
|
formspec = formspec .. ";"..sid.."]"
|
|
|
|
-- Show formspec to user
|
|
minetest.show_formspec(to,"awards:awards",formspec)
|
|
end
|
|
end
|
|
|
|
minetest.register_on_player_receive_fields(function(player, formname, fields)
|
|
if formname~="awards:awards" then
|
|
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
|
|
awards.showto(name,name,event.index,false)
|
|
end
|
|
end
|
|
|
|
return true
|
|
end)
|
|
|