ModChannelRef Class Reference

#include <l_modchannels.h>

Inheritance diagram for ModChannelRef:

Collaboration diagram for ModChannelRef:

Public Member Functions
	ModChannelRef (const std::string &modchannel)
	~ModChannelRef ()=default

Static Public Member Functions
static void	Register (lua_State *L)
static void	create (lua_State *L, const std::string &channel)
static int	l_leave (lua_State *L)
static int	l_send_all (lua_State *L)
static int	l_is_writeable (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 Client *	getClient (lua_State *L)
static GUIEngine *	getGuiEngine (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)
static void	registerClass (lua_State *L, const char *name, 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 Public Attributes
static const char	className [] = "ModChannelRef"

Static Private Member Functions
static int	gc_object (lua_State *L)
static ModChannel *	getobject (lua_State *L, ModChannelRef *ref)

Private Attributes
std::string	m_modchannel_name

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)
	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

ModChannelRef()

ModChannelRef::ModChannelRef

(

const std::string &

modchannel

)

~ModChannelRef()

ModChannelRef::~ModChannelRef ( )

default

Member Function Documentation

create()

void ModChannelRef::create ( lua_State *  L, const std::string &  channel  )

static

References className.

Referenced by ModApiChannels::l_mod_channel_join().

Here is the caller graph for this function:

gc_object()

int ModChannelRef::gc_object ( lua_State *  L )

staticprivate

Referenced by Register().

Here is the caller graph for this function:

getobject()

ModChannel * ModChannelRef::getobject ( lua_State *  L, ModChannelRef *  ref  )

staticprivate

References ModApiBase::getGameDef(), IGameDef::getModChannel(), and m_modchannel_name.

Referenced by l_is_writeable(), and l_send_all().

Here is the call graph for this function:

Here is the caller graph for this function:

l_is_writeable()

int ModChannelRef::l_is_writeable ( lua_State *  L )

static

References ModChannel::canWrite(), and getobject().

Here is the call graph for this function:

l_leave()

int ModChannelRef::l_leave ( lua_State *  L )

static

References ModApiBase::getGameDef(), IGameDef::leaveModChannel(), and m_modchannel_name.

Here is the call graph for this function:

l_send_all()

int ModChannelRef::l_send_all ( lua_State *  L )

static

References ModChannel::canWrite(), ModApiBase::getGameDef(), ModChannel::getName(), getobject(), and IGameDef::sendModChannelMessage().

Here is the call graph for this function:

Register()

void ModChannelRef::Register ( lua_State *  L )

static

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

Referenced by ClientScripting::InitializeModApi(), and ServerScripting::InitializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

className

const char ModChannelRef::className = "ModChannelRef"

static

Referenced by create(), and Register().

m_modchannel_name

std::string ModChannelRef::m_modchannel_name

private

Referenced by getobject(), and l_leave().

methods

const luaL_Reg ModChannelRef::methods

staticprivate

Initial value:

= {
    luamethod(ModChannelRef, leave),
    luamethod(ModChannelRef, is_writeable),
    luamethod(ModChannelRef, send_all),
    {0, 0},
}

Referenced by Register().

---

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

• script/lua_api/l_modchannels.h
• script/lua_api/l_modchannels.cpp