upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-05-03 22:27:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move path-related functions into a new wesnoth.paths module

Browse Source 
This also adds support to the mapgen version of wesnoth.find_path for
taking an options table as the 3rd argument instead of several additional arguments.

The intent of this is to bring the two versions of find_path closer together.
For now, however, the actual options accepted in the table have not changed.
This commit is contained in:
Celtic Minstrel 2021-05-19 01:51:42 -04:00 committed by Celtic Minstrel
parent 5a1e38e99b
commit 45c3ca3a73
3 changed files with 76 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
data/lua/core/_initial.lua
View File

@ -121,6 +121,10 @@ wesnoth.set_end_campaign_text = wesnoth.deprecate_api('wesnoth.set_end_campaign_
end
end)
if wesnoth.kernel_type() ~= 'Application Lua Kernel' then
wesnoth.find_path = wesnoth.deprecate_api('wesnoth.find_path', 'wesnoth.paths.find_path', 1, nil, wesnoth.paths.find_path)
end
if wesnoth.kernel_type() == 'Game Lua Kernel' then
local function get_time_of_day(...)
local arg_i, turn = 1, nil
@ -167,4 +171,9 @@ if wesnoth.kernel_type() == 'Game Lua Kernel' then
wesnoth.unsynced = wesnoth.deprecate_api('wesnoth.unsynced', 'wesnoth.sync.run_unsynced', 1, nil, wesnoth.sync.run_unsynced)
wesnoth.synchronize_choice = wesnoth.deprecate_api('wesnoth.synchronize_choice', 'wesnoth.sync.evaluate_single', 1, nil, wesnoth.sync.evaluate_single)
wesnoth.synchronize_choices = wesnoth.deprecate_api('wesnoth.synchronize_choices', 'wesnoth.sync.evaluate_multiple', 1, nil, wesnoth.sync.evaluate_multiple)
wesnoth.find_cost_map = wesnoth.deprecate_api('wesnoth.find_cost_map', 'wesnoth.paths.find_cost_map', 1, nil, wesnoth.paths.find_cost_map)
wesnoth.find_reach = wesnoth.deprecate_api('wesnoth.find_reach', 'wesnoth.paths.find_reach', 1, nil, wesnoth.paths.find_reach)
wesnoth.find_vacant_tile = wesnoth.deprecate_api('wesnoth.find_vacant_tile', 'wesnoth.paths.find_vacant_tile', 1, nil, wesnoth.paths.find_vacant_tile)
wesnoth.find_vision_range = wesnoth.deprecate_api('wesnoth.find_vision_range', 'wesnoth.paths.find_vision_range', 1, nil, wesnoth.paths.find_vision_range)
end

21
src/scripting/game_lua_kernel.cpp
View File

@ -4168,11 +4168,6 @@ game_lua_kernel::game_lua_kernel(game_state & gs, play_controller & pc, reports
{ "add_event_handler", &dispatch<&game_lua_kernel::intf_add_event > },
{ "allow_undo", &dispatch<&game_lua_kernel::intf_allow_undo > },
{ "cancel_action", &dispatch<&game_lua_kernel::intf_cancel_action > },
{ "find_cost_map", &dispatch<&game_lua_kernel::intf_find_cost_map > },
{ "find_path", &dispatch<&game_lua_kernel::intf_find_path > },
{ "find_reach", &dispatch<&game_lua_kernel::intf_find_reach > },
{ "find_vacant_tile", &dispatch<&game_lua_kernel::intf_find_vacant_tile > },
{ "find_vision_range", &dispatch<&game_lua_kernel::intf_find_vision_range > },
{ "fire_event", &dispatch2<&game_lua_kernel::intf_fire_event, false > },
{ "fire_event_by_id", &dispatch2<&game_lua_kernel::intf_fire_event, true > },
{ "log_replay", &dispatch<&game_lua_kernel::intf_log_replay > },
@ -4428,6 +4423,22 @@ game_lua_kernel::game_lua_kernel(game_state & gs, play_controller & pc, reports
luaL_setfuncs(L, audio_callbacks, 0);
lua_setfield(L, -2, "audio");
lua_pop(L, 1);
// Create the paths module
cmd_log_ << "Adding paths module...\n";
static luaL_Reg const path_callbacks[] {
{ "find_cost_map", &dispatch<&game_lua_kernel::intf_find_cost_map > },
{ "find_path", &dispatch<&game_lua_kernel::intf_find_path > },
{ "find_reach", &dispatch<&game_lua_kernel::intf_find_reach > },
{ "find_vacant_tile", &dispatch<&game_lua_kernel::intf_find_vacant_tile > },
{ "find_vision_range", &dispatch<&game_lua_kernel::intf_find_vision_range > },
{ nullptr, nullptr }
};
lua_getglobal(L, "wesnoth");
lua_newtable(L);
luaL_setfuncs(L, path_callbacks, 0);
lua_setfield(L, -2, "paths");
lua_pop(L, 1);
// Create the sync module
cmd_log_ << "Adding sync module...\n";

81
src/scripting/mapgen_lua_kernel.cpp
View File

@ -157,34 +157,55 @@ static int intf_default_generate_height_map(lua_State *L)
}
/**
* Finds a path between two locations.
* - Args 1,2: source location.
* - Args 3,4: destination.
* - Arg 5: cost function
* - Args 6,7 size of map.
* - Arg 8 include border.
* - Args 1: source location.
* - Args 2: destination.
* - Arg 3: cost function
* - Args 4,5 size of map.
* - Arg 6 include border.
* OR
* - Arg 3: options table containing calculate, width, height, (optional) include_borders
* - Ret 1: array of pairs containing path steps.
* - Ret 2: path cost.
*/
static int intf_find_path(lua_State *L)
{
int arg = 1;
map_location src, dst;
src.set_wml_x(luaL_checkinteger(L, 1));
src.set_wml_y(luaL_checkinteger(L, 2));
dst.set_wml_x(luaL_checkinteger(L, 3));
dst.set_wml_y(luaL_checkinteger(L, 4));
map_location src = luaW_checklocation(L, 1), dst = luaW_checklocation(L, 2);
if(lua_isfunction(L, arg)) {
const char *msg = lua_pushfstring(L, "%s expected, got %s", lua_typename(L, LUA_TFUNCTION), luaL_typename(L, 5));
return luaL_argerror(L, 5, msg);
const char *msg = lua_pushfstring(L, "%s expected, got %s", lua_typename(L, LUA_TFUNCTION), luaL_typename(L, 3));
return luaL_argerror(L, 3, msg);
}
lua_pathfind_cost_calculator calc(L, 5);
int width = luaL_checkinteger(L, 6);
int height = luaL_checkinteger(L, 7);
std::optional<lua_pathfind_cost_calculator> calc;
int width, height;
bool border = false;
if(lua_isboolean(L, 8)) {
border = luaW_toboolean(L, 8);
if(lua_istable(L, 3)) {
if(luaW_tableget(L, 3, "calculate")) {
calc = lua_pathfind_cost_calculator(L, lua_gettop(L));
} else {
return luaL_argerror(L, 3, "missing key: calculate");
}
if(!luaW_tableget(L, 3, "width")) {
width = luaL_checkinteger(L, -1);
} else {
return luaL_argerror(L, 3, "missing key: width");
}
if(!luaW_tableget(L, 3, "height")) {
height = luaL_checkinteger(L, -1);
} else {
return luaL_argerror(L, 3, "missing key: height");
}
if(!luaW_tableget(L, 3, "include_borders")) {
border = luaW_toboolean(L, -1);
}
} else {
calc = lua_pathfind_cost_calculator(L, 3);
width = luaL_checkinteger(L, 4);
height = luaL_checkinteger(L, 5);
if(lua_isboolean(L, 6)) {
border = luaW_toboolean(L, 6);
}
}
pathfind::plain_route res = pathfind::a_star_search(src, dst, 10000, calc, width, height, nullptr, border);
pathfind::plain_route res = pathfind::a_star_search(src, dst, 10000, *calc, width, height, nullptr, border);
int nb = res.steps.size();
lua_createtable(L, nb, 0);
@ -219,18 +240,6 @@ mapgen_lua_kernel::mapgen_lua_kernel(const config* vars)
lua_settop(L, 0);
static luaL_Reg const callbacks[] {
{ "find_path", &intf_find_path },
{ "random", &intf_random },
{ nullptr, nullptr }
};
lua_getglobal(L, "wesnoth");
assert(lua_istable(L,-1));
luaL_setfuncs(L, callbacks, 0);
lua_pop(L, 1);
assert(lua_gettop(L) == 0);
static luaL_Reg const map_callbacks[] {
// Map methods
{ "find", &intf_mg_get_locations },
@ -248,6 +257,18 @@ mapgen_lua_kernel::mapgen_lua_kernel(const config* vars)
luaL_setfuncs(L, map_callbacks, 0);
lua_pop(L, 1);
assert(lua_gettop(L) == 0);
// Create the paths module
cmd_log_ << "Adding paths module...\n";
static luaL_Reg const path_callbacks[] {
{ "find_path", &intf_find_path },
{ nullptr, nullptr }
};
lua_getglobal(L, "wesnoth");
lua_newtable(L);
luaL_setfuncs(L, path_callbacks, 0);
lua_setfield(L, -2, "paths");
lua_pop(L, 1);
// Add functions to the WML module
lua_getglobal(L, "wml");