ScriptApiClient Class Reference

#include <s_client.h>

Inheritance diagram for ScriptApiClient:

Collaboration diagram for ScriptApiClient:

Public Member Functions
void	on_mods_loaded ()
void	on_shutdown ()
bool	on_sending_message (const std::string &message)
bool	on_receiving_message (const std::string &message)
void	on_damage_taken (int32_t damage_amount)
void	on_hp_modification (int32_t newhp)
void	environment_step (float dtime)
bool	on_dignode (v3s16 p, MapNode node)
bool	on_punchnode (v3s16 p, MapNode node)
bool	on_placenode (const PointedThing &pointed, const ItemDefinition &item)
bool	on_item_use (const ItemStack &item, const PointedThing &pointed)
bool	on_inventory_open (Inventory *inventory)
void	setEnv (ClientEnvironment *env)
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 ()

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

environment_step()

void ScriptApiClient::environment_step

(

float

dtime

)

References RUN_CALLBACKS_MODE_FIRST, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by ClientEnvironment::step().

Here is the caller graph for this function:

on_damage_taken()

void ScriptApiClient::on_damage_taken

(

int32_t

damage_amount

)

References RUN_CALLBACKS_MODE_OR_SC, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

on_dignode()

bool ScriptApiClient::on_dignode	(	v3s16	p,
		MapNode	node )

References p(), push_v3s16(), pushnode(), RUN_CALLBACKS_MODE_OR, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

on_hp_modification()

void ScriptApiClient::on_hp_modification

(

int32_t

newhp

)

References RUN_CALLBACKS_MODE_OR_SC, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Client::handleCommand_HP().

Here is the caller graph for this function:

on_inventory_open()

bool ScriptApiClient::on_inventory_open

(

Inventory *

inventory

)

References push_inventory_lists(), LuaHelper::readParam(), RUN_CALLBACKS_MODE_OR, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by GameFormSpec::showPlayerInventory().

Here is the call graph for this function:

Here is the caller graph for this function:

on_item_use()

bool ScriptApiClient::on_item_use	(	const ItemStack &	item,
		const PointedThing &	pointed )

References LuaItemStack::create(), push_pointed_thing(), LuaHelper::readParam(), RUN_CALLBACKS_MODE_OR, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

on_mods_loaded()

void ScriptApiClient::on_mods_loaded

(

)

References RUN_CALLBACKS_MODE_FIRST, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Client::loadMods().

Here is the caller graph for this function:

on_placenode()

bool ScriptApiClient::on_placenode	(	const PointedThing &	pointed,
		const ItemDefinition &	item )

References push_item_definition(), push_pointed_thing(), LuaHelper::readParam(), RUN_CALLBACKS_MODE_OR, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

on_punchnode()

bool ScriptApiClient::on_punchnode	(	v3s16	p,
		MapNode	node )

References p(), push_v3s16(), pushnode(), LuaHelper::readParam(), RUN_CALLBACKS_MODE_OR, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Here is the call graph for this function:

on_receiving_message()

bool ScriptApiClient::on_receiving_message

(

const std::string &

message

)

References LuaHelper::readParam(), RUN_CALLBACKS_MODE_OR_SC, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Client::handleCommand_ChatMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

on_sending_message()

bool ScriptApiClient::on_sending_message

(

const std::string &

message

)

References LuaHelper::readParam(), RUN_CALLBACKS_MODE_OR_SC, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Client::typeChatMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

on_shutdown()

void ScriptApiClient::on_shutdown

(

)

References RUN_CALLBACKS_MODE_FIRST, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by Client::Stop().

Here is the caller graph for this function:

setEnv()

void ScriptApiClient::setEnv

(

ClientEnvironment *

env

)

References ScriptApiBase::setEnv().

Here is the call graph for this function:

---

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

• script/cpp_api/s_client.h
• script/cpp_api/s_client.cpp