examples.lua

   1 ----- EXAMPLE EFFECT TYPES -----
   2
   3 -- Makes the user faster
   4 playereffects.register_effect_type("high_speed", "High speed", nil, {"speed"},
   5         function(player)
   6                 player:set_physics_override(4,nil,nil)
   7         end,
   8
   9         function(effect)
  10                 local player = minetest.get_player_by_name(effect.playername)
  11                 player:set_physics_override(1,nil,nil)
  12         end
  13 )
  14
  15 -- Makes the user faster (hidden effect)
  16 playereffects.register_effect_type("high_speed_hidden", "High speed", nil, {"speed"},
  17         function(player)
  18                 player:set_physics_override(4,nil,nil)
  19         end,
  20
  21         function(effect)
  22                 local player = minetest.get_player_by_name(effect.playername)
  23                 player:set_physics_override(1,nil,nil)
  24         end,
  25         true
  26 )
  27
  28
  29
  30 -- Slows the user down
  31 playereffects.register_effect_type("low_speed", "Low speed", nil, {"speed"},
  32         function(player)
  33                 player:set_physics_override(0.25,nil,nil)
  34         end,
  35
  36         function(effect)
  37                 local player = minetest.get_player_by_name(effect.playername)
  38                 player:set_physics_override(1,nil,nil)
  39         end
  40 )
  41
  42 -- Increases the jump height
  43 playereffects.register_effect_type("highjump", "Greater jump height", "playereffects_example_highjump.png", {"jump"},
  44         function(player)
  45                 player:set_physics_override(nil,2,nil)
  46         end,
  47         function(effect)
  48                 local player = minetest.get_player_by_name(effect.playername)
  49                 player:set_physics_override(nil,1,nil)
  50         end
  51 )
  52
  53 -- Adds the “fly” privilege
  54 playereffects.register_effect_type("fly", "Fly mode available", "playereffects_example_fly.png", {"fly"},
  55         function(player)
  56                 local playername = player:get_player_name()
  57                 local privs = minetest.get_player_privs(playername)
  58                 privs.fly = true
  59                 minetest.set_player_privs(playername, privs)
  60         end,
  61         function(effect)
  62                 local privs = minetest.get_player_privs(effect.playername)
  63                 privs.fly = nil
  64                 minetest.set_player_privs(effect.playername, privs)
  65         end
  66 )
  67
  68 -- Dummy effect for the stree test
  69 playereffects.register_effect_type("stress", "Stress Test Effect", nil, {},
  70         function(player)
  71         end,
  72         function(effect)
  73         end
  74 )
  75
  76
  77 ------ Chat commands for the example effects ------
  78
  79 minetest.register_chatcommand("fast", {
  80         params = "",
  81         description = "Makes you fast for a short time.",
  82         privs = {},
  83         func = function(name, param)
  84                 playereffects.apply_effect_type("high_speed", 10, minetest.get_player_by_name(name))
  85         end,
  86 })
  87 minetest.register_chatcommand("hfast", {
  88         params = "",
  89         description = "Makes you fast for a short time (hidden effect).",
  90         privs = {},
  91         func = function(name, param)
  92                 playereffects.apply_effect_type("high_speed_hidden", 10, minetest.get_player_by_name(name))
  93         end,
  94 })
  95 minetest.register_chatcommand("slow", {
  96         params = "",
  97         description = "Makes you slow for a long time.",
  98         privs = {},
  99         func = function(name, param)
 100                 playereffects.apply_effect_type("low_speed", 120, minetest.get_player_by_name(name))
 101         end,
 102 })
 103 minetest.register_chatcommand("highjump", {
 104         params = "",
 105         description = "Makes you jump higher for a short time.",
 106         privs = {},
 107         func = function(name, param)
 108                 playereffects.apply_effect_type("highjump", 20, minetest.get_player_by_name(name))
 109         end,
 110 })
 111
 112 minetest.register_chatcommand("fly", {
 113         params = "",
 114         description = "Grants you the fly privilege for a short time.",
 115         privs = {},
 116         func = function(name, param)
 117                 playereffects.apply_effect_type("fly", 20, minetest.get_player_by_name(name))
 118         end,
 119 })
 120
 121 --[[ The stress test applies a shitload of effects at once.
 122 This is used to test the performance of this mod at very large effect numbers. ]]
 123 minetest.register_chatcommand("stresstest", {
 124         params = "[<effects>]",
 125         descriptions = "Start the stress test for Player Effects with <effects> effects.",
 126         privs = {server=true},
 127         func = function(name, param)
 128                 local player = minetest.get_player_by_name(name)
 129                 local max = 100
 130                 if(type(param)=="string") then
 131                         if(type(tonumber(param)) == "number") then
 132                                 max = tonumber(param)
 133                                 if(max > 1000) then max = 1000 end
 134                         end
 135                 end
 136                 minetest.debug("[playereffects] Stress test started for "..name.." with "..max.." effects.")
 137                 for i=1,max do
 138                         playereffects.apply_effect_type("stress", 10, player)
 139                 end
 140         end
 141 })