MetaDataRef Class Reference

#include <l_metadata.h>

Inheritance diagram for MetaDataRef:

Collaboration diagram for MetaDataRef:

Public Member Functions
virtual	~MetaDataRef ()=default

Protected Member Functions
virtual void	reportMetadataChange (const std::string *name=nullptr)
virtual Metadata *	getmeta (bool auto_create)=0
virtual void	clearMeta ()=0
virtual void	handleToTable (lua_State *L, Metadata *meta)
virtual bool	handleFromTable (lua_State *L, int table, Metadata *meta)
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)

Static Protected Member Functions
static MetaDataRef *	checkobject (lua_State *L, int narg)
static int	l_contains (lua_State *L)
static int	l_get (lua_State *L)
static int	l_get_string (lua_State *L)
static int	l_set_string (lua_State *L)
static int	l_get_int (lua_State *L)
static int	l_set_int (lua_State *L)
static int	l_get_float (lua_State *L)
static int	l_set_float (lua_State *L)
static int	l_to_table (lua_State *L)
static int	l_from_table (lua_State *L)
static int	l_equals (lua_State *L)
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...

Additional Inherited Members
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 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 int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions. More...

Constructor & Destructor Documentation

~MetaDataRef()

virtual MetaDataRef::~MetaDataRef ( )

virtualdefault

Member Function Documentation

checkobject()

MetaDataRef * MetaDataRef::checkobject ( lua_State *  L, int  narg  )

staticprotected

References luaL_checkudata_is_metadataref().

Referenced by l_contains(), l_equals(), l_from_table(), l_get(), l_get_float(), l_get_int(), l_get_string(), l_set_float(), l_set_int(), l_set_string(), and l_to_table().

Here is the call graph for this function:

Here is the caller graph for this function:

clearMeta()

virtual void MetaDataRef::clearMeta ( )

protectedpure virtual

Implemented in StorageRef, PlayerMetaRef, NodeMetaRef, and ItemStackMetaRef.

Referenced by l_from_table().

Here is the caller graph for this function:

getmeta()

virtual Metadata* MetaDataRef::getmeta ( bool  auto_create )

protectedpure virtual

Implemented in StorageRef, PlayerMetaRef, NodeMetaRef, and ItemStackMetaRef.

Referenced by l_contains(), l_equals(), l_from_table(), l_get(), l_get_float(), l_get_int(), l_get_string(), l_set_float(), l_set_int(), l_set_string(), and l_to_table().

Here is the caller graph for this function:

handleFromTable()

bool MetaDataRef::handleFromTable ( lua_State *  L, int  table, Metadata *  meta  )

protectedvirtual

Reimplemented in NodeMetaRef.

References Metadata::setString(), and table.

Referenced by NodeMetaRef::handleFromTable(), and l_from_table().

Here is the call graph for this function:

Here is the caller graph for this function:

handleToTable()

void MetaDataRef::handleToTable ( lua_State *  L, Metadata *  meta  )

protectedvirtual

Reimplemented in NodeMetaRef.

References Metadata::getStrings().

Referenced by NodeMetaRef::handleToTable(), and l_to_table().

Here is the call graph for this function:

Here is the caller graph for this function:

l_contains()

int MetaDataRef::l_contains ( lua_State *  L )

staticprotected

References checkobject(), Metadata::contains(), getmeta(), and MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_equals()

int MetaDataRef::l_equals ( lua_State *  L )

staticprotected

References checkobject(), and getmeta().

Referenced by ItemStackMetaRef::Register(), PlayerMetaRef::Register(), StorageRef::Register(), and NodeMetaRef::RegisterCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

l_from_table()

int MetaDataRef::l_from_table ( lua_State *  L )

staticprotected

References checkobject(), clearMeta(), getmeta(), handleFromTable(), MAP_LOCK_REQUIRED, and reportMetadataChange().

Here is the call graph for this function:

l_get()

int MetaDataRef::l_get ( lua_State *  L )

staticprotected

References checkobject(), getmeta(), Metadata::getStringToRef(), and MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_get_float()

int MetaDataRef::l_get_float ( lua_State *  L )

staticprotected

References checkobject(), getmeta(), Metadata::getString(), MAP_LOCK_REQUIRED, and stof.

Here is the call graph for this function:

l_get_int()

int MetaDataRef::l_get_int ( lua_State *  L )

staticprotected

References checkobject(), getmeta(), Metadata::getString(), MAP_LOCK_REQUIRED, and stoi.

Here is the call graph for this function:

l_get_string()

int MetaDataRef::l_get_string ( lua_State *  L )

staticprotected

References checkobject(), getmeta(), Metadata::getString(), and MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_set_float()

int MetaDataRef::l_set_float ( lua_State *  L )

staticprotected

References checkobject(), ftos(), getmeta(), Metadata::getString(), MAP_LOCK_REQUIRED, reportMetadataChange(), and Metadata::setString().

Here is the call graph for this function:

l_set_int()

int MetaDataRef::l_set_int ( lua_State *  L )

staticprotected

References checkobject(), getmeta(), Metadata::getString(), itos(), MAP_LOCK_REQUIRED, reportMetadataChange(), and Metadata::setString().

Here is the call graph for this function:

l_set_string()

int MetaDataRef::l_set_string ( lua_State *  L )

staticprotected

References checkobject(), getmeta(), Metadata::getString(), MAP_LOCK_REQUIRED, reportMetadataChange(), and Metadata::setString().

Here is the call graph for this function:

l_to_table()

int MetaDataRef::l_to_table ( lua_State *  L )

staticprotected

References checkobject(), getmeta(), handleToTable(), and MAP_LOCK_REQUIRED.

Here is the call graph for this function:

reportMetadataChange()

virtual void MetaDataRef::reportMetadataChange ( const std::string *  name = nullptr )

inlineprotectedvirtual

Reimplemented in PlayerMetaRef, NodeMetaRef, and ItemStackMetaRef.

Referenced by l_from_table(), l_set_float(), l_set_int(), and l_set_string().

Here is the caller graph for this function:

---

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

• script/lua_api/l_metadata.h
• script/lua_api/l_metadata.cpp