ScriptApiEnv Class Reference

#include <s_env.h>

Inheritance diagram for ScriptApiEnv:

Collaboration diagram for ScriptApiEnv:

Public Member Functions
void	environment_Step (float dtime)
void	environment_OnGenerated (v3s16 minp, v3s16 maxp, u32 blockseed)
void	player_event (ServerActiveObject *player, const std::string &type)
void	on_emerge_area_completion (v3s16 blockpos, int action, ScriptCallbackState *state)
void	initializeEnvironment (ServerEnvironment *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	loadModFromMemory (const std::string &mod_name)
void	runCallbacksRaw (int nargs, RunCallbacksMode mode, const char *fxn)
void	addObjectReference (ServerActiveObject *cobj)
void	removeObjectReference (ServerActiveObject *cobj)
IGameDef *	getGameDef ()
Server *	getServer ()
ScriptingType	getType ()
Client *	getClient ()
std::string	getOrigin ()
void	setOriginDirect (const char *origin)
void	setOriginFromTableRaw (int index, const char *fxn)
void	clientOpenLibs (lua_State *L)

Additional Inherited Members
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)
GUIEngine *	getGuiEngine ()
void	setGuiEngine (GUIEngine *guiengine)
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)
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...
Protected Attributes inherited from ScriptApiBase
std::recursive_mutex	m_luastackmutex
std::string	m_last_run_mod
bool	m_secure = false
int	m_lock_recursion_count {}
std::thread::id	m_owning_thread

Member Function Documentation

environment_OnGenerated()

void ScriptApiEnv::environment_OnGenerated	(	v3s16	minp,
		v3s16	maxp,
		u32	blockseed
	)

References push_v3s16(), RUN_CALLBACKS_MODE_FIRST, runCallbacks, and SCRIPTAPI_PRECHECKHEADER.

Referenced by EmergeThread::finishGen().

Here is the call graph for this function:

Here is the caller graph for this function:

environment_Step()

void ScriptApiEnv::environment_Step

(

float

dtime

)

References ScriptApiBase::getServer(), RUN_CALLBACKS_MODE_FIRST, runCallbacks, script_get_backtrace(), SCRIPTAPI_PRECHECKHEADER, Server::setAsyncFatalError(), and BaseException::what().

Referenced by ServerEnvironment::step().

Here is the call graph for this function:

Here is the caller graph for this function:

initializeEnvironment()

void ScriptApiEnv::initializeEnvironment

(

ServerEnvironment *

env

)

References ServerEnvironment::addActiveBlockModifier(), ServerEnvironment::addLoadingBlockModifierDef(), getboolfield(), getboolfield_default(), getfloatfield(), getintfield(), getstringfield(), ScriptApiBase::LuaABM, ScriptApiBase::LuaLBM, SCRIPTAPI_PRECHECKHEADER, ScriptApiBase::setEnv(), table, and verbosestream.

Referenced by Server::init().

Here is the call graph for this function:

Here is the caller graph for this function:

on_emerge_area_completion()

void ScriptApiEnv::on_emerge_area_completion	(	v3s16	blockpos,
		int	action,
		ScriptCallbackState *	state
	)

References ScriptCallbackState::args_ref, ScriptCallbackState::callback_ref, ScriptApiBase::getServer(), ScriptCallbackState::origin, PCALL_RES, PUSH_ERROR_HANDLER, push_v3s16(), ScriptCallbackState::refcount, script_get_backtrace(), SCRIPTAPI_PRECHECKHEADER, ScriptApiBase::setOriginDirect(), and BaseException::what().

Referenced by LuaEmergeAreaCallback().

Here is the call graph for this function:

Here is the caller graph for this function:

player_event()

void ScriptApiEnv::player_event	(	ServerActiveObject *	player,
		const std::string &	type
	)

References ScriptApiBase::getServer(), ScriptApiBase::objectrefGetOrCreate(), RUN_CALLBACKS_MODE_FIRST, runCallbacks, script_get_backtrace(), SCRIPTAPI_PRECHECKHEADER, Server::setAsyncFatalError(), and BaseException::what().

Referenced by Server::hudSetFlags(), Server::SendPlayerBreath(), Server::SendPlayerHP(), and PlayerSAO::step().

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_env.h
• script/cpp_api/s_env.cpp