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