ModApiMainMenu Class Reference

Implementation of lua api support for mainmenu. More...

#include <l_mainmenu.h>

Inheritance diagram for ModApiMainMenu:

Collaboration diagram for ModApiMainMenu:

Static Public Member Functions
static void	Initialize (lua_State *L, int top)
	initialize this API module
static void	InitializeAsync (lua_State *L, int top)
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 EmergeThread *	getEmergeThread (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 void	registerClass (lua_State *L, const char *name, const luaL_Reg *methods, const luaL_Reg *metamethods)
template<typename T >
static T *	checkObject (lua_State *L, int narg)
static int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions.

Static Private Member Functions
static std::string	getTextData (lua_State *L, const std::string &name)
	read a text variable from gamedata table within lua stack
static int	getIntegerData (lua_State *L, const std::string &name, bool &valid)
	read an integer variable from gamedata table within lua stack
static int	getBoolData (lua_State *L, const std::string &name, bool &valid)
	read a bool variable from gamedata table within lua stack
static bool	mayModifyPath (std::string path)
	Checks if a path may be modified.
static int	l_start (lua_State *L)
static int	l_close (lua_State *L)
static int	l_create_world (lua_State *L)
static int	l_delete_world (lua_State *L)
static int	l_get_worlds (lua_State *L)
static int	l_get_mapgen_names (lua_State *L)
static int	l_get_language (lua_State *L)
static int	l_gettext (lua_State *L)
static int	l_get_games (lua_State *L)
static int	l_get_content_info (lua_State *L)
static int	l_check_mod_configuration (lua_State *L)
static int	l_get_content_translation (lua_State *L)
static int	l_show_keys_menu (lua_State *L)
static int	l_show_path_select_dialog (lua_State *L)
static int	l_set_topleft_text (lua_State *L)
static int	l_set_clouds (lua_State *L)
static int	l_get_textlist_index (lua_State *L)
static int	l_get_table_index (lua_State *L)
static int	l_set_background (lua_State *L)
static int	l_update_formspec (lua_State *L)
static int	l_set_formspec_prepend (lua_State *L)
static int	l_get_window_info (lua_State *L)
static int	l_get_active_driver (lua_State *L)
static int	l_get_active_renderer (lua_State *L)
static int	l_get_active_irrlicht_device (lua_State *L)
static int	l_irrlicht_device_supports_touch (lua_State *L)
static int	l_get_mainmenu_path (lua_State *L)
static int	l_get_user_path (lua_State *L)
static int	l_get_modpath (lua_State *L)
static int	l_get_modpaths (lua_State *L)
static int	l_get_clientmodpath (lua_State *L)
static int	l_get_gamepath (lua_State *L)
static int	l_get_texturepath (lua_State *L)
static int	l_get_texturepath_share (lua_State *L)
static int	l_get_cache_path (lua_State *L)
static int	l_get_temp_path (lua_State *L)
static int	l_create_dir (lua_State *L)
static int	l_delete_dir (lua_State *L)
static int	l_copy_dir (lua_State *L)
static int	l_is_dir (lua_State *L)
static int	l_extract_zip (lua_State *L)
static int	l_may_modify_path (lua_State *L)
static int	l_download_file (lua_State *L)
static int	l_get_video_drivers (lua_State *L)
static int	l_get_min_supp_proto (lua_State *L)
static int	l_get_max_supp_proto (lua_State *L)
static int	l_get_formspec_version (lua_State *L)
static int	l_open_url (lua_State *L)
static int	l_open_url_dialog (lua_State *L)
static int	l_open_dir (lua_State *L)
static int	l_share_file (lua_State *L)
static int	l_do_async_callback (lua_State *L)

Additional Inherited Members
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.

Detailed Description

Implementation of lua api support for mainmenu.

Member Function Documentation

getBoolData()

int ModApiMainMenu::getBoolData ( lua_State * L, const std::string & name, bool & valid )

staticprivate

read a bool variable from gamedata table within lua stack

Parameters

L	stack to read variable from
name	name of variable to read

Returns

bool value of requested variable

References LuaHelper::readParam().

Referenced by l_start().

Here is the call graph for this function:

Here is the caller graph for this function:

getIntegerData()

int ModApiMainMenu::getIntegerData ( lua_State * L, const std::string & name, bool & valid )

staticprivate

read an integer variable from gamedata table within lua stack

Parameters

L	stack to read variable from
name	name of variable to read

Returns

integer value of requested variable

Referenced by l_start().

Here is the caller graph for this function:

getTextData()

std::string ModApiMainMenu::getTextData ( lua_State * L, const std::string & name )

staticprivate

read a text variable from gamedata table within lua stack

Parameters

L	stack to read variable from
name	name of variable to read

Returns

string value of requested variable

Referenced by l_start().

Here is the caller graph for this function:

Initialize()

void ModApiMainMenu::Initialize ( lua_State * L, int top )

static

initialize this API module

Parameters

L	lua stack to initialize
top	index (in lua stack) of global API table

References API_FCT.

Referenced by MainMenuScripting::initializeModApi().

Here is the caller graph for this function:

InitializeAsync()

void ModApiMainMenu::InitializeAsync ( lua_State * L, int top )

static

References API_FCT.

Referenced by MainMenuScripting::initializeModApi().

Here is the caller graph for this function:

l_check_mod_configuration()

int ModApiMainMenu::l_check_mod_configuration ( lua_State * L )

staticprivate

References ModConfiguration::addGameMods(), ModConfiguration::addMods(), ModConfiguration::addModsInPath(), ModConfiguration::checkConflictsAndDeps(), DIR_DELIM, errorstream, findWorldSubgame(), fs::GetFilenameFromPath(), ModConfiguration::getMods(), ModConfiguration::getUnsatisfiedMods(), ModConfiguration::isConsistent(), ModSpec::name, parseModContents(), ModSpec::path, push_mod_spec(), ModSpec::virtual_path, and BaseException::what().

Here is the call graph for this function:

l_close()

int ModApiMainMenu::l_close ( lua_State * L )

staticprivate

References GUIEngine::m_kill, and sanity_check.

l_copy_dir()

int ModApiMainMenu::l_copy_dir ( lua_State * L )

staticprivate

References fs::CopyDir(), mayModifyPath(), fs::MoveDir(), LuaHelper::readParam(), and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_create_dir()

int ModApiMainMenu::l_create_dir ( lua_State * L )

staticprivate

References fs::CreateAllDirs(), and mayModifyPath().

Here is the call graph for this function:

l_create_world()

int ModApiMainMenu::l_create_world ( lua_State * L )

staticprivate

References DIR_DELIM, Settings::existsLocal(), g_settings, Settings::get(), getAvailableGames(), loadGameConfAndInitWorld(), porting::path_user, Settings::remove(), sanitizeDirName(), Settings::set(), and BaseException::what().

Here is the call graph for this function:

l_delete_dir()

int ModApiMainMenu::l_delete_dir ( lua_State * L )

staticprivate

References mayModifyPath(), fs::RecursiveDelete(), and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_delete_world()

int ModApiMainMenu::l_delete_world ( lua_State * L )

staticprivate

References getAvailableWorlds(), WorldSpec::path, and fs::RecursiveDelete().

Here is the call graph for this function:

l_do_async_callback()

int ModApiMainMenu::l_do_async_callback ( lua_State * L )

staticprivate

References ModApiBase::getScriptApi(), MainMenuScripting::queueAsync(), and sanity_check.

Here is the call graph for this function:

l_download_file()

int ModApiMainMenu::l_download_file ( lua_State * L )

staticprivate

References GUIEngine::downloadFile(), errorstream, mayModifyPath(), and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_extract_zip()

int ModApiMainMenu::l_extract_zip ( lua_State * L )

staticprivate

References RenderingEngine::get_raw_device(), mayModifyPath(), and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_active_driver()

int ModApiMainMenu::l_get_active_driver ( lua_State * L )

staticprivate

References RenderingEngine::get_video_driver(), and RenderingEngine::getVideoDriverInfo().

Here is the call graph for this function:

l_get_active_irrlicht_device()

int ModApiMainMenu::l_get_active_irrlicht_device ( lua_State * L )

staticprivate

References RenderingEngine::get_raw_device().

Here is the call graph for this function:

l_get_active_renderer()

int ModApiMainMenu::l_get_active_renderer ( lua_State * L )

staticprivate

References RenderingEngine::get_video_driver().

Here is the call graph for this function:

l_get_cache_path()

int ModApiMainMenu::l_get_cache_path ( lua_State * L )

staticprivate

References porting::path_cache, and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_clientmodpath()

int ModApiMainMenu::l_get_clientmodpath ( lua_State * L )

staticprivate

References DIR_DELIM, porting::path_user, and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_content_info()

int ModApiMainMenu::l_get_content_info ( lua_State * L )

staticprivate

References ContentSpec::author, ModSpec::depends, ContentSpec::desc, ContentSpec::name, ModSpec::optdepends, parseContentInfo(), parseModContents(), ContentSpec::path, ModSpec::path, ContentSpec::release, ContentSpec::textdomain, ContentSpec::title, and ContentSpec::type.

Here is the call graph for this function:

l_get_content_translation()

int ModApiMainMenu::l_get_content_translation ( lua_State * L )

staticprivate

References GUIEngine::getContentTranslations(), sanity_check, translate_string(), utf8_to_wide(), and wide_to_utf8().

Here is the call graph for this function:

l_get_formspec_version()

int ModApiMainMenu::l_get_formspec_version ( lua_State * L )

staticprivate

References FORMSPEC_API_VERSION.

l_get_gamepath()

int ModApiMainMenu::l_get_gamepath ( lua_State * L )

staticprivate

References DIR_DELIM, porting::path_user, and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_games()

int ModApiMainMenu::l_get_games ( lua_State * L )

staticprivate

References DIR_DELIM, getAvailableGames(), and getImagePath().

Here is the call graph for this function:

l_get_language()

int ModApiMainMenu::l_get_language ( lua_State * L )

staticprivate

l_get_mainmenu_path()

int ModApiMainMenu::l_get_mainmenu_path ( lua_State * L )

staticprivate

References GUIEngine::getScriptDir(), and sanity_check.

Here is the call graph for this function:

l_get_mapgen_names()

int ModApiMainMenu::l_get_mapgen_names ( lua_State * L )

staticprivate

References Mapgen::getMapgenNames(), and LuaHelper::readParam().

Here is the call graph for this function:

l_get_max_supp_proto()

int ModApiMainMenu::l_get_max_supp_proto ( lua_State * L )

staticprivate

References LATEST_PROTOCOL_VERSION.

l_get_min_supp_proto()

int ModApiMainMenu::l_get_min_supp_proto ( lua_State * L )

staticprivate

References CLIENT_PROTOCOL_VERSION_MIN.

l_get_modpath()

int ModApiMainMenu::l_get_modpath ( lua_State * L )

staticprivate

References DIR_DELIM, porting::path_user, and fs::RemoveRelativePathComponents().

Referenced by l_get_modpaths().

Here is the call graph for this function:

Here is the caller graph for this function:

l_get_modpaths()

int ModApiMainMenu::l_get_modpaths ( lua_State * L )

staticprivate

References fs::AbsolutePath(), DIR_DELIM, getEnvModPaths(), l_get_modpath(), porting::path_share, porting::path_user, and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_table_index()

int ModApiMainMenu::l_get_table_index ( lua_State * L )

staticprivate

References GUIEngine::m_menu, sanity_check, and table.

Referenced by l_get_textlist_index().

Here is the caller graph for this function:

l_get_temp_path()

int ModApiMainMenu::l_get_temp_path ( lua_State * L )

staticprivate

References fs::CreateTempDir(), and fs::CreateTempFile().

Here is the call graph for this function:

l_get_textlist_index()

int ModApiMainMenu::l_get_textlist_index ( lua_State * L )

staticprivate

References l_get_table_index().

Here is the call graph for this function:

l_get_texturepath()

int ModApiMainMenu::l_get_texturepath ( lua_State * L )

staticprivate

References DIR_DELIM, porting::path_user, and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_texturepath_share()

int ModApiMainMenu::l_get_texturepath_share ( lua_State * L )

staticprivate

References DIR_DELIM, porting::path_share, and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_user_path()

int ModApiMainMenu::l_get_user_path ( lua_State * L )

staticprivate

References porting::path_user, and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_get_video_drivers()

int ModApiMainMenu::l_get_video_drivers ( lua_State * L )

staticprivate

References RenderingEngine::getSupportedVideoDrivers(), and RenderingEngine::getVideoDriverInfo().

Here is the call graph for this function:

l_get_window_info()

int ModApiMainMenu::l_get_window_info ( lua_State * L )

staticprivate

References push_v2f(), and push_v2u32().

Here is the call graph for this function:

l_get_worlds()

int ModApiMainMenu::l_get_worlds ( lua_State * L )

staticprivate

References getAvailableWorlds().

Here is the call graph for this function:

l_gettext()

int ModApiMainMenu::l_gettext ( lua_State * L )

staticprivate

l_irrlicht_device_supports_touch()

int ModApiMainMenu::l_irrlicht_device_supports_touch ( lua_State * L )

staticprivate

References RenderingEngine::get_raw_device().

Here is the call graph for this function:

l_is_dir()

int ModApiMainMenu::l_is_dir ( lua_State * L )

staticprivate

References fs::IsDir().

Here is the call graph for this function:

l_may_modify_path()

int ModApiMainMenu::l_may_modify_path ( lua_State * L )

staticprivate

References mayModifyPath(), and fs::RemoveRelativePathComponents().

Here is the call graph for this function:

l_open_dir()

int ModApiMainMenu::l_open_dir ( lua_State * L )

staticprivate

References porting::open_directory().

Here is the call graph for this function:

l_open_url()

int ModApiMainMenu::l_open_url ( lua_State * L )

staticprivate

References porting::open_url().

Here is the call graph for this function:

l_open_url_dialog()

int ModApiMainMenu::l_open_url_dialog ( lua_State * L )

staticprivate

References RenderingEngine::get_gui_env(), GUIEngine::m_menumanager, GUIEngine::m_parent, GUIEngine::m_rendering_engine, GUIEngine::m_texture_source, and sanity_check.

Here is the call graph for this function:

l_set_background()

int ModApiMainMenu::l_set_background ( lua_State * L )

staticprivate

References minsize(), LuaHelper::readParam(), sanity_check, GUIEngine::setTexture(), TEX_LAYER_BACKGROUND, TEX_LAYER_FOOTER, TEX_LAYER_HEADER, and TEX_LAYER_OVERLAY.

Here is the call graph for this function:

l_set_clouds()

int ModApiMainMenu::l_set_clouds ( lua_State * L )

staticprivate

References GUIEngine::m_clouds_enabled, LuaHelper::readParam(), and sanity_check.

Here is the call graph for this function:

l_set_formspec_prepend()

int ModApiMainMenu::l_set_formspec_prepend ( lua_State * L )

staticprivate

References GUIEngine::m_startgame, sanity_check, and GUIEngine::setFormspecPrepend().

Here is the call graph for this function:

l_set_topleft_text()

int ModApiMainMenu::l_set_topleft_text ( lua_State * L )

staticprivate

References sanity_check, and GUIEngine::setTopleftText().

Here is the call graph for this function:

l_share_file()

int ModApiMainMenu::l_share_file ( lua_State * L )

staticprivate

References porting::shareFileAndroid().

Here is the call graph for this function:

l_show_keys_menu()

int ModApiMainMenu::l_show_keys_menu ( lua_State * L )

staticprivate

References RenderingEngine::get_gui_env(), GUIEngine::m_menumanager, GUIEngine::m_parent, GUIEngine::m_rendering_engine, GUIEngine::m_texture_source, and sanity_check.

Here is the call graph for this function:

l_show_path_select_dialog()

int ModApiMainMenu::l_show_path_select_dialog ( lua_State * L )

staticprivate

References RenderingEngine::get_gui_env(), GUIEngine::m_buttonhandler, GUIEngine::m_menumanager, GUIEngine::m_parent, GUIEngine::m_rendering_engine, LuaHelper::readParam(), sanity_check, and GUIFileSelectMenu::setTextDest().

Here is the call graph for this function:

l_start()

int ModApiMainMenu::l_start ( lua_State * L )

staticprivate

References MainMenuData::address, MainMenuData::allow_login_or_register, Any, MainMenuData::do_reconnect, getBoolData(), getIntegerData(), getTextData(), Login, GUIEngine::m_data, GUIEngine::m_startgame, MainMenuData::name, MainMenuData::password, MainMenuData::port, Register, sanity_check, MainMenuData::selected_world, MainMenuData::serverdescription, MainMenuData::servername, and MainMenuData::simple_singleplayer_mode.

Here is the call graph for this function:

l_update_formspec()

int ModApiMainMenu::l_update_formspec ( lua_State * L )

staticprivate

References GUIEngine::m_formspecgui, GUIEngine::m_startgame, sanity_check, and FormspecFormSource::setForm().

Here is the call graph for this function:

mayModifyPath()

bool ModApiMainMenu::mayModifyPath ( std::string path )

staticprivate

Checks if a path may be modified.

Paths in the temp directory or the user games, mods, textures, or worlds directories may be modified.

Parameters

path	path to check

Returns

true if the path may be modified

References DIR_DELIM, porting::path_cache, porting::path_user, fs::PathStartsWith(), fs::RemoveRelativePathComponents(), and fs::TempPath().

Referenced by l_copy_dir(), l_create_dir(), l_delete_dir(), l_download_file(), l_extract_zip(), and l_may_modify_path().

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/lua_api/l_mainmenu.h
• script/lua_api/l_mainmenu.cpp