]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/script/lua_api/l_client.cpp
Improve core.sound_play with ephemeral sounds and player exclusion
[dragonfireclient.git] / src / script / lua_api / l_client.cpp
index 5f94747029dea11d6c4d827adab118dde05e3753..fba18249293566ed6abb414d2b97eae1b5495e09 100644 (file)
@@ -19,29 +19,70 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 */
 
 #include "l_client.h"
+#include "chatmessage.h"
+#include "client/client.h"
+#include "client/clientevent.h"
+#include "client/sound.h"
+#include "client/clientenvironment.h"
 #include "common/c_content.h"
 #include "common/c_converter.h"
 #include "cpp_api/s_base.h"
 #include "gettext.h"
 #include "l_internal.h"
 #include "lua_api/l_item.h"
-#include "mainmenumanager.h"
+#include "lua_api/l_nodemeta.h"
+#include "gui/mainmenumanager.h"
+#include "map.h"
 #include "util/string.h"
+#include "nodedef.h"
 
-extern MainGameCallback *g_gamecallback;
+#define checkCSMRestrictionFlag(flag) \
+       ( getClient(L)->checkCSMRestrictionFlag(CSMRestrictionFlags::flag) )
 
+// Not the same as FlagDesc, which contains an `u32 flag`
+struct CSMFlagDesc {
+       const char *name;
+       u64 flag;
+};
+
+/*
+       FIXME: This should eventually be moved somewhere else
+       It also needs to be kept in sync with the definition of CSMRestrictionFlags
+       in network/networkprotocol.h
+*/
+const static CSMFlagDesc flagdesc_csm_restriction[] = {
+       {"load_client_mods",  CSM_RF_LOAD_CLIENT_MODS},
+       {"chat_messages",     CSM_RF_CHAT_MESSAGES},
+       {"read_itemdefs",     CSM_RF_READ_ITEMDEFS},
+       {"read_nodedefs",     CSM_RF_READ_NODEDEFS},
+       {"lookup_nodes",      CSM_RF_LOOKUP_NODES},
+       {"read_playerinfo",   CSM_RF_READ_PLAYERINFO},
+       {NULL,      0}
+};
+
+// get_current_modname()
 int ModApiClient::l_get_current_modname(lua_State *L)
 {
        lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
        return 1;
 }
 
+// get_modpath(modname)
+int ModApiClient::l_get_modpath(lua_State *L)
+{
+       std::string modname = readParam<std::string>(L, 1);
+       // Client mods use a virtual filesystem, see Client::scanModSubfolder()
+       std::string path = modname + ":";
+       lua_pushstring(L, path.c_str());
+       return 1;
+}
+
 // get_last_run_mod()
 int ModApiClient::l_get_last_run_mod(lua_State *L)
 {
        lua_rawgeti(L, LUA_REGISTRYINDEX, CUSTOM_RIDX_CURRENT_MOD_NAME);
-       const char *current_mod = lua_tostring(L, -1);
-       if (current_mod == NULL || current_mod[0] == '\0') {
+       std::string current_mod = readParam<std::string>(L, -1, "");
+       if (current_mod.empty()) {
                lua_pop(L, 1);
                lua_pushstring(L, getScriptApiBase(L)->getOrigin().c_str());
        }
@@ -60,6 +101,15 @@ int ModApiClient::l_set_last_run_mod(lua_State *L)
        return 1;
 }
 
+// print(text)
+int ModApiClient::l_print(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+       std::string text = luaL_checkstring(L, 1);
+       rawstream << text << std::endl;
+       return 0;
+}
+
 // display_chat_message(message)
 int ModApiClient::l_display_chat_message(lua_State *L)
 {
@@ -67,20 +117,46 @@ int ModApiClient::l_display_chat_message(lua_State *L)
                return 0;
 
        std::string message = luaL_checkstring(L, 1);
-       getClient(L)->pushToChatQueue(utf8_to_wide(message));
+       getClient(L)->pushToChatQueue(new ChatMessage(utf8_to_wide(message)));
        lua_pushboolean(L, true);
        return 1;
 }
 
+// send_chat_message(message)
+int ModApiClient::l_send_chat_message(lua_State *L)
+{
+       if (!lua_isstring(L, 1))
+               return 0;
+
+       // If server disabled this API, discard
+
+       if (checkCSMRestrictionFlag(CSM_RF_CHAT_MESSAGES))
+               return 0;
+
+       std::string message = luaL_checkstring(L, 1);
+       getClient(L)->sendChatMessage(utf8_to_wide(message));
+       return 0;
+}
+
+// clear_out_chat_queue()
+int ModApiClient::l_clear_out_chat_queue(lua_State *L)
+{
+       getClient(L)->clearOutChatQueue();
+       return 0;
+}
+
 // get_player_names()
 int ModApiClient::l_get_player_names(lua_State *L)
 {
+       if (checkCSMRestrictionFlag(CSM_RF_READ_PLAYERINFO))
+               return 0;
+
        const std::list<std::string> &plist = getClient(L)->getConnectedPlayerNames();
        lua_createtable(L, plist.size(), 0);
        int newTable = lua_gettop(L);
        int index = 1;
        std::list<std::string>::const_iterator iter;
-       for (iter = plist.begin(); iter != plist.end(); iter++) {
+       for (iter = plist.begin(); iter != plist.end(); ++iter) {
                lua_pushstring(L, (*iter).c_str());
                lua_rawseti(L, newTable, index);
                index++;
@@ -94,10 +170,10 @@ int ModApiClient::l_show_formspec(lua_State *L)
        if (!lua_isstring(L, 1) || !lua_isstring(L, 2))
                return 0;
 
-       ClientEvent event;
-       event.type = CE_SHOW_LOCAL_FORMSPEC;
-       event.show_formspec.formname = new std::string(luaL_checkstring(L, 1));
-       event.show_formspec.formspec = new std::string(luaL_checkstring(L, 2));
+       ClientEvent *event = new ClientEvent();
+       event->type = CE_SHOW_LOCAL_FORMSPEC;
+       event->show_formspec.formname = new std::string(luaL_checkstring(L, 1));
+       event->show_formspec.formspec = new std::string(luaL_checkstring(L, 2));
        getClient(L)->pushToEventQueue(event);
        lua_pushboolean(L, true);
        return 1;
@@ -135,27 +211,14 @@ int ModApiClient::l_gettext(lua_State *L)
 
 // get_node(pos)
 // pos = {x=num, y=num, z=num}
-int ModApiClient::l_get_node(lua_State *L)
-{
-       // pos
-       v3s16 pos = read_v3s16(L, 1);
-       // Do it
-       bool pos_ok;
-       MapNode n = getClient(L)->getNode(pos, &pos_ok);
-       // Return node
-       pushnode(L, n, getClient(L)->ndef());
-       return 1;
-}
-
-// get_node_or_nil(pos)
-// pos = {x=num, y=num, z=num}
 int ModApiClient::l_get_node_or_nil(lua_State *L)
 {
        // pos
        v3s16 pos = read_v3s16(L, 1);
+
        // Do it
        bool pos_ok;
-       MapNode n = getClient(L)->getNode(pos, &pos_ok);
+       MapNode n = getClient(L)->CSMGetNode(pos, &pos_ok);
        if (pos_ok) {
                // Return node
                pushnode(L, n, getClient(L)->ndef());
@@ -165,19 +228,180 @@ int ModApiClient::l_get_node_or_nil(lua_State *L)
        return 1;
 }
 
+int ModApiClient::l_get_language(lua_State *L)
+{
+#ifdef _WIN32
+       char *locale = setlocale(LC_ALL, NULL);
+#else
+       char *locale = setlocale(LC_MESSAGES, NULL);
+#endif
+       std::string lang = gettext("LANG_CODE");
+       if (lang == "LANG_CODE")
+               lang = "";
+
+       lua_pushstring(L, locale);
+       lua_pushstring(L, lang.c_str());
+       return 2;
+}
+
 int ModApiClient::l_get_wielded_item(lua_State *L)
 {
        Client *client = getClient(L);
+       LocalPlayer *player = client->getEnv().getLocalPlayer();
+       if (!player)
+               return 0;
 
-       Inventory local_inventory(client->idef());
-       client->getLocalInventory(local_inventory);
+       ItemStack selected_item;
+       player->getWieldedItem(&selected_item, nullptr);
+       LuaItemStack::create(L, selected_item);
+       return 1;
+}
 
-       InventoryList *mlist = local_inventory.getList("main");
+// get_meta(pos)
+int ModApiClient::l_get_meta(lua_State *L)
+{
+       v3s16 p = read_v3s16(L, 1);
+       NodeMetadata *meta = getClient(L)->getEnv().getMap().getNodeMetadata(p);
+       NodeMetaRef::createClient(L, meta);
+       return 1;
+}
 
-       if (mlist && client->getPlayerItem() < mlist->getSize()) {
-               LuaItemStack::create(L, mlist->getItem(client->getPlayerItem()));
-       } else {
-               LuaItemStack::create(L, ItemStack());
+int ModApiClient::l_sound_play(lua_State *L)
+{
+       ISoundManager *sound = getClient(L)->getSoundManager();
+
+       SimpleSoundSpec spec;
+       read_soundspec(L, 1, spec);
+       float gain = 1.0f;
+       float pitch = 1.0f;
+       bool looped = false;
+       s32 handle;
+
+       if (lua_istable(L, 2)) {
+               getfloatfield(L, 2, "gain", gain);
+               getfloatfield(L, 2, "pitch", pitch);
+               getboolfield(L, 2, "loop", looped);
+
+               lua_getfield(L, 2, "pos");
+               if (!lua_isnil(L, -1)) {
+                       v3f pos = read_v3f(L, -1) * BS;
+                       lua_pop(L, 1);
+                       handle = sound->playSoundAt(
+                                       spec.name, looped, gain * spec.gain, pos, pitch);
+                       lua_pushinteger(L, handle);
+                       return 1;
+               }
+       }
+
+       handle = sound->playSound(spec.name, looped, gain * spec.gain, 0.0f, pitch);
+       lua_pushinteger(L, handle);
+
+       return 1;
+}
+
+int ModApiClient::l_sound_stop(lua_State *L)
+{
+       u32 handle = luaL_checkinteger(L, 1);
+
+       getClient(L)->getSoundManager()->stopSound(handle);
+
+       return 0;
+}
+
+// get_server_info()
+int ModApiClient::l_get_server_info(lua_State *L)
+{
+       Client *client = getClient(L);
+       Address serverAddress = client->getServerAddress();
+       lua_newtable(L);
+       lua_pushstring(L, client->getAddressName().c_str());
+       lua_setfield(L, -2, "address");
+       lua_pushstring(L, serverAddress.serializeString().c_str());
+       lua_setfield(L, -2, "ip");
+       lua_pushinteger(L, serverAddress.getPort());
+       lua_setfield(L, -2, "port");
+       lua_pushinteger(L, client->getProtoVersion());
+       lua_setfield(L, -2, "protocol_version");
+       return 1;
+}
+
+// get_item_def(itemstring)
+int ModApiClient::l_get_item_def(lua_State *L)
+{
+       IGameDef *gdef = getGameDef(L);
+       assert(gdef);
+
+       IItemDefManager *idef = gdef->idef();
+       assert(idef);
+
+       if (checkCSMRestrictionFlag(CSM_RF_READ_ITEMDEFS))
+               return 0;
+
+       if (!lua_isstring(L, 1))
+               return 0;
+
+       std::string name = readParam<std::string>(L, 1);
+       if (!idef->isKnown(name))
+               return 0;
+       const ItemDefinition &def = idef->get(name);
+
+       push_item_definition_full(L, def);
+
+       return 1;
+}
+
+// get_node_def(nodename)
+int ModApiClient::l_get_node_def(lua_State *L)
+{
+       IGameDef *gdef = getGameDef(L);
+       assert(gdef);
+
+       const NodeDefManager *ndef = gdef->ndef();
+       assert(ndef);
+
+       if (!lua_isstring(L, 1))
+               return 0;
+
+       if (checkCSMRestrictionFlag(CSM_RF_READ_NODEDEFS))
+               return 0;
+
+       std::string name = readParam<std::string>(L, 1);
+       const ContentFeatures &cf = ndef->get(ndef->getId(name));
+       if (cf.name != name) // Unknown node. | name = <whatever>, cf.name = ignore
+               return 0;
+
+       push_content_features(L, cf);
+
+       return 1;
+}
+
+int ModApiClient::l_get_privilege_list(lua_State *L)
+{
+       const Client *client = getClient(L);
+       lua_newtable(L);
+       for (const std::string &priv : client->getPrivilegeList()) {
+               lua_pushboolean(L, true);
+               lua_setfield(L, -2, priv.c_str());
+       }
+       return 1;
+}
+
+// get_builtin_path()
+int ModApiClient::l_get_builtin_path(lua_State *L)
+{
+       lua_pushstring(L, BUILTIN_MOD_NAME ":");
+       return 1;
+}
+
+// get_csm_restrictions()
+int ModApiClient::l_get_csm_restrictions(lua_State *L)
+{
+       u64 flags = getClient(L)->getCSMRestrictionFlags();
+       const CSMFlagDesc *flagdesc = flagdesc_csm_restriction;
+
+       lua_newtable(L);
+       for (int i = 0; flagdesc[i].name; i++) {
+               setboolfield(L, -1, flagdesc[i].name, !!(flags & flagdesc[i].flag));
        }
        return 1;
 }
@@ -185,15 +409,28 @@ int ModApiClient::l_get_wielded_item(lua_State *L)
 void ModApiClient::Initialize(lua_State *L, int top)
 {
        API_FCT(get_current_modname);
+       API_FCT(get_modpath);
+       API_FCT(print);
        API_FCT(display_chat_message);
+       API_FCT(send_chat_message);
+       API_FCT(clear_out_chat_queue);
        API_FCT(get_player_names);
        API_FCT(set_last_run_mod);
        API_FCT(get_last_run_mod);
        API_FCT(show_formspec);
        API_FCT(send_respawn);
        API_FCT(gettext);
-       API_FCT(get_node);
        API_FCT(get_node_or_nil);
        API_FCT(get_wielded_item);
        API_FCT(disconnect);
+       API_FCT(get_meta);
+       API_FCT(sound_play);
+       API_FCT(sound_stop);
+       API_FCT(get_server_info);
+       API_FCT(get_item_def);
+       API_FCT(get_node_def);
+       API_FCT(get_privilege_list);
+       API_FCT(get_builtin_path);
+       API_FCT(get_language);
+       API_FCT(get_csm_restrictions);
 }