ModApiUtil Class Reference

#include <l_util.h>

Inheritance diagram for ModApiUtil:

Collaboration diagram for ModApiUtil:

Static Public Member Functions
static void	Initialize (lua_State *L, int top)
static void	InitializeAsync (lua_State *L, int top)
static void	InitializeClient (lua_State *L, int top)
static void	InitializeSSCSM (lua_State *L, int top)
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.

Static Private Member Functions
static int	l_log (lua_State *L)
static int	l_get_us_time (lua_State *L)
static int	l_get_us_time_sscsm (lua_State *L)
static int	l_parse_json (lua_State *L)
static int	l_write_json (lua_State *L)
static int	l_get_tool_wear_after_use (lua_State *L)
static int	l_get_dig_params (lua_State *L)
static int	l_get_hit_params (lua_State *L)
static int	l_check_password_entry (lua_State *L)
static int	l_get_password_hash (lua_State *L)
static int	l_is_yes (lua_State *L)
static int	l_path_exists (lua_State *L)
static int	l_get_builtin_path (lua_State *L)
static int	l_get_user_path (lua_State *L)
static int	l_compress (lua_State *L)
static int	l_decompress (lua_State *L)
static int	l_mkdir (lua_State *L)
static int	l_rmdir (lua_State *L)
static int	l_cpdir (lua_State *L)
static int	l_mvdir (lua_State *L)
static int	l_get_dir_list (lua_State *L)
static int	l_safe_file_write (lua_State *L)
static int	l_request_insecure_environment (lua_State *L)
static int	l_encode_base64 (lua_State *L)
static int	l_decode_base64 (lua_State *L)
static int	l_get_version (lua_State *L)
static int	l_sha1 (lua_State *L)
static int	l_sha256 (lua_State *L)
static int	l_colorspec_to_colorstring (lua_State *L)
static int	l_colorspec_to_bytes (lua_State *L)
static int	l_colorspec_to_table (lua_State *L)
static int	l_time_to_day_night_ratio (lua_State *L)
static int	l_encode_png (lua_State *L)
static int	l_get_last_run_mod (lua_State *L)
static int	l_set_last_run_mod (lua_State *L)
static int	l_urlencode (lua_State *L)
static int	l_is_valid_player_name (lua_State *L)
static int	l_strip_escapes (lua_State *L)

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.
static bool	geti (lua_State *L, int table, int i)
	Utility for list iteration.
template<typename F>
static void	for_ipairs (lua_State *L, int table, const F &f)
	Iterate values t[1], t[2], ... of the given table in order.

Member Function Documentation

Initialize()

void ModApiUtil::Initialize ( lua_State * L, int top )

static

References API_FCT, compress(), LuaSettings::create(), decompress(), g_settings, g_settings_path, is_valid_player_name(), is_yes(), and urlencode().

Referenced by ServerScripting::InitializeModApi(), MainMenuScripting::initializeModApi(), and PauseMenuScripting::initializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

InitializeAsync()

void ModApiUtil::InitializeAsync ( lua_State * L, int top )

static

References API_FCT, compress(), LuaSettings::create(), decompress(), g_settings, g_settings_path, is_yes(), and urlencode().

Referenced by ServerScripting::initAsync(), EmergeScripting::InitializeModApi(), and MainMenuScripting::initializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

InitializeClient()

void ModApiUtil::InitializeClient ( lua_State * L, int top )

static

References API_FCT, compress(), LuaSettings::create(), decompress(), g_settings, g_settings_path, is_yes(), and urlencode().

Referenced by ClientScripting::InitializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

InitializeSSCSM()

void ModApiUtil::InitializeSSCSM ( lua_State * L, int top )

static

References API_FCT, compress(), decompress(), is_yes(), l_get_us_time_sscsm(), ModApiBase::registerFunction(), and urlencode().

Referenced by SSCSMScripting::initializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

l_check_password_entry()

int ModApiUtil::l_check_password_entry ( lua_State * L )

staticprivate

References base64_is_valid(), decode_srp_verifier_and_salt(), generate_srp_verifier(), hash(), NO_MAP_LOCK_REQUIRED, translate_password(), and warningstream.

Here is the call graph for this function:

l_colorspec_to_bytes()

int ModApiUtil::l_colorspec_to_bytes ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, and read_color().

Here is the call graph for this function:

l_colorspec_to_colorstring()

int ModApiUtil::l_colorspec_to_colorstring ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, and read_color().

Here is the call graph for this function:

l_colorspec_to_table()

int ModApiUtil::l_colorspec_to_table ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, push_ARGB8(), and read_color().

Here is the call graph for this function:

l_compress()

int ModApiUtil::l_compress ( lua_State * L )

staticprivate

References compressZlib(), compressZstd(), get_compress_method(), LUA_COMPRESS_METHOD_DEFLATE, LUA_COMPRESS_METHOD_ZSTD, NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), and ZSTD_CLEVEL_DEFAULT.

Here is the call graph for this function:

l_cpdir()

int ModApiUtil::l_cpdir ( lua_State * L )

staticprivate

References CHECK_SECURE_PATH, fs::CopyDir(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_decode_base64()

int ModApiUtil::l_decode_base64 ( lua_State * L )

staticprivate

References base64_decode(), base64_is_valid(), NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_decompress()

int ModApiUtil::l_decompress ( lua_State * L )

staticprivate

References decompressZlib(), decompressZstd(), get_compress_method(), LUA_COMPRESS_METHOD_DEFLATE, LUA_COMPRESS_METHOD_ZSTD, NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_encode_base64()

int ModApiUtil::l_encode_base64 ( lua_State * L )

staticprivate

References base64_encode(), NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_encode_png()

int ModApiUtil::l_encode_png ( lua_State * L )

staticprivate

References encodePNG(), NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_get_builtin_path()

int ModApiUtil::l_get_builtin_path ( lua_State * L )

staticprivate

References DIR_DELIM, NO_MAP_LOCK_REQUIRED, and porting::path_share.

l_get_dig_params()

int ModApiUtil::l_get_dig_params ( lua_State * L )

staticprivate

References getDigParams(), NO_MAP_LOCK_REQUIRED, push_dig_params(), read_groups(), read_tool_capabilities(), and LuaHelper::readParam().

Here is the call graph for this function:

l_get_dir_list()

int ModApiUtil::l_get_dir_list ( lua_State * L )

staticprivate

References CHECK_SECURE_PATH, fs::GetDirListing(), NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_get_hit_params()

int ModApiUtil::l_get_hit_params ( lua_State * L )

staticprivate

References getHitParams(), NO_MAP_LOCK_REQUIRED, push_hit_params(), read_groups(), read_tool_capabilities(), and LuaHelper::readParam().

Here is the call graph for this function:

l_get_last_run_mod()

int ModApiUtil::l_get_last_run_mod ( lua_State * L )

staticprivate

References ScriptApiBase::getCurrentModNameInsecure(), ScriptApiBase::getOrigin(), ModApiBase::getScriptApiBase(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_get_password_hash()

int ModApiUtil::l_get_password_hash ( lua_State * L )

staticprivate

References hash(), NO_MAP_LOCK_REQUIRED, and translate_password().

Here is the call graph for this function:

l_get_tool_wear_after_use()

int ModApiUtil::l_get_tool_wear_after_use ( lua_State * L )

staticprivate

References calculateResultWear(), NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_get_us_time()

int ModApiUtil::l_get_us_time ( lua_State * L )

staticprivate

References porting::getTimeUs(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_get_us_time_sscsm()

int ModApiUtil::l_get_us_time_sscsm ( lua_State * L )

staticprivate

References porting::getTimeUs(), NO_MAP_LOCK_REQUIRED, and SSCSM_CLOCK_RESOLUTION_US.

Referenced by InitializeSSCSM().

Here is the call graph for this function:

Here is the caller graph for this function:

l_get_user_path()

int ModApiUtil::l_get_user_path ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, and porting::path_user.

l_get_version()

int ModApiUtil::l_get_version ( lua_State * L )

staticprivate

References g_version_hash, g_version_string, LATEST_PROTOCOL_VERSION, SERVER_PROTOCOL_VERSION_MIN, and table.

l_is_valid_player_name()

int ModApiUtil::l_is_valid_player_name ( lua_State * L )

staticprivate

References is_valid_player_name(), NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_is_yes()

int ModApiUtil::l_is_yes ( lua_State * L )

staticprivate

References is_yes(), NO_MAP_LOCK_REQUIRED, and LuaHelper::readParam().

Here is the call graph for this function:

l_log()

int ModApiUtil::l_log ( lua_State * L )

staticprivate

References g_logger, LL_MAX, LL_NONE, log_deprecated(), NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), Logger::stringToLevel(), and warningstream.

Here is the call graph for this function:

l_mkdir()

int ModApiUtil::l_mkdir ( lua_State * L )

staticprivate

References CHECK_SECURE_PATH, fs::CreateAllDirs(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_mvdir()

int ModApiUtil::l_mvdir ( lua_State * L )

staticprivate

References CHECK_SECURE_PATH, fs::MoveDir(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_parse_json()

int ModApiUtil::l_parse_json ( lua_State * L )

staticprivate

References errorstream, MAX_JSON_DEPTH, NO_MAP_LOCK_REQUIRED, push_json_value(), and LuaHelper::readParam().

Here is the call graph for this function:

l_path_exists()

int ModApiUtil::l_path_exists ( lua_State * L )

staticprivate

References CHECK_SECURE_PATH, NO_MAP_LOCK_REQUIRED, and fs::PathExists().

Here is the call graph for this function:

l_request_insecure_environment()

int ModApiUtil::l_request_insecure_environment ( lua_State * L )

staticprivate

References ScriptApiSecurity::checkWhitelisted(), ScriptApiSecurity::getGlobalsBackup(), ScriptApiSecurity::isSecure(), and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_rmdir()

int ModApiUtil::l_rmdir ( lua_State * L )

staticprivate

References CHECK_SECURE_PATH, fs::DeleteSingleFileOrEmptyDirectory(), NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), and fs::RecursiveDelete().

Here is the call graph for this function:

l_safe_file_write()

int ModApiUtil::l_safe_file_write ( lua_State * L )

staticprivate

References CHECK_SECURE_PATH, NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), and fs::safeWriteToFile().

Here is the call graph for this function:

l_set_last_run_mod()

int ModApiUtil::l_set_last_run_mod ( lua_State * L )

staticprivate

References ModApiBase::getScriptApiBase(), NO_MAP_LOCK_REQUIRED, and ScriptApiBase::setOriginDirect().

Here is the call graph for this function:

l_sha1()

int ModApiUtil::l_sha1 ( lua_State * L )

staticprivate

References hex_encode(), NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), and hashing::sha1().

Here is the call graph for this function:

l_sha256()

int ModApiUtil::l_sha256 ( lua_State * L )

staticprivate

References hex_encode(), NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), and hashing::sha256().

Here is the call graph for this function:

l_strip_escapes()

int ModApiUtil::l_strip_escapes ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), and unescape_enriched().

Here is the call graph for this function:

l_time_to_day_night_ratio()

int ModApiUtil::l_time_to_day_night_ratio ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, and time_to_daynight_ratio().

Here is the call graph for this function:

l_urlencode()

int ModApiUtil::l_urlencode ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, LuaHelper::readParam(), and urlencode().

Here is the call graph for this function:

l_write_json()

int ModApiUtil::l_write_json ( lua_State * L )

staticprivate

References fastWriteJson(), MAX_JSON_DEPTH, NO_MAP_LOCK_REQUIRED, read_json_value(), LuaHelper::readParam(), and BaseException::what().

Here is the call graph for this function:

---

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

• script/lua_api/l_util.h
• script/lua_api/l_util.cpp