LuaAreaStore Class Reference

#include <l_areastore.h>

Inheritance diagram for LuaAreaStore:

Collaboration diagram for LuaAreaStore:

Public Member Functions
	LuaAreaStore ()
	LuaAreaStore (const std::string &type)
	~LuaAreaStore ()

Static Public Member Functions
static int	create_object (lua_State *L)
static void	Register (lua_State *L)
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)
template<typename T >
static void	registerClass (lua_State *L, 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.

Public Attributes
AreaStore *	as = nullptr

Static Public Attributes
static const char	className [] = "AreaStore"

Static Private Member Functions
static int	gc_object (lua_State *L)
static int	l_get_area (lua_State *L)
static int	l_get_areas_for_pos (lua_State *L)
static int	l_get_areas_in_area (lua_State *L)
static int	l_insert_area (lua_State *L)
static int	l_reserve (lua_State *L)
static int	l_remove_area (lua_State *L)
static int	l_set_cache_params (lua_State *L)
static int	l_to_string (lua_State *L)
static int	l_to_file (lua_State *L)
static int	l_from_string (lua_State *L)
static int	l_from_file (lua_State *L)

Static Private Attributes
static const luaL_Reg	methods []

Additional Inherited Members
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.
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.

Constructor & Destructor Documentation

LuaAreaStore() [1/2]

LuaAreaStore::LuaAreaStore

(

)

Referenced by create_object().

Here is the caller graph for this function:

LuaAreaStore() [2/2]

LuaAreaStore::LuaAreaStore

(

const std::string &

type

)

References as.

~LuaAreaStore()

LuaAreaStore::~LuaAreaStore

(

)

References as.

Member Function Documentation

create_object()

int LuaAreaStore::create_object ( lua_State * L )

static

References LuaAreaStore(), className, NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Referenced by Register().

Here is the call graph for this function:

Here is the caller graph for this function:

gc_object()

int LuaAreaStore::gc_object ( lua_State * L )

staticprivate

Referenced by Register().

Here is the caller graph for this function:

l_from_file()

int LuaAreaStore::l_from_file ( lua_State * L )

staticprivate

References as, CHECK_SECURE_PATH, ModApiBase::checkObject(), deserialization_helper(), NO_MAP_LOCK_REQUIRED, and open_ifstream().

Here is the call graph for this function:

l_from_string()

int LuaAreaStore::l_from_string ( lua_State * L )

staticprivate

References as, ModApiBase::checkObject(), deserialization_helper(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_get_area()

int LuaAreaStore::l_get_area ( lua_State * L )

staticprivate

References as, ModApiBase::checkObject(), get_data_and_corner_flags(), AreaStore::getArea(), NO_MAP_LOCK_REQUIRED, and push_area().

Here is the call graph for this function:

l_get_areas_for_pos()

int LuaAreaStore::l_get_areas_for_pos ( lua_State * L )

staticprivate

References as, check_v3s16(), ModApiBase::checkObject(), get_data_and_corner_flags(), AreaStore::getAreasForPos(), NO_MAP_LOCK_REQUIRED, and push_areas().

Here is the call graph for this function:

l_get_areas_in_area()

int LuaAreaStore::l_get_areas_in_area ( lua_State * L )

staticprivate

References as, check_v3s16(), ModApiBase::checkObject(), get_data_and_corner_flags(), AreaStore::getAreasInArea(), NO_MAP_LOCK_REQUIRED, push_areas(), LuaHelper::readParam(), and sortBoxVerticies().

Here is the call graph for this function:

l_insert_area()

int LuaAreaStore::l_insert_area ( lua_State * L )

staticprivate

References as, check_v3s16(), ModApiBase::checkObject(), Area::data, Area::id, AreaStore::insertArea(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_remove_area()

int LuaAreaStore::l_remove_area ( lua_State * L )

staticprivate

References as, ModApiBase::checkObject(), NO_MAP_LOCK_REQUIRED, and AreaStore::removeArea().

Here is the call graph for this function:

l_reserve()

int LuaAreaStore::l_reserve ( lua_State * L )

staticprivate

References as, ModApiBase::checkObject(), NO_MAP_LOCK_REQUIRED, and AreaStore::reserve().

Here is the call graph for this function:

l_set_cache_params()

int LuaAreaStore::l_set_cache_params ( lua_State * L )

staticprivate

References as, ModApiBase::checkObject(), getboolfield_default(), getintfield_default(), NO_MAP_LOCK_REQUIRED, and AreaStore::setCacheParams().

Here is the call graph for this function:

l_to_file()

int LuaAreaStore::l_to_file ( lua_State * L )

staticprivate

References as, CHECK_SECURE_PATH, ModApiBase::checkObject(), NO_MAP_LOCK_REQUIRED, fs::safeWriteToFile(), and AreaStore::serialize().

Here is the call graph for this function:

l_to_string()

int LuaAreaStore::l_to_string ( lua_State * L )

staticprivate

References as, ModApiBase::checkObject(), NO_MAP_LOCK_REQUIRED, and AreaStore::serialize().

Here is the call graph for this function:

Register()

void LuaAreaStore::Register ( lua_State * L )

static

References className, create_object(), gc_object(), methods, and ModApiBase::registerClass().

Referenced by ServerScripting::InitializeAsync(), EmergeScripting::InitializeModApi(), and ServerScripting::InitializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

as

AreaStore* LuaAreaStore::as = nullptr

Referenced by LuaAreaStore(), ~LuaAreaStore(), l_from_file(), l_from_string(), l_get_area(), l_get_areas_for_pos(), l_get_areas_in_area(), l_insert_area(), l_remove_area(), l_reserve(), l_set_cache_params(), l_to_file(), and l_to_string().

className

const char LuaAreaStore::className = "AreaStore"

static

Referenced by create_object(), and Register().

methods

const luaL_Reg LuaAreaStore::methods

staticprivate

Initial value:

= {
        luamethod(LuaAreaStore, get_area),
        luamethod(LuaAreaStore, get_areas_for_pos),
        luamethod(LuaAreaStore, get_areas_in_area),
        luamethod(LuaAreaStore, insert_area),
        luamethod(LuaAreaStore, reserve),
        luamethod(LuaAreaStore, remove_area),
        luamethod(LuaAreaStore, set_cache_params),
        luamethod(LuaAreaStore, to_string),
        luamethod(LuaAreaStore, to_file),
        luamethod(LuaAreaStore, from_string),
        luamethod(LuaAreaStore, from_file),
        {0,0}
}

Referenced by Register().

---

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

• script/lua_api/l_areastore.h
• script/lua_api/l_areastore.cpp