Freeciv21
Develop your civilization from humble roots to a global empire
extras.cpp File Reference
#include "fcintl.h"
#include "rand.h"
#include "base.h"
#include "game.h"
#include "map.h"
#include "research.h"
#include "road.h"
#include "extras.h"
+ Include dependency graph for extras.cpp:

Go to the source code of this file.

Functions

void extras_init ()
 Initialize extras structures. More...
 
void extras_free ()
 Free the memory associated with extras. More...
 
int extra_count ()
 Return the number of extra_types. More...
 
int extra_number (const struct extra_type *pextra)
 Return the extra id. More...
 
struct extra_typeextra_by_number (int id)
 Return extras type of given id. More...
 
const char * extra_name_translation (const struct extra_type *pextra)
 Return the (translated) name of the extra type. More...
 
const char * extra_rule_name (const struct extra_type *pextra)
 Return the (untranslated) rule name of the extra type. More...
 
struct extra_typeextra_type_by_rule_name (const char *name)
 Returns extra type matching rule name or nullptr if there is no extra type with such name. More...
 
struct extra_typeextra_type_by_translated_name (const char *name)
 Returns extra type matching the translated name, or nullptr if there is no extra type with that name. More...
 
struct extra_type_list * extra_type_list_by_cause (enum extra_cause cause)
 Returns extra type for given cause. More...
 
struct extra_type_list * extra_type_list_of_unit_hiders ()
 Returns extra types that hide units. More...
 
struct extra_typerand_extra_for_tile (struct tile *ptile, enum extra_cause cause, bool generated)
 Return random extra type for given cause that is native to the tile. More...
 
void extra_to_caused_by_list (struct extra_type *pextra, enum extra_cause cause)
 Add extra type to list of extra caused by given cause. More...
 
struct extra_type_list * extra_type_list_by_rmcause (enum extra_rmcause rmcause)
 Returns extra type for given rmcause. More...
 
void extra_to_removed_by_list (struct extra_type *pextra, enum extra_rmcause rmcause)
 Add extra type to list of extra removed by given cause. More...
 
bool is_extra_removed_by (const struct extra_type *pextra, enum extra_rmcause rmcause)
 Is given cause one of the removal causes for the given extra? More...
 
bool is_extra_card_near (const struct tile *ptile, const struct extra_type *pextra)
 Is there extra of the given type cardinally near tile? (Does not check ptile itself.) More...
 
bool is_extra_near_tile (const struct tile *ptile, const struct extra_type *pextra)
 Is there extra of the given type near tile? (Does not check ptile itself.) More...
 
bool extra_can_be_built (const struct extra_type *pextra, const struct tile *ptile)
 Tells if extra can build to tile if all other requirements are met. More...
 
bool can_build_extra_base (const struct extra_type *pextra, const struct player *pplayer, const struct tile *ptile)
 Tells if player can build extra to tile with suitable unit. More...
 
bool player_can_build_extra (const struct extra_type *pextra, const struct player *pplayer, const struct tile *ptile)
 Tells if player can build extra to tile with suitable unit. More...
 
bool player_can_place_extra (const struct extra_type *pextra, const struct player *pplayer, const struct tile *ptile)
 Tells if player can place extra on tile. More...
 
bool can_build_extra (const struct extra_type *pextra, const struct unit *punit, const struct tile *ptile)
 Tells if unit can build extra on tile. More...
 
static bool can_extra_be_removed (const struct extra_type *pextra, const struct tile *ptile)
 Is it possible at all to remove this extra now. More...
 
bool player_can_remove_extra (const struct extra_type *pextra, const struct player *pplayer, const struct tile *ptile)
 Tells if player can remove extra from tile with suitable unit. More...
 
bool can_remove_extra (const struct extra_type *pextra, const struct unit *punit, const struct tile *ptile)
 Tells if unit can remove extra from tile. More...
 
bool is_native_tile_to_extra (const struct extra_type *pextra, const struct tile *ptile)
 Is tile native to extra? More...
 
bool extra_conflicting_on_tile (const struct extra_type *pextra, const struct tile *ptile)
 Returns TRUE iff an extra that conflicts with pextra exists at ptile. More...
 
bool hut_on_tile (const struct tile *ptile)
 Returns TRUE iff an extra on the tile is a hut (removed by entering). More...
 
bool unit_can_enter_hut (const struct unit *punit, const struct tile *ptile)
 Returns TRUE iff the unit can enter any hut on the tile. More...
 
bool unit_can_displace_hut (const struct unit *punit, const struct tile *ptile)
 Returns TRUE iff the unit can enter or frighten any hut on the tile. More...
 
struct extra_typenext_extra_for_tile (const struct tile *ptile, enum extra_cause cause, const struct player *pplayer, const struct unit *punit)
 Returns next extra by cause that unit or player can build to tile. More...
 
struct extra_typeprev_extra_in_tile (const struct tile *ptile, enum extra_rmcause rmcause, const struct player *pplayer, const struct unit *punit)
 Returns prev extra by cause that unit or player can remove from tile. More...
 
bool is_native_extra_to_uclass (const struct extra_type *pextra, const struct unit_class *pclass)
 Is extra native to unit class? More...
 
bool is_native_extra_to_utype (const struct extra_type *pextra, const struct unit_type *punittype)
 Is extra native to unit type? More...
 
bool extra_has_flag (const struct extra_type *pextra, enum extra_flag_id flag)
 Check if extra has given flag. More...
 
bool is_extra_flag_card_near (const struct tile *ptile, enum extra_flag_id flag)
 Returns TRUE iff any cardinally adjacent tile contains an extra with the given flag (does not check ptile itself). More...
 
bool is_extra_flag_near_tile (const struct tile *ptile, enum extra_flag_id flag)
 Returns TRUE iff any adjacent tile contains an extra with the given flag (does not check ptile itself). More...
 
void user_extra_flags_init ()
 Initialize user extra flags. More...
 
void extra_flags_free ()
 Frees the memory associated with all extra flags. More...
 
void set_user_extra_flag_name (enum extra_flag_id id, const char *name, const char *helptxt)
 Sets user defined name for extra flag. More...
 
const char * extra_flag_id_name_cb (enum extra_flag_id flag)
 Extra flag name callback, called from specenum code. More...
 
const char * extra_flag_helptxt (enum extra_flag_id id)
 Return the (untranslated) help text of the user extra flag. More...
 
bool can_extras_coexist (const struct extra_type *pextra1, const struct extra_type *pextra2)
 Can two extras coexist in same tile? More...
 
bool extra_causes_env_upset (struct extra_type *pextra, enum environment_upset_type upset)
 Does the extra count toward environment upset? More...
 
bool is_extra_caused_by_worker_action (const struct extra_type *pextra)
 Is the extra caused by some kind of worker action? More...
 
bool is_extra_removed_by_worker_action (const struct extra_type *pextra)
 Is the extra removed by some kind of worker action? More...
 
bool is_extra_caused_by_action (const struct extra_type *pextra, const struct action *paction)
 Is the extra caused by specific worker action? More...
 
bool is_extra_removed_by_action (const struct extra_type *pextra, const struct action *paction)
 Is the extra removed by specific worker action? More...
 
enum extra_cause activity_to_extra_cause (enum unit_activity act)
 What extra cause activity is considered to be? More...
 
enum extra_rmcause activity_to_extra_rmcause (enum unit_activity act)
 What extra rmcause activity is considered to be? More...
 
struct playerextra_owner (const struct tile *ptile)
 Who owns extras on tile. More...
 
bool can_extra_appear (const struct extra_type *pextra, const struct tile *ptile)
 Are all the requirements for extra to appear on tile fulfilled. More...
 
bool can_extra_disappear (const struct extra_type *pextra, const struct tile *ptile)
 Are all the requirements for extra to disappear from tile fulfilled. More...
 
bool player_knows_extra_exist (const struct player *pplayer, const struct extra_type *pextra, const struct tile *ptile)
 Extra is not hidden from the user. More...
 

Variables

static struct extra_type extras [MAX_EXTRA_TYPES]
 
static struct user_flag user_extra_flags [MAX_NUM_USER_EXTRA_FLAGS]
 
static struct extra_type_list * caused_by [EC_LAST]
 
static struct extra_type_list * removed_by [ERM_COUNT]
 
static struct extra_type_list * unit_hidden
 

Function Documentation

◆ activity_to_extra_cause()

enum extra_cause activity_to_extra_cause ( enum unit_activity  act)

◆ activity_to_extra_rmcause()

enum extra_rmcause activity_to_extra_rmcause ( enum unit_activity  act)

◆ can_build_extra()

bool can_build_extra ( const struct extra_type pextra,
const struct unit punit,
const struct tile ptile 
)

Tells if unit can build extra on tile.

Definition at line 475 of file extras.cpp.

Referenced by can_unit_do_connect(), and next_extra_for_tile().

◆ can_build_extra_base()

bool can_build_extra_base ( const struct extra_type pextra,
const struct player pplayer,
const struct tile ptile 
)

Tells if player can build extra to tile with suitable unit.

Definition at line 371 of file extras.cpp.

Referenced by can_build_base(), can_build_extra(), can_build_road(), player_can_build_extra(), and player_can_build_road().

◆ can_extra_appear()

bool can_extra_appear ( const struct extra_type pextra,
const struct tile ptile 
)

Are all the requirements for extra to appear on tile fulfilled.

Definition at line 1021 of file extras.cpp.

Referenced by end_turn().

◆ can_extra_be_removed()

static bool can_extra_be_removed ( const struct extra_type pextra,
const struct tile ptile 
)
static

Is it possible at all to remove this extra now.

Definition at line 492 of file extras.cpp.

Referenced by can_extra_disappear(), can_remove_extra(), and player_can_remove_extra().

◆ can_extra_disappear()

bool can_extra_disappear ( const struct extra_type pextra,
const struct tile ptile 
)

Are all the requirements for extra to disappear from tile fulfilled.

Definition at line 1036 of file extras.cpp.

Referenced by end_turn().

◆ can_extras_coexist()

bool can_extras_coexist ( const struct extra_type pextra1,
const struct extra_type pextra2 
)

Can two extras coexist in same tile?

Definition at line 902 of file extras.cpp.

Referenced by adv_calc_extra(), can_unit_do_activity_targeted_at(), create_extra(), extra_conflicting_on_tile(), save_terrain_ruleset(), and tile_extra_apply().

◆ can_remove_extra()

bool can_remove_extra ( const struct extra_type pextra,
const struct unit punit,
const struct tile ptile 
)

Tells if unit can remove extra from tile.

Does not examine action requirements if an action is required for it.

Definition at line 543 of file extras.cpp.

Referenced by prev_extra_in_tile().

◆ extra_by_number()

◆ extra_can_be_built()

bool extra_can_be_built ( const struct extra_type pextra,
const struct tile ptile 
)

Tells if extra can build to tile if all other requirements are met.

Definition at line 352 of file extras.cpp.

Referenced by can_build_extra_base().

◆ extra_causes_env_upset()

bool extra_causes_env_upset ( struct extra_type pextra,
enum environment_upset_type  upset 
)

Does the extra count toward environment upset?

Definition at line 915 of file extras.cpp.

Referenced by update_environmental_upset().

◆ extra_conflicting_on_tile()

bool extra_conflicting_on_tile ( const struct extra_type pextra,
const struct tile ptile 
)

Returns TRUE iff an extra that conflicts with pextra exists at ptile.

Definition at line 607 of file extras.cpp.

Referenced by can_extra_appear().

◆ extra_count()

int extra_count ( )

Return the number of extra_types.

Definition at line 127 of file extras.cpp.

Referenced by fill_tile_edit_packet().

◆ extra_flag_helptxt()

const char* extra_flag_helptxt ( enum extra_flag_id  id)

Return the (untranslated) help text of the user extra flag.

Definition at line 892 of file extras.cpp.

Referenced by helptext_extra(), save_terrain_ruleset(), and send_ruleset_extras().

◆ extra_flag_id_name_cb()

const char* extra_flag_id_name_cb ( enum extra_flag_id  flag)

Extra flag name callback, called from specenum code.

Definition at line 880 of file extras.cpp.

Referenced by save_terrain_ruleset().

◆ extra_flags_free()

void extra_flags_free ( )

Frees the memory associated with all extra flags.

Definition at line 847 of file extras.cpp.

Referenced by game_ruleset_free().

◆ extra_has_flag()

◆ extra_name_translation()

◆ extra_number()

◆ extra_owner()

◆ extra_rule_name()

◆ extra_to_caused_by_list()

void extra_to_caused_by_list ( struct extra_type pextra,
enum extra_cause  cause 
)

Add extra type to list of extra caused by given cause.

Definition at line 274 of file extras.cpp.

Referenced by handle_ruleset_extra(), and load_ruleset_terrain().

◆ extra_to_removed_by_list()

void extra_to_removed_by_list ( struct extra_type pextra,
enum extra_rmcause  rmcause 
)

Add extra type to list of extra removed by given cause.

Definition at line 296 of file extras.cpp.

Referenced by handle_ruleset_extra(), load_ruleset_terrain(), and rscompat_extra_adjust_3_1().

◆ extra_type_by_rule_name()

◆ extra_type_by_translated_name()

struct extra_type* extra_type_by_translated_name ( const char *  name)

Returns extra type matching the translated name, or nullptr if there is no extra type with that name.

Definition at line 208 of file extras.cpp.

Referenced by help_dialog::make_tree(), and help_widget::set_topic_extra().

◆ extra_type_list_by_cause()

struct extra_type_list* extra_type_list_by_cause ( enum extra_cause  cause)

◆ extra_type_list_by_rmcause()

struct extra_type_list* extra_type_list_by_rmcause ( enum extra_rmcause  rmcause)

Returns extra type for given rmcause.

Definition at line 286 of file extras.cpp.

◆ extra_type_list_of_unit_hiders()

struct extra_type_list* extra_type_list_of_unit_hiders ( )

Returns extra types that hide units.

Definition at line 234 of file extras.cpp.

Referenced by can_player_see_unit_at(), handle_ruleset_extra(), load_ruleset_terrain(), and player_can_trust_tile_has_no_units().

◆ extras_free()

void extras_free ( )

Free the memory associated with extras.

Definition at line 71 of file extras.cpp.

Referenced by game_ruleset_free().

◆ extras_init()

void extras_init ( )

Initialize extras structures.

Definition at line 36 of file extras.cpp.

Referenced by game_ruleset_init().

◆ hut_on_tile()

bool hut_on_tile ( const struct tile ptile)

Returns TRUE iff an extra on the tile is a hut (removed by entering).

The effect of entering is handled by unit_enter_hut() in unittools.c

Definition at line 626 of file extras.cpp.

Referenced by adv_data_phase_init(), dai_unit_move(), explorer_desirable(), and is_valid_start_pos().

◆ is_extra_card_near()

bool is_extra_card_near ( const struct tile ptile,
const struct extra_type pextra 
)

Is there extra of the given type cardinally near tile? (Does not check ptile itself.)

Definition at line 317 of file extras.cpp.

◆ is_extra_caused_by_action()

bool is_extra_caused_by_action ( const struct extra_type pextra,
const struct action paction 
)

Is the extra caused by specific worker action?

Definition at line 953 of file extras.cpp.

Referenced by settler_evaluate_improvements(), tai_tile_worker_task_select(), and texai_tile_worker_task_select().

◆ is_extra_caused_by_worker_action()

bool is_extra_caused_by_worker_action ( const struct extra_type pextra)

Is the extra caused by some kind of worker action?

Definition at line 931 of file extras.cpp.

Referenced by helptext_extra(), initialize_infrastructure_cache(), and load_ruleset_terrain().

◆ is_extra_flag_card_near()

bool is_extra_flag_card_near ( const struct tile ptile,
enum extra_flag_id  flag 
)

Returns TRUE iff any cardinally adjacent tile contains an extra with the given flag (does not check ptile itself).

Definition at line 788 of file extras.cpp.

◆ is_extra_flag_near_tile()

bool is_extra_flag_near_tile ( const struct tile ptile,
enum extra_flag_id  flag 
)

Returns TRUE iff any adjacent tile contains an extra with the given flag (does not check ptile itself).

Definition at line 812 of file extras.cpp.

◆ is_extra_near_tile()

bool is_extra_near_tile ( const struct tile ptile,
const struct extra_type pextra 
)

Is there extra of the given type near tile? (Does not check ptile itself.)

Definition at line 335 of file extras.cpp.

◆ is_extra_removed_by()

bool is_extra_removed_by ( const struct extra_type pextra,
enum extra_rmcause  rmcause 
)

◆ is_extra_removed_by_action()

bool is_extra_removed_by_action ( const struct extra_type pextra,
const struct action paction 
)

Is the extra removed by specific worker action?

Definition at line 963 of file extras.cpp.

Referenced by settler_evaluate_improvements(), tai_tile_worker_task_select(), and texai_tile_worker_task_select().

◆ is_extra_removed_by_worker_action()

bool is_extra_removed_by_worker_action ( const struct extra_type pextra)

Is the extra removed by some kind of worker action?

Definition at line 942 of file extras.cpp.

Referenced by initialize_infrastructure_cache().

◆ is_native_extra_to_uclass()

bool is_native_extra_to_uclass ( const struct extra_type pextra,
const struct unit_class pclass 
)

◆ is_native_extra_to_utype()

bool is_native_extra_to_utype ( const struct extra_type pextra,
const struct unit_type punittype 
)

Is extra native to unit type?

Definition at line 770 of file extras.cpp.

Referenced by base_has_flag_for_utype(), can_player_see_unit_at(), create_extra(), destroy_extra(), tile_has_native_base(), and tile_has_refuel_extra().

◆ is_native_tile_to_extra()

bool is_native_tile_to_extra ( const struct extra_type pextra,
const struct tile ptile 
)

Is tile native to extra?

Definition at line 559 of file extras.cpp.

Referenced by add_recursive_extras(), can_extra_appear(), create_city(), rand_extra_for_tile(), remove_city(), and tile_change_terrain().

◆ next_extra_for_tile()

struct extra_type* next_extra_for_tile ( const struct tile ptile,
enum extra_cause  cause,
const struct player pplayer,
const struct unit punit 
)

◆ player_can_build_extra()

bool player_can_build_extra ( const struct extra_type pextra,
const struct player pplayer,
const struct tile ptile 
)

Tells if player can build extra to tile with suitable unit.

Definition at line 414 of file extras.cpp.

Referenced by adv_calc_extra(), can_extra_be_removed(), impr_provides_buildable_extras(), next_extra_for_tile(), player_can_place_extra(), and upgrade_city_extras().

◆ player_can_place_extra()

bool player_can_place_extra ( const struct extra_type pextra,
const struct player pplayer,
const struct tile ptile 
)

Tells if player can place extra on tile.

Definition at line 430 of file extras.cpp.

◆ player_can_remove_extra()

bool player_can_remove_extra ( const struct extra_type pextra,
const struct player pplayer,
const struct tile ptile 
)

Tells if player can remove extra from tile with suitable unit.

Definition at line 525 of file extras.cpp.

Referenced by adv_calc_rmextra(), do_nuke_tile(), and prev_extra_in_tile().

◆ player_knows_extra_exist()

bool player_knows_extra_exist ( const struct player pplayer,
const struct extra_type pextra,
const struct tile ptile 
)

Extra is not hidden from the user.

Definition at line 1051 of file extras.cpp.

Referenced by update_player_tile_knowledge().

◆ prev_extra_in_tile()

struct extra_type* prev_extra_in_tile ( const struct tile ptile,
enum extra_rmcause  rmcause,
const struct player pplayer,
const struct unit punit 
)

◆ rand_extra_for_tile()

struct extra_type* rand_extra_for_tile ( struct tile ptile,
enum extra_cause  cause,
bool  generated 
)

Return random extra type for given cause that is native to the tile.

Definition at line 242 of file extras.cpp.

Referenced by do_nuke_tile(), fair_map_make_huts(), make_huts(), and place_pollution().

◆ set_user_extra_flag_name()

void set_user_extra_flag_name ( enum extra_flag_id  id,
const char *  name,
const char *  helptxt 
)

Sets user defined name for extra flag.

Definition at line 859 of file extras.cpp.

Referenced by handle_ruleset_extra_flag(), and load_terrain_names().

◆ unit_can_displace_hut()

bool unit_can_displace_hut ( const struct unit punit,
const struct tile ptile 
)

Returns TRUE iff the unit can enter or frighten any hut on the tile.

For the unit, tests only its class and its owner.

Definition at line 665 of file extras.cpp.

Referenced by explorer_desirable().

◆ unit_can_enter_hut()

bool unit_can_enter_hut ( const struct unit punit,
const struct tile ptile 
)

Returns TRUE iff the unit can enter any hut on the tile.

For the unit, tests only its class and its owner.

Definition at line 643 of file extras.cpp.

Referenced by dai_rampage_want().

◆ user_extra_flags_init()

void user_extra_flags_init ( )

Initialize user extra flags.

Definition at line 835 of file extras.cpp.

Referenced by game_ruleset_init().

Variable Documentation

◆ caused_by

struct extra_type_list* caused_by[EC_LAST]
static

◆ extras

struct extra_type extras[MAX_EXTRA_TYPES]
static

Definition at line 1 of file extras.cpp.

Referenced by extra_by_number(), extras_free(), and extras_init().

◆ removed_by

struct extra_type_list* removed_by[ERM_COUNT]
static

◆ unit_hidden

struct extra_type_list* unit_hidden
static

Definition at line 31 of file extras.cpp.

Referenced by extra_type_list_of_unit_hiders(), extras_free(), and extras_init().

◆ user_extra_flags