ScriptApiServer Class Reference

#include <s_server.h>

Inheritance diagram for ScriptApiServer:

Collaboration diagram for ScriptApiServer:

Public Member Functions
bool	on_chat_message (const std::string &name, const std::string &message)
void	on_mods_loaded ()
void	on_shutdown ()
std::string	formatChatMessage (const std::string &name, const std::string &message)
bool	getAuth (const std::string &playername, std::string *dst_password, std::set< std::string > *dst_privs, s64 *dst_last_login=nullptr)
void	createAuth (const std::string &playername, const std::string &password)
bool	setPassword (const std::string &playername, const std::string &password)
void	freeDynamicMediaCallback (u32 token)
void	on_dynamic_media_added (u32 token, const std::string &playername)
Public Member Functions inherited from ScriptApiBase
	ScriptApiBase (ScriptingType type)
	ScriptApiBase ()
virtual	~ScriptApiBase ()
	DISABLE_CLASS_COPY (ScriptApiBase)
void	loadMod (const std::string &script_path, const std::string &mod_name)
void	loadScript (const std::string &script_path)
void	runCallbacksRaw (int nargs, RunCallbacksMode mode, const char *fxn)
void	addObjectReference (ServerActiveObject *cobj)
void	removeObjectReference (ServerActiveObject *cobj)
ScriptingType	getType ()
IGameDef *	getGameDef ()
Server *	getServer ()
const std::string &	getOrigin ()
void	setOriginDirect (const char *origin)
void	setOriginFromTableRaw (int index, const char *fxn)
void	clientOpenLibs (lua_State *L)
void	checkSetByBuiltin ()

Static Public Member Functions
static u32	allocateDynamicMediaCallback (lua_State *L, int f_idx)
Static Public Member Functions inherited from ScriptApiBase
static std::string	getCurrentModNameInsecure (lua_State *L)
	Returns the currently running mod, only during init time.

Private Member Functions
void	getAuthHandler ()
void	readPrivileges (int index, std::set< std::string > &result)

Additional Inherited Members
Protected Member Functions inherited from ScriptApiBase
lua_State *	getStack ()
void	realityCheck ()
void	scriptError (int result, const char *fxn)
void	stackDump (std::ostream &o)
void	setGameDef (IGameDef *gamedef)
Environment *	getEnv ()
void	setEnv (Environment *env)
EmergeThread *	getEmergeThread ()
void	setEmergeThread (EmergeThread *emerge)
void	objectrefGetOrCreate (lua_State *L, ServerActiveObject *cobj)
void	pushPlayerHPChangeReason (lua_State *L, const PlayerHPChangeReason &reason)
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.
Protected Attributes inherited from ScriptApiBase
std::recursive_mutex	m_luastackmutex
std::string	m_last_run_mod
int	m_lock_recursion_count {}
std::thread::id	m_owning_thread

Member Function Documentation

allocateDynamicMediaCallback()

u32 ScriptApiServer::allocateDynamicMediaCallback ( lua_State * L, int f_idx )

static

References FATAL_ERROR, myrand(), and verbosestream.

Here is the call graph for this function:

createAuth()

void ScriptApiServer::createAuth	(	const std::string &	playername,
		const std::string &	password )

References getAuthHandler(), PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

formatChatMessage()

std::string ScriptApiServer::formatChatMessage	(	const std::string &	name,
		const std::string &	message )

References SCRIPTAPI_PRECHECKHEADER.

freeDynamicMediaCallback()

void ScriptApiServer::freeDynamicMediaCallback

(

u32

token

)

References SCRIPTAPI_PRECHECKHEADER, and verbosestream.

Referenced by Server::stepPendingDynMediaCallbacks().

Here is the caller graph for this function:

getAuth()

bool ScriptApiServer::getAuth	(	const std::string &	playername,
		std::string *	dst_password,
		std::set< std::string > *	dst_privs,
		s64 *	dst_last_login = nullptr )

References getAuthHandler(), getintfield(), getstringfield(), PCALL_RES, PUSH_ERROR_HANDLER, readPrivileges(), and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

getAuthHandler()

void ScriptApiServer::getAuthHandler ( )

private

References ScriptApiBase::getStack(), and setOriginFromTable.

Referenced by createAuth(), getAuth(), and setPassword().

Here is the call graph for this function:

Here is the caller graph for this function:

on_chat_message()

bool ScriptApiServer::on_chat_message	(	const std::string &	name,
		const std::string &	message )

References LuaHelper::readParam(), RUN_CALLBACKS_MODE_OR_SC, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

on_dynamic_media_added()

void ScriptApiServer::on_dynamic_media_added	(	u32	token,
		const std::string &	playername )

References PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Server::dynamicAddMedia(), and Server::handleCommand_HaveMedia().

Here is the caller graph for this function:

on_mods_loaded()

void ScriptApiServer::on_mods_loaded

(

)

References RUN_CALLBACKS_MODE_FIRST, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by ServerModManager::loadMods().

Here is the caller graph for this function:

on_shutdown()

void ScriptApiServer::on_shutdown

(

)

References RUN_CALLBACKS_MODE_FIRST, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

readPrivileges()

void ScriptApiServer::readPrivileges ( int index, std::set< std::string > & result )

private

References ScriptApiBase::getStack(), and LuaHelper::readParam().

Referenced by getAuth().

Here is the call graph for this function:

Here is the caller graph for this function:

setPassword()

bool ScriptApiServer::setPassword	(	const std::string &	playername,
		const std::string &	password )

References getAuthHandler(), PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

---

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

• script/cpp_api/s_server.h
• script/cpp_api/s_server.cpp