ModApiClient Class Reference

#include <l_client.h>

Inheritance diagram for ModApiClient:

Collaboration diagram for ModApiClient:

Static Public Member Functions
static void	Initialize (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_get_current_modname (lua_State *L)
static int	l_get_modpath (lua_State *L)
static int	l_print (lua_State *L)
static int	l_display_chat_message (lua_State *L)
static int	l_send_chat_message (lua_State *L)
static int	l_clear_out_chat_queue (lua_State *L)
static int	l_get_player_names (lua_State *L)
static int	l_disconnect (lua_State *L)
static int	l_gettext (lua_State *L)
static int	l_get_node_or_nil (lua_State *L)
static int	l_get_language (lua_State *L)
static int	l_get_wielded_item (lua_State *L)
static int	l_get_meta (lua_State *L)
static int	l_get_server_info (lua_State *L)
static int	l_get_item_def (lua_State *L)
static int	l_get_node_def (lua_State *L)
static int	l_get_privilege_list (lua_State *L)
static int	l_get_builtin_path (lua_State *L)
static int	l_get_csm_restrictions (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 ModApiClient::Initialize ( lua_State * L, int top )

static

References API_FCT.

Referenced by ClientScripting::InitializeModApi().

Here is the caller graph for this function:

InitializeSSCSM()

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

static

References API_FCT.

Referenced by SSCSMScripting::initializeModApi().

Here is the caller graph for this function:

l_clear_out_chat_queue()

int ModApiClient::l_clear_out_chat_queue ( lua_State * L )

staticprivate

l_disconnect()

int ModApiClient::l_disconnect ( lua_State * L )

staticprivate

References g_gamecallback.

l_display_chat_message()

int ModApiClient::l_display_chat_message ( lua_State * L )

staticprivate

References utf8_to_wide().

Here is the call graph for this function:

l_get_builtin_path()

int ModApiClient::l_get_builtin_path ( lua_State * L )

staticprivate

References BUILTIN_MOD_NAME, Client, ScriptApiBase::getCurrentModNameInsecure(), ModApiBase::getScriptApiBase(), and SSCSM.

Here is the call graph for this function:

l_get_csm_restrictions()

int ModApiClient::l_get_csm_restrictions ( lua_State * L )

staticprivate

References flagdesc_csm_restriction, CSMFlagDesc::name, and setboolfield().

Here is the call graph for this function:

l_get_current_modname()

int ModApiClient::l_get_current_modname ( lua_State * L )

staticprivate

References ScriptApiBase::getCurrentModNameInsecure().

Here is the call graph for this function:

l_get_item_def()

int ModApiClient::l_get_item_def ( lua_State * L )

staticprivate

References checkCSMRestrictionFlag, CSM_RF_READ_ITEMDEFS, IItemDefManager::get(), ModApiBase::getGameDef(), IGameDef::idef(), IItemDefManager::isKnown(), push_item_definition_full(), and LuaHelper::readParam().

Here is the call graph for this function:

l_get_language()

int ModApiClient::l_get_language ( lua_State * L )

staticprivate

l_get_meta()

int ModApiClient::l_get_meta ( lua_State * L )

staticprivate

References NodeMetaRef::createClient(), ModApiBase::getEnv(), Environment::getMap(), Map::getNodeMetadata(), p(), and read_v3s16().

Here is the call graph for this function:

l_get_modpath()

int ModApiClient::l_get_modpath ( lua_State * L )

staticprivate

References LuaHelper::readParam().

Here is the call graph for this function:

l_get_node_def()

int ModApiClient::l_get_node_def ( lua_State * L )

staticprivate

References checkCSMRestrictionFlag, CSM_RF_READ_NODEDEFS, NodeDefManager::get(), ModApiBase::getGameDef(), NodeDefManager::getId(), ContentFeatures::name, IGameDef::ndef(), push_content_features(), and LuaHelper::readParam().

Here is the call graph for this function:

l_get_node_or_nil()

int ModApiClient::l_get_node_or_nil ( lua_State * L )

staticprivate

References pushnode(), and read_v3s16().

Here is the call graph for this function:

l_get_player_names()

int ModApiClient::l_get_player_names ( lua_State * L )

staticprivate

References checkCSMRestrictionFlag, and CSM_RF_READ_PLAYERINFO.

l_get_privilege_list()

int ModApiClient::l_get_privilege_list ( lua_State * L )

staticprivate

l_get_server_info()

int ModApiClient::l_get_server_info ( lua_State * L )

staticprivate

References Address::getPort(), and Address::serializeString().

Here is the call graph for this function:

l_get_wielded_item()

int ModApiClient::l_get_wielded_item ( lua_State * L )

staticprivate

l_gettext()

int ModApiClient::l_gettext ( lua_State * L )

staticprivate

References strgettext().

Here is the call graph for this function:

l_print()

int ModApiClient::l_print ( lua_State * L )

staticprivate

References NO_MAP_LOCK_REQUIRED, and rawstream.

l_send_chat_message()

int ModApiClient::l_send_chat_message ( lua_State * L )

staticprivate

References checkCSMRestrictionFlag, CSM_RF_CHAT_MESSAGES, and utf8_to_wide().

Here is the call graph for this function:

---

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

• script/lua_api/l_client.h
• script/lua_api/l_client.cpp