factions/factions.lua

427 lines
11 KiB
Lua
Raw Normal View History

2016-07-30 07:38:52 +02:00
-------------------------------------------------------------------------------
2016-08-07 19:31:11 +02:00
-- factions Mod by Sapier
2016-07-30 07:38:52 +02:00
--
-- License WTFPL
--
2016-08-07 19:31:11 +02:00
--! @file factions.lua
--! @brief factions core file containing datastorage
2016-07-30 07:38:52 +02:00
--! @copyright Sapier
--! @author Sapier
--! @date 2013-05-08
--
-- Contact sapier a t gmx net
-------------------------------------------------------------------------------
--read some basic information
2016-08-07 19:31:11 +02:00
local factions_worldid = minetest.get_worldpath()
2016-07-30 07:38:52 +02:00
2016-08-07 19:31:11 +02:00
--! @class factions
--! @brief main class for factions
factions = {}
2016-07-30 07:38:52 +02:00
--! @brief runtime data
2016-08-07 19:31:11 +02:00
factions.factions = {}
factions.chunks = {}
factions.players = {}
2016-07-30 07:38:52 +02:00
2016-08-07 19:31:11 +02:00
factions.print = function(text)
print("factions: " .. dump(text))
2016-07-30 07:38:52 +02:00
end
factions.dbg_lvl1 = function() end --factions.print -- errors
factions.dbg_lvl2 = function() end --factions.print -- non cyclic trace
factions.dbg_lvl3 = function() end --factions.print -- cyclic trace
2016-07-30 07:38:52 +02:00
2016-08-07 19:31:11 +02:00
factions.factions = {}
2016-08-07 02:11:17 +02:00
--- settings
factions.lower_laimable_height = -512
2016-08-07 02:11:17 +02:00
---------------------
--! @brief returns whether a faction can be created or not (allows for implementation of blacklists and the like)
2016-08-07 19:31:11 +02:00
factions.can_create_faction = function(name)
if factions.factions[name] then
2016-08-07 02:11:17 +02:00
return false
else
return true
2016-08-07 19:36:56 +02:00
end
2016-08-07 02:11:17 +02:00
end
factions.Faction = {
power = 0.,
players = {},
ranks = {["leader"] = {"disband", "claim", "playerlist", "build", "edit", "ranks"},
["member"] = {"build"}
},
leader = nil,
default_rank = "member",
default_leader_rank = "leader",
description = "Default faction description.",
invited_players = {},
land = {},
allies = {},
enemies = {},
join_free = false,
spawn = nil,
}
factions.Faction.__index = factions.Faction
function factions.Faction:new(faction)
faction = {
2016-08-07 02:11:17 +02:00
power = 0.,
players = {},
ranks = {["leader"] = {"disband", "claim", "playerlist", "build", "edit", "ranks"},
2016-08-07 02:11:17 +02:00
["member"] = {"build"}
},
leader = nil,
default_rank = "member",
default_leader_rank = "leader",
description = "Default faction description.",
invited_players = {},
land = {},
allies = {},
enemies = {},
join_free = false,
spawn = nil,
} or faction
setmetatable(faction, self)
return faction
end
2016-08-07 02:11:17 +02:00
factions.new_faction = function(name)
local faction = factions.Faction:new(nil)
faction.name = name
2016-08-07 19:36:56 +02:00
factions.factions[name] = faction
factions.save()
2016-08-07 02:11:17 +02:00
return faction
end
function factions.Faction.increase_power(self, power)
self.power = self.power + power
factions.save()
end
function factions.Faction.decrease_power(self, power)
self.power = self.power - power
factions.save()
end
function factions.Faction.add_player(self, player, rank)
self.players[player] = rank or self.default_rank
factions.players[player] = self.name
self:on_player_join(player)
self.invited_players[player] = nil
factions.save()
end
function factions.Faction.remove_player(self, player)
self.players[player] = nil
factions.players[player] = nil
self:on_player_leave(player)
factions.save()
end
function factions.Faction.claim_chunk(self, chunkpos)
factions.chunks[chunkpos] = self.name
self.land[chunkpos] = true
self:on_claim_chunk(chunkpos)
factions.save()
end
function factions.Faction.unclaim_chunk(self, chunkpos)
factions.chunks[chunkpos] = nil
self.land[chunkpos] = nil
self:on_unclaim_chunk(chunkpos)
factions.save()
end
function factions.Faction.disband(self)
for k, _ in pairs(self.players) do -- remove players affiliation
factions.players[k] = nil
end
for k, v in pairs(self.land) do -- remove chunk claims
factions.chunks[k] = nil
end
self:on_disband()
factions.factions[self.name] = nil
factions.save()
end
function factions.Faction.set_leader(self, player)
self.leader = player
self.players[player] = self.default_leader_rank
self:on_new_leader()
factions.save()
end
function factions.Faction.has_permission(self, player, permission)
local p = self.players[player]
if not p then
return false
end
local perms = self.ranks[p]
for i in ipairs(perms) do
if perms[i] == permission then
return true
end
end
return false
end
function factions.Faction.set_description(self, new)
self.description = new
self:on_change_description()
factions.save()
end
function factions.Faction.invite_player(self, player)
self.invited_players[player] = true
self:on_player_invited(player)
factions.save()
end
function factions.Faction.revoke_invite(self, player)
self.invited_players[player] = nil
self:on_revoke_invite(player)
factions.save()
end
function factions.Faction.is_invited(self, player)
return table.contains(self.invited_players, player)
end
function factions.Faction.toggle_join_free(self, bool)
self.join_free = bool
self:on_toggle_join_free()
factions.save()
end
function factions.Faction.can_join(self, player)
return self.join_free or self.invited_players[player]
end
function factions.Faction.new_alliance(self, faction)
self.allies[faction] = true
self:on_new_alliance(faction)
if self.enemies[faction] then
self:end_enemy(faction)
end
factions.save()
end
function factions.Faction.end_alliance(self, faction)
self.allies[faction] = nil
self:on_end_alliance(faction)
factions.save()
end
function factions.Faction.new_enemy(self, faction)
self.enemies[faction] = true
self:on_new_enemy(faction)
if self.allies[faction] then
self:end_alliance(faction)
end
factions.save()
end
function factions.Faction.end_enemy(self, faction)
self.enemies[faction] = nil
self:on_end_enemy(faction)
factions.save()
end
function factions.Faction.set_spawn(self, pos)
self.spawn = pos
self:on_set_spawn()
factions.save()
end
function factions.Faction.add_rank(self, rank, perms)
self.ranks[rank] = perms
self:on_new_rank(rank)
factions.save()
end
function factions.Faction.delete_rank(self, rank, newrank)
for player, r in pairs(self.players) do
if r == rank then
self.players[player] = newrank
end
end
self.ranks[rank] = nil
self:on_delete_rank(rank, newrank)
factions.save()
end
--------------------------
-- callbacks for events --
function factions.Faction.on_create(self) --! @brief called when the faction is added to the global faction list
--TODO: implement
end
function factions.Faction.on_player_leave(self, player)
--TODO: implement
end
function factions.Faction.on_player_join(self, player)
--TODO: implement
end
function factions.Faction.on_claim_chunk(self, pos)
--TODO: implement
end
function factions.Faction.on_unclaim_chunk(self, pos)
--TODO: implement
end
function factions.Faction.on_disband(self, pos)
--TODO: implement
end
function factions.Faction.on_new_leader(self)
--TODO: implement
end
function factions.Faction.on_change_description(self)
--TODO: implement
end
function factions.Faction.on_player_invited(self, player)
--TODO: implement
end
function factions.Faction.on_toggle_join_free(self, player)
--TODO: implement
end
function factions.Faction.on_new_alliance(self, faction)
--TODO: implement
end
function factions.Faction.on_end_alliance(self, faction)
--TODO: implement
end
function factions.Faction.on_set_spawn(self)
--TODO: implement
end
function factions.Faction.on_add_rank(self, rank)
--TODO: implement
end
function factions.Faction.on_delete_rank(self, rank, newrank)
--TODO: implement
end
2016-08-07 02:11:17 +02:00
--??????????????
2016-08-07 19:31:11 +02:00
function factions.fix_powercap(name)
factions.data.factions[name].powercap = #factions.dynamic_data.membertable[name] + 10
2016-08-04 07:21:22 +02:00
end
2016-08-07 02:11:17 +02:00
--??????????????
2016-07-30 07:38:52 +02:00
2016-08-07 19:31:11 +02:00
function factions.get_chunk(pos)
return factions.chunks[factions.get_chunkpos(pos)]
2016-07-30 07:38:52 +02:00
end
function factions.get_chunk_pos(pos)
return math.floor(pos.x / 16.)..","..math.floor(pos.z / 16.)
2016-08-07 19:36:56 +02:00
end
2016-07-30 07:38:52 +02:00
-------------------------------------------------------------------------------
2016-08-07 02:11:17 +02:00
-- name: add_faction(name)
2016-07-30 07:38:52 +02:00
--
2016-08-07 02:11:17 +02:00
--! @brief add a faction
2016-08-07 19:31:11 +02:00
--! @memberof factions
2016-07-30 07:38:52 +02:00
--! @public
--
2016-08-07 02:11:17 +02:00
--! @param name of faction to add
2016-07-30 07:38:52 +02:00
--!
2016-08-07 02:11:17 +02:00
--! @return faction object/false (succesfully added faction or not)
2016-07-30 07:38:52 +02:00
-------------------------------------------------------------------------------
2016-08-07 19:31:11 +02:00
function factions.add_faction(name)
2016-08-07 19:36:56 +02:00
if factions.can_create_faction(name) then
local fac = factions.new_faction(name)
fac:on_create()
return fac
else
return nil
end
2016-07-30 07:38:52 +02:00
end
-------------------------------------------------------------------------------
-- name: get_faction_list()
--
2016-08-07 19:31:11 +02:00
--! @brief get list of factions
--! @memberof factions
2016-07-30 07:38:52 +02:00
--! @public
--!
2016-08-07 19:31:11 +02:00
--! @return list of factions
2016-07-30 07:38:52 +02:00
-------------------------------------------------------------------------------
2016-08-07 19:31:11 +02:00
function factions.get_faction_list()
2016-07-30 07:38:52 +02:00
local retval = {}
2016-08-07 19:31:11 +02:00
for key,value in pairs(factions.factions) do
2016-07-30 07:38:52 +02:00
table.insert(retval,key)
end
return retval
end
-------------------------------------------------------------------------------
-- name: save()
--
--! @brief save data to file
2016-08-07 19:31:11 +02:00
--! @memberof factions
2016-07-30 07:38:52 +02:00
--! @private
-------------------------------------------------------------------------------
2016-08-07 19:31:11 +02:00
function factions.save()
2016-07-30 07:38:52 +02:00
--saving is done much more often than reading data to avoid delay
--due to figuring out which data to save and which is temporary only
--all data is saved here
--this implies data needs to be cleant up on load
local file,error = io.open(factions_worldid .. "/" .. "factions.conf","w")
2016-07-30 07:38:52 +02:00
if file ~= nil then
2016-08-07 19:31:11 +02:00
file:write(minetest.serialize(factions.factions))
2016-07-30 07:38:52 +02:00
file:close()
else
minetest.log("error","MOD factions: unable to save factions world specific data!: " .. error)
2016-07-30 07:38:52 +02:00
end
end
-------------------------------------------------------------------------------
-- name: load()
--
--! @brief load data from file
2016-08-07 19:31:11 +02:00
--! @memberof factions
2016-07-30 07:38:52 +02:00
--! @private
--
--! @return true/false
-------------------------------------------------------------------------------
2016-08-07 19:31:11 +02:00
function factions.load()
local file,error = io.open(factions_worldid .. "/" .. "factions.conf","r")
2016-07-30 07:38:52 +02:00
if file ~= nil then
local raw_data = file:read("*a")
2016-08-07 19:31:11 +02:00
factions.factions = minetest.deserialize(raw_data)
for facname, faction in pairs(factions.factions) do
minetest.log("action", facname..","..faction.name)
for player, rank in pairs(faction.players) do
minetest.log("action", player..","..rank)
factions.players[player] = facname
2016-08-07 02:11:17 +02:00
end
for chunkpos, val in pairs(faction.land) do
factions.chunks[chunkpos] = facname
2016-08-07 02:11:17 +02:00
end
setmetatable(faction, factions.Faction)
2016-08-07 02:11:17 +02:00
end
2016-07-30 07:38:52 +02:00
file:close()
2016-08-07 02:11:17 +02:00
end
2016-07-30 22:33:10 +02:00
end
2016-08-07 02:11:17 +02:00
minetest.register_on_dieplayer(
function(player)
end
)
minetest.register_globalstep(
function(dtime)
end
)
minetest.register_on_joinplayer(
function(player)
end
)
2016-08-04 07:21:22 +02:00
local default_is_protected = minetest.is_protected
minetest.is_protected = function(pos, player)
local chunkpos = factions.get_chunk_pos(pos)
local faction = factions.chunks[chunkpos]
if not faction then
return default_is_protected(pos, player)
else
faction = factions.factions[faction]
return not faction:has_permission(player, "build")
end
end