Freeciv21
Develop your civilization from humble roots to a global empire
governor.h File Reference
#include "attribute.h"
#include <set>
+ Include dependency graph for governor.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  governor
 

Functions

void cma_put_city_under_agent (struct city *pcity, const struct cm_parameter *const parameter)
 Put city under governor control. More...
 
void cma_release_city (struct city *pcity)
 Release city from governor control. More...
 
bool cma_is_city_under_agent (const struct city *pcity, struct cm_parameter *parameter)
 Check whether city is under governor control, and fill parameter if it is. More...
 
bool cma_get_parameter (enum attr_city attr, int city_id, struct cm_parameter *parameter)
 Get the parameter. More...
 
void cma_set_parameter (enum attr_city attr, int city_id, const struct cm_parameter *parameter)
 Set attribute block for city from parameter. More...
 
int cities_results_request ()
 
void cma_got_result (int)
 
void cmafec_set_fe_parameter (struct city *pcity, const struct cm_parameter *const parameter)
 Sets the front-end parameter. More...
 
void cmafec_get_fe_parameter (struct city *pcity, struct cm_parameter *dest)
 Return the front-end parameter for the given city. More...
 
const char * cmafec_get_short_descr (const struct cm_parameter *const parameter)
 Returns the description of the matching preset or "custom" if no preset could be found. More...
 
const char * cmafec_get_short_descr_of_city (const struct city *pcity)
 Return short description of city governor preset. More...
 
void cmafec_preset_add (const char *descr_name, const cm_parameter *pparam)
 Adds a preset. More...
 
void cmafec_preset_remove (int idx)
 Removes a preset. More...
 
int cmafec_preset_get_index_of_parameter (const struct cm_parameter *const parameter)
 Returns the index of the preset which matches the given parameter. More...
 
char * cmafec_preset_get_descr (int idx)
 Returns the indexed preset's description. More...
 
const struct cm_parametercmafec_preset_get_parameter (int idx)
 Returns the indexed preset's parameter. More...
 
int cmafec_preset_num ()
 Returns the total number of presets. More...
 
void create_default_cma_presets ()
 Create default cma presets for a new user (or without configuration file) More...
 

Function Documentation

◆ cities_results_request()

int cities_results_request ( )

Definition at line 204 of file governor.cpp.

Referenced by input_from_server().

◆ cma_get_parameter()

bool cma_get_parameter ( enum attr_city  attr,
int  city_id,
struct cm_parameter parameter 
)

Get the parameter.

Don't bother to cm_init_parameter, since we set all the fields anyway. But leave the comment here so we can find this place when searching for all the creators of a parameter.

Definition at line 645 of file governor.cpp.

Referenced by cma_yoloswag::check_city(), cmafec_get_fe_parameter(), and cma_yoloswag::is_city_under_agent().

◆ cma_got_result()

void cma_got_result ( int  citynr)

Definition at line 206 of file governor.cpp.

Referenced by input_from_server().

◆ cma_is_city_under_agent()

◆ cma_put_city_under_agent()

void cma_put_city_under_agent ( struct city pcity,
const struct cm_parameter *const  parameter 
)

Put city under governor control.

Definition at line 618 of file governor.cpp.

Referenced by city_dialog::cma_changed(), city_dialog::cma_double_clicked(), city_dialog::cma_selected(), and city_widget::display_list_menu().

◆ cma_release_city()

void cma_release_city ( struct city pcity)

Release city from governor control.

Definition at line 627 of file governor.cpp.

Referenced by cma_yoloswag::check_city(), client_state(), city_dialog::cma_enable(), city_widget::display_list_menu(), and cma_yoloswag::handle_city().

◆ cma_set_parameter()

void cma_set_parameter ( enum attr_city  attr,
int  city_id,
const struct cm_parameter parameter 
)

Set attribute block for city from parameter.

Definition at line 654 of file governor.cpp.

Referenced by cmafec_set_fe_parameter(), and cma_yoloswag::put_city_under_agent().

◆ cmafec_get_fe_parameter()

void cmafec_get_fe_parameter ( struct city pcity,
struct cm_parameter dest 
)

Return the front-end parameter for the given city.

Returns a dummy parameter if no parameter was set.

Definition at line 673 of file governor.cpp.

Referenced by city_dialog::update_cma_tab().

◆ cmafec_get_short_descr()

const char* cmafec_get_short_descr ( const struct cm_parameter *const  parameter)

Returns the description of the matching preset or "custom" if no preset could be found.

Definition at line 790 of file governor.cpp.

Referenced by cmafec_get_short_descr_of_city().

◆ cmafec_get_short_descr_of_city()

const char* cmafec_get_short_descr_of_city ( const struct city pcity)

Return short description of city governor preset.

Definition at line 774 of file governor.cpp.

Referenced by city_dialog::update_cma_tab().

◆ cmafec_preset_add()

void cmafec_preset_add ( const char *  descr_name,
const cm_parameter pparam 
)

Adds a preset.

Definition at line 692 of file governor.cpp.

Referenced by create_default_cma_presets(), and load_cma_preset().

◆ cmafec_preset_get_descr()

char* cmafec_preset_get_descr ( int  idx)

Returns the indexed preset's description.

Definition at line 725 of file governor.cpp.

Referenced by city_dialog::cma_remove(), cmafec_get_short_descr(), city_widget::gen_cma_labels(), save_cma_preset(), and city_dialog::update_cma_tab().

◆ cmafec_preset_get_index_of_parameter()

int cmafec_preset_get_index_of_parameter ( const struct cm_parameter *const  parameter)

Returns the index of the preset which matches the given parameter.

Returns -1 if no preset could be found.

Definition at line 752 of file governor.cpp.

Referenced by cmafec_get_short_descr(), and city_dialog::update_cma_tab().

◆ cmafec_preset_get_parameter()

const struct cm_parameter* cmafec_preset_get_parameter ( int  idx)

◆ cmafec_preset_num()

◆ cmafec_preset_remove()

void cmafec_preset_remove ( int  idx)

Removes a preset.

Definition at line 709 of file governor.cpp.

Referenced by city_dialog::cma_remove().

◆ cmafec_set_fe_parameter()

void cmafec_set_fe_parameter ( struct city pcity,
const struct cm_parameter *const  parameter 
)

Sets the front-end parameter.

Definition at line 663 of file governor.cpp.

Referenced by cmafec_get_fe_parameter().

◆ create_default_cma_presets()

void create_default_cma_presets ( )

Create default cma presets for a new user (or without configuration file)

Definition at line 804 of file governor.cpp.