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