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