oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-06-27 16:36:03 +00:00
Code Wiki Activity

Refactor ABM/LBM related code

Browse source
This commit is contained in:
sfan5 2024-08-11 13:34:03 +02:00
parent 387856a1c3
commit 7ae51382c8
7 changed files with 295 additions and 269 deletions
Download patch file Download diff file Expand all files Collapse all files

260
src/script/cpp_api/s_env.cpp
View file

@ -25,8 +25,102 @@ with this program; if not, write to the Free Software Foundation, Inc.,
#include "mapgen/mapgen.h"
#include "lua_api/l_env.h"
#include "server.h"
#include "scripting_server.h"
#include "script/common/c_content.h"
/*
LuaABM & LuaLBM
*/
class LuaABM : public ActiveBlockModifier {
private:
int m_id;
std::vector<std::string> m_trigger_contents;
std::vector<std::string> m_required_neighbors;
float m_trigger_interval;
u32 m_trigger_chance;
bool m_simple_catch_up;
s16 m_min_y;
s16 m_max_y;
public:
LuaABM(int id,
const std::vector<std::string> &trigger_contents,
const std::vector<std::string> &required_neighbors,
float trigger_interval, u32 trigger_chance, bool simple_catch_up,
s16 min_y, s16 max_y):
m_id(id),
m_trigger_contents(trigger_contents),
m_required_neighbors(required_neighbors),
m_trigger_interval(trigger_interval),
m_trigger_chance(trigger_chance),
m_simple_catch_up(simple_catch_up),
m_min_y(min_y),
m_max_y(max_y)
{
}
virtual const std::vector<std::string> &getTriggerContents() const
{
return m_trigger_contents;
}
virtual const std::vector<std::string> &getRequiredNeighbors() const
{
return m_required_neighbors;
}
virtual float getTriggerInterval()
{
return m_trigger_interval;
}
virtual u32 getTriggerChance()
{
return m_trigger_chance;
}
virtual bool getSimpleCatchUp()
{
return m_simple_catch_up;
}
virtual s16 getMinY()
{
return m_min_y;
}
virtual s16 getMaxY()
{
return m_max_y;
}
virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
u32 active_object_count, u32 active_object_count_wider)
{
auto *script = env->getScriptIface();
script->triggerABM(m_id, p, n, active_object_count, active_object_count_wider);
}
};
class LuaLBM : public LoadingBlockModifierDef
{
private:
int m_id;
public:
LuaLBM(int id,
const std::vector<std::string> &trigger_contents,
const std::string &name, bool run_at_every_load):
m_id(id)
{
this->run_at_every_load = run_at_every_load;
this->trigger_contents = trigger_contents;
this->name = name;
}
virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n, float dtime_s)
{
auto *script = env->getScriptIface();
script->triggerLBM(m_id, p, n, dtime_s);
}
};
/*
ScriptApiEnv
*/
void ScriptApiEnv::environment_OnGenerated(v3s16 minp, v3s16 maxp,
u32 blockseed)
@ -46,7 +140,6 @@ void ScriptApiEnv::environment_OnGenerated(v3s16 minp, v3s16 maxp,
void ScriptApiEnv::environment_Step(float dtime)
{
SCRIPTAPI_PRECHECKHEADER
//infostream << "scriptapi_environment_step" << std::endl;
// Get core.registered_globalsteps
lua_getglobal(L, "core");
@ -76,12 +169,40 @@ void ScriptApiEnv::player_event(ServerActiveObject *player, const std::string &t
void ScriptApiEnv::initializeEnvironment(ServerEnvironment *env)
{
SCRIPTAPI_PRECHECKHEADER
assert(env);
verbosestream << "ScriptApiEnv: Environment initialized" << std::endl;
setEnv(env);
/*
Add {Loading,Active}BlockModifiers to environment
*/
readABMs();
readLBMs();
}
// Reads a single or a list of node names into a vector
bool ScriptApiEnv::read_nodenames(lua_State *L, int idx, std::vector<std::string> &to)
{
if (lua_istable(L, idx)) {
const int table = idx < 0 ? (lua_gettop(L) + idx + 1) : idx;
lua_pushnil(L);
while (lua_next(L, table)) {
// key at index -2 and value at index -1
luaL_checktype(L, -1, LUA_TSTRING);
to.emplace_back(readParam<std::string>(L, -1));
// removes value, keeps key for next iteration
lua_pop(L, 1);
}
} else if (lua_isstring(L, idx)) {
to.emplace_back(readParam<std::string>(L, idx));
} else {
return false;
}
return true;
}
void ScriptApiEnv::readABMs()
{
SCRIPTAPI_PRECHECKHEADER
auto *env = reinterpret_cast<ServerEnvironment*>(getEnv());
// Get core.registered_abms
lua_getglobal(L, "core");
@ -100,36 +221,12 @@ void ScriptApiEnv::initializeEnvironment(ServerEnvironment *env)
std::vector<std::string> trigger_contents;
lua_getfield(L, current_abm, "nodenames");
if (lua_istable(L, -1)) {
int table = lua_gettop(L);
lua_pushnil(L);
while (lua_next(L, table)) {
// key at index -2 and value at index -1
luaL_checktype(L, -1, LUA_TSTRING);
trigger_contents.emplace_back(readParam<std::string>(L, -1));
// removes value, keeps key for next iteration
lua_pop(L, 1);
}
} else if (lua_isstring(L, -1)) {
trigger_contents.emplace_back(readParam<std::string>(L, -1));
}
read_nodenames(L, -1, trigger_contents);
lua_pop(L, 1);
std::vector<std::string> required_neighbors;
lua_getfield(L, current_abm, "neighbors");
if (lua_istable(L, -1)) {
int table = lua_gettop(L);
lua_pushnil(L);
while (lua_next(L, table)) {
// key at index -2 and value at index -1
luaL_checktype(L, -1, LUA_TSTRING);
required_neighbors.emplace_back(readParam<std::string>(L, -1));
// removes value, keeps key for next iteration
lua_pop(L, 1);
}
} else if (lua_isstring(L, -1)) {
required_neighbors.emplace_back(readParam<std::string>(L, -1));
}
read_nodenames(L, -1, required_neighbors);
lua_pop(L, 1);
float trigger_interval = 10.0;
@ -151,7 +248,7 @@ void ScriptApiEnv::initializeEnvironment(ServerEnvironment *env)
luaL_checktype(L, current_abm + 1, LUA_TFUNCTION);
lua_pop(L, 1);
LuaABM *abm = new LuaABM(L, id, trigger_contents, required_neighbors,
LuaABM *abm = new LuaABM(id, trigger_contents, required_neighbors,
trigger_interval, trigger_chance, simple_catch_up, min_y, max_y);
env->addActiveBlockModifier(abm);
@ -160,6 +257,12 @@ void ScriptApiEnv::initializeEnvironment(ServerEnvironment *env)
lua_pop(L, 1);
}
lua_pop(L, 1);
}
void ScriptApiEnv::readLBMs()
{
SCRIPTAPI_PRECHECKHEADER
auto *env = reinterpret_cast<ServerEnvironment*>(getEnv());
// Get core.registered_lbms
lua_getglobal(L, "core");
@ -177,21 +280,9 @@ void ScriptApiEnv::initializeEnvironment(ServerEnvironment *env)
int id = lua_tonumber(L, -2);
int current_lbm = lua_gettop(L);
std::set<std::string> trigger_contents;
std::vector<std::string> trigger_contents;
lua_getfield(L, current_lbm, "nodenames");
if (lua_istable(L, -1)) {
int table = lua_gettop(L);
lua_pushnil(L);
while (lua_next(L, table)) {
// key at index -2 and value at index -1
luaL_checktype(L, -1, LUA_TSTRING);
trigger_contents.insert(readParam<std::string>(L, -1));
// removes value, keeps key for next iteration
lua_pop(L, 1);
}
} else if (lua_isstring(L, -1)) {
trigger_contents.insert(readParam<std::string>(L, -1));
}
read_nodenames(L, -1, trigger_contents);
lua_pop(L, 1);
std::string name;
@ -204,7 +295,7 @@ void ScriptApiEnv::initializeEnvironment(ServerEnvironment *env)
luaL_checktype(L, current_lbm + 1, LUA_TFUNCTION);
lua_pop(L, 1);
LuaLBM *lbm = new LuaLBM(L, id, trigger_contents, name,
LuaLBM *lbm = new LuaLBM(id, trigger_contents, name,
run_at_every_load);
env->addLoadingBlockModifierDef(lbm);
@ -288,7 +379,7 @@ void ScriptApiEnv::on_liquid_transformed(
int index = 1;
lua_createtable(L, list.size(), 0);
lua_createtable(L, list.size(), 0);
for(std::pair<v3s16, MapNode> p : list) {
for(auto &p : list) {
lua_pushnumber(L, index);
push_v3s16(L, p.first);
lua_rawset(L, -4);
@ -332,3 +423,78 @@ bool ScriptApiEnv::has_on_mapblocks_changed()
luaL_checktype(L, -1, LUA_TTABLE);
return lua_objlen(L, -1) > 0;
}
void ScriptApiEnv::triggerABM(int id, v3s16 p, MapNode n,
u32 active_object_count, u32 active_object_count_wider)
{
SCRIPTAPI_PRECHECKHEADER
int error_handler = PUSH_ERROR_HANDLER(L);
// Get registered_abms
lua_getglobal(L, "core");
lua_getfield(L, -1, "registered_abms");
luaL_checktype(L, -1, LUA_TTABLE);
lua_remove(L, -2); // Remove core
// Get registered_abms[m_id]
lua_pushinteger(L, id);
lua_gettable(L, -2);
FATAL_ERROR_IF(lua_isnil(L, -1), "Entry with given id not found in registered_abms table");
lua_remove(L, -2); // Remove registered_abms
setOriginFromTable(-1);
// Call action
luaL_checktype(L, -1, LUA_TTABLE);
lua_getfield(L, -1, "action");
luaL_checktype(L, -1, LUA_TFUNCTION);
lua_remove(L, -2); // Remove registered_abms[m_id]
push_v3s16(L, p);
pushnode(L, n);
lua_pushnumber(L, active_object_count);
lua_pushnumber(L, active_object_count_wider);
int result = lua_pcall(L, 4, 0, error_handler);
if (result)
scriptError(result, "LuaABM::trigger");
lua_pop(L, 1); // Pop error handler
}
void ScriptApiEnv::triggerLBM(int id, v3s16 p,
const MapNode n, const float dtime_s)
{
SCRIPTAPI_PRECHECKHEADER
int error_handler = PUSH_ERROR_HANDLER(L);
// Get registered_lbms
lua_getglobal(L, "core");
lua_getfield(L, -1, "registered_lbms");
luaL_checktype(L, -1, LUA_TTABLE);
lua_remove(L, -2); // Remove core
// Get registered_lbms[m_id]
lua_pushinteger(L, id);
lua_gettable(L, -2);
FATAL_ERROR_IF(lua_isnil(L, -1), "Entry with given id not found in registered_lbms table");
lua_remove(L, -2); // Remove registered_lbms
setOriginFromTable(-1);
// Call action
luaL_checktype(L, -1, LUA_TTABLE);
lua_getfield(L, -1, "action");
luaL_checktype(L, -1, LUA_TFUNCTION);
lua_remove(L, -2); // Remove registered_lbms[m_id]
push_v3s16(L, p);
pushnode(L, n);
lua_pushnumber(L, dtime_s);
int result = lua_pcall(L, 3, 0, error_handler);
if (result)
scriptError(result, "LuaLBM::trigger");
lua_pop(L, 1); // Pop error handler
}

14
src/script/cpp_api/s_env.h
View file

@ -55,5 +55,19 @@ public:
// Determines whether there are any on_mapblocks_changed callbacks
bool has_on_mapblocks_changed();
// Initializes environment and loads some definitions from Lua
void initializeEnvironment(ServerEnvironment *env);
void triggerABM(int id, v3s16 p, MapNode n,
u32 active_object_count, u32 active_object_count_wider);
void triggerLBM(int id, v3s16 p, MapNode n, float dtime_s);
private:
void readABMs();
void readLBMs();
// Reads a single or a list of node names into a vector
static bool read_nodenames(lua_State *L, int idx, std::vector<std::string> &to);
};

87
src/script/lua_api/l_env.cpp
View file

@ -65,93 +65,6 @@ const EnumString ModApiEnvBase::es_BlockStatusType[] =
///////////////////////////////////////////////////////////////////////////////
void LuaABM::trigger(ServerEnvironment *env, v3s16 p, MapNode n,
u32 active_object_count, u32 active_object_count_wider)
{
ServerScripting *scriptIface = env->getScriptIface();
scriptIface->realityCheck();
lua_State *L = scriptIface->getStack();
sanity_check(lua_checkstack(L, 20));
StackUnroller stack_unroller(L);
int error_handler = PUSH_ERROR_HANDLER(L);
// Get registered_abms
lua_getglobal(L, "core");
lua_getfield(L, -1, "registered_abms");
luaL_checktype(L, -1, LUA_TTABLE);
lua_remove(L, -2); // Remove core
// Get registered_abms[m_id]
lua_pushinteger(L, m_id);
lua_gettable(L, -2);
if(lua_isnil(L, -1))
FATAL_ERROR("");
lua_remove(L, -2); // Remove registered_abms
scriptIface->setOriginFromTable(-1);
// Call action
luaL_checktype(L, -1, LUA_TTABLE);
lua_getfield(L, -1, "action");
luaL_checktype(L, -1, LUA_TFUNCTION);
lua_remove(L, -2); // Remove registered_abms[m_id]
push_v3s16(L, p);
pushnode(L, n);
lua_pushnumber(L, active_object_count);
lua_pushnumber(L, active_object_count_wider);
int result = lua_pcall(L, 4, 0, error_handler);
if (result)
scriptIface->scriptError(result, "LuaABM::trigger");
lua_pop(L, 1); // Pop error handler
}
void LuaLBM::trigger(ServerEnvironment *env, v3s16 p,
const MapNode n, const float dtime_s)
{
ServerScripting *scriptIface = env->getScriptIface();
scriptIface->realityCheck();
lua_State *L = scriptIface->getStack();
sanity_check(lua_checkstack(L, 20));
StackUnroller stack_unroller(L);
int error_handler = PUSH_ERROR_HANDLER(L);
// Get registered_lbms
lua_getglobal(L, "core");
lua_getfield(L, -1, "registered_lbms");
luaL_checktype(L, -1, LUA_TTABLE);
lua_remove(L, -2); // Remove core
// Get registered_lbms[m_id]
lua_pushinteger(L, m_id);
lua_gettable(L, -2);
FATAL_ERROR_IF(lua_isnil(L, -1), "Entry with given id not found in registered_lbms table");
lua_remove(L, -2); // Remove registered_lbms
scriptIface->setOriginFromTable(-1);
// Call action
luaL_checktype(L, -1, LUA_TTABLE);
lua_getfield(L, -1, "action");
luaL_checktype(L, -1, LUA_TFUNCTION);
lua_remove(L, -2); // Remove registered_lbms[m_id]
push_v3s16(L, p);
pushnode(L, n);
lua_pushnumber(L, dtime_s);
int result = lua_pcall(L, 3, 0, error_handler);
if (result)
scriptIface->scriptError(result, "LuaLBM::trigger");
lua_pop(L, 1); // Pop error handler
}
int LuaRaycast::l_next(lua_State *L)
{
GET_PLAIN_ENV_PTR;

79
src/script/lua_api/l_env.h
View file

@ -20,9 +20,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
#pragma once
#include "lua_api/l_base.h"
#include "serverenvironment.h"
#include "raycast.h"
class ServerScripting;
// base class containing helpers
class ModApiEnvBase : public ModApiBase {
protected:
@ -281,82 +282,6 @@ public:
static void InitializeEmerge(lua_State *L, int top);
};
class LuaABM : public ActiveBlockModifier {
private:
int m_id;
std::vector<std::string> m_trigger_contents;
std::vector<std::string> m_required_neighbors;
float m_trigger_interval;
u32 m_trigger_chance;
bool m_simple_catch_up;
s16 m_min_y;
s16 m_max_y;
public:
LuaABM(lua_State *L, int id,
const std::vector<std::string> &trigger_contents,
const std::vector<std::string> &required_neighbors,
float trigger_interval, u32 trigger_chance, bool simple_catch_up, s16 min_y, s16 max_y):
m_id(id),
m_trigger_contents(trigger_contents),
m_required_neighbors(required_neighbors),
m_trigger_interval(trigger_interval),
m_trigger_chance(trigger_chance),
m_simple_catch_up(simple_catch_up),
m_min_y(min_y),
m_max_y(max_y)
{
}
virtual const std::vector<std::string> &getTriggerContents() const
{
return m_trigger_contents;
}
virtual const std::vector<std::string> &getRequiredNeighbors() const
{
return m_required_neighbors;
}
virtual float getTriggerInterval()
{
return m_trigger_interval;
}
virtual u32 getTriggerChance()
{
return m_trigger_chance;
}
virtual bool getSimpleCatchUp()
{
return m_simple_catch_up;
}
virtual s16 getMinY()
{
return m_min_y;
}
virtual s16 getMaxY()
{
return m_max_y;
}
virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n,
u32 active_object_count, u32 active_object_count_wider);
};
class LuaLBM : public LoadingBlockModifierDef
{
private:
int m_id;
public:
LuaLBM(lua_State *L, int id,
const std::set<std::string> &trigger_contents,
const std::string &name,
bool run_at_every_load):
m_id(id)
{
this->run_at_every_load = run_at_every_load;
this->trigger_contents = trigger_contents;
this->name = name;
}
virtual void trigger(ServerEnvironment *env, v3s16 p, MapNode n, float dtime_s);
};
//! Lua wrapper for RaycastState objects
class LuaRaycast : public ModApiBase
{