aiunit.h

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 is free software: you can 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
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
#pragma once
 
// common
#include "combat.h"
#include "fc_types.h"
#include "unittype.h"
 
struct pf_map;
class PFPath;
 
struct section_file;
 
enum ai_unit_task {
  AIUNIT_NONE,
  AIUNIT_AUTO_SETTLER,
  AIUNIT_BUILD_CITY,
  AIUNIT_DEFEND_HOME,
  AIUNIT_ATTACK,
  AIUNIT_ESCORT,
  AIUNIT_EXPLORE,
  AIUNIT_RECOVER,
  AIUNIT_HUNTER,
  AIUNIT_TRADE,
  AIUNIT_WONDER
};
 
struct unit_ai {
  // The following are unit ids or special indicator values (<=0)
  int ferryboat; // the ferryboat assigned to us
  int passenger; // the unit assigned to this ferryboat
  int bodyguard; // the unit bodyguarding us
  int charge;    // the unit this unit is bodyguarding
 
  struct tile *prev_struct, *cur_struct;
  struct tile **prev_pos, **cur_pos;
 
  int target;       // target we hunt
  bv_player hunted; // if a player is hunting us, set by that player
  bool done;        // we are done controlling this unit this turn
 
  enum ai_unit_task task;
};
 
struct unit_type_ai {
  bool firepower1;
  bool ferry;
  bool missile_platform;
  bool carries_occupiers;
  struct unit_type_list *potential_charges;
};
 
// Simple military macros
 
/* pplayers_at_war() thinks no contacts equals war, which often is
 * very annoying. */
#define WAR(plr1, plr2) (player_diplstate_get(plr1, plr2)->type == DS_WAR)
#define NEVER_MET(plr1, plr2)                                               \
  (player_diplstate_get(plr1, plr2)->type == DS_NO_CONTACT)
#define DEFENSE_POWER(ptype)                                                \
  (ptype->defense_strength * ptype->hp * ptype->firepower)
#define ATTACK_POWER(ptype)                                                 \
  (ptype->attack_strength * ptype->hp * ptype->firepower)
#define IS_ATTACKER(ptype)                                                  \
  (ptype->attack_strength > ptype->transport_capacity)
#define POTENTIALLY_HOSTILE_PLAYER(ait, pplayer, aplayer)                   \
  (WAR(pplayer, aplayer) || NEVER_MET(pplayer, aplayer)                     \
   || dai_diplomacy_get(ait, pplayer, aplayer)->countdown >= 0)
#define UNITTYPE_COSTS(ut)                                                  \
  (ut->pop_cost * 3 + ut->happy_cost + ut->upkeep[O_SHIELD]                 \
   + ut->upkeep[O_FOOD] + ut->upkeep[O_GOLD])
 
// Invasion types
#define INVASION_OCCUPY 0
#define INVASION_ATTACK 1
 
extern struct unit_type *simple_ai_types[U_LAST];
 
#define RAMPAGE_ANYTHING 1
#define RAMPAGE_HUT_OR_BETTER 99998
#define RAMPAGE_FREE_CITY_OR_BETTER 99999
#define BODYGUARD_RAMPAGE_THRESHOLD (SHIELD_WEIGHTING * 4)
bool dai_military_rampage(struct unit *punit, int thresh_adj,
                          int thresh_move);
void dai_manage_units(struct ai_type *ait, struct player *pplayer);
void dai_manage_unit(struct ai_type *ait, struct player *pplayer,
                     struct unit *punit);
void dai_manage_military(struct ai_type *ait, struct player *pplayer,
                         struct unit *punit);
struct city *find_nearest_safe_city(struct unit *punit);
int look_for_charge(struct ai_type *ait, struct player *pplayer,
                    struct unit *punit, struct unit **aunit,
                    struct city **acity);
bool dai_can_unit_type_follow_unit_type(const struct unit_type *follower,
                                        const struct unit_type *followee,
                                        struct ai_type *ait);
 
bool find_beachhead(const struct player *pplayer, struct pf_map *ferry_map,
                    struct tile *dest_tile,
                    const struct unit_type *cargo_type,
                    struct tile **ferry_dest, struct tile **beachhead_tile);
int find_something_to_kill(ai_type *ait, player *pplayer, unit *punit,
                           tile **pdest_tile, PFPath *ppath,
                           pf_map **pferrymap, unit **pferryboat,
                           const unit_type **pboattype, int *pmove_time);
 
int build_cost_balanced(const struct unit_type *punittype);
int unittype_def_rating_squared(const struct unit_type *att_type,
                                const struct unit_type *def_type,
                                struct player *def_player,
                                struct tile *ptile, bool fortified,
                                int veteran);
int kill_desire(int benefit, int attack, int loss, int vuln,
                int attack_count);
 
const struct impr_type *
utype_needs_improvement(const struct unit_type *putype,
                        const struct city *pcity);
 
void dai_consider_tile_dangerous(struct ai_type *ait, struct tile *ptile,
                                 struct unit *punit,
                                 enum override_bool *result);
 
void dai_units_ruleset_init(struct ai_type *ait);
void dai_units_ruleset_close(struct ai_type *ait);
 
void dai_unit_init(struct ai_type *ait, struct unit *punit);
void dai_unit_turn_end(struct ai_type *ait, struct unit *punit);
void dai_unit_close(struct ai_type *ait, struct unit *punit);
 
#define simple_ai_unit_type_iterate(_ut)                                    \
  {                                                                         \
    struct unit_type *_ut;                                                  \
    int _ut##_index = 0;                                                    \
    while (nullptr != (_ut = simple_ai_types[_ut##_index++])) {
 
#define simple_ai_unit_type_iterate_end                                     \
  }                                                                         \
  }
 
void dai_unit_save(struct ai_type *ait, const char *aitstr,
                   struct section_file *file, const struct unit *punit,
                   const char *unitstr);
void dai_unit_load(struct ai_type *ait, const char *aitstr,
                   const struct section_file *file, struct unit *punit,
                   const char *unitstr);
 
struct unit_type *dai_role_utype_for_terrain_class(struct city *pcity,
                                                   int role,
                                                   enum terrain_class tc);
 
bool dai_unit_can_strike_my_unit(const struct unit *attacker,
                                 const struct unit *defender);
 
void dai_switch_to_explore(struct ai_type *ait, struct unit *punit,
                           struct tile *target, enum override_bool *allow);