ScriptApiDetached Class Reference

#include <s_inventory.h>

Inheritance diagram for ScriptApiDetached:

Collaboration diagram for ScriptApiDetached:

Public Member Functions
int	detached_inventory_AllowMove (const MoveAction &ma, int count, ServerActiveObject *player)
int	detached_inventory_AllowPut (const MoveAction &ma, const ItemStack &stack, ServerActiveObject *player)
int	detached_inventory_AllowTake (const MoveAction &ma, const ItemStack &stack, ServerActiveObject *player)
void	detached_inventory_OnMove (const MoveAction &ma, int count, ServerActiveObject *player)
void	detached_inventory_OnPut (const MoveAction &ma, const ItemStack &stack, ServerActiveObject *player)
void	detached_inventory_OnTake (const MoveAction &ma, const ItemStack &stack, ServerActiveObject *player)
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 ()

Private Member Functions
bool	getDetachedInventoryCallback (const std::string &name, const char *callbackname)

Additional Inherited Members
Static Public Member Functions inherited from ScriptApiBase
static std::string	getCurrentModNameInsecure (lua_State *L)
	Returns the currently running mod, only during init time.
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

detached_inventory_AllowMove()

int ScriptApiDetached::detached_inventory_AllowMove	(	const MoveAction &	ma,
		int	count,
		ServerActiveObject *	player )

References InvRef::create(), MoveAction::from_i, MoveAction::from_inv, MoveAction::from_list, getDetachedInventoryCallback(), InventoryLocation::name, ScriptApiBase::objectrefGetOrCreate(), PCALL_RES, PUSH_ERROR_HANDLER, SCRIPTAPI_PRECHECKHEADER, MoveAction::to_i, and MoveAction::to_list.

Referenced by IMoveAction::allowMove().

Here is the call graph for this function:

Here is the caller graph for this function:

detached_inventory_AllowPut()

int ScriptApiDetached::detached_inventory_AllowPut	(	const MoveAction &	ma,
		const ItemStack &	stack,
		ServerActiveObject *	player )

References ItemStack::count, InvRef::create(), LuaItemStack::create(), getDetachedInventoryCallback(), InventoryLocation::name, ScriptApiBase::objectrefGetOrCreate(), PCALL_RES, PUSH_ERROR_HANDLER, SCRIPTAPI_PRECHECKHEADER, MoveAction::to_i, MoveAction::to_inv, and MoveAction::to_list.

Referenced by IMoveAction::allowPut().

Here is the call graph for this function:

Here is the caller graph for this function:

detached_inventory_AllowTake()

int ScriptApiDetached::detached_inventory_AllowTake	(	const MoveAction &	ma,
		const ItemStack &	stack,
		ServerActiveObject *	player )

References ItemStack::count, InvRef::create(), LuaItemStack::create(), MoveAction::from_i, MoveAction::from_inv, MoveAction::from_list, getDetachedInventoryCallback(), InventoryLocation::name, ScriptApiBase::objectrefGetOrCreate(), PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

Referenced by IMoveAction::allowTake().

Here is the call graph for this function:

Here is the caller graph for this function:

detached_inventory_OnMove()

void ScriptApiDetached::detached_inventory_OnMove	(	const MoveAction &	ma,
		int	count,
		ServerActiveObject *	player )

References InvRef::create(), MoveAction::from_i, MoveAction::from_inv, MoveAction::from_list, getDetachedInventoryCallback(), InventoryLocation::name, ScriptApiBase::objectrefGetOrCreate(), PCALL_RES, PUSH_ERROR_HANDLER, SCRIPTAPI_PRECHECKHEADER, MoveAction::to_i, and MoveAction::to_list.

Referenced by IMoveAction::onMove().

Here is the call graph for this function:

Here is the caller graph for this function:

detached_inventory_OnPut()

void ScriptApiDetached::detached_inventory_OnPut	(	const MoveAction &	ma,
		const ItemStack &	stack,
		ServerActiveObject *	player )

References InvRef::create(), LuaItemStack::create(), getDetachedInventoryCallback(), InventoryLocation::name, ScriptApiBase::objectrefGetOrCreate(), PCALL_RES, PUSH_ERROR_HANDLER, SCRIPTAPI_PRECHECKHEADER, MoveAction::to_i, MoveAction::to_inv, and MoveAction::to_list.

Referenced by IMoveAction::onPut().

Here is the call graph for this function:

Here is the caller graph for this function:

detached_inventory_OnTake()

void ScriptApiDetached::detached_inventory_OnTake	(	const MoveAction &	ma,
		const ItemStack &	stack,
		ServerActiveObject *	player )

References InvRef::create(), LuaItemStack::create(), MoveAction::from_i, MoveAction::from_inv, MoveAction::from_list, getDetachedInventoryCallback(), InventoryLocation::name, ScriptApiBase::objectrefGetOrCreate(), PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

Referenced by IMoveAction::onTake().

Here is the call graph for this function:

Here is the caller graph for this function:

getDetachedInventoryCallback()

bool ScriptApiDetached::getDetachedInventoryCallback ( const std::string & name, const char * callbackname )

private

References errorstream, ScriptApiBase::getStack(), and setOriginFromTable.

Referenced by detached_inventory_AllowMove(), detached_inventory_AllowPut(), detached_inventory_AllowTake(), detached_inventory_OnMove(), detached_inventory_OnPut(), and detached_inventory_OnTake().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• script/cpp_api/s_inventory.h
• script/cpp_api/s_inventory.cpp