Freeciv-3.1: /fast/freeciv/nightly/S3_1/common/research.h File Reference

Freeciv-3.1

Loading...
Searching...
No Matches
Data Structures | Macros | Functions
research.h File Reference
`#include "iterator.h"`
`#include "support.h"`
`#include "fc_types.h"`
`#include "tech.h"`
`#include "specenum_gen.h"`

Go to the source code of this file.

## Data Structures

struct | research
struct | research::research_invention

## Macros

#define | SPECENUM_NAME tech_state
#define | SPECENUM_VALUE0 TECH_UNKNOWN
#define | SPECENUM_VALUE1 TECH_PREREQS_KNOWN
#define | SPECENUM_VALUE2 TECH_KNOWN
#define | researches_iterate(_presearch)
#define | researches_iterate_end generic_iterate_end
#define | research_players_iterate(_presearch, _pplayer)
#define | research_players_iterate_end generic_iterate_end

## Functions

void | researches_init (void)
void | researches_free (void)
int | research_number (const struct research *presearch)
const char * | research_rule_name (const struct research *presearch)
const char * | research_name_translation (const struct research *presearch)
int | research_pretty_name (const struct research *presearch, char *buf, size_t buf_len)
struct research * | research_by_number (int number)
struct research * | research_get (const struct player *pplayer)
const char * | research_advance_rule_name (const struct research *presearch, Tech_type_id tech)
const char * | research_advance_name_translation (const struct research *presearch, Tech_type_id tech)
void | research_update (struct research *presearch)
enum tech_state | research_invention_state (const struct research *presearch, Tech_type_id tech)
enum tech_state | research_invention_set (struct research *presearch, Tech_type_id tech, enum tech_state value)
bool | research_invention_reachable (const struct research *presearch, const Tech_type_id tech)
bool | research_invention_gettable (const struct research *presearch, const Tech_type_id tech, bool allow_holes)
Tech_type_id | research_goal_step (const struct research *presearch, Tech_type_id goal)
int | research_goal_unknown_techs (const struct research *presearch, Tech_type_id goal)
int | research_goal_bulbs_required (const struct research *presearch, Tech_type_id goal)
bool | research_goal_tech_req (const struct research *presearch, Tech_type_id goal, Tech_type_id tech)
int | research_total_bulbs_required (const struct research *presearch, Tech_type_id tech, bool loss_value)
int | player_tech_upkeep (const struct player *pplayer)
size_t | research_iter_sizeof (void)
struct iterator * | research_iter_init (struct research_iter *it)
size_t | research_player_iter_sizeof (void)
struct iterator * | research_player_iter_init (struct research_player_iter *it, const struct research *presearch)
int | recalculate_techs_researched (const struct research *presearch)
bool | research_future_next (const struct research *presearch)

## Macro Definition Documentation

## ◆ research_players_iterate

#define research_players_iterate | ( |  | _presearch,
|  |  | _pplayer
| ) |  |

Value:
generic_iterate(struct research_player_iter, struct player *, _pplayer, \
research_player_iter_sizeof, research_player_iter_init, \
_presearch)
generic_iterate
#define generic_iterate(TYPE_it, TYPE_a, NAME_a, FUNC_size, FUNC_init,...)
Definition iterator.h:117
research_player_iter_sizeof
size_t research_player_iter_sizeof(void)
Definition research.c:1217
research_player_iter_init
struct iterator * research_player_iter_init(struct research_player_iter *it, const struct research *presearch)
Definition research.c:1287
player
Definition player.h:249
research_player_iter
Definition research.c:41

Definition at line 168 of file research.h.

## ◆ research_players_iterate_end

#define research_players_iterate_end generic_iterate_end

Definition at line 172 of file research.h.

## ◆ researches_iterate

#define researches_iterate | ( |  | _presearch | ) |

Value:
generic_iterate(struct research_iter, struct research *, \
_presearch, research_iter_sizeof, research_iter_init)
research_iter_sizeof
size_t research_iter_sizeof(void)
Definition research.c:1127
research_iter_init
struct iterator * research_iter_init(struct research_iter *it)
Definition research.c:1195
research_iter
Definition research.c:35
research
Definition research.h:39

Definition at line 157 of file research.h.

## ◆ researches_iterate_end

#define researches_iterate_end generic_iterate_end

Definition at line 160 of file research.h.

## ◆ SPECENUM_NAME

#define SPECENUM_NAME tech_state

Definition at line 31 of file research.h.

## ◆ SPECENUM_VALUE0

#define SPECENUM_VALUE0 TECH_UNKNOWN

Definition at line 34 of file research.h.

## ◆ SPECENUM_VALUE1

#define SPECENUM_VALUE1 TECH_PREREQS_KNOWN

Definition at line 35 of file research.h.

## ◆ SPECENUM_VALUE2

#define SPECENUM_VALUE2 TECH_KNOWN

Definition at line 36 of file research.h.

## Function Documentation

## ◆ player_tech_upkeep()

int player_tech_upkeep | ( | const struct player * | pplayer | ) |

Calculate the bulb upkeep needed for all techs of a player. See also research_total_bulbs_required().

Definition at line 1040 of file research.c.

Referenced by dai_goldequiv_clause(), dai_manage_taxes(), end_phase(), init_tech(), and package_player_info().

## ◆ recalculate_techs_researched()

int recalculate_techs_researched | ( | const struct research * | presearch | ) |

Return recalculated number of techs researched. Useful for sanity checking techs_researched counter.

Definition at line 1318 of file research.c.

Referenced by sg_load_sanitycheck(), and sg_load_sanitycheck().

## ◆ research_advance_name_translation()

const char * research_advance_name_translation | ( | const struct research * | presearch,
|  | Tech_type_id | tech
| ) |  |

Store the translated name of the given tech (including A_FUTURE) in 'buf'. 'presearch' may be NULL. We don't return a static buffer because that would break anything that needed to work with more than one name at a time.

Definition at line 271 of file research.c.

Referenced by api_edit_give_technology(), choose_tech_goal(), city_build_building(), cmp_func(), create_advances_list(), create_tech_tree(), research_diagram::create_tooltip_help(), do_tech_parasite_effect(), draw_reqtree(), forget_tech_transferred(), found_new_tech(), get_bulb_tooltip(), get_info_label_text_popup(), get_researching_info(), research_diagram::mousePressEvent(), plr_widget::nation_selected(), node_rectangle_minimum_size(), real_science_report_dialog_update(), research_tech_lost(), science_diagram_button_release_callback(), science_diagram_right_button_up(), science_report_store_set(), set_indicator_icons(), show_new_turn_info(), spy_steal_shared(), steal_a_tech(), tech_researched(), tech_transfer(), update_bulbs(), update_intel_dialog(), and science_report::update_report().

## ◆ research_advance_rule_name()

const char * research_advance_rule_name | ( | const struct research * | presearch,
|  | Tech_type_id | tech
| ) |  |

Store the rule name of the given tech (including A_FUTURE) in 'buf'. 'presearch' may be NULL. We don't return a static buffer because that would break anything that needed to work with more than one name at a time.

Definition at line 238 of file research.c.

Referenced by dai_manage_tech(), dai_select_tech(), update_bulbs(), and wipe_unit_full().

## ◆ research_by_number()

struct research * research_by_number | ( | int | number | ) |

Returns the research for the given index.

Definition at line 116 of file research.c.

Referenced by handle_research_info(), handle_unknown_research(), sg_load_researches(), and sg_load_researches().

## ◆ research_future_next()

bool research_future_next | ( | const struct research * | presearch | ) |

Is this research group going to research some Future Tech next?

Definition at line 1335 of file research.c.

Referenced by science_report_update().

## ◆ research_get()

struct research * research_get | ( | const struct player * | pplayer | ) |

Returns the research structure associated with the player.

Definition at line 126 of file research.c.

Referenced by adjust_improvement_wants_by_effects(), adv_best_government(), adv_data_phase_init(), diplo_wdg::all_advances(), api_edit_give_technology(), api_edit_player_give_bulbs(), api_methods_player_knows_tech(), api_methods_player_shares_research(), api_methods_research_name_translation(), api_methods_research_rule_name(), api_notify_research_embassies_msg(), api_notify_research_msg(), calc_civ_score(), can_player_build_unit_direct(), choose_tech_to_steal(), city_build_building(), client_research_sprite(), cmp_func(), compute_tech_sell_price(), count_stealable_techs(), create_advances_list(), create_animals(), create_barbarian_player(), create_clause_menu(), create_command_newcomer(), create_dummy_reqtree(), create_select_tech_icon(), create_tech_tree(), research_diagram::create_tooltip_help(), dai_choose_diplomat_offensive(), dai_choose_paratrooper(), dai_effect_value(), dai_goldequiv_clause(), dai_goldequiv_tech(), dai_gov_value(), dai_manage_government(), dai_manage_taxes(), dai_manage_tech(), dai_process_defender_want(), dai_select_tech(), dai_share(), dai_tech_base_want(), dai_tech_effect_values(), dai_treaty_evaluate(), dai_wants_defender_against(), dai_wants_role_unit(), dai_war_desire(), diplomacy_dialog_tech_callback(), diplomacy_dialog_tech_callback(), diplomat_get_tech(), do_tech_parasite_effect(), do_unit_establish_trade(), draw_reqtree(), end_phase(), establish_embassy(), find_city_to_diplomat(), forget_tech_transferred(), found_new_tech(), get_bulb_tooltip(), get_bulbs_per_turn(), get_edge_type(), get_info_label_text_popup(), get_researching_info(), get_science_goal_text(), get_science_target_text(), get_tech_color(), government_change(), handle_diplomacy_accept_treaty_req(), handle_edit_player(), handle_edit_player_create(), handle_player_research(), handle_player_tech_goal(), handle_research_info(), helptext_advance(), historian_generic(), is_mintechs_req_active(), is_tech_req_active(), research_diagram::mousePressEvent(), plr_widget::nation_selected(), node_color(), node_rectangle_minimum_size(), notify_research_embassies(), num_known_tech_with_flag(), objbind_get_value_from_object(), objbind_pack_current_values(), player_has_really_useful_tech_parasite(), player_knows_extra_exist(), player_tech_upkeep(), popup_add_menu(), popup_change_research_dialog(), popup_change_research_goal_dialog(), popup_diplomatic_objects(), process_attacker_want(), real_science_report_dialog_update(), real_tech_log(), research_total_bulbs_required(), science_diagram_button_release_callback(), science_diagram_left_button_up(), science_diagram_right_button_up(), science_dialog_text(), science_report_current_callback(), science_report_dialog_popup(), science_report_goal_callback(), science_report_redraw(), science_report_store_set(), science_report_update(), script_tech_learned(), send_city_info(), send_research_info(), set_client_state(), set_indicator_icons(), diplo_wdg::show_menu(), show_new_turn_info(), side_right_click_science(), split_player(), spy_steal_popup_shared(), spy_steal_shared(), steal_a_tech(), suggest_tech_exchange(), tech_can_be_stolen(), tech_transfer(), update_bulbs(), update_intel_dialog(), science_report::update_report(), wipe_unit_full(), and worklist_change_build_target().

## ◆ research_goal_bulbs_required()

int research_goal_bulbs_required | ( | const struct research * | presearch,
|  | Tech_type_id | goal
| ) |  |

Function to determine cost (in bulbs) of reaching goal technology. These costs include the cost for researching the goal technology itself.

'presearch' may be NULL in which case it will returns the total number of bulbs needed for reaching the goal.

Definition at line 769 of file research.c.

Referenced by adjust_improvement_wants_by_effects(), dai_goldequiv_tech(), dai_process_defender_want(), dai_wants_defender_against(), dai_wants_role_unit(), get_science_goal_text(), helptext_advance(), and process_attacker_want().

## ◆ research_goal_step()

Tech_type_id research_goal_step | ( | const struct research * | presearch,
|  | Tech_type_id | goal
| ) |  |

Return the next tech we should research to advance towards our goal. Returns A_UNSET if nothing is available or the goal is already known.

Definition at line 717 of file research.c.

Referenced by end_phase(), found_new_tech(), and init_tech().

## ◆ research_goal_tech_req()

bool research_goal_tech_req | ( | const struct research * | presearch,
|  | Tech_type_id | goal,
|  | Tech_type_id | tech
| ) |  |

Returns if the given tech has to be researched to reach the goal. The goal itself isn't a requirement of itself.

'presearch' may be NULL.

Definition at line 797 of file research.c.

Referenced by dai_choose_paratrooper(), dai_select_tech(), dai_treaty_evaluate(), get_edge_type(), get_science_goal_text(), and node_color().

## ◆ research_goal_unknown_techs()

int research_goal_unknown_techs | ( | const struct research * | presearch,
|  | Tech_type_id | goal
| ) |  |

Returns the number of technologies the player need to research to get the goal technology. This includes the goal technology. Technologies are only counted once.

'presearch' may be NULL in which case it will returns the total number of technologies needed for reaching the goal.

Definition at line 747 of file research.c.

Referenced by adjust_improvement_wants_by_effects(), adv_best_government(), create_tech_tree(), dai_effect_value(), dai_gov_value(), dai_select_tech(), get_science_goal_text(), helptext_advance(), popup_change_research_goal_dialog(), process_attacker_want(), real_tech_log(), and science_report_store_set().

## ◆ research_invention_gettable()

bool research_invention_gettable | ( | const struct research * | presearch,
|  | const Tech_type_id | tech,
|  | bool | allow_holes
| ) |  |

Returns TRUE iff the given tech can be given to the players sharing the research immediately.

If allow_holes is TRUE, any tech with known root reqs is ok. If it's FALSE, getting the tech must not leave holes to the known techs tree.

Definition at line 690 of file research.c.

Referenced by diplo_wdg::all_advances(), choose_tech_to_steal(), create_advances_list(), create_clause_menu(), dai_goldequiv_tech(), dai_select_tech(), dai_share(), diplomacy_dialog_tech_callback(), diplomacy_dialog_tech_callback(), diplomat_get_tech(), do_tech_parasite_effect(), get_tech_color(), handle_diplomacy_accept_treaty_req(), init_tech(), node_color(), player_has_really_useful_tech_parasite(), popup_add_menu(), popup_change_research_dialog(), popup_diplomatic_objects(), diplo_wdg::show_menu(), spy_steal_popup_shared(), spy_steal_shared(), steal_a_tech(), suggest_tech_exchange(), and tech_can_be_stolen().

## ◆ research_invention_reachable()

bool research_invention_reachable | ( | const struct research * | presearch,
|  | const Tech_type_id | tech
| ) |  |

Returns TRUE iff the given tech is ever reachable via research by the players sharing the research by checking tech tree limitations.

'presearch' may be NULL in which case a simplified result is returned (used by the client).

Definition at line 665 of file research.c.

Referenced by create_dummy_reqtree(), dai_select_tech(), dai_wants_defender_against(), dai_wants_role_unit(), handle_player_tech_goal(), helptext_advance(), init_tech(), node_color(), popup_change_research_goal_dialog(), research_goal_step(), science_report_dialog_popup(), science_report_update(), sg_load_sanitycheck(), sg_load_sanitycheck(), update_intel_dialog(), and science_report::update_report().

## ◆ research_invention_set()

enum tech_state research_invention_set | ( | struct research * | presearch,
|  | Tech_type_id | tech,
|  | enum tech_state | value
| ) |  |

Set research knowledge about tech to given state.

Definition at line 634 of file research.c.

Referenced by dai_tech_base_want(), found_new_tech(), handle_edit_player(), handle_research_info(), handle_unknown_research(), init_tech(), research_tech_lost(), sg_load_researches(), sg_load_researches(), and split_player().

## ◆ research_invention_state()

enum tech_state research_invention_state | ( | const struct research * | presearch,
|  | Tech_type_id | tech
| ) |  |

Returns state of the tech for current research. This can be: TECH_KNOWN, TECH_UNKNOWN, or TECH_PREREQS_KNOWN Should be called with existing techs.

If 'presearch' is NULL this checks whether any player knows the tech (used by the client).

Definition at line 616 of file research.c.

Referenced by diplo_wdg::all_advances(), api_edit_give_technology(), api_methods_player_knows_tech(), calc_civ_score(), can_player_build_unit_direct(), choose_tech(), choose_tech_to_steal(), compute_tech_sell_price(), count_stealable_techs(), create_advances_list(), create_clause_menu(), create_tech_tree(), dai_goldequiv_clause(), dai_goldequiv_tech(), dai_manage_government(), dai_select_tech(), dai_share(), dai_tech_base_want(), dai_tech_effect_values(), dai_wants_defender_against(), dai_wants_role_unit(), diplomacy_dialog_tech_callback(), diplomacy_dialog_tech_callback(), diplomat_get_tech(), do_tech_parasite_effect(), found_new_tech(), get_edge_type(), get_tech_color(), give_initial_techs(), handle_diplomacy_accept_treaty_req(), handle_edit_player(), handle_player_research(), handle_player_tech_goal(), helptext_advance(), init_tech(), is_tech_req_active(), research_diagram::mousePressEvent(), plr_widget::nation_selected(), node_color(), objbind_get_value_from_object(), objbind_pack_current_values(), pick_cheapest_tech(), pick_random_tech(), pick_random_tech_to_lose(), player_has_really_useful_tech_parasite(), player_knows_extra_exist(), player_tech_upkeep(), popup_add_menu(), popup_change_research_goal_dialog(), popup_diplomatic_objects(), recalculate_techs_researched(), research_future_next(), research_goal_step(), research_total_bulbs_required(), research_update(), science_diagram_button_release_callback(), science_diagram_left_button_up(), science_report_dialog_popup(), sg_load_sanitycheck(), sg_load_sanitycheck(), sg_save_researches(), diplo_wdg::show_menu(), split_player(), spy_steal_popup_shared(), spy_steal_shared(), steal_a_tech(), suggest_tech_exchange(), tech_can_be_stolen(), tech_transfer(), update_intel_dialog(), and worklist_change_build_target().

## ◆ research_iter_init()

struct iterator * research_iter_init | ( | struct research_iter * | it | ) |

Initializes a player research iterator.

Definition at line 1195 of file research.c.

## ◆ research_iter_sizeof()

size_t research_iter_sizeof | ( | void |  | ) |

Returns the real size of the player research iterator.

Definition at line 1127 of file research.c.

## ◆ research_name_translation()

const char * research_name_translation | ( | const struct research * | presearch | ) |

Returns the name of the research owner: a player name or a team name. For most uses you probably want research_pretty_name() instead.

Definition at line 154 of file research.c.

Referenced by sg_load_sanitycheck(), and sg_load_sanitycheck().

## ◆ research_number()

int research_number | ( | const struct research * | presearch | ) |

Returns the index of the research in the array.

Definition at line 107 of file research.c.

Referenced by init_tech(), package_research_info(), research_name_translation(), research_player_iter_init(), research_pretty_name(), research_rule_name(), send_research_info(), and sg_save_researches().

## ◆ research_player_iter_init()

struct iterator * research_player_iter_init | ( | struct research_player_iter * | it,
|  | const struct research * | presearch
| ) |  |

Initializes a research player iterator.

Definition at line 1287 of file research.c.

## ◆ research_player_iter_sizeof()

size_t research_player_iter_sizeof | ( | void |  | ) |

Returns the real size of the research player iterator.

Definition at line 1217 of file research.c.

## ◆ research_pretty_name()

int research_pretty_name | ( | const struct research * | presearch,
|  | char * | buf,
|  | size_t | buf_len
| ) |  |

Set in 'buf' the name of the research owner. It may be either a nation plural name, or something like "members of team Red".

Definition at line 167 of file research.c.

Referenced by api_edit_give_technology(), api_methods_research_name_translation(), city_build_building(), do_tech_parasite_effect(), found_new_tech(), handle_diplomacy_accept_treaty_req(), research_tech_lost(), steal_a_tech(), and tech_researched().

## ◆ research_rule_name()

const char * research_rule_name | ( | const struct research * | presearch | ) |

Returns the name of the research owner: a player name or a team name.

Definition at line 141 of file research.c.

Referenced by api_methods_research_rule_name(), research_tech_lost(), research_update(), and update_bulbs().

## ◆ research_total_bulbs_required()

int research_total_bulbs_required | ( | const struct research * | presearch,
|  | Tech_type_id | tech,
|  | bool | loss_value
| ) |  |

Function to determine cost for technology. The equation is determined from game.info.tech_cost_style and game.info.tech_leakage.

tech_cost_style: TECH_COST_CIV1CIV2: Civ (I|II) style. Every new tech add base_tech_cost to cost of next tech. TECH_COST_CLASSIC: Cost of technology is: base_tech_cost * (1 + reqs) * sqrt(1 + reqs) / 2 where reqs == number of requirement for tech, counted recursively. TECH_COST_CLASSIC_PRESET: Cost are read from tech.ruleset. Missing costs are generated by style "Classic". TECH_COST_EXPERIMENTAL: Cost of technology is: base_tech_cost * (reqs^2 / (1 + sqrt(sqrt(reqs + 1)))

- 0.5) where reqs == number of requirement for tech, counted recursively. TECH_COST_EXPERIMENTAL_PRESET: Cost are read from tech.ruleset. Missing costs are generated by style "Experimental".

tech_leakage: TECH_LEAKAGE_NONE: No reduction of the technology cost. TECH_LEAKAGE_EMBASSIES: Technology cost is reduced depending on the number of players which already know the tech and you have an embassy with. TECH_LEAKAGE_PLAYERS: Technology cost is reduced depending on the number of all players (human, AI and barbarians) which already know the tech. TECH_LEAKAGE_NO_BARBS: Technology cost is reduced depending on the number of normal players (human and AI) which already know the tech.

At the end we multiply by the sciencebox value, as a percentage. The cost can never be less than 1.

'presearch' may be NULL in which case a simplified result is returned (used by client and manual code).

Definition at line 858 of file research.c.

Referenced by choose_tech(), dai_choose_diplomat_offensive(), dai_manage_tech(), helptext_advance(), init_tech(), lose_tech(), package_research_info(), pick_cheapest_tech(), research_apply_penalty(), research_update(), tech_researched(), and update_bulbs().

## ◆ research_update()

void research_update | ( | struct research * | presearch | ) |

Mark as TECH_PREREQS_KNOWN each tech which is available, not known and which has all requirements fulfilled.

Recalculate presearch->num_known_tech_with_flag Should always be called after research_invention_set().

Definition at line 499 of file research.c.

Referenced by found_new_tech(), government_change(), handle_edit_player(), handle_research_info(), init_tech(), research_tech_lost(), set_client_state(), sg_load_researches(), sg_load_researches(), and split_player().

## ◆ researches_free()

void researches_free | ( | void |  | ) |

Free all resources allocated for the research system

Definition at line 98 of file research.c.

Referenced by game_free().

## ◆ researches_init()

void researches_init | ( | void |  | ) |

Initializes all player research structure.

Definition at line 62 of file research.c.

Referenced by game_init(), and game_reset().