Lua: expose more map and player infos (dkfans#4804)

Author: Shinthoras0815

Makefile

@@ -258,6 +258,7 @@ obj/light_data.o \
 obj/lua_api.o \
 obj/lua_api_camera.o \
 obj/lua_api_lens.o \
+obj/lua_api_map.o \
 obj/lua_api_player.o \
 obj/lua_api_room.o \
 obj/lua_api_things.o \

config/fxdata/lua/classes/Map.lua

@@ -0,0 +1,12 @@
+---@meta
+
+---@class Map
+---@field map_name string The name of the map
+---@field map_number integer The map number
+---@field campaign string The campaign/Mappack this map belongs to
+---@field map_type string The type of map (Campaign, Multiplayer, Bonus, Moon, MapPack)
+---@field width integer The width of the map in tiles
+---@field height integer The height of the map in tiles
+---@field default_texture texture_pack The default texture for the map, id for custom textures, or string for built-in textures
+---@field creature_pool table<string, integer> A table containing the creature pool for the map, with creature types as keys and their counts as values
+if not Map then Map = {} end

config/fxdata/lua/classes/Player.lua

@@ -82,6 +82,10 @@
 ---@field MANAGE_SCORE integer Part of level score, based on quality of the dungeon
 ---@field heart Thing The player's primary dungeon heart
 ---@field camera Camera The player's camera
+---@field type string The type of player (Human, Computer, Roaming, Neutral, Inactive)
+---@field max_creatures integer The maximum number of creatures the player can have from portals
+---@field colour string The colour of the player
+---@field player_name string The name of the player
 if not Player then Player = {} end
 
 

keeperfx_vs2010.vcxproj

@@ -187,6 +187,7 @@
     <ClCompile Include="src\lua_api_player.c" />
     <ClCompile Include="src\lua_api_slabs.c" />
     <ClCompile Include="src\lua_api_things.c" />
+    <ClCompile Include="src\lua_api_map.c" />
     <ClCompile Include="src\lua_base.c" />
     <ClCompile Include="src\lua_cfg_funcs.c" />
     <ClCompile Include="src\lua_params.c" />

keeperfx_vs2010.vcxproj.filters

@@ -752,6 +752,8 @@
     </ClCompile>
     <ClCompile Include="src\lua_api_slabs.c">
       <Filter>Source Files</Filter>
+    <ClCompile Include="src\lua_api_map.c">
+      <Filter>Source Files</Filter>
     </ClCompile>
     <ClCompile Include="src\lua_api_things.c">
       <Filter>Source Files</Filter>

linux.mk

@@ -181,6 +181,7 @@ src/light_data.c \
 src/linux.cpp \
 src/lua_api.c \
 src/lua_api_lens.c \
+src/lua_api_map.c \
 src/lua_api_player.c \
 src/lua_api_room.c \
 src/lua_api_things.c \

src/lua_api.c

@@ -2570,6 +2570,7 @@ static const luaL_Reg game_meta[] = {
     {NULL, NULL}
 };
 */
+
 static void Global_register(lua_State *L)
 {
     //luaL_newlib(L, global_methods);
@@ -2587,6 +2588,7 @@ void Slab_register(lua_State *L);
 void Room_register(lua_State *L);
 void Camera_register(lua_State *L);
 void Lens_register(lua_State *L);
+void Map_register(lua_State *L);
 
 void reg_host_functions(lua_State *L)
 {
@@ -2597,4 +2599,5 @@ void reg_host_functions(lua_State *L)
     Room_register(L);
     Camera_register(L);
     Lens_register(L);
+    Map_register(L);
 }

src/lua_api_map.c

@@ -0,0 +1,137 @@
+#include "pre_inc.h"
+
+#include <lua.h>
+#include <lauxlib.h>
+#include <lualib.h>
+
+#include "globals.h"
+#include "game_legacy.h"         // game.map_tiles_x/y, game.pool, game.texture_id
+#include "config_campaigns.h"    // is_map_pack, campaign, LevelInformation, get_level_info
+#include "config.h"              // LvKind_IsSingle, LvKind_IsMulti, etc.
+#include "config_creature.h"     // creature_desc, CREATURE_TYPES_MAX
+#include "engine_textures.h"     // load_texture_map_file
+#include "lvl_filesdk1.h"        // get_loaded_level_number, get_level_fgroup
+#include "lvl_script_lib.h"      // texture_pack_desc
+
+#include "lua_base.h"
+#include "lua_params.h"          // luaL_checkNamedCommand
+
+#include "post_inc.h"
+
+/**********************************************/
+
+static int map_tostring(lua_State *L) {
+    lua_pushfstring(L, "Map(%dx%d)", game.map_tiles_x, game.map_tiles_y);
+    return 1;
+}
+
+//read creature pool from a map
+static void push_map_pool(lua_State *L) {
+    lua_newtable(L);
+    for (int i = 0; i < CREATURE_TYPES_MAX; i++) {
+        int n = game.pool.crtr_kind[i];
+        if (n <= 0) continue;
+        lua_pushstring(L, get_conf_parameter_text(creature_desc, i));
+        lua_pushinteger(L, n);
+        lua_rawset(L, -3);
+    }
+}
+
+
+//read map fields
+static int map_get_field(lua_State *L){
+    const char *key = luaL_checkstring(L, 2);
+    LevelNumber lv_number = get_loaded_level_number();
+    struct LevelInformation *lv_inf = get_level_info(lv_number);
+
+    const char *map_name = "";
+    unsigned long ltype  = 0;
+    if (lv_inf) {
+        map_name = lv_inf->name;
+        ltype    = lv_inf->level_type;
+    }
+
+    if (strcmp(key, "creature_pool") == 0)           
+        push_map_pool(L);
+    else if (strcmp(key, "map_name") == 0) {     
+        lua_pushstring(L, map_name);
+    } else if (strcmp(key, "map_number") == 0)          
+        lua_pushinteger(L, lv_number);
+    else if (strcmp(key, "campaign") == 0)          
+        lua_pushstring(L, campaign.name);
+    else if (strcmp(key, "map_type") == 0) {     
+        if (ltype & LvKind_IsMulti) {
+            lua_pushstring(L, "Multiplayer");
+        } else if (ltype & LvKind_IsExtra) {
+            lua_pushstring(L, "Moon");
+        } else if (ltype & LvKind_IsBonus) {
+            lua_pushstring(L, "Bonus");
+        } else if (ltype & LvKind_IsFree) {
+            lua_pushstring(L, "MapPack");
+        } else if (ltype & LvKind_IsSingle) {
+            lua_pushstring(L, "Campaign");
+        } else {
+            lua_pushstring(L, "Unknown");
+        }
+    } else if (strcmp(key, "width") == 0) {
+        lua_pushinteger(L, game.map_tiles_x);
+    } else if (strcmp(key, "height") == 0) {          
+        lua_pushinteger(L, game.map_tiles_y);
+    } else if (strcmp(key, "default_texture") == 0) {
+        const char *name = get_conf_parameter_text(texture_pack_desc, game.texture_id);
+        if (name[0] != '\0') {
+            lua_pushstring(L, name);            // "STANDARD", "ANCIENT", ...
+        } else {
+            lua_pushinteger(L, game.texture_id); // 17, 20, ... (Custom)
+        }
+    } else {
+        return luaL_error(L, "Unknown field '%s' for MAP", key);
+    }
+    return 1;
+}
+
+//write map fields
+static int map_set_field(lua_State *L) {
+    const char *key = luaL_checkstring(L, 2);
+
+    if (strcmp(key, "default_texture") == 0) {
+        long texture_id = luaL_checkNamedCommand(L, 3, texture_pack_desc);
+        game.texture_id = texture_id;                           
+        LevelNumber lvnumb = get_loaded_level_number();
+        load_texture_map_file(texture_id, lvnumb, get_level_fgroup(lvnumb));
+
+        return 0;
+    }
+
+    return luaL_error(L, "MAP field '%s' is read-only", key);
+}
+
+// Metamethod registration table for the MAP metatable.
+static const struct luaL_Reg map_meta[] = {
+    {"__index", map_get_field},
+    {"__newindex", map_set_field},
+    {"__tostring", map_tostring},
+    {NULL, NULL}
+};
+
+// Builds the global MAP singleton and binds its metatable.
+void Map_register(lua_State *L) {
+    luaL_newmetatable(L, "Map");
+    luaL_setfuncs(L, map_meta, 0);
+
+    lua_pushliteral(L, "__metatable");
+    lua_pushnil(L);
+    lua_rawset(L, -3);
+
+    lua_pop(L, 1);
+
+    lua_newtable(L);
+
+    lua_pushstring(L, "Map");
+    lua_setfield(L, -2, "__class");
+
+    luaL_getmetatable(L, "Map");
+    lua_setmetatable(L, -2);
+
+    lua_setglobal(L, "Map");
+}

src/lua_api_player.c

@@ -11,6 +11,8 @@
 #include "player_data.h"
 #include "lvl_script_lib.h"
 #include "player_utils.h"
+#include "dungeon_data.h"
+#include "config_campaigns.h"
 
 #include "post_inc.h"
 
@@ -142,6 +144,29 @@ static int player_set_field(lua_State *L) {
 
     PlayerNumber player_idx = luaL_checkPlayerSingle(L, 1);
     const char* key = luaL_checkstring(L, 2);
+    struct PlayerInfo *player = get_player(player_idx);
+
+    if (strcmp(key, "player_name") == 0) {
+        const char* name = luaL_checkstring(L, 3);
+        if (!player_invalid(player)) {
+            snprintf(player->player_name, sizeof(player->player_name), "%s", name);
+        }
+        return 0;
+    } else if (strcmp(key, "colour") == 0) {
+        long colour_idx;
+        if (lua_type(L, 3) == LUA_TSTRING) {
+            const char* name = lua_tostring(L, 3);
+            colour_idx = get_rid(cmpgn_human_player_options, name);
+            if (colour_idx == -1) {
+                return luaL_argerror(L, 3, "unrecognized colour name");
+            }
+        } else {
+            colour_idx = luaL_checkinteger(L, 3);
+        }
+        set_player_colour(player_idx, (unsigned char)colour_idx);
+        return 0;
+    }
+
     int value = luaL_checkinteger(L, 3);
 
     int32_t variable_type;
@@ -159,7 +184,9 @@ static int player_set_field(lua_State *L) {
 static int player_get_field(lua_State *L) {
     const char* key = luaL_checkstring(L, 2);
     PlayerNumber plyr_idx = luaL_checkPlayerSingle(L, 1);
-
+    struct PlayerInfo *player = get_player(plyr_idx);
+    struct Dungeon *dungeon = get_dungeon(plyr_idx);
+    
     int32_t variable_type, variable_id;
 
     // C method lookup
@@ -177,8 +204,31 @@ static int player_get_field(lua_State *L) {
     } else if (strcmp(key, "available") == 0) {
         lua_pushinteger(L, plyr_idx);
         lua_pushcclosure(L, player_get_available, 1);
-    }
-    else if (parse_get_varib(key, &variable_id, &variable_type, 1)) {
+    } else if (strcmp(key, "type") == 0) {
+        if (player_invalid(player)) {
+            lua_pushnil(L);
+        } else if (player_is_roaming(plyr_idx)) {
+            lua_pushstring(L, "Roaming");
+        } else if (player_is_neutral(plyr_idx)) {
+            lua_pushstring(L, "Neutral");
+        } else if (player->allocflags & PlaF_CompCtrl) {
+            lua_pushstring(L, "Computer");
+        } else if (player->is_active) {
+            lua_pushstring(L, "Human");
+        } else {
+            lua_pushstring(L, "Inactive");
+        }
+    } else if (strcmp(key, "max_creatures") == 0) {
+        if (dungeon_invalid(dungeon)) {
+            lua_pushinteger(L, 0);
+        } else {
+            lua_pushinteger(L, dungeon->max_creatures_attracted);
+        }
+    } else if (strcmp(key, "player_name") == 0) {
+        lua_pushstring(L, player_invalid(player) ? "" : player->player_name);
+    } else if (strcmp(key, "colour") == 0) {
+        lua_pushstring(L, get_conf_parameter_text(cmpgn_human_player_options, get_player_color_idx(plyr_idx)));
+    } else if (parse_get_varib(key, &variable_id, &variable_type, 1)) {
         lua_pushinteger(L, get_condition_value(plyr_idx, variable_type, variable_id));
     } else if (try_get_from_methods(L, 1, key)) {
         return 1;