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", "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", "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                 minetest.log("action", "thesegroups = "..dump(thesegroups))
 145                 minetest.log("action", "groupname = "..dump(groupname))
 146                 local delete = false
 147                 for g=1,#thesegroups do
 148                         if(thesegroups[g] == groupname) then
 149                                 playereffects.cancel_effect(effect.effect_id)
 150                                 break
 151                         end
 152                 end
 153         end
 154 end
 155
 156 function playereffects.cancel_effect(effect_id)
 157         local effect = playereffects.effects[effect_id]
 158         if(effect ~= nil) then
 159                 local player = minetest.get_player_by_name(effect.playername)
 160                 if(effect.hudids.text_id~=nil) then
 161                         player:hud_remove(effect.hudids.text_id)
 162                 end
 163                 if(effect.hudids.icon_id~=nil) then
 164                         player:hud_remove(effect.hudids.icon_id)
 165                 end
 166                 playereffects.effect_types[effect.effect_type_id].cancel(effect)
 167                 playereffects.effects[effect_id] = nil
 168                 minetest.log("action", "Effect type "..effect.effect_type_id.." cancelled from player "..effect.playername.."!")
 169         end
 170 end
 171
 172 function playereffects.get_player_effects(playername)
 173         if(minetest.get_player_by_name(playername) ~= nil) then
 174                 local effects = {}
 175                 for k,v in pairs(playereffects.effects) do
 176                         if(v.playername == playername) then
 177                                 table.insert(effects, v)
 178                         end
 179                 end
 180                 return effects
 181         else
 182                 return {}
 183         end
 184 end
 185
 186 --[=[ Callbacks ]=]
 187 --[[ Cancel all effects on player death ]]
 188 minetest.register_on_dieplayer(function(player)
 189         local effects = playereffects.get_player_effects(player:get_player_name())
 190         for e=1,#effects do
 191                 playereffects.cancel_effect(effects[e].effect_id)
 192         end
 193 end)
 194
 195
 196 minetest.register_on_leaveplayer(function(player)
 197         local leave_time = os.time()
 198         local playername = player:get_player_name()
 199         local effects = playereffects.get_player_effects(playername)
 200
 201         playereffects.hud_clear(player)
 202
 203         if(playereffects.inactive_effects[playername] == nil) then
 204                 playereffects.inactive_effects[playername] = {}
 205         end
 206         for e=1,#effects do
 207                 local new_duration = effects[e].time_left - os.difftime(leave_time, effects[e].start_time)
 208                 local new_effect = effects[e]
 209                 new_effect.time_left = new_duration
 210                 table.insert(playereffects.inactive_effects[playername], new_effect)
 211                 playereffects.cancel_effect(effects[e].effect_id)
 212         end
 213 end)
 214
 215 minetest.register_on_shutdown(function()
 216         minetest.log("action", "[playereffects] Server shuts down. Rescuing data into playereffects.mt")
 217         local shutdown_time = os.time()
 218         local savetable = {}
 219         local effects = playereffects.effects
 220         local inactive_effects = playereffects.inactive_effects
 221         for id,effect in pairs(effects) do
 222                 local new_duration = effect.time_left - os.difftime(shutdown_time, effect.start_time)
 223                 local new_effect = effect
 224                 new_effect.time_left = new_duration
 225                 if(inactive_effects[effect.playername] == nil) then
 226                         inactive_effects[effect.playername] = {}
 227                 end
 228                 table.insert(inactive_effects[effect.playername], new_effect)
 229                 playereffects.cancel_effect(effect.effect_id)
 230         end
 231
 232         savetable.inactive_effects = inactive_effects
 233         savetable.last_effect_id = playereffects.last_effect_id
 234
 235         savestring = minetest.serialize(savetable)
 236
 237         local filepath = minetest.get_worldpath().."/playereffects.mt"
 238         local file = io.open(filepath, "w")
 239         if file then
 240                 file:write(savestring)
 241                 io.close(file)
 242                 minetest.log("action", "[playereffects] Wrote playereffects data into "..filepath..".")
 243         else
 244                 minetest.log("error", "[playereffects] Failed to write playereffects data into "..filepath..".")
 245         end
 246
 247 end)
 248
 249 minetest.register_on_joinplayer(function(player)
 250         local playername = player:get_player_name()
 251
 252         -- load all the effects again (if any)
 253         if(playereffects.inactive_effects[playername] ~= nil) then
 254                 for i=1,#playereffects.inactive_effects[playername] do
 255                         local effect = playereffects.inactive_effects[playername][i]
 256                         playereffects.apply_effect_type(effect.effect_type_id, effect.time_left, player)
 257                 end
 258                 playereffects.inactive_effects[playername] = nil
 259         end
 260 end)
 261
 262 playereffects.globalstep_timer = 0
 263 minetest.register_globalstep(function(dtime)
 264         playereffects.globalstep_timer = playereffects.globalstep_timer + dtime
 265         if(playereffects.globalstep_timer < 1) then
 266                 return
 267         end
 268         playereffects.globalstep_timer = 0
 269
 270         local players = minetest.get_connected_players()
 271         for p=1,#players do
 272                 playereffects.hud_update(players[p])
 273         end
 274 end)
 275
 276
 277
 278
 279 --[=[ HUD ]=]
 280 function playereffects.hud_update(player)
 281         if(playereffects.use_hud == true) then
 282                 local now = os.time()
 283                 local effects = playereffects.get_player_effects(player:get_player_name())
 284                 for e=1,#effects do
 285                         local effect = effects[e]
 286                         if(effect.hudids.text_id ~= nil) then
 287                                 local description = playereffects.effect_types[effect.effect_type_id].description
 288                                 local time_left = os.difftime(effect.start_time + effect.time_left, now)
 289                                 player:hud_change(effect.hudids.text_id, "text", description .. " ("..tostring(time_left).." s)")
 290                         end
 291                 end
 292         end
 293 end
 294
 295 function playereffects.hud_clear(player)
 296         if(playereffects.use_hud == true) then
 297                 local playername = player:get_player_name()
 298                 local effects = playereffects.get_player_effects(playername)
 299                 if(effects ~= nil) then
 300                         for e=1,#effects do
 301                                 if(effects[e].hudids.text_id ~= nil) then
 302                                         player:hud_remove(effects[e].hudids.text_id)
 303                                 end
 304                                 if(effects[e].hudids.icon_id ~= nil) then
 305                                         player:hud_remove(effects[e].hudids.icon_id)
 306                                 end
 307                         end
 308                 end
 309         end
 310 end
 311
 312 function playereffects.hud_effect(effect_type_id, player, pos, time_left)
 313         local text_id, icon_id
 314         local effect_type = playereffects.effect_types[effect_type_id]
 315         if(playereffects.use_hud == true and effect_type.hidden == false) then
 316                 text_id = player:hud_add({
 317                         hud_elem_type = "text",
 318                         position = { x = 1, y = 0.3 },
 319                         name = "effect_"..effect_type_id,
 320                         text = playereffects.effect_types[effect_type_id].description .. " ("..tostring(time_left).." s)",
 321                         scale = { x = 170, y = 20},
 322                         alignment = { x = -1, y = 0 },
 323                         direction = 1,
 324                         number = 0xFFFFFF,
 325                         offset = { x = -5, y = pos*20 }
 326                 })
 327                 if(playereffects.effect_types[effect_type_id].icon ~= nil) then
 328                         icon_id = player:hud_add({
 329                                 hud_elem_type = "image",
 330                                 scale = { x = 1, y = 1 },
 331                                 position = { x = 1, y = 0.3 },
 332                                 name = "effect_icon_"..effect_type_id,
 333                                 text = playereffects.effect_types[effect_type_id].icon,
 334                                 alignment = { x = -1, y=0 },
 335                                 direction = 0,
 336                                 offset = { x = -186, y = pos*20 },
 337                         })
 338                 end
 339         else
 340                 text_id = nil
 341                 icon_id = nil
 342         end
 343         return { text_id = text_id, icon_id = icon_id }
 344 end
 345
 346
 347 -- LOAD EXAMPLES
 348 dofile(minetest.get_modpath(minetest.get_current_modname()).."/examples.lua")