ModApiBase Class Reference

#include <l_base.h>

Inheritance diagram for ModApiBase:

Collaboration diagram for ModApiBase:

Static Public Member Functions
static ScriptApiBase *	getScriptApiBase (lua_State *L)
static Server *	getServer (lua_State *L)
static ServerInventoryManager *	getServerInventoryMgr (lua_State *L)
static Client *	getClient (lua_State *L)
static GUIEngine *	getGuiEngine (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 int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions. More...

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

Member Function Documentation

getClient()

Client * ModApiBase::getClient ( lua_State *  L )

static

References ScriptApiBase::getClient(), and getScriptApiBase().

Referenced by ModApiParticlesLocal::l_add_particle(), ModApiParticlesLocal::l_add_particlespawner(), ModApiClient::l_clear_out_chat_queue(), ModApiParticlesLocal::l_delete_particlespawner(), ModApiClient::l_disconnect(), ModApiClient::l_display_chat_message(), ModApiEnvMod::l_find_node_near(), ModApiEnvMod::l_find_nodes_in_area(), ModApiEnvMod::l_find_nodes_in_area_under_air(), ModApiClient::l_get_csm_restrictions(), LuaCamera::l_get_look_horizontal(), LuaCamera::l_get_look_vertical(), ModApiClient::l_get_meta(), ModApiClient::l_get_node_or_nil(), LuaCamera::l_get_offset(), ModApiClient::l_get_player_names(), ModApiClient::l_get_privilege_list(), ModApiClient::l_get_server_info(), LuaMinimap::l_hide(), LuaRaycast::l_next(), ModApiClient::l_send_chat_message(), ModApiClient::l_send_respawn(), LuaCamera::l_set_camera_mode(), LuaMinimap::l_show(), ModApiClient::l_show_formspec(), ModApiClient::l_sound_fade(), ModApiClient::l_sound_play(), and ModApiClient::l_sound_stop().

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentModPath()

std::string ModApiBase::getCurrentModPath ( lua_State *  L )

static

References CUSTOM_RIDX_CURRENT_MOD_NAME, Server::getModSpec(), getServer(), and ModSpec::path.

Referenced by load_schematic().

Here is the call graph for this function:

Here is the caller graph for this function:

getEnv()

Environment * ModApiBase::getEnv ( lua_State *  L )

static

References ScriptApiBase::getEnv(), and getScriptApiBase().

Referenced by ModApiAuth::getAuthDb(), ModApiMapgen::l_create_schematic(), ModApiServer::l_dynamic_add_media_raw(), ModApiEnvMod::l_get_connected_players(), ModApiClient::l_get_meta(), ModApiServer::l_kick_player(), and ModApiServer::l_remove_player().

Here is the call graph for this function:

Here is the caller graph for this function:

getGameDef()

IGameDef * ModApiBase::getGameDef ( lua_State *  L )

static

References ScriptApiBase::getGameDef(), and getScriptApiBase().

Referenced by LuaItemStack::create_object(), StorageRef::gc_object(), ModChannelRef::getobject(), LuaItemStack::l_add_item(), ModApiParticles::l_add_particle(), ModApiParticlesLocal::l_add_particle(), ModApiParticles::l_add_particlespawner(), ModApiParticlesLocal::l_add_particlespawner(), LuaItemStack::l_add_wear(), ModApiItemMod::l_get_content_id(), LuaItemStack::l_get_description(), LuaItemStack::l_get_free_space(), ModApiClient::l_get_item_def(), ModApiStorage::l_get_mod_storage(), ModApiItemMod::l_get_name_from_content_id(), ModApiClient::l_get_node_def(), LuaItemStack::l_get_short_description(), LuaItemStack::l_get_stack_max(), LuaItemStack::l_get_tool_capabilities(), LuaItemStack::l_is_known(), LuaItemStack::l_item_fits(), ModChannelRef::l_leave(), ModApiChannels::l_mod_channel_join(), LuaItemStack::l_replace(), and ModChannelRef::l_send_all().

Here is the call graph for this function:

Here is the caller graph for this function:

getGuiEngine()

GUIEngine * ModApiBase::getGuiEngine ( lua_State *  L )

static

References ScriptApiBase::getGuiEngine(), and getScriptApiBase().

Referenced by ModApiHttp::Initialize(), ModApiMainMenu::l_close(), ModApiMainMenu::l_do_async_callback(), ModApiMainMenu::l_get_mainmenu_path(), ModApiMainMenu::l_get_table_index(), ModApiMainMenu::l_set_background(), ModApiMainMenu::l_set_clouds(), ModApiMainMenu::l_set_formspec_prepend(), ModApiMainMenu::l_set_topleft_text(), ModApiMainMenu::l_show_keys_menu(), ModApiMainMenu::l_show_path_select_dialog(), ModApiSound::l_sound_play(), ModApiSound::l_sound_stop(), ModApiMainMenu::l_start(), and ModApiMainMenu::l_update_formspec().

Here is the call graph for this function:

Here is the caller graph for this function:

getScriptApi()

template<typename T >

static T* ModApiBase::getScriptApi ( lua_State *  L )

inlinestatic

References getScriptApiBase().

Here is the call graph for this function:

getScriptApiBase()

ScriptApiBase * ModApiBase::getScriptApiBase ( lua_State *  L )

static

References CUSTOM_RIDX_SCRIPTAPI.

Referenced by getClient(), getEnv(), getGameDef(), getGuiEngine(), getScriptApi(), getServer(), getServerInventoryMgr(), ModApiEnvMod::l_add_entity(), ModApiEnvMod::l_emerge_area(), ObjectRef::l_get_attach(), ObjectRef::l_get_children(), ModApiEnvMod::l_get_connected_players(), ModApiClient::l_get_last_run_mod(), ModApiServer::l_get_last_run_mod(), ModApiEnvMod::l_get_objects_in_area(), ModApiEnvMod::l_get_objects_inside_radius(), ModApiEnvMod::l_get_player_by_name(), ModApiClient::l_set_last_run_mod(), and ModApiServer::l_set_last_run_mod().

Here is the caller graph for this function:

getServer()

Server * ModApiBase::getServer ( lua_State *  L )

static

References getScriptApiBase(), and ScriptApiBase::getServer().

Referenced by getCurrentModPath(), NodeMetaRef::handleFromTable(), ModApiEnvMod::l_add_item(), InvRef::l_add_item(), ModApiParticles::l_add_particle(), ModApiParticles::l_add_particlespawner(), ObjectRef::l_add_velocity(), ModApiServer::l_ban_player(), LuaVoxelManip::l_calc_lighting(), ModApiServer::l_chat_send_all(), ModApiServer::l_chat_send_player(), ModApiCraft::l_clear_craft(), ModApiMapgen::l_clear_registered_biomes(), ModApiMapgen::l_clear_registered_decorations(), ModApiMapgen::l_clear_registered_ores(), ModApiMapgen::l_clear_registered_schematics(), InvRef::l_contains_item(), ModApiInventory::l_create_detached_inventory_raw(), ModApiMapgen::l_create_schematic(), ModApiParticles::l_delete_particlespawner(), ModApiServer::l_dynamic_add_media_raw(), ModApiEnvMod::l_emerge_area(), ModApiMapgen::l_generate_decorations(), ModApiMapgen::l_generate_ores(), ModApiCraft::l_get_all_craft_recipes(), ModApiServer::l_get_ban_description(), ModApiServer::l_get_ban_list(), ModApiMapgen::l_get_biome_data(), ModApiMapgen::l_get_biome_id(), ModApiMapgen::l_get_biome_name(), ModApiCraft::l_get_craft_recipe(), ModApiCraft::l_get_craft_result(), ModApiMapgen::l_get_decoration_id(), ModApiMapgen::l_get_gen_notify(), ModApiMapgen::l_get_heat(), ModApiMapgen::l_get_humidity(), ModApiMapgen::l_get_mapgen_object(), ModApiMapgen::l_get_mapgen_params(), ModApiMapgen::l_get_mapgen_setting(), ModApiMapgen::l_get_mapgen_setting_noiseparams(), ModApiServer::l_get_modnames(), ModApiServer::l_get_modpath(), LuaVoxelManip::l_get_node_at(), ModApiServer::l_get_player_information(), ModApiServer::l_get_player_ip(), ModApiServer::l_get_player_privs(), ModApiServer::l_get_server_status(), ModApiServer::l_get_server_uptime(), ModApiMapgen::l_get_spawn_level(), ModApiEnvMod::l_get_translated_string(), ModApiServer::l_get_worldpath(), ObjectRef::l_hud_add(), ObjectRef::l_hud_change(), ObjectRef::l_hud_remove(), ObjectRef::l_hud_set_flags(), ObjectRef::l_hud_set_hotbar_image(), ObjectRef::l_hud_set_hotbar_itemcount(), ObjectRef::l_hud_set_hotbar_selected_image(), ModApiServer::l_is_singleplayer(), ModApiServer::l_kick_player(), ModApiServer::l_notify_authentication_modified(), ObjectRef::l_override_day_night_ratio(), ModApiEnvMod::l_place_node(), ModApiMapgen::l_place_schematic(), ModApiMapgen::l_place_schematic_on_vmanip(), ModApiServer::l_print(), ObjectRef::l_punch(), ModApiMapgen::l_read_schematic(), ModApiItemMod::l_register_alias_raw(), ModApiMapgen::l_register_biome(), ModApiCraft::l_register_craft(), ModApiMapgen::l_register_decoration(), ModApiItemMod::l_register_item_raw(), ModApiMapgen::l_register_ore(), ModApiMapgen::l_register_schematic(), InvRef::l_remove_item(), ModApiServer::l_request_shutdown(), ModApiRollback::l_rollback_get_node_actions(), ModApiRollback::l_rollback_revert_actions_by(), InvRef::l_room_for_item(), ObjectRef::l_send_mapblock(), ModApiMapgen::l_serialize_schematic(), ObjectRef::l_set_clouds(), ObjectRef::l_set_eye_offset(), ObjectRef::l_set_formspec_prepend(), ObjectRef::l_set_fov(), ModApiMapgen::l_set_gen_notify(), ObjectRef::l_set_hp(), ObjectRef::l_set_inventory_formspec(), InvRef::l_set_list(), InvRef::l_set_lists(), ObjectRef::l_set_local_animation(), ModApiMapgen::l_set_mapgen_params(), ModApiMapgen::l_set_mapgen_setting(), ModApiMapgen::l_set_mapgen_setting_noiseparams(), ObjectRef::l_set_minimap_modes(), ObjectRef::l_set_moon(), LuaVoxelManip::l_set_node_at(), ObjectRef::l_set_properties(), ObjectRef::l_set_sky(), InvRef::l_set_stack(), ObjectRef::l_set_stars(), ObjectRef::l_set_sun(), ModApiEnvMod::l_set_timeofday(), ObjectRef::l_set_wielded_item(), ModApiServer::l_show_formspec(), ModApiServer::l_sound_fade(), ModApiServer::l_sound_play(), ModApiServer::l_sound_stop(), ModApiServer::l_unban_player_or_ip(), ModApiItemMod::l_unregister_item_raw(), and LuaVoxelManip::l_update_liquids().

Here is the call graph for this function:

getServerInventoryMgr()

ServerInventoryManager * ModApiBase::getServerInventoryMgr ( lua_State *  L )

static

References Server::getInventoryMgr(), getScriptApiBase(), and ScriptApiBase::getServer().

Referenced by InvRef::getinv(), ModApiInventory::l_create_detached_inventory_raw(), ModApiInventory::l_get_inventory(), ObjectRef::l_get_inventory(), ModApiInventory::l_remove_detached_inventory_raw(), and InvRef::reportInventoryChange().

Here is the call graph for this function:

Here is the caller graph for this function:

l_deprecated_function()

int ModApiBase::l_deprecated_function ( lua_State *  L, const char *  good, const char *  bad, lua_CFunction  func  )

static

A wrapper for deprecated functions.

When called, handles the deprecation according to user settings and then calls func.

Exceptions

Lua	Error if required by the user settings.

Parameters

L	Lua state
good	Name of good function/method
bad	Name of deprecated function/method
func	Actual implementation of function

Returns

value from func

References Profiler::avg(), Error, FATAL_ERROR_IF, g_profiler, get_deprecated_handling_mode(), porting::getTimeUs(), hash(), Ignore, murmur_hash_64_ua(), script_error(), and warningstream.

Here is the call graph for this function:

registerFunction()

bool ModApiBase::registerFunction ( lua_State *  L, const char *  name, lua_CFunction  func, int  top  )

static

Referenced by ModApiAuth::Initialize().

Here is the caller graph for this function:

---

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

• script/lua_api/l_base.h
• script/lua_api/l_base.cpp