NodeTimerRef Class Reference

#include <l_nodetimer.h>

Inheritance diagram for NodeTimerRef:

Collaboration diagram for NodeTimerRef:

Public Member Functions
	NodeTimerRef (v3s16 p, ServerMap *map)
	~NodeTimerRef ()=default

Static Public Member Functions
static void	create (lua_State *L, v3s16 p, ServerMap *map)
static void	Register (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 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 Public Attributes
static const char	className [] = "NodeTimerRef"

Static Private Member Functions
static int	gc_object (lua_State *L)
static int	l_set (lua_State *L)
static int	l_start (lua_State *L)
static int	l_stop (lua_State *L)
static int	l_is_started (lua_State *L)
static int	l_get_timeout (lua_State *L)
static int	l_get_elapsed (lua_State *L)

Private Attributes
v3s16	m_p
ServerMap *	m_map

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

Constructor & Destructor Documentation

NodeTimerRef()

NodeTimerRef::NodeTimerRef ( v3s16 p, ServerMap * map )

inline

References m_map, m_p, and p().

Referenced by create(), gc_object(), l_get_elapsed(), l_get_timeout(), l_is_started(), l_set(), l_start(), and l_stop().

Here is the call graph for this function:

Here is the caller graph for this function:

~NodeTimerRef()

NodeTimerRef::~NodeTimerRef ( )

default

References p().

Here is the call graph for this function:

Member Function Documentation

create()

void NodeTimerRef::create ( lua_State * L, v3s16 p, ServerMap * map )

static

References NodeTimerRef(), className, and p().

Referenced by ModApiEnv::l_get_node_timer().

Here is the call graph for this function:

Here is the caller graph for this function:

gc_object()

int NodeTimerRef::gc_object ( lua_State * L )

staticprivate

References NodeTimerRef().

Referenced by Register().

Here is the call graph for this function:

Here is the caller graph for this function:

l_get_elapsed()

int NodeTimerRef::l_get_elapsed ( lua_State * L )

staticprivate

References NodeTimerRef(), ModApiBase::checkObject(), NodeTimer::elapsed, Map::getNodeTimer(), m_map, m_p, and MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_get_timeout()

int NodeTimerRef::l_get_timeout ( lua_State * L )

staticprivate

References NodeTimerRef(), ModApiBase::checkObject(), Map::getNodeTimer(), m_map, m_p, MAP_LOCK_REQUIRED, and NodeTimer::timeout.

Here is the call graph for this function:

l_is_started()

int NodeTimerRef::l_is_started ( lua_State * L )

staticprivate

References NodeTimerRef(), ModApiBase::checkObject(), Map::getNodeTimer(), m_map, m_p, MAP_LOCK_REQUIRED, and NodeTimer::timeout.

Here is the call graph for this function:

l_set()

int NodeTimerRef::l_set ( lua_State * L )

staticprivate

References NodeTimerRef(), ModApiBase::checkObject(), m_map, m_p, MAP_LOCK_REQUIRED, LuaHelper::readParam(), and Map::setNodeTimer().

Here is the call graph for this function:

l_start()

int NodeTimerRef::l_start ( lua_State * L )

staticprivate

References NodeTimerRef(), ModApiBase::checkObject(), m_map, m_p, MAP_LOCK_REQUIRED, LuaHelper::readParam(), and Map::setNodeTimer().

Here is the call graph for this function:

l_stop()

int NodeTimerRef::l_stop ( lua_State * L )

staticprivate

References NodeTimerRef(), ModApiBase::checkObject(), m_map, m_p, MAP_LOCK_REQUIRED, and Map::removeNodeTimer().

Here is the call graph for this function:

Register()

void NodeTimerRef::Register ( lua_State * L )

static

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

Referenced by ServerScripting::InitializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

className

const char NodeTimerRef::className = "NodeTimerRef"

static

Referenced by create().

m_map

ServerMap* NodeTimerRef::m_map

private

Referenced by NodeTimerRef(), l_get_elapsed(), l_get_timeout(), l_is_started(), l_set(), l_start(), and l_stop().

m_p

v3s16 NodeTimerRef::m_p

private

Referenced by NodeTimerRef(), l_get_elapsed(), l_get_timeout(), l_is_started(), l_set(), l_start(), and l_stop().

methods

const luaL_Reg NodeTimerRef::methods

staticprivate

Initial value:

                                     = {
        luamethod(NodeTimerRef, start),
        luamethod(NodeTimerRef, set),
        luamethod(NodeTimerRef, stop),
        luamethod(NodeTimerRef, is_started),
        luamethod(NodeTimerRef, get_timeout),
        luamethod(NodeTimerRef, get_elapsed),
        {0,0}
}

Referenced by Register().

---

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

• script/lua_api/l_nodetimer.h
• script/lua_api/l_nodetimer.cpp