awards/api.lua

170 lines
5.0 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-02-22 21:43:40 +01:00
-- Table Save Load Functions
function save_playerD()
2013-02-22 21:43:40 +01:00
local file = io.open(minetest.get_worldpath().."/awards.txt", "w")
if file then
file:write(minetest.serialize(player_data))
file:close()
end
end
local function load_playerD()
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
-- The global award namespace
awards={}
player_data=load_playerD()
-- A table of award definitions
awards.def={}
-- 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-02-23 13:02:02 +01:00
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)
2013-02-23 16:13:21 +01:00
elseif data_table['trigger']['type']=="death" then
local tmp={
award=name,
target=data_table['trigger']['target'],
}
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
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
2013-02-27 13:34:38 +01:00
-- add the achievement to the definition table
2013-02-22 21:43:40 +01:00
awards['def'][name] = data_table
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-02-27 13:34:38 +01:00
-- load the player's data table
2013-02-22 21:43:40 +01:00
local data=player_data[name]
2013-02-27 13:34:38 +01:00
-- check if the table that holds a player's achievements exists
2013-02-22 21:43:40 +01:00
if not data['unlocked'] then
data['unlocked']={}
end
2013-02-27 13:34:38 +01:00
-- check to see if the player does not already have that achievement
2013-02-22 21:43:40 +01:00
if not data['unlocked'][award] or data['unlocked'][award]~=award then
2013-02-27 13:34:38 +01:00
-- save the achievement to the player_data table
2013-02-22 21:43:40 +01:00
data['unlocked'][award]=award
2013-02-27 13:34:38 +01:00
-- define local variables, so award data can be saved
2013-02-22 21:43:40 +01:00
local title = award
local desc = ""
2013-02-27 13:34:38 +01:00
-- check definition table to get values
if awards['def'][award] and awards['def'][award]['title'] and awards['def'][award]['custom_announce'] and awards['def'][award]['background'] and awards['def'][award]['icon'] then
2013-02-22 21:43:40 +01:00
title=awards['def'][award]['title']
background=awards['def'][award]['background']
icon=awards['def'][award]['icon']
custom_announce=awards['def'][award]['custom_announce']
2013-02-22 21:43:40 +01:00
end
2013-02-27 13:34:38 +01:00
-- check definition table to get description
2013-02-22 21:43:40 +01:00
if awards['def'][award] and awards['def'][award]['description'] then
desc=awards['def'][award]['description']
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
save_playerD()
end
end
-- List a player's achievements
minetest.register_chatcommand("list_awards", {
params = "",
description = "list_awards: list your awards",
func = function(name, param)
2013-02-23 13:02:02 +01:00
minetest.chat_send_player(name, name.."'s awards:");
2013-02-22 21:43:40 +01:00
for _, str in pairs(player_data[name].unlocked) do
minetest.chat_send_player(name, str);
end
end,
})