Cleanup of fef953a

- Fix the rabbit AI
- Enable invoke_synced_command to also call (some) built-in commands
  and give an error message in the case of an unknown command
- Remove some unnecessary implementation details

data/_main.cfg

@@ -60,7 +60,6 @@
 {scenario-story.cfg}
 {ai/scenarios/}
 {ai/micro_ais/scenarios/}
-{ai/utils/custom_command.cfg}
 #define DONT_RELOAD_CORE
 #enddef
 

data/ai/micro_ais/mai-defs/animals.lua

@@ -82,6 +82,9 @@ function wesnoth.micro_ais.herding(cfg)
     return required_keys, optional_keys, CA_parms
 end
 
+local rabbit_registry_counter = 0;
+local save_rabbit_spawn, save_rabbit_despawn
+
 function wesnoth.micro_ais.forest_animals(cfg)
 	local optional_keys = { "rabbit_type", "rabbit_number", "rabbit_enemy_distance", "rabbit_hole_img",
 		"tusker_type", "tusklet_type", "deer_type", "[filter_location]"
@@ -94,6 +97,33 @@ function wesnoth.micro_ais.forest_animals(cfg)
 		{ ca_id = "move", location = 'ca_forest_animals_move.lua', score = score - 2 },
 		{ ca_id = "tusklet_move", location = 'ca_forest_animals_tusklet_move.lua', score = score - 3 }
 	}
+
+	-- Register custom synced commands for the rabbit AI
+	if cfg.action == "delete" then
+		rabbit_registry_counter = rabbit_registry_counter - 1
+		if rabbit_registry_counter == 0 then
+			wesnoth.custom_synced_commands.rabbit_spawn = save_rabbit_spawn
+			wesnoth.custom_synced_commands.rabbit_despawn = save_rabbit_despawn
+		end
+	else
+		if rabbit_registry_counter == 0 then
+			save_rabbit_spawn = wesnoth.custom_synced_commands.rabbit_spawn
+			save_rabbit_despawn = wesnoth.custom_synced_commands.rabbit_despawn
+		end
+
+		rabbit_registry_counter = rabbit_registry_counter + 1
+
+		function wesnoth.custom_synced_commands.rabbit_despawn(cfg)
+			--TODO: maybe we only want to allow erasing of unit of certain types/sides/locations?
+			wesnoth.erase_unit(cfg.x, cfg.y)
+		end
+
+		function wesnoth.custom_synced_commands.rabbit_spawn(cfg)
+			--TODO: maybe we only want to allow creation of unit of certain types/sides/locations?
+			wesnoth.put_unit({ side = wesnoth.current.side, type = cfg.rabbit_type}, cfg.x, cfg.y)
+		end
+	end
+
     return {}, optional_keys, CA_parms
 end
 

data/core/_main.cfg

@@ -8,7 +8,6 @@
 wesnoth.dofile 'lua/backwards-compatibility.lua'
 wesnoth.dofile 'lua/wml-tags.lua'
 wesnoth.dofile 'lua/feeding.lua'
-wesnoth.dofile 'lua/custom_command.lua'
 >>
 [/lua]
 

src/scripting/game_lua_kernel.cpp

@@ -80,6 +80,7 @@
 #include "scripting/lua_team.hpp"
 #include "scripting/lua_unit_type.hpp"
 #include "scripting/push_check.hpp"
+#include "synced_commands.hpp"
 #include "color.hpp"                // for surface
 #include "sdl/surface.hpp"                // for surface
 #include "side_filter.hpp"              // for side_filter
@@ -3946,6 +3947,33 @@ int game_lua_kernel::intf_toggle_fog(lua_State *L, const bool clear)
 	return 0;
 }
 
+// Invokes a synced command
+int intf_invoke_synced_command(lua_State* L)
+{
+	const std::string name = luaL_checkstring(L, 1);
+	auto it = synced_command::registry().find(name);
+	config cmd;
+	if(it == synced_command::registry().end()) {
+		// Custom command
+		if(!luaW_getglobal(L, "wesnoth", "custom_synced_commands", name)) {
+			return luaL_argerror(L, 1, "Unknown synced command");
+		}
+		config& cmd_tag = cmd.child_or_add("custom_command");
+		cmd_tag["name"] = name;
+		if(!lua_isnoneornil(L, 2)) {
+			cmd_tag.add_child("data", luaW_checkconfig(L, 2));
+		}
+	} else {
+		// Built-in command
+		cmd.add_child(name, luaW_checkconfig(L, 2));
+	}
+	// Now just forward to the WML action.
+	luaW_getglobal(L, "wesnoth", "wml_actions", "do_command");
+	luaW_pushconfig(L, cmd);
+	luaW_pcall(L, 1, 0);
+	return 0;
+}
+
 // END CALLBACK IMPLEMENTATION
 
 game_board & game_lua_kernel::board() {
@@ -4007,6 +4035,7 @@ game_lua_kernel::game_lua_kernel(game_state & gs, play_controller & pc, reports
 		{ "get_era",                  &intf_get_era                  },
 		{ "get_traits",               &intf_get_traits               },
 		{ "get_viewing_side",         &intf_get_viewing_side         },
+		{ "invoke_synced_command",    &intf_invoke_synced_command    },
 		{ "modify_ai",                &intf_modify_ai_old            },
 		{ "remove_modifications",     &intf_remove_modifications     },
 		{ "set_music",                &intf_set_music                },
@@ -4207,6 +4236,14 @@ game_lua_kernel::game_lua_kernel(game_state & gs, play_controller & pc, reports
 	lua_setfield(L, -2, "effects");
 	lua_pop(L, 1);
 
+	// Create the custom_synced_commands table.
+	cmd_log_ << "Adding custom_synced_commands table...\n";
+
+	lua_getglobal(L, "wesnoth");
+	lua_newtable(L);
+	lua_setfield(L, -2, "custom_synced_commands");
+	lua_pop(L, 1);
+
 	// Create the game_events table.
 	cmd_log_ << "Adding game_events table...\n";
 
@@ -4395,11 +4432,11 @@ bool game_lua_kernel::run_event(const game_events::queued_event& ev)
 	return true;
 }
 
-void game_lua_kernel::custom_command(const config& cfg)
+void game_lua_kernel::custom_command(const std::string& name, const config& cfg)
 {
 	lua_State *L = mState;
 
-	if (!luaW_getglobal(L, "wesnoth", "game_events", "on_synced_command")) {
+	if (!luaW_getglobal(L, "wesnoth", "custom_synced_commands", name)) {
 		return;
 	}
 	luaW_pushconfig(L, cfg);

src/scripting/game_lua_kernel.hpp

@@ -200,7 +200,7 @@ class game_lua_kernel : public lua_kernel_base
 	void save_game(config & level);
 	void load_game(const config& level);
 	bool run_event(const game_events::queued_event&);
-	void custom_command(const config&);
+	void custom_command(const std::string&, const config&);
 	void push_builtin_effect();
 	void set_wml_action(const std::string&, game_events::wml_action::handler);
 	void set_wml_condition(const std::string&, bool(*)(const vconfig&));

src/synced_commands.cpp

@@ -347,7 +347,7 @@ SYNCED_COMMAND_HANDLER_FUNCTION(fire_event, child,  use_undo, /*show*/, /*error_
 SYNCED_COMMAND_HANDLER_FUNCTION(custom_command, child,  /*use_undo*/, /*show*/, /*error_handler*/)
 {
 	assert(resources::lua_kernel);
-	resources::lua_kernel->custom_command(child);
+	resources::lua_kernel->custom_command(child["name"], child.child_or_empty("data"));
 	return true;
 }