|
Freeciv-3.3
|
#include "support.h"#include "fc_types.h"#include "requirements.h"#include "effects_enums_gen.h"#include "speclist.h"Go to the source code of this file.
Data Structures | |
| struct | effect |
Typedefs | |
| typedef double(* | eft_value_filter_cb) (const struct effect *eft, const struct req_context *context, const struct player *other_player, void *data, int n_data) |
| typedef bool(* | iec_cb) (struct effect *, void *data) |
| #define effect_list_iterate | ( | effect_list, | |
| peffect | |||
| ) | TYPED_LIST_ITERATE(struct effect, effect_list, peffect) |
| #define effect_list_iterate_end LIST_ITERATE_END |
| #define EFT_USER_EFFECT_LAST EFT_USER_EFFECT_4 |
| #define USER_EFFECT_NUMBER | ( | eff | ) | (eff - EFT_USER_EFFECT_1) |
Returns TRUE if the building has any effect bonuses of the given type.
Note that this function returns a boolean rather than an integer value giving the exact bonus. Finding the exact bonus requires knowing the effect range and may take longer. This function should only be used in situations where the range doesn't matter.
Definition at line 639 of file effects.c.
Referenced by building_crucial(), can_player_build_improvement_direct(), get_building_for_effect(), helptext_building(), try_to_sell_stuff(), and valid_improvement().
Create copy of the effect. It gets fully registered to the ruleset caches.
| old | Original effect to copy |
| override_type | Type of the effect to create, or effect_type_invalid() to copy type from the original effect |
Get the maximum effect value in this ruleset for the universal (that is, the sum of all positive effects clauses that apply specifically to this universal – this can be an overestimate in the case of mutually exclusive effects). for_uni can be NULL to get max effect value ignoring requirements.
Definition at line 388 of file effects.c.
Referenced by helptext_unit(), rs_common_units(), rs_max_city_radius_sq(), sanity_check_boolean_effects(), set_unit_type_caches(), and utype_unknown_move_cost().
Get the minimum effect value in this ruleset for the universal (that is, the sum of all negative effects clauses that apply specifically to this universal – this can be an overestimate in the case of mutually exclusive effects). for_uni can be NULL to get min effect value ignoring requirements.
Definition at line 424 of file effects.c.
Referenced by effect_value_will_make_positive(), and sanity_check_boolean_effects().
Free resources reserved for the effect.
This does not remove effect from the cache lists. See effect_remove() for that.
Definition at line 216 of file effects.c.
Referenced by ruleset_cache_free().
Add effect to ruleset cache.
Definition at line 186 of file effects.c.
Referenced by effect_edit::add_now(), effect_copy(), load_ruleset_effects(), recv_ruleset_effect(), rscompat_civil_war_effects_3_3(), and rscompat_postprocess().
Remove effect from the caches.
This does not free effect itself. See effect_free() for that.
Definition at line 230 of file effects.c.
Referenced by effect_edit::delete_now().
| void effect_req_append | ( | struct effect * | peffect, |
| struct requirement | req | ||
| ) |
Append requirement to effect.
Definition at line 266 of file effects.c.
Referenced by effect_edit::add_now(), effect_copy(), load_ruleset_effects(), recv_ruleset_effect(), rscompat_civil_war_effects_3_3(), and rscompat_postprocess().
| bool effect_universals_value_never_below | ( | enum effect_type | type, |
| struct universal * | unis, | ||
| size_t | n_unis, | ||
| int | min_value | ||
| ) |
Returns TRUE iff the specified effect type is guaranteed to always have a value at or above the specified value given the presence of the specified list of universals. Note that it may be true that the effect type always will be at or above the specified value a even if this function refuses to guarantee it by returning FALSE. It may simply be unable to detect that it is so.
| type | the effect type |
| unis | the list of present universals |
| n_unis | the number of universals in unis |
| min_value | the value the effect always should be at or above |
Definition at line 545 of file effects.c.
Referenced by helptext_unit(), utype_act_takes_all_mp_cache_set(), and utype_act_takes_all_mp_ustate_cache_set().
Return the base value of a given effect that can always be expected from just the sources in the list, independent of other factors. Adds up all the effects that rely only on these universals; effects that have extra conditions are ignored. In effect, 'unis' is a template against which effects are matched. The first universal in the list is special: effects must have a condition that specifically applies to that source to be included (may be a superset requirement, e.g. ExtraFlag for VUT_EXTRA source).
Definition at line 459 of file effects.c.
Referenced by extra_bonus_for_terrain(), and helptext_unit().
| int get_building_bonus | ( | const struct city * | pcity, |
| const struct impr_type * | building, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect bonus at a building.
Definition at line 1004 of file effects.c.
Referenced by city_improvement_upkeep(), impr_build_shield_cost(), and impr_buy_gold_cost().
Returns the effect bonus at a city.
Definition at line 842 of file effects.c.
Referenced by api_effects_city_bonus(), citizen_content_buildings(), citizen_happiness_nationality(), citizen_happy_wonders(), city_airlift_max(), city_build_slots(), city_can_grow_to(), city_citywalls_gfx(), city_culture(), city_dialog_update_supported_units(), city_got_defense_effect(), city_growth_granary_savings(), city_history_gain(), city_incite_cost(), city_map_update_radius_sq(), city_migration_score(), city_pollution_types(), city_rapture_grow(), city_refresh_vision(), city_shrink_granary_savings(), city_support(), city_total_impr_gold_upkeep(), city_turn_notify(), city_unit_slots_available(), city_unit_unhappiness(), civil_war_triggered(), create_unit_surface(), dai_action_choose_sub_tgt_unit_vs_city(), dai_assess_military_unhappiness(), dai_content_effect_value(), dai_effect_value(), dai_set_defenders(), dai_spend_gold(), dai_war_desire(), diplomat_sabotage(), get_city_dialog_output_text(), get_city_health(), get_city_sprite(), get_city_tithes_bonus(), is_gov_center(), max_trade_routes(), military_advisor_choose_build(), multiairlift(), package_city(), redraw_city_dialog(), redraw_unit_info_label(), set_city_production(), spy_steal_gold(), text_happiness_nationality(), text_happiness_units(), tile_border_source_strength(), update_capital(), update_city_activity(), update_dumb_city(), and city_dialog::update_units().
| int get_city_bonus_effects | ( | struct effect_list * | plist, |
| const struct city * | pcity, | ||
| const struct output_type * | poutput, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect sources of this type currently active at the city.
The returned vector must be freed (building_vector_free) when the caller is done with it.
Definition at line 1151 of file effects.c.
Referenced by get_city_dialog_culture_text(), get_city_dialog_illness_text(), get_city_dialog_output_text(), redraw_happiness_city_dialog(), text_happiness_buildings(), and text_happiness_wonders().
| int get_city_output_bonus | ( | const struct city * | pcity, |
| const struct output_type * | poutput, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the player effect bonus of an output.
Definition at line 980 of file effects.c.
Referenced by city_units_upkeep(), city_waste(), set_city_bonuses(), and set_surpluses().
| int get_city_specialist_output_bonus | ( | const struct city * | pcity, |
| const struct specialist * | pspecialist, | ||
| const struct output_type * | poutput, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect bonus of a specialist in a city.
Definition at line 881 of file effects.c.
Referenced by get_specialist_output().
| int get_city_tile_output_bonus | ( | const struct city * | pcity, |
| const struct tile * | ptile, | ||
| const struct output_type * | poutput, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect bonus at a city tile. pcity must be supplied.
FIXME: this is now used both for tile bonuses, tile-output bonuses, and city-output bonuses. Thus ptile or poutput may be NULL for certain callers. This could be changed by adding 2 new functions to the interface but they'd be almost identical and their likely names would conflict with functions already in city.c. It's also very similar to get_tile_output_bonus(); it should be called when the city is mandatory.
Definition at line 912 of file effects.c.
Referenced by base_city_can_work_tile(), city_tc_effect_refresh(), get_final_city_output_bonus(), and tile_change_side_effects().
| int get_current_construction_bonus | ( | const struct city * | pcity, |
| enum effect_type | effect_type, | ||
| const enum req_problem_type | prob_type | ||
| ) |
Returns the effect bonus the currently-in-construction-item will provide.
Note this is not called get_current_production_bonus because that would be confused with EFT_PROD_BONUS.
Problem type tells if we need to be CERTAIN about bonus before counting it or is POSSIBLE bonus enough.
Definition at line 1180 of file effects.c.
Referenced by city_build_building(), city_increase_size(), and city_turn_notify().
| double get_effect_expected_value | ( | const struct req_context * | context, |
| const struct player * | other_player, | ||
| enum effect_type | effect_type, | ||
| eft_value_filter_cb | weighter, | ||
| void * | data, | ||
| int | n_data | ||
| ) |
Returns the expected value of the effect of given type for given context, calculating value weighted with probability for each individual effect with given callback using arbitrary additional data passed to it.
The way of using multipliers is left on the callback.
Make user-friendly text for an effect list. The text is put into a user astring.
Definition at line 1301 of file effects.c.
Referenced by do_tech_parasite_effects(), text_happiness_buildings(), and text_happiness_wonders().
Make user-friendly text for the source. The text is put into a user buffer.
Definition at line 1273 of file effects.c.
Referenced by get_city_dialog_culture_text(), get_city_dialog_illness_text(), get_city_dialog_output_text(), and get_effect_list_req_text().
| struct effect_list * get_effects | ( | enum effect_type | effect_type | ) |
Get a list of effects of this type.
Definition at line 143 of file effects.c.
Referenced by adv_units_ruleset_init(), dai_find_source_building(), effect_new(), effect_remove(), effect_universals_value_never_below(), effect_value_from_universals(), get_effect_expected_value(), get_target_bonus_effects(), is_effect_val_known(), ruleset_purge_redundant_reqs_effects(), and ruleset_purge_unused_effects().
Returns the effect bonus for a player.
Definition at line 824 of file effects.c.
Referenced by adv_best_government(), adv_gov_player_bonus_want(), api_effects_player_bonus(), can_change_to_government(), can_player_build_improvement_direct(), can_player_build_unit_direct(), check_for_game_over(), civil_war_triggered(), could_meet_with_player(), dai_assess_military_unhappiness(), dai_content_effect_value(), dai_diplomacy_actions(), dai_diplomacy_begin_new_phase(), dai_effect_value(), dai_gov_value(), dai_manage_taxes(), do_border_vision_effect(), do_have_contacts_effect(), do_reveal_effects(), do_upgrade_effects(), economy_report_dialog_popup(), fc_double_edge::fc_double_edge(), found_new_tech(), get_player_maxrate(), handle_diplomacy_cancel_pact(), handle_diplomacy_init_meeting_req(), handle_player_change_government(), horiz_taxrate_callback(), make_contact(), nation_history_gain(), player_base_citizen_happiness(), player_culture(), player_has_embassy_from_effect(), player_has_really_useful_tech_parasite(), player_tech_upkeep(), popup_rates_dialog(), pplayer_can_cancel_treaty(), pplayer_can_make_treaty(), rates_set_values(), remove_city(), research_total_bulbs_required(), split_player(), steal_a_tech(), tax_rates_dialog::tax_rates_dialog(), text_happiness_cities(), try_summon_barbarians(), unit_upgrade_price(), fc_client::update_sidebar_tooltips(), utype_happy_cost(), and utype_upkeep_cost().
| int get_player_bonus_effects | ( | struct effect_list * | plist, |
| const struct player * | pplayer, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect sources of this type currently active at the player.
The returned vector must be freed (building_vector_free) when the caller is done with it.
Definition at line 1128 of file effects.c.
Referenced by do_tech_parasite_effects().
| int get_player_output_bonus | ( | const struct player * | pplayer, |
| const struct output_type * | poutput, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the player effect bonus of an output.
Definition at line 957 of file effects.c.
Referenced by get_tile_output_text().
| int get_potential_improvement_bonus | ( | const struct impr_type * | pimprove, |
| const struct city * | pcity, | ||
| enum effect_type | effect_type, | ||
| const enum req_problem_type | prob_type, | ||
| bool | consider_multipliers | ||
| ) |
Returns the effect bonus the improvement would or does provide if present.
Problem type tells if we need to be CERTAIN about bonus before counting it or is POSSIBLE bonus enough.
Definition at line 1202 of file effects.c.
Referenced by get_current_construction_bonus(), improvement_has_effects(), and rs_buildings().
| struct effect_list * get_req_source_effects | ( | const struct universal * | psource | ) |
Get a list of effects with this requirement source.
Currently only buildings, advances, and governments are supported.
Definition at line 153 of file effects.c.
Referenced by adjust_improvement_wants_by_effects(), adv_data_city_impr_calc(), building_has_effect(), dai_gov_value(), dai_tech_effect_values(), effect_req_append(), get_potential_improvement_bonus(), helptext_government(), improvement_has_effects(), and is_building_replaced().
| int get_target_bonus_effects | ( | struct effect_list * | plist, |
| const struct req_context * | context, | ||
| const struct req_context * | other_context, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect bonus of a given type for any target.
context gives the target (or targets) to evaluate requirements against effect_type gives the effect type to be considered
context and other_context may be NULL. This is equivalent to passing empty contexts.
Returns the effect sources of this type currently active.
The returned vector must be freed (building_vector_free) when the caller is done with it.
Definition at line 744 of file effects.c.
Referenced by action_dice_roll_odds(), action_success_target_pay_mp(), ap_dipl_battle_win(), api_effects_tile_bonus(), api_effects_unit_bonus(), api_methods_city_inspire_partisans(), casus_belli_range_for(), city_support(), city_tile_output(), dai_choose_trade_route(), dai_effect_value(), defense_multiplication(), diplomat_success_vs_defender(), do_heal_unit(), do_nuclear_explosion(), fill_grid_sprite_array(), get_building_bonus(), get_caravan_enter_city_trade_bonus(), get_city_bonus(), get_city_bonus_effects(), get_city_output_bonus(), get_city_specialist_output_bonus(), get_city_tile_output_bonus(), get_player_bonus(), get_player_bonus_effects(), get_player_output_bonus(), get_tile_bonus(), get_tile_output_bonus(), get_total_attack_power(), get_unit_bonus(), get_unit_vs_tile_bonus(), get_unittype_bonus(), get_world_bonus(), helptext_government(), illegal_action_pay_price(), impr_estimate_build_shield_cost(), is_tile_claimable(), process_attacker_want(), sdi_try_defend(), spy_steal_some_maps(), tile_activity_time(), unit_attack_civilian_casualties(), unit_bribe_cost(), unit_pays_mp_for_action(), unit_shield_value(), unit_vision_range_modifiers(), utype_pays_mp_for_action_estimate(), and utype_upkeep_cost().
Returns the effect bonus at a tile. Even if the tile has a city, player requirements are not about city owner but tile owner.
Definition at line 862 of file effects.c.
Referenced by tile_border_source_strength().
| int get_tile_output_bonus | ( | const struct city * | pcity, |
| const struct tile * | ptile, | ||
| const struct output_type * | poutput, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect bonus at a tile for given output type (or NULL for output-type-independent bonus). If pcity is supplied, it's the bonus for that particular city, otherwise it's the player/city-independent bonus (and any city on the tile is ignored).
Definition at line 936 of file effects.c.
Referenced by city_tile_output().
Returns the effect bonus at a unit
Definition at line 1066 of file effects.c.
Referenced by begin_turn(), dai_find_strategic_airbase(), diplomats_unignored_tech_stealings(), hp_gain_coord(), is_losing_hp(), maybe_become_veteran_real(), regen_turns(), request_unit_return(), spy_steal_gold(), unit_conquer_city(), unit_gain_hitpoints(), and unit_versus_unit().
| int get_unit_vs_tile_bonus | ( | const struct tile * | ptile, |
| const struct unit * | punit, | ||
| enum effect_type | etype | ||
| ) |
Returns the effect bonus at a tile
Definition at line 1090 of file effects.c.
Referenced by api_effects_unit_vs_tile_bonus().
| int get_unittype_bonus | ( | const struct player * | pplayer, |
| const struct tile * | ptile, | ||
| const struct unit_type * | punittype, | ||
| const struct action * | paction, | ||
| enum effect_type | effect_type | ||
| ) |
Returns the effect bonus that applies at a tile for a given unittype.
For instance with EFT_DEFEND_BONUS the attacker's unittype and the defending tile should be passed in. Slightly counter-intuitive! See doc/README.effects to see how the unittype applies for each effect here.
Definition at line 1031 of file effects.c.
Referenced by assess_danger(), assess_danger_unit(), city_got_defense_effect(), city_production_unit_veteran_level(), dai_choose_defender_versus(), dai_wants_defender_against(), defense_multiplication(), find_nearest_safe_city(), get_modified_firepower(), pf_reverse_map_utype_pos(), pft_fill_utype_default_parameter(), unit_type_is_losing_hp(), utype_build_shield_cost(), utype_buy_gold_cost(), utype_move_rate(), and utype_pop_value().
Returns the effect bonus for the whole world.
Definition at line 812 of file effects.c.
Referenced by api_effects_world_bonus(), game_next_year(), and tri_req_active_turns().
| bool is_building_replaced | ( | const struct city * | pcity, |
| const struct impr_type * | pimprove, | ||
| const enum req_problem_type | prob_type | ||
| ) |
Returns TRUE if a building is replaced. To be replaced, all its effects must be made redundant by groups that it is in. prob_type CERTAIN or POSSIBLE is answer to function name.
Definition at line 693 of file effects.c.
Referenced by is_improvement_redundant().
Is the effect type an user effect type?
Definition at line 1337 of file effects.c.
Referenced by load_ruleset_effects(), user_effect_ai_valued_as(), and user_effect_ai_valued_set().
Iterate through all the effects in cache, and call callback for each. If any callback returns FALSE, there is no further checking and this will return FALSE.
Definition at line 1321 of file effects.c.
Referenced by is_multiplier_needed(), is_universal_needed(), effect_edit::refresh(), tab_misc::refresh_stats(), rscompat_postprocess(), sanity_check_ruleset_data(), and save_effects_ruleset().
| void recv_ruleset_effect | ( | const struct packet_ruleset_effect * | packet | ) |
Receives a new effect. This is called by the client when the packet arrives.
Definition at line 591 of file effects.c.
Referenced by handle_ruleset_effect().
Free the ruleset cache. This should be called at the end of the game or when the client disconnects from the server. See ruleset_cache_init().
Definition at line 329 of file effects.c.
Referenced by game_ruleset_free().
Initialize the ruleset cache. The ruleset cache should be empty before this is done (so if it's previously been initialized, it needs to be freed (see ruleset_cache_free) before it can be reused).
Definition at line 297 of file effects.c.
Referenced by game_ruleset_init().
Send the ruleset cache data over the network.
Definition at line 609 of file effects.c.
Referenced by send_rulesets().
Get the ai_valued_as effect type for effect. Can be used also for non-user effects - then it just returns the effect itself.
Definition at line 1357 of file effects.c.
Referenced by dai_effect_value(), load_ruleset_effects(), and save_effects_ruleset().
1.9.8