ModApiEnvBase Class Reference

#include <l_env.h>

Inheritance diagram for ModApiEnvBase:

Collaboration diagram for ModApiEnvBase:

Static Protected Member Functions
static void	collectNodeIds (lua_State *L, int idx, const NodeDefManager *ndef, std::vector< content_t > &filter)
static void	checkArea (v3s16 &minp, v3s16 &maxp)
template<typename F >
static int	findNodeNear (lua_State *L, v3s16 pos, int radius, const std::vector< content_t > &filter, int start_radius, F &&getNode)
template<typename F >
static int	findNodesInArea (lua_State *L, const NodeDefManager *ndef, const std::vector< content_t > &filter, bool grouped, F &&iterate)
template<typename F >
static int	findNodesInAreaUnderAir (lua_State *L, v3s16 minp, v3s16 maxp, const std::vector< content_t > &filter, F &&getNode)
Static Protected Member Functions inherited from LuaHelper
template<typename T >
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua state L at index.
template<typename T >
static T	readParam (lua_State *L, int index, const T &default_value)
	Read a value using a template type T from Lua state L at index.

Static Protected Attributes
static const EnumString	es_ClearObjectsMode []
static const EnumString	es_BlockStatusType []

Additional Inherited Members
Static Public Member Functions inherited from ModApiBase
static ScriptApiBase *	getScriptApiBase (lua_State *L)
static Server *	getServer (lua_State *L)
static ServerInventoryManager *	getServerInventoryMgr (lua_State *L)
static EmergeThread *	getEmergeThread (lua_State *L)
static IGameDef *	getGameDef (lua_State *L)
static Environment *	getEnv (lua_State *L)
static std::string	getCurrentModPath (lua_State *L)
template<typename T >
static T *	getScriptApi (lua_State *L)
static bool	registerFunction (lua_State *L, const char *name, lua_CFunction func, int top)
static void	registerClass (lua_State *L, const char *name, const luaL_Reg *methods, const luaL_Reg *metamethods)
template<typename T >
static T *	checkObject (lua_State *L, int narg)
static int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions.
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)
template<>
s16	readParam (lua_State *L, int index)
template<>
int	readParam (lua_State *L, int index)
template<>
float	readParam (lua_State *L, int index)
template<>
v2s16	readParam (lua_State *L, int index)
template<>
v2f	readParam (lua_State *L, int index)
template<>
v3f	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
template<>
std::string	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
	Read a string from Lua state L at index without copying it.

Member Function Documentation

checkArea()

void ModApiEnvBase::checkArea ( v3s16 & minp, v3s16 & maxp )

staticprotected

References CLAMP, VoxelArea::getVolume(), and MAX_WORKING_VOLUME.

Referenced by ModApiEnv::l_find_nodes_in_area(), ModApiEnvVM::l_find_nodes_in_area(), ModApiEnv::l_find_nodes_in_area_under_air(), and ModApiEnvVM::l_find_nodes_in_area_under_air().

Here is the call graph for this function:

Here is the caller graph for this function:

collectNodeIds()

void ModApiEnvBase::collectNodeIds ( lua_State * L, int idx, const NodeDefManager * ndef, std::vector< content_t > & filter )

staticprotected

References NodeDefManager::getIds(), idx, and LuaHelper::readParam().

Referenced by ModApiEnv::l_find_node_near(), ModApiEnvVM::l_find_node_near(), ModApiEnv::l_find_nodes_in_area(), ModApiEnvVM::l_find_nodes_in_area(), ModApiEnv::l_find_nodes_in_area_under_air(), and ModApiEnvVM::l_find_nodes_in_area_under_air().

Here is the call graph for this function:

Here is the caller graph for this function:

findNodeNear()

template<typename F >

int ModApiEnvBase::findNodeNear ( lua_State * L, v3s16 pos, int radius, const std::vector< content_t > & filter, int start_radius, F && getNode )

staticprotected

References CONTAINS, FacePositionCache::getFacePositions(), p(), and push_v3s16().

Referenced by ModApiEnv::l_find_node_near(), and ModApiEnvVM::l_find_node_near().

Here is the call graph for this function:

Here is the caller graph for this function:

findNodesInArea()

template<typename F >

int ModApiEnvBase::findNodesInArea ( lua_State * L, const NodeDefManager * ndef, const std::vector< content_t > & filter, bool grouped, F && iterate )

staticprotected

References NodeDefManager::get(), MapNode::getContent(), idx, ContentFeatures::name, p(), and push_v3s16().

Referenced by ModApiEnv::l_find_nodes_in_area(), and ModApiEnvVM::l_find_nodes_in_area().

Here is the call graph for this function:

Here is the caller graph for this function:

findNodesInAreaUnderAir()

template<typename F >

int ModApiEnvBase::findNodesInAreaUnderAir ( lua_State * L, v3s16 minp, v3s16 maxp, const std::vector< content_t > & filter, F && getNode )

staticprotected

References CONTAINS, CONTENT_AIR, p(), and push_v3s16().

Referenced by ModApiEnv::l_find_nodes_in_area_under_air(), and ModApiEnvVM::l_find_nodes_in_area_under_air().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

es_BlockStatusType

const EnumString ModApiEnvBase::es_BlockStatusType

staticprotected

Initial value:

=
{
        {ServerEnvironment::BS_UNKNOWN, "unknown"},
        {ServerEnvironment::BS_EMERGING, "emerging"},
        {ServerEnvironment::BS_LOADED,  "loaded"},
        {ServerEnvironment::BS_ACTIVE,  "active"},
        {0, NULL},
}

Referenced by ModApiEnv::l_compare_block_status().

es_ClearObjectsMode

const EnumString ModApiEnvBase::es_ClearObjectsMode

staticprotected

Initial value:

=
{
        {CLEAR_OBJECTS_MODE_FULL,  "full"},
        {CLEAR_OBJECTS_MODE_QUICK, "quick"},
        {0, NULL},
}

Referenced by ModApiEnv::l_clear_objects().

---

The documentation for this class was generated from the following files:

• script/lua_api/l_env.h
• script/lua_api/l_env.cpp