Add new AI aspect retreat_enemy_weight

data/ai/utils/default_config.cfg

@@ -92,6 +92,7 @@
         [/value]
     [/default]
 [/aspect]
+{DEFAULT_ASPECT_VALUE retreat_enemy_weight 1.0}
 {DEFAULT_ASPECT_VALUE retreat_factor 0.25}
 {DEFAULT_ASPECT_VALUE scout_village_targeting 3}
 {DEFAULT_ASPECT_VALUE simple_targeting no}

data/schema/ai/aspect_complex.cfg

@@ -60,7 +60,7 @@
 	[switch]
 		key=id
 		[case]
-			value=aggression,caution,leader_aggression,leader_value,retreat_factor,scout_village_targeting,village_value,recruitment_diversity
+			value=aggression,caution,leader_aggression,leader_value,retreat_enemy_weight,retreat_factor,scout_village_targeting,village_value,recruitment_diversity
 			super="{BASE}~real"
 		[/case]
 		[case]

data/schema/ai/aspect_simple.cfg

@@ -48,6 +48,7 @@
 {AI_ASPECT_KEY passive_leader_shares_keep s_bool}
 {AI_ASPECT_KEY recruitment_diversity s_real}
 {AI_ASPECT_KEY recruitment_randomness s_int}
+{AI_ASPECT_KEY retreat_enemy_weight s_real}
 {AI_ASPECT_KEY retreat_factor s_real}
 {AI_ASPECT_KEY scout_village_targeting s_real}
 {AI_ASPECT_KEY simple_targeting s_bool}

data/schema/ai/modify.cfg

@@ -154,6 +154,7 @@
 		{AI_MODIFY_MATCH_ASPECT caution real}
 		{AI_MODIFY_MATCH_ASPECT leader_aggression real}
 		{AI_MODIFY_MATCH_ASPECT leader_value real}
+		{AI_MODIFY_MATCH_ASPECT retreat_enemy_weight real}
 		{AI_MODIFY_MATCH_ASPECT retreat_factor real}
 		{AI_MODIFY_MATCH_ASPECT scout_village_targeting real}
 		{AI_MODIFY_MATCH_ASPECT village_value real}

data/tools/emacs_mode/wesnoth-wml-data.el

@@ -76,7 +76,7 @@
   ("rulebase"))
  ("ai"
   ("team_formula" "register_candidate_action" "candidate_action" "not" "protect_area" "aspect" "leader_goal" "avoid" "vars" "modify_ai" "engine" "goal" "stage")
-  ("priority" "formula" "eval_list" "_stage" "_aspect" "leader" "loop_formula" "y" "x" "passive_leader_shares_keep" "leader_aggression" "number_of_possible_recruits_to_force_recruit" "time_of_day" "ai_algorithm" "retreat_factor" "scout_village_targeting" "turns" "attack_depth" "grouping" "villages_per_scout" "leader_value" "village_value" "leader_shares_keep" "passive_leader" "recruitment_pattern" "simple_targeting" "recruitment_ignore_bad_combat" "recruitment_ignore_bad_movement" "caution" "aggression" "version" "description" "id"))
+  ("priority" "formula" "eval_list" "_stage" "_aspect" "leader" "loop_formula" "y" "x" "passive_leader_shares_keep" "leader_aggression" "number_of_possible_recruits_to_force_recruit" "time_of_day" "ai_algorithm" "retreat_enemy_weight" "retreat_factor" "scout_village_targeting" "turns" "attack_depth" "grouping" "villages_per_scout" "leader_value" "village_value" "leader_shares_keep" "passive_leader" "recruitment_pattern" "simple_targeting" "recruitment_ignore_bad_combat" "recruitment_ignore_bad_movement" "caution" "aggression" "version" "description" "id"))
  ("side"
   ("leader" "variables" "goal" "village" "unit" "ai" "modifications")
   ("recall_cost" "village_support" "gold_lock" "faction_from_recruit" "income_lock" "team_lock" "disallow_observers" "variation" "ai_special" "hitpoints" "overlays" "ai_algorithm" "generate_name" "random_traits" "extra_recruit" "y" "x" "allow_player" "faction" "image" "experience" "race" "facing" "moves" "color" "share_maps" "share_view" "shroud" "fog" "profile" "scroll_to_leader" "village_gold" "unrenamable" "gender" "save_id" "income" "no_leader" "gold" "recruit" "canrecruit" "user_team_name" "team_name" "persistent" "max_moves" "type" "id" "name" "hidden" "controller" "side"))

src/ai/contexts.cpp

@@ -196,6 +196,7 @@ readonly_context_impl::readonly_context_impl(side_context &context, const config
 	recruitment_randomness_(),
 	recruitment_save_gold_(),
 	recursion_counter_(context.get_recursion_count()),
+	retreat_enemy_weight_(),
 	retreat_factor_(),
 	scout_village_targeting_(),
 	simple_targeting_(),
@@ -226,6 +227,7 @@ readonly_context_impl::readonly_context_impl(side_context &context, const config
 	add_known_aspect("recruitment_pattern",recruitment_pattern_);
 	add_known_aspect("recruitment_randomness",recruitment_randomness_);
 	add_known_aspect("recruitment_save_gold",recruitment_save_gold_);
+	add_known_aspect("retreat_enemy_weight",retreat_enemy_weight_);
 	add_known_aspect("retreat_factor",retreat_factor_);
 	add_known_aspect("scout_village_targeting",scout_village_targeting_);
 	add_known_aspect("simple_targeting",simple_targeting_);
@@ -756,6 +758,14 @@ const config readonly_context_impl::get_recruitment_save_gold() const
 	return config();
 }
 
+double readonly_context_impl::get_retreat_enemy_weight() const
+{
+	if (retreat_enemy_weight_) {
+		return retreat_enemy_weight_->get();
+	}
+	return 1;
+}
+
 double readonly_context_impl::get_retreat_factor() const
 {
 	if (retreat_factor_) {

src/ai/contexts.hpp

@@ -264,6 +264,8 @@ public:
 
 	virtual const config get_recruitment_save_gold() const = 0;
 
+	virtual double get_retreat_enemy_weight() const = 0;
+
 	virtual double get_retreat_factor() const = 0;
 
 	virtual double get_scout_village_targeting() const = 0;
@@ -715,6 +717,11 @@ public:
 		return target_->get_srcdst();
 	}
 
+	virtual double get_retreat_enemy_weight() const override
+	{
+		return target_->get_retreat_enemy_weight();
+	}
+
 	virtual double get_retreat_factor() const override
 	{
 		return target_->get_retreat_factor();
@@ -1187,6 +1194,8 @@ public:
 
 	virtual const config get_recruitment_save_gold() const override;
 
+	virtual double get_retreat_enemy_weight() const override;
+
 	virtual double get_retreat_factor() const override;
 
 	virtual double get_scout_village_targeting() const override;
@@ -1304,6 +1313,7 @@ private:
 	typesafe_aspect_ptr<int> recruitment_randomness_;
 	typesafe_aspect_ptr<config> recruitment_save_gold_;
 	recursion_counter recursion_counter_;
+	typesafe_aspect_ptr<double> retreat_enemy_weight_;
 	typesafe_aspect_ptr<double> retreat_factor_;
 	typesafe_aspect_ptr<double> scout_village_targeting_;
 	typesafe_aspect_ptr<bool> simple_targeting_;

src/ai/formula/ai.cpp

@@ -346,6 +346,10 @@ variant formula_ai::get_value(const std::string& key) const
 		}
 		return variant(vars);
 
+	} else if(key == "retreat_enemy_weight")
+	{
+		return variant(get_retreat_enemy_weight()*1000,variant::DECIMAL_VARIANT);
+
 	} else if(key == "retreat_factor")
 	{
 		return variant(get_retreat_factor()*1000,variant::DECIMAL_VARIANT);

src/ai/lua/core.cpp

@@ -498,6 +498,14 @@ static int cfun_ai_get_recruitment_pattern(lua_State *L)
 	return 1;
 }
 
+static int cfun_ai_get_retreat_enemy_weight(lua_State *L)
+{
+	DEPRECATED_ASPECT_MESSAGE("retreat_enemy_weight");
+	double retreat_enemy_weight = get_readonly_context(L).get_retreat_enemy_weight();
+	lua_pushnumber(L, retreat_enemy_weight);
+	return 1;
+}
+
 static int cfun_ai_get_retreat_factor(lua_State *L)
 {
 	DEPRECATED_ASPECT_MESSAGE("retreat_factor");
@@ -904,6 +912,7 @@ static int impl_ai_get(lua_State* L)
 			{ "get_passive_leader", &cfun_ai_get_passive_leader },
 			{ "get_passive_leader_shares_keep", &cfun_ai_get_passive_leader_shares_keep },
 			{ "get_recruitment_pattern", &cfun_ai_get_recruitment_pattern },
+			{ "get_retreat_enemy_weight", &cfun_ai_get_retreat_enemy_weight },
 			{ "get_retreat_factor", &cfun_ai_get_retreat_factor },
 			{ "get_scout_village_targeting", &cfun_ai_get_scout_village_targeting },
 			{ "get_simple_targeting", &cfun_ai_get_simple_targeting },

src/ai/manager.cpp

@@ -254,6 +254,7 @@ const std::string holder::get_ai_overview()
 	s << "recruitment_randomness:  " << this->ai_->get_recruitment_randomness() << std::endl;
 	s << "recruitment_save_gold:  " << std::endl << "----config begin----" << std::endl;
 	s << this->ai_->get_recruitment_save_gold() << "-----config end-----" << std::endl;
+	s << "retreat_enemy_weight:  " << this->ai_->get_retreat_enemy_weight() << std::endl;
 	s << "retreat_factor:  " << this->ai_->get_retreat_factor() << std::endl;
 	s << "scout_village_targeting:  " << this->ai_->get_scout_village_targeting() << std::endl;
 	s << "simple_targeting:  " << cfg["simple_targeting"] << std::endl;

src/ai/registry.cpp

@@ -236,6 +236,9 @@ static register_aspect_factory< composite_aspect<int>>
 static register_aspect_factory< composite_aspect<config>>
 	recruitment_save_gold__composite_aspect_factory("recruitment_save_gold*composite_aspect");
 
+static register_aspect_factory< composite_aspect<double>>
+	retreat_enemy_weight__composite_aspect_factory("retreat_enemy_weight*composite_aspect");
+
 static register_aspect_factory< composite_aspect<double>>
 	retreat_factor__composite_aspect_factory("retreat_factor*composite_aspect");
 
@@ -310,6 +313,9 @@ static register_aspect_factory< standard_aspect<int>>
 static register_aspect_factory< standard_aspect<config>>
 	recruitment_save_gold__standard_aspect_factory("recruitment_save_gold*standard_aspect");
 
+static register_aspect_factory< standard_aspect<double>>
+	retreat_enemy_weight__standard_aspect_factory("retreat_enemy_weight*standard_aspect");
+
 static register_aspect_factory< standard_aspect<double>>
 	retreat_factor__standard_aspect_factory("retreat_factor*standard_aspect");
 
@@ -388,6 +394,9 @@ static register_aspect_factory< standard_aspect<int>>
 static register_aspect_factory< standard_aspect<config>>
 	recruitment_save_gold__standard_aspect_factory2("recruitment_save_gold*");
 
+static register_aspect_factory< standard_aspect<double>>
+	retreat_enemy_weight__standard_aspect_factory2("retreat_enemy_weight*");
+
 static register_aspect_factory< standard_aspect<double>>
 	retreat_factor__standard_aspect_factory2("retreat_factor*");
 
@@ -444,6 +453,9 @@ static register_lua_aspect_factory< lua_aspect<utils::variant<bool, std::vector<
 static register_lua_aspect_factory< lua_aspect<utils::variant<bool, std::vector<std::string>>>>
 	passive_leader_shares_keep__lua_aspect_factory("passive_leader_shares_keep*lua_aspect");
 
+static register_lua_aspect_factory< lua_aspect<double>>
+	retreat_enemy_weight__lua_aspect_factory("retreat_enemy_weight*lua_aspect");
+
 static register_lua_aspect_factory< lua_aspect<double>>
 	retreat_factor__lua_aspect_factory("retreat_factor*lua_aspect");