ScriptApiModChannels Class Reference

#include <s_modchannels.h>

Inheritance diagram for ScriptApiModChannels:

Collaboration diagram for ScriptApiModChannels:

Public Member Functions
void	on_modchannel_message (const std::string &channel, const std::string &sender, const std::string &message)
void	on_modchannel_signal (const std::string &channel, ModChannelSignal signal)
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	loadModFromMemory (const std::string &mod_name)
void	runCallbacksRaw (int nargs, RunCallbacksMode mode, const char *fxn)
void	addObjectReference (ServerActiveObject *cobj)
void	removeObjectReference (ServerActiveObject *cobj)
IGameDef *	getGameDef ()
Server *	getServer ()
ScriptingType	getType ()
Client *	getClient ()
std::string	getOrigin ()
void	setOriginDirect (const char *origin)
void	setOriginFromTableRaw (int index, const char *fxn)
void	clientOpenLibs (lua_State *L)

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)
GUIEngine *	getGuiEngine ()
void	setGuiEngine (GUIEngine *guiengine)
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)
Static Protected Member Functions inherited from LuaHelper
static bool	isNaN (lua_State *L, int idx)
template<typename T >
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua State L and index. More...
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 and index. More...
Protected Attributes inherited from ScriptApiBase
std::recursive_mutex	m_luastackmutex
std::string	m_last_run_mod
bool	m_secure = false
int	m_lock_recursion_count {}
std::thread::id	m_owning_thread

Member Function Documentation

on_modchannel_message()

void ScriptApiModChannels::on_modchannel_message	(	const std::string &	channel,
		const std::string &	sender,
		const std::string &	message
	)

References RUN_CALLBACKS_MODE_AND, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Server::broadcastModChannelMessage(), and Client::handleCommand_ModChannelMsg().

Here is the caller graph for this function:

on_modchannel_signal()

void ScriptApiModChannels::on_modchannel_signal	(	const std::string &	channel,
		ModChannelSignal	signal
	)

References RUN_CALLBACKS_MODE_AND, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Client::handleCommand_ModChannelSignal().

Here is the caller graph for this function:

---

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

• script/cpp_api/s_modchannels.h
• script/cpp_api/s_modchannels.cpp