minetest_playereffects/examples.lua
Wuzzy c400ac1ed9 Add cancel_on_death parameter for effect types.
This optional parameter controls wheather the effect shall be cancelled
when the player dies. By default, this is true.
2014-07-15 00:38:01 +02:00

224 lines
6.4 KiB
Lua

----- EXAMPLE EFFECT TYPES -----
--[[ This is just a helper function to inform the user of the chat command
of the result and, if successful, shows the effect ID. ]]
local function notify(name, retcode)
if(retcode == false) then
minetest.chat_send_player(name, "Effect application failed. Effect was NOT applied.")
else
minetest.chat_send_player(name, "Effect applied. Effect ID: "..tostring(retcode))
end
end
--[[ Null effect. The apply function always returns false, which means applying the
effect will never succeed ]]
playereffects.register_effect_type("null", "No effect", nil, {},
function()
return false
end
)
-- Makes the player screen black for 5 seconds (very experimental!)
playereffects.register_effect_type("blind", "Blind", nil, {},
function(player)
local hudid = player:hud_add({
hud_elem_type = "image",
position = { x=0.5, y=0.5 },
scale = { x=-100, y=-100 },
text = "playereffects_example_black.png",
})
if(hudid ~= nil) then
return { hudid = hudid }
else
minetest.log("error", "[playereffects] [examples] The effect \"Blind\" could not be applied. The call to hud_add(...) failed.")
return false
end
end,
function(effect)
local player = minetest.get_player_by_name(effect.playername)
player:hud_remove(effect.metadata.hudid)
end
)
-- Makes the user faster
playereffects.register_effect_type("high_speed", "High speed", nil, {"speed"},
function(player)
player:set_physics_override(4,nil,nil)
end,
function(effect)
local player = minetest.get_player_by_name(effect.playername)
player:set_physics_override(1,nil,nil)
end
)
-- Makes the user faster (hidden effect)
playereffects.register_effect_type("high_speed_hidden", "High speed", nil, {"speed"},
function(player)
player:set_physics_override(4,nil,nil)
end,
function(effect)
local player = minetest.get_player_by_name(effect.playername)
player:set_physics_override(1,nil,nil)
end,
true
)
-- Slows the user down
playereffects.register_effect_type("low_speed", "Low speed", nil, {"speed"},
function(player)
player:set_physics_override(0.25,nil,nil)
end,
function(effect)
local player = minetest.get_player_by_name(effect.playername)
player:set_physics_override(1,nil,nil)
end
)
-- Increases the jump height
playereffects.register_effect_type("highjump", "Greater jump height", "playereffects_example_highjump.png", {"jump"},
function(player)
player:set_physics_override(nil,2,nil)
end,
function(effect)
local player = minetest.get_player_by_name(effect.playername)
player:set_physics_override(nil,1,nil)
end
)
-- Adds the “fly” privilege. Keep the privilege even if the player dies
playereffects.register_effect_type("fly", "Fly mode available", "playereffects_example_fly.png", {"fly"},
function(player)
local playername = player:get_player_name()
local privs = minetest.get_player_privs(playername)
privs.fly = true
minetest.set_player_privs(playername, privs)
end,
function(effect)
local privs = minetest.get_player_privs(effect.playername)
privs.fly = nil
minetest.set_player_privs(effect.playername, privs)
end,
false, -- not hidden
false -- do NOT cancel the effect on death
)
-- Dummy effect for the stree test
playereffects.register_effect_type("stress", "Stress Test Effect", nil, {},
function(player)
end,
function(effect)
end
)
------ Chat commands for the example effects ------
-- Null effect (never succeeds)
minetest.register_chatcommand("null", {
params = "",
description = "Does nothing.",
privs = {},
func = function(name, param)
local ret = playereffects.apply_effect_type("null", 5, minetest.get_player_by_name(name))
notify(name, ret)
end,
})
minetest.register_chatcommand("blind", {
params = "",
description = "Makes your screen black for a short time.",
privs = {},
func = function(name, param)
local ret = playereffects.apply_effect_type("blind", 5, minetest.get_player_by_name(name))
notify(name, ret)
end,
})
minetest.register_chatcommand("fast", {
params = "",
description = "Makes you fast for a short time.",
privs = {},
func = function(name, param)
local ret = playereffects.apply_effect_type("high_speed", 10, minetest.get_player_by_name(name))
notify(name, ret)
end,
})
minetest.register_chatcommand("hfast", {
params = "",
description = "Makes you fast for a short time (hidden effect).",
privs = {},
func = function(name, param)
local ret = playereffects.apply_effect_type("high_speed_hidden", 10, minetest.get_player_by_name(name))
notify(name, ret)
end,
})
minetest.register_chatcommand("slow", {
params = "",
description = "Makes you slow for a long time.",
privs = {},
func = function(name, param)
local ret = playereffects.apply_effect_type("low_speed", 120, minetest.get_player_by_name(name))
notify(name, ret)
end,
})
minetest.register_chatcommand("highjump", {
params = "",
description = "Makes you jump higher for a short time.",
privs = {},
func = function(name, param)
local ret = playereffects.apply_effect_type("highjump", 20, minetest.get_player_by_name(name))
notify(name, ret)
end,
})
minetest.register_chatcommand("fly", {
params = "",
description = "Grants you the fly privilege for a minute. You keep the effect when you die.",
privs = {},
func = function(name, param)
local ret = playereffects.apply_effect_type("fly", 60, minetest.get_player_by_name(name))
notify(name, ret)
end,
})
--[[
Cancel all active effects
]]
minetest.register_chatcommand("cancelall", {
params = "",
description = "Cancels all your effects.",
privs = {},
func = function(name, param)
local effects = playereffects.get_player_effects(name)
for e=1, #effects do
playereffects.cancel_effect(effects[e].effect_id)
end
minetest.chat_send_player(name, "All effects cancelled.")
end,
})
--[[ The stress test applies a shitload of effects at once.
This is used to test the performance of this mod at very large effect numbers. ]]
minetest.register_chatcommand("stresstest", {
params = "[<effects>]",
descriptions = "Start the stress test for Player Effects with <effects> effects.",
privs = {server=true},
func = function(name, param)
local player = minetest.get_player_by_name(name)
local max = 100
if(type(param)=="string") then
if(type(tonumber(param)) == "number") then
max = tonumber(param)
if(max > 1000) then max = 1000 end
end
end
minetest.debug("[playereffects] Stress test started for "..name.." with "..max.." effects.")
for i=1,max do
playereffects.apply_effect_type("stress", 10, player)
end
end
})