Skip to content

Commit

Permalink
Add reasons to on_dieplayer and on_hpchange
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenwardy authored Mar 28, 2018
1 parent 2323842 commit dfc8198
Show file tree
Hide file tree
Showing 14 changed files with 219 additions and 52 deletions.
6 changes: 3 additions & 3 deletions builtin/game/register.lua
Original file line number Diff line number Diff line change
Expand Up @@ -529,11 +529,11 @@ end

core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }

function core.registered_on_player_hpchange(player, hp_change)
function core.registered_on_player_hpchange(player, hp_change, reason)
local last = false
for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
local func = core.registered_on_player_hpchanges.modifiers[i]
hp_change, last = func(player, hp_change)
hp_change, last = func(player, hp_change, reason)
if type(hp_change) ~= "number" then
local debuginfo = debug.getinfo(func)
error("The register_on_hp_changes function has to return a number at " ..
Expand All @@ -544,7 +544,7 @@ function core.registered_on_player_hpchange(player, hp_change)
end
end
for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
func(player, hp_change)
func(player, hp_change, reason)
end
return hp_change
end
Expand Down
30 changes: 21 additions & 9 deletions doc/lua_api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1136,7 +1136,7 @@ previous.

This combination results in noise varying very roughly between -2.0 and 2.0 and
with an average value of 0.0, so `scale` and `offset` are then used to multiply
and offset the noise variation.
and offset the noise variation.

The final perlin noise variation is created as follows:

Expand Down Expand Up @@ -2779,8 +2779,6 @@ Call these functions only at load time!
is a bit faster than usually.
* `minetest.register_on_newplayer(func(ObjectRef))`
* Called after a new player has been created
* `minetest.register_on_dieplayer(func(ObjectRef))`
* Called when a player dies
* `minetest.register_on_punchplayer(func(player, hitter, time_from_last_punch, tool_capabilities, dir, damage))`
* Called when a player is punched
* `player` - ObjectRef - Player that was punched
Expand All @@ -2792,15 +2790,28 @@ Call these functions only at load time!
the puncher to the punched.
* `damage` - number that represents the damage calculated by the engine
* should return `true` to prevent the default damage mechanism
* `minetest.register_on_player_hpchange(func(player, hp_change), modifier)`
* `minetest.register_on_player_hpchange(func(player, hp_change, reason), modifier)`
* Called when the player gets damaged or healed
* `player`: ObjectRef of the player
* `hp_change`: the amount of change. Negative when it is damage.
* `reason`: a PlayerHPChangeReason table.
* The `type` field will have one of the following values:
* `set_hp` - A mod or the engine called `set_hp` without
giving a type - use this for custom damage types.
* `punch` - Was punched. `reason.object` will hold the puncher, or nil if none.
* `fall`
* `node_damage` - damage_per_second from a neighbouring node.
* `drown`
* `respawn`
* Any of the above types may have additional fields from mods.
* `reason.from` will be `mod` or `engine`.
* `modifier`: when true, the function should return the actual `hp_change`.
Note: modifiers only get a temporary hp_change that can be modified by
later modifiers. modifiers can return true as a second argument to stop
the execution of further functions. Non-modifiers receive the final hp
change calculated by the modifiers.
Note: modifiers only get a temporary hp_change that can be modified by later modifiers.
modifiers can return true as a second argument to stop the execution of further functions.
Non-modifiers receive the final hp change calculated by the modifiers.
* `minetest.register_on_dieplayer(func(ObjectRef, reason))`
* Called when a player dies
* `reason`: a PlayerHPChangeReason table, see register_on_player_hpchange
* `minetest.register_on_respawnplayer(func(ObjectRef))`
* Called when player is to be respawned
* Called _before_ repositioning of player occurs
Expand Down Expand Up @@ -3939,7 +3950,8 @@ This is basically a reference to a C++ `ServerActiveObject`
* `direction`: can be `nil`
* `right_click(clicker)`; `clicker` is another `ObjectRef`
* `get_hp()`: returns number of hitpoints (2 * number of hearts)
* `set_hp(hp)`: set number of hitpoints (2 * number of hearts)
* `set_hp(hp, reason)`: set number of hitpoints (2 * number of hearts).
* See reason in register_on_player_hpchange
* `get_inventory()`: returns an `InvRef`
* `get_wield_list()`: returns the name of the inventory list the wielded item
is in.
Expand Down
29 changes: 29 additions & 0 deletions games/minimal/mods/test/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,32 @@ assert(pseudo:next() == 22290)
assert(pseudo:next() == 13854)


--
-- HP Change Reasons
--
local expect = nil
minetest.register_on_joinplayer(function(player)
expect = { type = "set_hp", from = "mod" }
player:set_hp(3)
assert(expect == nil)

expect = { a = 234, type = "set_hp", from = "mod" }
player:set_hp(10, { a= 234 })
assert(expect == nil)

expect = { df = 3458973454, type = "fall", from = "mod" }
player:set_hp(10, { type = "fall", df = 3458973454 })
assert(expect == nil)
end)

minetest.register_on_player_hpchange(function(player, hp, reason)
for key, value in pairs(reason) do
assert(expect[key] == value)
end

for key, value in pairs(expect) do
assert(reason[key] == value)
end

expect = nil
end)
17 changes: 10 additions & 7 deletions src/content_sao.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -921,8 +921,9 @@ void PlayerSAO::step(float dtime, bool send_recommended)

// No more breath, damage player
if (m_breath == 0) {
setHP(m_hp - c.drowning);
m_env->getGameDef()->SendPlayerHPOrDie(this);
PlayerHPChangeReason reason(PlayerHPChangeReason::DROWNING);
setHP(m_hp - c.drowning, reason);
m_env->getGameDef()->SendPlayerHPOrDie(this, reason);
}
}
}
Expand Down Expand Up @@ -961,8 +962,9 @@ void PlayerSAO::step(float dtime, bool send_recommended)

if (damage_per_second != 0 && m_hp > 0) {
s16 newhp = ((s32) damage_per_second > m_hp ? 0 : m_hp - damage_per_second);
setHP(newhp);
m_env->getGameDef()->SendPlayerHPOrDie(this);
PlayerHPChangeReason reason(PlayerHPChangeReason::NODE_DAMAGE);
setHP(newhp, reason);
m_env->getGameDef()->SendPlayerHPOrDie(this, reason);
}
}

Expand Down Expand Up @@ -1208,7 +1210,8 @@ int PlayerSAO::punch(v3f dir,
hitparams.hp);

if (!damage_handled) {
setHP(getHP() - hitparams.hp);
setHP(getHP() - hitparams.hp,
PlayerHPChangeReason(PlayerHPChangeReason::PLAYER_PUNCH, puncher));
} else { // override client prediction
if (puncher->getType() == ACTIVEOBJECT_TYPE_PLAYER) {
std::string str = gob_cmd_punched(0, getHP());
Expand Down Expand Up @@ -1238,11 +1241,11 @@ s16 PlayerSAO::readDamage()
return damage;
}

void PlayerSAO::setHP(s16 hp)
void PlayerSAO::setHP(s16 hp, const PlayerHPChangeReason &reason)
{
s16 oldhp = m_hp;

s16 hp_change = m_env->getScriptIface()->on_player_hpchange(this, hp - oldhp);
s16 hp_change = m_env->getScriptIface()->on_player_hpchange(this, hp - oldhp, reason);
if (hp_change == 0)
return;
hp = oldhp + hp_change;
Expand Down
63 changes: 62 additions & 1 deletion src/content_sao.h
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ class PlayerSAO : public UnitSAO
ServerActiveObject *puncher,
float time_from_last_punch);
void rightClick(ServerActiveObject *clicker) {}
void setHP(s16 hp);
void setHP(s16 hp, const PlayerHPChangeReason &reason);
void setHPRaw(s16 hp) { m_hp = hp; }
s16 readDamage();
u16 getBreath() const { return m_breath; }
Expand Down Expand Up @@ -417,3 +417,64 @@ class PlayerSAO : public UnitSAO
bool m_physics_override_new_move = true;
bool m_physics_override_sent = false;
};


struct PlayerHPChangeReason {
enum Type : u8 {
SET_HP,
PLAYER_PUNCH,
FALL,
NODE_DAMAGE,
DROWNING,
RESPAWN
};

Type type = SET_HP;
ServerActiveObject *object;
bool from_mod = false;
int lua_reference = -1;

bool setTypeFromString(const std::string &typestr)
{
if (typestr == "set_hp")
type = SET_HP;
else if (typestr == "punch")
type = PLAYER_PUNCH;
else if (typestr == "fall")
type = FALL;
else if (typestr == "node_damage")
type = NODE_DAMAGE;
else if (typestr == "drown")
type = DROWNING;
else if (typestr == "respawn")
type = RESPAWN;
else
return false;

return true;
}

std::string getTypeAsString() const
{
switch (type) {
case PlayerHPChangeReason::SET_HP:
return "set_hp";
case PlayerHPChangeReason::PLAYER_PUNCH:
return "punch";
case PlayerHPChangeReason::FALL:
return "fall";
case PlayerHPChangeReason::NODE_DAMAGE:
return "node_damage";
case PlayerHPChangeReason::DROWNING:
return "drown";
case PlayerHPChangeReason::RESPAWN:
return "respawn";
default:
return "?";
}
}

PlayerHPChangeReason(Type type, ServerActiveObject *object=NULL):
type(type), object(object)
{}
};
11 changes: 7 additions & 4 deletions src/network/serverpackethandler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -812,8 +812,9 @@ void Server::handleCommand_Damage(NetworkPacket* pkt)
<< (int)damage << " hp at " << PP(playersao->getBasePosition() / BS)
<< std::endl;

playersao->setHP(playersao->getHP() - damage);
SendPlayerHPOrDie(playersao);
PlayerHPChangeReason reason(PlayerHPChangeReason::FALL);
playersao->setHP(playersao->getHP() - damage, reason);
SendPlayerHPOrDie(playersao, reason);
}
}

Expand Down Expand Up @@ -1175,12 +1176,14 @@ void Server::handleCommand_Interact(NetworkPacket* pkt)
// If the object is a player and its HP changed
if (src_original_hp != pointed_object->getHP() &&
pointed_object->getType() == ACTIVEOBJECT_TYPE_PLAYER) {
SendPlayerHPOrDie((PlayerSAO *)pointed_object);
SendPlayerHPOrDie((PlayerSAO *)pointed_object,
PlayerHPChangeReason(PlayerHPChangeReason::PLAYER_PUNCH, playersao));
}

// If the puncher is a player and its HP changed
if (dst_origin_hp != playersao->getHP())
SendPlayerHPOrDie(playersao);
SendPlayerHPOrDie(playersao,
PlayerHPChangeReason(PlayerHPChangeReason::PLAYER_PUNCH, pointed_object));
}

} // action == 0
Expand Down
23 changes: 22 additions & 1 deletion src/script/cpp_api/s_base.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ extern "C" {
#include <cstdio>
#include <cstdarg>
#include "script/common/c_content.h"
#include "content_sao.h"
#include <sstream>


Expand Down Expand Up @@ -151,7 +152,7 @@ void ScriptApiBase::clientOpenLibs(lua_State *L)
{ LUA_JITLIBNAME, luaopen_jit },
#endif
};

for (const std::pair<std::string, lua_CFunction> &lib : m_libs) {
lua_pushcfunction(L, lib.second);
lua_pushstring(L, lib.first.c_str());
Expand Down Expand Up @@ -381,6 +382,26 @@ void ScriptApiBase::objectrefGetOrCreate(lua_State *L,
}
}

void ScriptApiBase::pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason &reason)
{
if (reason.lua_reference >= 0) {
lua_rawgeti(L, LUA_REGISTRYINDEX, reason.lua_reference);
luaL_unref(L, LUA_REGISTRYINDEX, reason.lua_reference);
} else
lua_newtable(L);

lua_pushstring(L, reason.getTypeAsString().c_str());
lua_setfield(L, -2, "type");

lua_pushstring(L, reason.from_mod ? "mod" : "engine");
lua_setfield(L, -2, "from");

if (reason.object) {
objectrefGetOrCreate(L, reason.object);
lua_setfield(L, -2, "object");
}
}

Server* ScriptApiBase::getServer()
{
return dynamic_cast<Server *>(m_gamedef);
Expand Down
3 changes: 3 additions & 0 deletions src/script/cpp_api/s_base.h
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ class IGameDef;
class Environment;
class GUIEngine;
class ServerActiveObject;
class PlayerHPChangeReason;

class ScriptApiBase {
public:
Expand Down Expand Up @@ -139,6 +140,8 @@ class ScriptApiBase {

void objectrefGetOrCreate(lua_State *L, ServerActiveObject *cobj);

void pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason& reason);

std::recursive_mutex m_luastackmutex;
std::string m_last_run_mod;
bool m_secure = false;
Expand Down
20 changes: 14 additions & 6 deletions src/script/cpp_api/s_player.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,20 @@ void ScriptApiPlayer::on_newplayer(ServerActiveObject *player)
runCallbacks(1, RUN_CALLBACKS_MODE_FIRST);
}

void ScriptApiPlayer::on_dieplayer(ServerActiveObject *player)
void ScriptApiPlayer::on_dieplayer(ServerActiveObject *player, const PlayerHPChangeReason &reason)
{
SCRIPTAPI_PRECHECKHEADER

// Get core.registered_on_dieplayers
// Get callback table
lua_getglobal(L, "core");
lua_getfield(L, -1, "registered_on_dieplayers");
// Call callbacks

// Push arguments
objectrefGetOrCreate(L, player);
runCallbacks(1, RUN_CALLBACKS_MODE_FIRST);
pushPlayerHPChangeReason(L, reason);

// Run callbacks
runCallbacks(2, RUN_CALLBACKS_MODE_FIRST);
}

bool ScriptApiPlayer::on_punchplayer(ServerActiveObject *player,
Expand All @@ -71,7 +75,7 @@ bool ScriptApiPlayer::on_punchplayer(ServerActiveObject *player,
}

s16 ScriptApiPlayer::on_player_hpchange(ServerActiveObject *player,
s16 hp_change)
s16 hp_change, const PlayerHPChangeReason &reason)
{
SCRIPTAPI_PRECHECKHEADER

Expand All @@ -82,9 +86,13 @@ s16 ScriptApiPlayer::on_player_hpchange(ServerActiveObject *player,
lua_getfield(L, -1, "registered_on_player_hpchange");
lua_remove(L, -2);

// Push arguments
objectrefGetOrCreate(L, player);
lua_pushnumber(L, hp_change);
PCALL_RES(lua_pcall(L, 2, 1, error_handler));
pushPlayerHPChangeReason(L, reason);

// Call callbacks
PCALL_RES(lua_pcall(L, 3, 1, error_handler));
hp_change = lua_tointeger(L, -1);
lua_pop(L, 2); // Pop result and error handler
return hp_change;
Expand Down
Loading

0 comments on commit dfc8198

Please sign in to comment.