ScriptApiMainMenu Class Reference

#include <s_mainmenu.h>

Inheritance diagram for ScriptApiMainMenu:

Collaboration diagram for ScriptApiMainMenu:

Public Member Functions
void	setMainMenuData (const MainMenuDataForScript *data)
	Hand over MainMenuDataForScript to lua to inform lua of the content.
void	handleMainMenuEvent (const std::string &text)
	process events received from formspec
void	handleMainMenuButtons (const StringMap &fields)
	process field data received from formspec
void	beforeClose ()
	Called before the menu is closed, either to exit or to join a game.
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

beforeClose()

void ScriptApiMainMenu::beforeClose

(

)

Called before the menu is closed, either to exit or to join a game.

References PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

handleMainMenuButtons()

void ScriptApiMainMenu::handleMainMenuButtons

(

const StringMap &

fields

)

process field data received from formspec

Parameters

fields

data in field format

References PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

handleMainMenuEvent()

void ScriptApiMainMenu::handleMainMenuEvent

(

const std::string &

text

)

process events received from formspec

Parameters

text	events in textual form

References PCALL_RES, PUSH_ERROR_HANDLER, and SCRIPTAPI_PRECHECKHEADER.

Referenced by GUIEngine::fullscreenChangedCallback().

Here is the caller graph for this function:

setMainMenuData()

void ScriptApiMainMenu::setMainMenuData

(

const MainMenuDataForScript *

data

)

Hand over MainMenuDataForScript to lua to inform lua of the content.

Parameters

data

the data

References MainMenuDataForScript::errormessage, MainMenuDataForScript::reconnect_requested, SCRIPTAPI_PRECHECKHEADER, and setboolfield().

Here is the call graph for this function:

---

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

• script/cpp_api/s_mainmenu.h
• script/cpp_api/s_mainmenu.cpp