init.lua

   1 --[=[ Main tables ]=]
   2
   3 playereffects = {}
   4
   5 --[[ table containing the groups (experimental) ]]
   6 playereffects.groups = {}
   7
   8 --[[ table containing all the effect types ]]
   9 playereffects.effect_types = {}
  10
  11 --[[ table containing all the active effects ]]
  12 playereffects.effects = {}
  13
  14 --[[ table containing all the inactive effects.
  15 Effects become inactive if a player leaves an become active again if they join again. ]]
  16 playereffects.inactive_effects = {}
  17
  18 -- Variable for counting the effect_id
  19 playereffects.last_effect_id = 0
  20
  21 --[=[ Include settings ]=]
  22 dofile(minetest.get_modpath("playereffects").."/settings.lua")
  23
  24 --[=[ Load inactive_effects and last_effect_id from playereffects.mt, if this file exists  ]=]
  25 do
  26         local filepath = minetest.get_worldpath().."/playereffects.mt"
  27         local file = io.open(filepath, "r")
  28         if file then
  29                 minetest.log("action", "[playereffects] playereffects.mt opened.")
  30                 local string = file:read()
  31                 io.close(file)
  32                 if(string ~= nil) then
  33                         local savetable = minetest.deserialize(string)
  34                         playereffects.inactive_effects = savetable.inactive_effects
  35                         minetest.debug("[playereffects] playereffects.mt successfully read.")
  36                         minetest.debug("[playereffects] inactive_effects = "..dump(playereffects.inactive_effects))
  37                         playereffects.last_effect_id = savetable.last_effect_id
  38                         minetest.debug("[playereffects] last_effect_id = "..dump(playereffects.last_effect_id))
  39
  40                 end
  41         end
  42 end
  43
  44 function playereffects.next_effect_id()
  45         playereffects.last_effect_id = playereffects.last_effect_id + 1
  46         return playereffects.last_effect_id
  47 end
  48
  49 --[=[ API functions ]=]
  50 function playereffects.register_effect_type(name, description, icon, groups, apply, cancel, hidden)
  51         effect_type = {}
  52         effect_type.description = description
  53         effect_type.apply = apply
  54         effect_type.groups = groups
  55         effect_type.icon = icon
  56         if cancel ~= nil then
  57                 effect_type.cancel = cancel
  58         else
  59                 effect_type.cancel = function() end
  60         end
  61         if hidden ~= nil then
  62                 effect_type.hidden = hidden
  63         else
  64                 effect_type.hidden = false
  65         end
  66         playereffects.effect_types[name] = effect_type
  67         minetest.log("action", "[playereffects] Effect type "..name.." registered!")
  68 end
  69
  70 function playereffects.apply_effect_type(effect_type_id, duration, player)
  71         local start_time = os.time()
  72         local is_player = false
  73         if(type(player)=="userdata") then
  74                 if(player.is_player ~= nil) then
  75                         if(player:is_player() == true) then
  76                                 is_player = true
  77                         end
  78                 end
  79         end
  80         if(is_player == false) then
  81                 minetest.log("error", "[playereffects] Attempted to apply effect type "..effect_type_id.." to a non-player!")
  82                 return false
  83         end
  84
  85         local playername = player:get_player_name()
  86         local groups = playereffects.effect_types[effect_type_id].groups
  87         for k,v in pairs(groups) do
  88                 playereffects.cancel_effect_group(v, playername)
  89         end
  90
  91         local status = playereffects.effect_types[effect_type_id].apply(player)
  92         local metadata
  93
  94         if(status == false) then
  95                 minetest.log("action", "[playereffects] Attempt to apply effect type "..effect_type_id.." to player "..playername.." failed!")
  96                 return false
  97         else
  98                 metadata = status
  99         end
 100
 101         local effect_id = playereffects.next_effect_id()
 102         local effects = playereffects.get_player_effects(playername)
 103         local smallest_hudpos
 104         local biggest_hudpos = -1
 105         local free_hudpos
 106         for e=1,#effects do
 107                 local hudpos = effects[e].hudpos
 108                 if(hudpos > biggest_hudpos) then
 109                         biggest_hudpos = hudpos
 110                 end
 111                 if(smallest_hudpos == nil) then
 112                         smallest_hudpos = hudpos
 113                 elseif(hudpos < smallest_hudpos) then
 114                         smallest_hudpos = hudpos
 115                 end
 116         end
 117         if(smallest_hudpos == nil) then
 118                 free_hudpos = 0
 119         elseif(smallest_hudpos >= 0) then
 120                 free_hudpos = smallest_hudpos - 1
 121         else
 122                 free_hudpos = biggest_hudpos + 1
 123         end
 124         local hudids
 125         --[[ show no more than 20 effects on the screen, so that hud_update does not need to be called so often ]]
 126         if(free_hudpos <= 20) then
 127                 hudids = playereffects.hud_effect(effect_type_id, player, free_hudpos, duration)
 128         else
 129                 hudids = {text_id=nil, icon_id=nil}
 130         end
 131
 132         local effect = {
 133                         playername = playername,
 134                         effect_id = effect_id,
 135                         effect_type_id = effect_type_id,
 136                         start_time = start_time,
 137                         time_left = duration,
 138                         hudids = hudids,
 139                         hudpos = free_hudpos,
 140                         metadata = metadata,
 141         }
 142
 143         playereffects.effects[effect_id] = effect
 144
 145         minetest.log("action", "[playereffects] Effect type "..effect_type_id.." applied to player "..playername.." (effect_id = "..effect_id..").")
 146         minetest.after(duration, function(effect_id) playereffects.cancel_effect(effect_id) end, effect_id)
 147
 148         return effect_id
 149 end
 150
 151 function playereffects.cancel_effect_type(effect_type_id, cancel_all, playername)
 152         local effects = playereffects.get_player_effects(playername)
 153         if(cancel_all==nil) then all = false end
 154         for e=1, #effects do
 155                 if(effects[e].effect_type_id == effect_type_id) then
 156                         playereffects.cancel_effect(effects[e].effect_id)
 157                         if(cancel_all==false) then
 158                                 return
 159                         end
 160                 end
 161         end
 162 end
 163
 164 function playereffects.cancel_effect_group(groupname, playername)
 165         local effects = playereffects.get_player_effects(playername)
 166         for e=1,#effects do
 167                 local effect = effects[e]
 168                 local thesegroups = playereffects.effect_types[effect.effect_type_id].groups
 169                 local delete = false
 170                 for g=1,#thesegroups do
 171                         if(thesegroups[g] == groupname) then
 172                                 playereffects.cancel_effect(effect.effect_id)
 173                                 break
 174                         end
 175                 end
 176         end
 177 end
 178
 179 function playereffects.cancel_effect(effect_id)
 180         local effect = playereffects.effects[effect_id]
 181         if(effect ~= nil) then
 182                 local player = minetest.get_player_by_name(effect.playername)
 183                 if(effect.hudids.text_id~=nil) then
 184                         player:hud_remove(effect.hudids.text_id)
 185                 end
 186                 if(effect.hudids.icon_id~=nil) then
 187                         player:hud_remove(effect.hudids.icon_id)
 188                 end
 189                 playereffects.effect_types[effect.effect_type_id].cancel(effect)
 190                 playereffects.effects[effect_id] = nil
 191                 minetest.log("action", "[playereffects] Effect type "..effect.effect_type_id.." cancelled from player "..effect.playername.."!")
 192         end
 193 end
 194
 195 function playereffects.get_player_effects(playername)
 196         if(minetest.get_player_by_name(playername) ~= nil) then
 197                 local effects = {}
 198                 for k,v in pairs(playereffects.effects) do
 199                         if(v.playername == playername) then
 200                                 table.insert(effects, v)
 201                         end
 202                 end
 203                 return effects
 204         else
 205                 return {}
 206         end
 207 end
 208
 209 --[=[ Saving all data to file ]=]
 210 function playereffects.save_to_file()
 211         local save_time = os.time()
 212         local savetable = {}
 213         local inactive_effects = {}
 214         for id,effecttable in pairs(playereffects.inactive_effects) do
 215                 local playername = id
 216                 if(inactive_effects[playername] == nil) then
 217                         inactive_effects[playername] = {}
 218                 end
 219                 for i=1,#effecttable do
 220                         table.insert(inactive_effects[playername], effecttable[i])
 221                 end
 222         end
 223         for id,effect in pairs(playereffects.effects) do
 224                 local new_duration = effect.time_left - os.difftime(save_time, effect.start_time)
 225                 local new_effect = {
 226                         effect_id = effect.effect_id,
 227                         effect_type_id = effect.effect_type_id,
 228                         time_left = new_duration,
 229                         start_time = effect.start_time,
 230                         playername = effect.playername,
 231                         metadata = effect.metadata
 232                 }
 233                 if(inactive_effects[effect.playername] == nil) then
 234                         inactive_effects[effect.playername] = {}
 235                 end
 236                 table.insert(inactive_effects[effect.playername], new_effect)
 237         end
 238
 239         savetable.inactive_effects = inactive_effects
 240         savetable.last_effect_id = playereffects.last_effect_id
 241
 242         local savestring = minetest.serialize(savetable)
 243
 244         local filepath = minetest.get_worldpath().."/playereffects.mt"
 245         local file = io.open(filepath, "w")
 246         if file then
 247                 file:write(savestring)
 248                 io.close(file)
 249                 minetest.log("action", "[playereffects] Wrote playereffects data into "..filepath..".")
 250         else
 251                 minetest.log("error", "[playereffects] Failed to write playereffects data into "..filepath..".")
 252         end
 253 end
 254
 255 --[=[ Callbacks ]=]
 256 --[[ Cancel all effects on player death ]]
 257 minetest.register_on_dieplayer(function(player)
 258         local effects = playereffects.get_player_effects(player:get_player_name())
 259         for e=1,#effects do
 260                 playereffects.cancel_effect(effects[e].effect_id)
 261         end
 262 end)
 263
 264
 265 minetest.register_on_leaveplayer(function(player)
 266         local leave_time = os.time()
 267         local playername = player:get_player_name()
 268         local effects = playereffects.get_player_effects(playername)
 269
 270         playereffects.hud_clear(player)
 271
 272         if(playereffects.inactive_effects[playername] == nil) then
 273                 playereffects.inactive_effects[playername] = {}
 274         end
 275         for e=1,#effects do
 276                 local new_duration = effects[e].time_left - os.difftime(leave_time, effects[e].start_time)
 277                 local new_effect = effects[e]
 278                 new_effect.time_left = new_duration
 279                 table.insert(playereffects.inactive_effects[playername], new_effect)
 280                 playereffects.cancel_effect(effects[e].effect_id)
 281         end
 282 end)
 283
 284 minetest.register_on_shutdown(function()
 285         minetest.log("action", "[playereffects] Server shuts down. Rescuing data into playereffects.mt")
 286         playereffects.save_to_file()
 287 end)
 288
 289 minetest.register_on_joinplayer(function(player)
 290         local playername = player:get_player_name()
 291
 292         -- load all the effects again (if any)
 293         if(playereffects.inactive_effects[playername] ~= nil) then
 294                 for i=1,#playereffects.inactive_effects[playername] do
 295                         local effect = playereffects.inactive_effects[playername][i]
 296                         playereffects.apply_effect_type(effect.effect_type_id, effect.time_left, player)
 297                 end
 298                 playereffects.inactive_effects[playername] = nil
 299         end
 300 end)
 301
 302 playereffects.globalstep_timer = 0
 303 playereffects.autosave_timer = 0
 304 minetest.register_globalstep(function(dtime)
 305         playereffects.globalstep_timer = playereffects.globalstep_timer + dtime
 306         playereffects.autosave_timer = playereffects.autosave_timer + dtime
 307         -- Update HUDs of all players
 308         if(playereffects.globalstep_timer >= 1) then
 309                 playereffects.globalstep_timer = 0
 310
 311                 local players = minetest.get_connected_players()
 312                 for p=1,#players do
 313                         playereffects.hud_update(players[p])
 314                 end
 315         end
 316         -- Autosave into file
 317         if(playereffects.use_autosave == true and playereffects.autosave_timer >= playereffects.autosave_time) then
 318                 playereffects.autosave_timer = 0
 319                 minetest.log("action", "[playereffects] Autosaving mod data to playereffects.mt ...")
 320                 playereffects.save_to_file()
 321         end
 322 end)
 323
 324
 325
 326
 327 --[=[ HUD ]=]
 328 function playereffects.hud_update(player)
 329         if(playereffects.use_hud == true) then
 330                 local now = os.time()
 331                 local effects = playereffects.get_player_effects(player:get_player_name())
 332                 for e=1,#effects do
 333                         local effect = effects[e]
 334                         if(effect.hudids.text_id ~= nil) then
 335                                 local description = playereffects.effect_types[effect.effect_type_id].description
 336                                 local time_left = os.difftime(effect.start_time + effect.time_left, now)
 337                                 player:hud_change(effect.hudids.text_id, "text", description .. " ("..tostring(time_left).." s)")
 338                         end
 339                 end
 340         end
 341 end
 342
 343 function playereffects.hud_clear(player)
 344         if(playereffects.use_hud == true) then
 345                 local playername = player:get_player_name()
 346                 local effects = playereffects.get_player_effects(playername)
 347                 if(effects ~= nil) then
 348                         for e=1,#effects do
 349                                 if(effects[e].hudids.text_id ~= nil) then
 350                                         player:hud_remove(effects[e].hudids.text_id)
 351                                 end
 352                                 if(effects[e].hudids.icon_id ~= nil) then
 353                                         player:hud_remove(effects[e].hudids.icon_id)
 354                                 end
 355                         end
 356                 end
 357         end
 358 end
 359
 360 function playereffects.hud_effect(effect_type_id, player, pos, time_left)
 361         local text_id, icon_id
 362         local effect_type = playereffects.effect_types[effect_type_id]
 363         if(playereffects.use_hud == true and effect_type.hidden == false) then
 364                 text_id = player:hud_add({
 365                         hud_elem_type = "text",
 366                         position = { x = 1, y = 0.3 },
 367                         name = "effect_"..effect_type_id,
 368                         text = playereffects.effect_types[effect_type_id].description .. " ("..tostring(time_left).." s)",
 369                         scale = { x = 170, y = 20},
 370                         alignment = { x = -1, y = 0 },
 371                         direction = 1,
 372                         number = 0xFFFFFF,
 373                         offset = { x = -5, y = pos*20 }
 374                 })
 375                 if(playereffects.effect_types[effect_type_id].icon ~= nil) then
 376                         icon_id = player:hud_add({
 377                                 hud_elem_type = "image",
 378                                 scale = { x = 1, y = 1 },
 379                                 position = { x = 1, y = 0.3 },
 380                                 name = "effect_icon_"..effect_type_id,
 381                                 text = playereffects.effect_types[effect_type_id].icon,
 382                                 alignment = { x = -1, y=0 },
 383                                 direction = 0,
 384                                 offset = { x = -186, y = pos*20 },
 385                         })
 386                 end
 387         else
 388                 text_id = nil
 389                 icon_id = nil
 390         end
 391         return { text_id = text_id, icon_id = icon_id }
 392 end
 393
 394
 395 -- LOAD EXAMPLES
 396 dofile(minetest.get_modpath(minetest.get_current_modname()).."/examples.lua")