aiair.cpp

Go to the documentation of this file.

/*
 Copyright (c) 1996-2021 Freeciv21 and Freeciv contributors. This file is
                   part of Freeciv21. Freeciv21 is free software: you can
    ^oo^      redistribute it and/or modify it under the terms of the GNU
    (..)        General Public License  as published by the Free Software
   ()  ()       Foundation, either version 3 of the License,  or (at your
   ()__()             option) any later version. You should have received
    a copy of the GNU General Public License along with Freeciv21. If not,
                  see https://www.gnu.org/licenses/.
 */
 
// utility
#include "log.h"
 
// common
#include "combat.h"
#include "game.h"
#include "map.h"
#include "movement.h"
#include "pf_tools.h"
#include "player.h"
#include "unit.h"
 
// server
#include "maphand.h"
#include "srv_log.h"
#include "unithand.h"
#include "unittools.h"
 
/* server/advisors */
#include "advbuilding.h"
#include "advgoto.h"
 
// ai
#include "handicaps.h"
 
/* ai/default */
#include "ailog.h"
#include "aiplayer.h"
#include "aitools.h"
#include "aiunit.h"
 
#include "aiair.h"
 
class PFPath;
static struct tile *find_nearest_airbase(const struct unit *punit,
                                         PFPath *path)
{
  struct player *pplayer = unit_owner(punit);
  struct pf_parameter parameter;
  struct pf_map *pfm;
 
  pft_fill_unit_parameter(&parameter, punit);
  parameter.omniscience = !has_handicap(pplayer, H_MAP);
  pfm = pf_map_new(&parameter);
 
  pf_map_move_costs_iterate(pfm, ptile, move_cost, true)
  {
    if (move_cost > punit->moves_left) {
      // Too far!
      break;
    }
 
    if (is_airunit_refuel_point(ptile, pplayer, punit)) {
      *path = pf_map_path(pfm, ptile);
      pf_map_destroy(pfm);
      return ptile;
    }
  }
  pf_map_move_costs_iterate_end;
 
  pf_map_destroy(pfm);
  return nullptr;
}
 
static bool dai_should_we_air_attack_tile(struct ai_type *ait,
                                          struct unit *punit,
                                          struct tile *ptile)
{
  struct city *acity = tile_city(ptile);
 
  // For a virtual unit (punit->id == 0), all targets are good
  /* TODO: There is a danger of producing too many units that will not
   * attack anything.  Production should not happen if there is an idle
   * unit of the same type nearby */
  if (acity && punit->id != 0
      && def_ai_city_data(acity, ait)->invasion.occupy == 0
      && !unit_can_take_over(punit)) {
    // No units capable of occupying are invading
    log_debug("Don't want to attack %s, although we could",
              city_name_get(acity));
    return false;
  }
 
  return true;
}
 
static int dai_evaluate_tile_for_air_attack(struct unit *punit,
                                            struct tile *dst_tile)
{
  struct unit *pdefender;
  // unit costs in shields
  int balanced_cost, unit_cost, victim_cost = 0;
  // unit stats
  int unit_attack, victim_defence;
  // final answer
  int profit;
  // time spent in the air
  int sortie_time;
#define PROB_MULTIPLIER 100 // should unify with those in combat.c
 
  if (!can_unit_attack_tile(punit, dst_tile)
      || !(pdefender = get_defender(punit, dst_tile))) {
    return 0;
  }
 
  // Ok, we can attack, but is it worth it?
 
  // Cost of our unit
  unit_cost = unit_build_shield_cost_base(punit);
  // This is to say "wait, ill unit will get better!"
  unit_cost = unit_cost * unit_type_get(punit)->hp / punit->hp;
 
  // Determine cost of enemy units
  victim_cost = stack_cost(punit, pdefender);
  if (0 == victim_cost) {
    return 0;
  }
 
  // Missile would die 100% so we adjust the victim_cost -- GB
  if (utype_can_do_action(unit_type_get(punit), ACTION_SUICIDE_ATTACK)) {
    /* Assume that the attack will be a suicide attack even if a regular
     * attack may be legal. */
    victim_cost -= unit_build_shield_cost_base(punit);
  }
 
  unit_attack =
      static_cast<int>(PROB_MULTIPLIER * unit_win_chance(punit, pdefender));
 
  victim_defence = PROB_MULTIPLIER - unit_attack;
 
  balanced_cost = build_cost_balanced(unit_type_get(punit));
 
  sortie_time = (utype_pays_mp_for_action_estimate(
                     action_by_number(ACTION_ATTACK), unit_type_get(punit),
                     unit_owner(punit),
                     /* Assume that dst_tile is closer to the tile the actor
                      * unit will attack from than its current tile. */
                     dst_tile, dst_tile)
                         >= MAX_MOVE_FRAGS
                     ? 1
                     : 0);
 
  profit =
      kill_desire(victim_cost, unit_attack, unit_cost, victim_defence, 1)
      - SHIELD_WEIGHTING + 2 * TRADE_WEIGHTING;
  if (profit > 0) {
    profit = military_amortize(unit_owner(punit),
                               game_city_by_number(punit->homecity), profit,
                               sortie_time, balanced_cost);
    log_debug("%s at (%d, %d) is a worthy target with profit %d",
              unit_rule_name(pdefender), TILE_XY(dst_tile), profit);
  } else {
    log_debug("%s(%d, %d): %s at (%d, %d) is unworthy with profit %d",
              unit_rule_name(punit), TILE_XY(unit_tile(punit)),
              unit_rule_name(pdefender), TILE_XY(dst_tile), profit);
    profit = 0;
  }
 
  return profit;
}
 
static int find_something_to_bomb(struct ai_type *ait, struct unit *punit,
                                  PFPath *path, struct tile **pptile)
{
  struct player *pplayer = unit_owner(punit);
  struct pf_parameter parameter;
  struct pf_map *pfm;
  struct tile *best_tile = nullptr;
  int best = 0;
 
  pft_fill_unit_parameter(&parameter, punit);
  parameter.omniscience = !has_handicap(pplayer, H_MAP);
  pfm = pf_map_new(&parameter);
 
  // Let's find something to bomb
  pf_map_move_costs_iterate(pfm, ptile, move_cost, false)
  {
    if (move_cost >= punit->moves_left) {
      // Too far!
      break;
    }
 
    if (has_handicap(pplayer, H_MAP) && !map_is_known(ptile, pplayer)) {
      // The target tile is unknown
      continue;
    }
 
    if (has_handicap(pplayer, H_FOG)
        && !map_is_known_and_seen(ptile, pplayer, V_MAIN)) {
      // The tile is fogged
      continue;
    }
 
    if (is_enemy_unit_tile(ptile, pplayer)
        && dai_should_we_air_attack_tile(ait, punit, ptile)
        && can_unit_attack_tile(punit, ptile)) {
      int new_best = dai_evaluate_tile_for_air_attack(punit, ptile);
 
      if (new_best > best) {
        best_tile = ptile;
        best = new_best;
        log_debug("%s wants to attack tile (%d, %d)", unit_rule_name(punit),
                  TILE_XY(ptile));
      }
    }
  }
  pf_map_move_costs_iterate_end;
 
  // Return the best values.
  if (pptile) {
    *pptile = best_tile;
  }
  if (path) {
    *path = best_tile ? pf_map_path(pfm, best_tile) : PFPath();
  }
  pf_map_destroy(pfm);
  return best;
}
 
static struct tile *dai_find_strategic_airbase(struct ai_type *ait,
                                               const struct unit *punit,
                                               PFPath *path)
{
  struct player *pplayer = unit_owner(punit);
  struct pf_parameter parameter;
  struct pf_map *pfm;
  struct tile *best_tile = nullptr;
  struct city *pcity;
  struct unit *pvirtual = nullptr;
  int best_worth = 0, target_worth;
 
  pft_fill_unit_parameter(&parameter, punit);
  parameter.omniscience = !has_handicap(pplayer, H_MAP);
  pfm = pf_map_new(&parameter);
  pf_map_move_costs_iterate(pfm, ptile, move_cost, false)
  {
    if (move_cost >= punit->moves_left) {
      break; // Too far!
    }
 
    if (!is_airunit_refuel_point(ptile, pplayer, punit)) {
      continue; // Cannot refuel here.
    }
 
    if ((pcity = tile_city(ptile))
        && def_ai_city_data(pcity, ait)->grave_danger != 0) {
      best_tile = ptile;
      break; // Fly there immediately!!
    }
 
    if (!pvirtual) {
      pvirtual = unit_virtual_create(
          pplayer, player_city_by_number(pplayer, punit->homecity),
          unit_type_get(punit), punit->veteran);
    }
 
    unit_tile_set(pvirtual, ptile);
    target_worth = find_something_to_bomb(ait, pvirtual, nullptr, nullptr);
    if (target_worth > best_worth) {
      // It's either a first find or it's better than the previous.
      best_worth = target_worth;
      best_tile = ptile;
      // We can still look for something better.
    }
  }
  pf_map_move_costs_iterate_end;
 
  if (pvirtual) {
    unit_virtual_destroy(pvirtual);
  }
 
  if (path) {
    // Stores the path.
    *path = best_tile ? pf_map_path(pfm, best_tile) : PFPath();
  }
  pf_map_destroy(pfm);
 
  return best_tile;
}
 
void dai_manage_airunit(struct ai_type *ait, struct player *pplayer,
                        struct unit *punit)
{
  struct tile *dst_tile = unit_tile(punit);
  // Loop prevention
  int moves = punit->moves_left;
  int id = punit->id;
  struct pf_parameter parameter;
  struct pf_map *pfm;
  PFPath path;
  CHECK_UNIT(punit);
  pft_fill_unit_parameter(&parameter, punit);
 
  if (!is_unit_being_refueled(punit)) {
    // We are out in the open, what shall we do?
    if (punit->activity == ACTIVITY_GOTO
        // We are on a GOTO.  Check if it will get us anywhere
        && nullptr != punit->goto_tile
        && !same_pos(unit_tile(punit), punit->goto_tile)
        && is_airunit_refuel_point(punit->goto_tile, pplayer, punit)) {
      pfm = pf_map_new(&parameter);
      path = pf_map_path(pfm, punit->goto_tile);
      if (!path.empty()) {
        bool alive = adv_follow_path(punit, path, punit->goto_tile);
        pf_map_destroy(pfm);
        if (alive && punit->moves_left > 0) {
          // Maybe do something else.
          dai_manage_airunit(ait, pplayer, punit);
        }
        return;
      }
      pf_map_destroy(pfm);
    } else if ((dst_tile = find_nearest_airbase(punit, &path))) {
      // Go refuelling
      if (!adv_follow_path(punit, path, dst_tile)) {
        return; // The unit died.
      }
    } else {
      if (punit->fuel == 1) {
        UNIT_LOG(LOG_DEBUG, punit, "Oops, fallin outta the sky");
      }
      def_ai_unit_data(punit, ait)->done = true; // Won't help trying again
      return;
    }
 
  } else if (punit->fuel == unit_type_get(punit)->fuel) {
    // We only leave a refuel point when we are on full fuel
 
    if (find_something_to_bomb(ait, punit, &path, &dst_tile) > 0) {
      /* Found target, coordinates are in punit's goto_dest.
       * TODO: separate attacking into a function, check for the best
       * tile to attack from */
      fc_assert_ret(!path.empty() && dst_tile != nullptr);
      if (!adv_follow_path(punit, path, dst_tile)) {
        return; // The unit died.
      }
 
      /* goto would be aborted: "Aborting GOTO for AI attack procedures"
       * now actually need to attack */
      // We could use ai_military_findvictim here, but I don't trust it...
      unit_activity_handling(punit, ACTIVITY_IDLE);
      if (is_tiles_adjacent(unit_tile(punit), dst_tile)) {
        dai_unit_attack(ait, punit, dst_tile);
      }
    } else if ((dst_tile = dai_find_strategic_airbase(ait, punit, &path))) {
      log_debug("%s will fly to (%i, %i) (%s) to fight there",
                unit_rule_name(punit), TILE_XY(dst_tile),
                tile_city(dst_tile) ? city_name_get(tile_city(dst_tile))
                                    : "");
      def_ai_unit_data(punit, ait)->done = true; // Wait for next turn
      if (!adv_follow_path(punit, path, dst_tile)) {
        return; // The unit died.
      }
    } else {
      log_debug("%s cannot find anything to kill and is staying put",
                unit_rule_name(punit));
      def_ai_unit_data(punit, ait)->done = true;
      unit_activity_handling(punit, ACTIVITY_IDLE);
    }
  }
 
  if ((punit = game_unit_by_number(id)) != nullptr && punit->moves_left > 0
      && punit->moves_left != moves) {
    /* We have moved this turn, might have ended up stuck out in the fields
     * so, as a safety measure, let's manage again */
    dai_manage_airunit(ait, pplayer, punit);
  }
}
 
bool dai_choose_attacker_air(struct ai_type *ait, struct player *pplayer,
                             struct city *pcity, struct adv_choice *choice,
                             bool allow_gold_upkeep)
{
  bool want_something = false;
 
  // This AI doesn't know to build planes
  if (has_handicap(pplayer, H_NOPLANES)) {
    return false;
  }
 
  /* military_advisor_choose_build does something idiotic,
   * this function should not be called if there is danger... */
  if (choice->want >= 100 && choice->type != CT_ATTACKER) {
    return false;
  }
 
  if (!player_knows_techs_with_flag(pplayer, TF_BUILD_AIRBORNE)) {
    return false;
  }
 
  unit_type_iterate(punittype)
  {
    struct unit_class *pclass = utype_class(punittype);
 
    if (pclass->adv.land_move == MOVE_NONE
        || pclass->adv.sea_move == MOVE_NONE
        || uclass_has_flag(pclass, UCF_TERRAIN_SPEED)
        || unit_type_is_losing_hp(pplayer, punittype)) {
      // We don't consider this a plane
      continue;
    }
 
    if (!allow_gold_upkeep
        && utype_upkeep_cost(punittype, pplayer, O_GOLD) > 0) {
      continue;
    }
 
    // Temporary hack because pathfinding can't handle Fighters.
    if (!utype_is_consumed_by_action_result(ACTRES_ATTACK, punittype)
        && 1 == utype_fuel(punittype)) {
      continue;
    }
 
    if (can_city_build_unit_now(pcity, punittype)) {
      struct unit *virtual_unit = unit_virtual_create(
          pplayer, pcity, punittype,
          city_production_unit_veteran_level(pcity, punittype));
      int profit =
          find_something_to_bomb(ait, virtual_unit, nullptr, nullptr);
 
      if (profit > choice->want) {
        // Update choice
        choice->want = profit;
        choice->value.utype = punittype;
        choice->type = CT_ATTACKER;
        choice->need_boat = false;
        adv_choice_set_use(choice, "offensive air");
        want_something = true;
        log_debug("%s wants to build %s (want=%d)", city_name_get(pcity),
                  utype_rule_name(punittype), profit);
      } else {
        log_debug("%s doesn't want to build %s (want=%d)",
                  city_name_get(pcity), utype_rule_name(punittype), profit);
      }
      unit_virtual_destroy(virtual_unit);
    }
  }
  unit_type_iterate_end;
 
  return want_something;
}