Freeciv-3.2
Loading...
Searching...
No Matches
Data Structures | Macros | Functions
maphand.h File Reference
#include "fc_types.h"
#include "map.h"
#include "packets.h"
#include "terrain.h"
#include "vision.h"
#include <hand_gen.h>

Go to the source code of this file.

Data Structures

struct  player_tile
 

Macros

#define map_get_playermap_site(_plrtile_)   (_plrtile_)->site
 
#define map_get_player_site(_ptile_, _pplayer_)    map_get_playermap_site(map_get_player_tile(_ptile_, _pplayer_))
 

Functions

void global_warming (int effect)
 
void nuclear_winter (int effect)
 
void climate_change (bool warming, int effect)
 
bool upgrade_city_extras (struct city *pcity, struct extra_type **gained)
 
void upgrade_all_city_extras (struct player *pplayer, bool discovery)
 
void give_map_from_player_to_player (struct player *pfrom, struct player *pdest)
 
void give_seamap_from_player_to_player (struct player *pfrom, struct player *pdest)
 
void give_citymap_from_player_to_player (struct city *pcity, struct player *pfrom, struct player *pdest)
 
void send_all_known_tiles (struct conn_list *dest)
 
bool send_tile_suppression (bool now)
 
void send_tile_info (struct conn_list *dest, struct tile *ptile, bool send_unknown)
 
void send_map_info (struct conn_list *dest)
 
void map_show_tile (struct player *pplayer, struct tile *ptile)
 
void map_hide_tile (struct player *pplayer, struct tile *ptile)
 
void map_show_circle (struct player *pplayer, struct tile *ptile, int radius_sq)
 
void map_vision_update (struct player *pplayer, struct tile *ptile, const v_radius_t old_radius_sq, const v_radius_t new_radius_sq, bool can_reveal_tiles)
 
void map_set_border_vision (struct player *pplayer, const bool is_enabled)
 
void map_show_all (struct player *pplayer)
 
bool map_is_known_and_seen (const struct tile *ptile, const struct player *pplayer, enum vision_layer vlayer)
 
bool map_is_known (const struct tile *ptile, const struct player *pplayer)
 
void map_set_known (struct tile *ptile, struct player *pplayer)
 
void map_clear_known (struct tile *ptile, struct player *pplayer)
 
void map_know_and_see_all (struct player *pplayer)
 
void show_map_to_all (void)
 
void player_map_init (struct player *pplayer)
 
void player_map_free (struct player *pplayer)
 
void remove_player_from_maps (struct player *pplayer)
 
struct vision_sitemap_get_player_city (const struct tile *ptile, const struct player *pplayer)
 
struct player_tilemap_get_player_tile (const struct tile *ptile, const struct player *pplayer)
 
bool update_player_tile_knowledge (struct player *pplayer, struct tile *ptile)
 
void update_tile_knowledge (struct tile *ptile)
 
void update_player_tile_last_seen (struct player *pplayer, struct tile *ptile)
 
void give_shared_vision (struct player *pfrom, struct player *pto)
 
void remove_shared_vision (struct player *pfrom, struct player *pto)
 
bool really_gives_vision (struct player *me, struct player *them)
 
void enable_fog_of_war (void)
 
void disable_fog_of_war (void)
 
void enable_fog_of_war_player (struct player *pplayer)
 
void disable_fog_of_war_player (struct player *pplayer)
 
void map_calculate_borders (void)
 
void map_claim_border (struct tile *ptile, struct player *powner, int radius_sq)
 
void map_claim_ownership (struct tile *ptile, struct player *powner, struct tile *psource, bool claim_bases)
 
void map_clear_border (struct tile *ptile)
 
void map_update_border (struct tile *ptile, struct player *owner, int old_radius_sq, int new_radius_sq)
 
void tile_claim_bases (struct tile *ptile, struct player *powner)
 
void map_claim_base (struct tile *ptile, struct extra_type *pextra, struct player *powner, struct player *ploser)
 
void terrain_changed (struct tile *ptile)
 
void check_terrain_change (struct tile *ptile, struct terrain *oldter)
 
void fix_tile_on_terrain_change (struct tile *ptile, struct terrain *oldter, bool extend_rivers)
 
bool need_to_reassign_continents (const struct terrain *oldter, const struct terrain *newter)
 
void bounce_units_on_terrain_change (struct tile *ptile)
 
void vision_change_sight (struct vision *vision, const v_radius_t radius_sq)
 
void vision_clear_sight (struct vision *vision)
 
void change_playertile_site (struct player_tile *ptile, struct vision_site *new_site)
 
void create_extra (struct tile *ptile, struct extra_type *pextra, struct player *pplayer)
 
void destroy_extra (struct tile *ptile, struct extra_type *pextra)
 
bool give_distorted_map (struct player *pfrom, struct player *pto, int prob, bool reveal_cities)
 
void tile_change_side_effects (struct tile *ptile, bool refresh_city) fc__attribute((nonnull(1)))
 

Macro Definition Documentation

◆ map_get_player_site

Definition at line 93 of file maphand.h.

◆ map_get_playermap_site

#define map_get_playermap_site (   _plrtile_)    (_plrtile_)->site

Definition at line 92 of file maphand.h.

Function Documentation

◆ bounce_units_on_terrain_change()

void bounce_units_on_terrain_change ( struct tile ptile)

Check ptile and nearby tiles to see if all units can remain at their current locations, and move or disband any that cannot. Call this after terrain or specials change on ptile.

Parameters
ptileTile where the terrain may have changed

Definition at line 1919 of file maphand.c.

Referenced by create_extra(), terrain_changed(), and update_unit_activity().

◆ change_playertile_site()

void change_playertile_site ( struct player_tile ptile,
struct vision_site new_site 
)

Changes site information for player tile.

Definition at line 1159 of file maphand.c.

Referenced by remove_player_from_maps(), sg_load_player_vision(), sg_load_player_vision(), and update_dumb_city().

◆ check_terrain_change()

void check_terrain_change ( struct tile ptile,
struct terrain oldter 
)

Handles local and global side effects for a terrain change for a single tile. Call this in the server immediately after calling tile_change_terrain(). Assumes an in-game terrain change (e.g., by workers/engineers).

Definition at line 1995 of file maphand.c.

Referenced by check_terrain_change(), climate_change(), and update_unit_activity().

◆ climate_change()

void climate_change ( bool  warming,
int  effect 
)

Do a climate change. Global warming occurred if 'warming' is TRUE, else there is a nuclear winter.

Definition at line 133 of file maphand.c.

Referenced by api_edit_climate_change(), global_warming(), and nuclear_winter().

◆ create_extra()

void create_extra ( struct tile ptile,
struct extra_type pextra,
struct player pplayer 
)

Create extra to tile.

Definition at line 2556 of file maphand.c.

Referenced by api_edit_create_owned_extra(), begin_phase(), fc_interface_init_server(), and update_unit_activity().

◆ destroy_extra()

void destroy_extra ( struct tile ptile,
struct extra_type pextra 
)

Remove extra from tile.

Definition at line 2621 of file maphand.c.

Referenced by create_city(), create_extra(), fc_interface_init_server(), unit_enter_hut(), and update_unit_activity().

◆ disable_fog_of_war()

void disable_fog_of_war ( void  )

Turns FoW off for everyone

Definition at line 1789 of file maphand.c.

Referenced by begin_turn().

◆ disable_fog_of_war_player()

void disable_fog_of_war_player ( struct player pplayer)

Turns FoW off for player

Definition at line 1773 of file maphand.c.

Referenced by check_leaving_edit_mode(), disable_fog_of_war(), and handle_edit_toggle_fogofwar().

◆ enable_fog_of_war()

void enable_fog_of_war ( void  )

Turns FoW on for everyone.

Definition at line 1763 of file maphand.c.

Referenced by begin_turn().

◆ enable_fog_of_war_player()

void enable_fog_of_war_player ( struct player pplayer)

Turns FoW on for player

Definition at line 1747 of file maphand.c.

Referenced by check_leaving_edit_mode(), enable_fog_of_war(), and handle_edit_toggle_fogofwar().

◆ fix_tile_on_terrain_change()

void fix_tile_on_terrain_change ( struct tile ptile,
struct terrain oldter,
bool  extend_rivers 
)

Handles local side effects for a terrain change (tile and its surroundings). Does not handle global side effects (such as reassigning continents). For in-game terrain changes 'extend_rivers' should be TRUE; for edits it should be FALSE.

Definition at line 1975 of file maphand.c.

Referenced by api_edit_change_terrain(), check_terrain_change(), and edit_tile_terrain_handling().

◆ give_citymap_from_player_to_player()

void give_citymap_from_player_to_player ( struct city pcity,
struct player pfrom,
struct player pdest 
)

Give information about tiles within city radius from player to player

Definition at line 418 of file maphand.c.

Referenced by handle_diplomacy_create_clause_req(), and transfer_city().

◆ give_distorted_map()

bool give_distorted_map ( struct player pfrom,
struct player pto,
int  prob,
bool  reveal_cities 
)

Transfer (random parts of) player pfrom's world map to pto.

Parameters
pfromplayer that is the source of the map
ptoplayer that receives the map
probprobability for the transfer each known tile
reveal_citiesif the map of all known cities should be transferred
Returns
Whether there any new info was given

Definition at line 2696 of file maphand.c.

Referenced by player_loot_player(), and spy_steal_some_maps().

◆ give_map_from_player_to_player()

void give_map_from_player_to_player ( struct player pfrom,
struct player pdest 
)

Give information about whole map (all tiles) from player to player. Takes care of shared vision chains.

Definition at line 384 of file maphand.c.

Referenced by handle_diplomacy_accept_treaty_req(), and split_player().

◆ give_seamap_from_player_to_player()

void give_seamap_from_player_to_player ( struct player pfrom,
struct player pdest 
)

Give information about all oceanic tiles from player to player

Definition at line 400 of file maphand.c.

Referenced by handle_diplomacy_accept_treaty_req().

◆ give_shared_vision()

void give_shared_vision ( struct player pfrom,
struct player pto 
)

Starts shared vision between two players.

Definition at line 1632 of file maphand.c.

Referenced by handle_diplomacy_accept_treaty_req(), sg_load_players(), sg_load_players(), and srv_ready().

◆ global_warming()

void global_warming ( int  effect)

Wrapper for climate_change().

Definition at line 106 of file maphand.c.

Referenced by end_turn(), and receive_packet_game_info_100().

◆ map_calculate_borders()

void map_calculate_borders ( void  )

Update borders for all sources. Call this on turn end.

Definition at line 2373 of file maphand.c.

Referenced by end_turn(), handle_edit_recalculate_borders(), server_remove_player(), sg_load_players(), and sg_load_players().

◆ map_claim_base()

void map_claim_base ( struct tile ptile,
struct extra_type pextra,
struct player powner,
struct player ploser 
)

Claim base to player's ownership.

Definition at line 2400 of file maphand.c.

Referenced by create_extra(), maybe_claim_base(), and tile_claim_bases().

◆ map_claim_border()

void map_claim_border ( struct tile ptile,
struct player owner,
int  radius_sq 
)

Update borders for this source. Call this for each new source.

If radius_sq is -1, get value from the border source on tile.

Definition at line 2286 of file maphand.c.

Referenced by city_change_size(), city_populate(), create_city(), map_calculate_borders(), map_claim_base(), map_update_border(), and transfer_city().

◆ map_claim_ownership()

void map_claim_ownership ( struct tile ptile,
struct player powner,
struct tile psource,
bool  claim_bases 
)

◆ map_clear_border()

void map_clear_border ( struct tile ptile)

Remove border for this source.

Definition at line 2237 of file maphand.c.

Referenced by check_terrain_change(), destroy_extra(), map_claim_base(), map_claim_border(), remove_city(), and transfer_city().

◆ map_clear_known()

void map_clear_known ( struct tile ptile,
struct player pplayer 
)

Clear known status of the tile.

Definition at line 1186 of file maphand.c.

Referenced by create_barbarian_player(), map_hide_tile(), and remove_player_from_maps().

◆ map_get_player_city()

struct vision_site * map_get_player_city ( const struct tile ptile,
const struct player pplayer 
)

Returns city located at given tile from player map.

Definition at line 1367 of file maphand.c.

Referenced by mapimg_server_tile_city(), package_dumb_city(), reality_check_city(), remove_dumb_city(), sg_save_player_vision(), spy_send_sabotage_list(), and update_dumb_city().

◆ map_get_player_tile()

struct player_tile * map_get_player_tile ( const struct tile ptile,
const struct player pplayer 
)

◆ map_hide_tile()

void map_hide_tile ( struct player src_player,
struct tile ptile 
)

Hides the area to the player.

Callers may wish to buffer_shared_vision() before calling this function.

Definition at line 820 of file maphand.c.

Referenced by handle_edit_player_vision().

◆ map_is_known()

bool map_is_known ( const struct tile ptile,
const struct player pplayer 
)

◆ map_is_known_and_seen()

bool map_is_known_and_seen ( const struct tile ptile,
const struct player pplayer,
enum vision_layer  vlayer 
)

◆ map_know_and_see_all()

void map_know_and_see_all ( struct player pplayer)

Call this function to unfog all tiles. This should only be called when a player dies or at the end of the game as it will result in permanent vision of the whole map.

Definition at line 1196 of file maphand.c.

Referenced by kill_player(), sg_load_player_vision(), sg_load_player_vision(), and show_map_to_all().

◆ map_set_border_vision()

void map_set_border_vision ( struct player pplayer,
const bool  is_enabled 
)

Turn a player's ability to see inside their borders on or off.

It is safe to set the current value.

Definition at line 740 of file maphand.c.

Referenced by do_border_vision_effect().

◆ map_set_known()

void map_set_known ( struct tile ptile,
struct player pplayer 
)

Set known status of the tile.

Definition at line 1178 of file maphand.c.

Referenced by map_change_seen(), map_show_tile(), really_give_tile_info_from_player_to_player(), sg_load_map_known(), and sg_load_map_known().

◆ map_show_all()

void map_show_all ( struct player pplayer)

Shows the area to the player. Unless the tile is "seen", it will remain fogged and units will be hidden.

Definition at line 879 of file maphand.c.

Referenced by do_reveal_effects(), and srv_ready().

◆ map_show_circle()

void map_show_circle ( struct player pplayer,
struct tile ptile,
int  radius_sq 
)

Shows the area to the player. Unless the tile is "seen", it will remain fogged and units will be hidden.

Definition at line 864 of file maphand.c.

Referenced by do_paradrop(), handle_edit_unit_create(), illegal_action_pay_price(), init_new_game(), place_starting_unit(), try_summon_barbarians(), and unleash_barbarians().

◆ map_show_tile()

void map_show_tile ( struct player src_player,
struct tile ptile 
)

Shows the area to the player. Unless the tile is "seen", it will remain fogged and units will be hidden.

Callers may wish to buffer_shared_vision() before calling this function.

Definition at line 768 of file maphand.c.

Referenced by api_edit_tile_show(), create_city_for_player(), do_reveal_effects(), do_unit_establish_trade(), handle_edit_player_vision(), map_show_all(), map_show_circle(), reestablish_city_trade_routes(), and remove_city().

◆ map_update_border()

void map_update_border ( struct tile ptile,
struct player owner,
int  old_radius_sq,
int  new_radius_sq 
)

Update borders for this source. Changes the radius without temporary clearing.

Definition at line 2254 of file maphand.c.

Referenced by city_reduce_size().

◆ map_vision_update()

void map_vision_update ( struct player pplayer,
struct tile ptile,
const v_radius_t  old_radius_sq,
const v_radius_t  new_radius_sq,
bool  can_reveal_tiles 
)

There doesn't have to be a city.

Definition at line 685 of file maphand.c.

Referenced by destroy_extra(), map_claim_base(), and vision_change_sight().

◆ need_to_reassign_continents()

bool need_to_reassign_continents ( const struct terrain oldter,
const struct terrain newter 
)

Returns TRUE if the terrain change from 'oldter' to 'newter' may require expensive reassignment of continents.

Definition at line 1937 of file maphand.c.

Referenced by api_edit_change_terrain(), check_terrain_change(), and edit_tile_terrain_handling().

◆ nuclear_winter()

void nuclear_winter ( int  effect)

Wrapper for climate_change().

Definition at line 119 of file maphand.c.

Referenced by end_turn(), and receive_packet_game_info_100().

◆ player_map_free()

void player_map_free ( struct player pplayer)

Free a player's private map.

Definition at line 1237 of file maphand.c.

Referenced by server_player_init(), and server_remove_player().

◆ player_map_init()

void player_map_init ( struct player pplayer)

Allocate space for map, and initialise the tiles. Uses current map.xsize and map.ysize.

Definition at line 1221 of file maphand.c.

Referenced by server_player_init(), sg_load_map_known(), sg_load_map_known(), and srv_ready().

◆ really_gives_vision()

bool really_gives_vision ( struct player me,
struct player them 
)

◆ remove_player_from_maps()

void remove_player_from_maps ( struct player pplayer)

Remove all knowledge of a player from main map and other players' private maps, and send updates to connected clients. Frees all vision_sites associated with that player.

Definition at line 1258 of file maphand.c.

Referenced by server_remove_player().

◆ remove_shared_vision()

void remove_shared_vision ( struct player pfrom,
struct player pto 
)

Removes shared vision from between two players.

Definition at line 1693 of file maphand.c.

Referenced by dai_diplomacy_actions(), dai_go_to_war(), dai_revolution_start(), handle_diplomacy_cancel_pact(), kill_player(), and server_remove_player().

◆ send_all_known_tiles()

void send_all_known_tiles ( struct conn_list dest)

Send all tiles known to specified clients. If dest is NULL means game.est_connections.

Note for multiple connections this may change "sent" multiple times for single player. This is ok, because "sent" data is just optimised calculations, so it will be correct before this, for each connection during this, and at end.

Definition at line 444 of file maphand.c.

Referenced by api_edit_change_terrain(), check_edited_tile_terrains(), check_terrain_change(), and send_all_info().

◆ send_map_info()

void send_map_info ( struct conn_list dest)

Send basic map information: map size, topology, and is_earth.

Definition at line 649 of file maphand.c.

Referenced by send_all_info().

◆ send_tile_info()

void send_tile_info ( struct conn_list dest,
struct tile ptile,
bool  send_unknown 
)

Send tile information to all the clients in dest which know and see the tile. If dest is NULL, sends to all clients (game.est_connections) which know and see tile.

Note that this function does not update the playermap. For that call update_tile_knowledge().

Definition at line 491 of file maphand.c.

Referenced by api_edit_tile_hide(), api_edit_tile_set_label(), city_map_update_empty(), city_map_update_tile_direct(), city_map_update_worker(), destroy_extra(), found_new_tech(), handle_edit_tile(), handle_player_place_infra(), map_change_seen(), map_claim_border_ownership(), map_hide_tile(), map_show_tile(), really_give_tile_info_from_player_to_player(), remove_city(), remove_player_from_maps(), send_all_known_tiles(), and update_tile_knowledge().

◆ send_tile_suppression()

bool send_tile_suppression ( bool  now)

Suppress send_tile_info() during game_load()

Definition at line 475 of file maphand.c.

Referenced by savegame2_load(), and savegame3_load().

◆ show_map_to_all()

void show_map_to_all ( void  )

Unfogs all tiles for all players. See map_know_and_see_all.

Definition at line 1210 of file maphand.c.

Referenced by srv_scores().

◆ terrain_changed()

void terrain_changed ( struct tile ptile)

Handle local side effects for a terrain change.

Definition at line 1956 of file maphand.c.

Referenced by edit_tile_extra_handling(), and fix_tile_on_terrain_change().

◆ tile_change_side_effects()

void tile_change_side_effects ( struct tile ptile,
bool  refresh_city 
)

Handle various side effects of the change on tile. If a city was working the tile, that city might need refresh after this call.

Parameters
ptiletile that has changed
refresh_citywhether city working the tile should be refreshed

Definition at line 2724 of file maphand.c.

Referenced by api_edit_change_terrain(), api_edit_create_owned_extra(), api_edit_remove_extra(), climate_change(), edit_tile_extra_handling(), edit_tile_terrain_handling(), end_turn(), handle_edit_tile(), remove_city(), and update_unit_activity().

◆ tile_claim_bases()

void tile_claim_bases ( struct tile ptile,
struct player powner 
)

Claim ownership of bases on single tile.

Definition at line 2220 of file maphand.c.

Referenced by map_claim_ownership(), sg_load_map_owner(), sg_load_map_owner(), sg_load_player_units(), and unit_move().

◆ update_player_tile_knowledge()

bool update_player_tile_knowledge ( struct player pplayer,
struct tile ptile 
)

Give pplayer the correct knowledge about tile; return TRUE iff knowledge changed.

Note that unlike update_tile_knowledge, this function will not send any packets to the client. Callers may want to call send_tile_info() if this function returns TRUE.

Definition at line 1398 of file maphand.c.

Referenced by destroy_extra(), found_new_tech(), map_change_seen(), map_show_tile(), sg_load_player_vision(), sg_load_player_vision(), and update_tile_knowledge().

◆ update_player_tile_last_seen()

void update_player_tile_last_seen ( struct player pplayer,
struct tile ptile 
)

Remember that tile was last seen this year.

Definition at line 1467 of file maphand.c.

Referenced by map_change_seen(), map_hide_tile(), map_show_tile(), sg_load_player_vision(), and sg_load_player_vision().

◆ update_tile_knowledge()

void update_tile_knowledge ( struct tile ptile)

Update playermap knowledge for everybody who sees the tile, and send a packet to everyone whose info is changed.

Note this only checks for changing of the terrain, special, or resource for the tile, since these are the only values held in the playermap.

A tile's owner always can see terrain changes in their territory.

Definition at line 1439 of file maphand.c.

Referenced by api_edit_change_terrain(), api_edit_create_owned_extra(), api_edit_remove_extra(), begin_phase(), check_terrain_change(), climate_change(), create_city(), do_nuke_tile(), edit_tile_extra_handling(), edit_tile_terrain_handling(), end_turn(), handle_edit_tile(), map_claim_border_ownership(), place_pollution(), place_starting_unit(), transfer_city(), try_summon_barbarians(), unit_enter_hut(), update_unit_activity(), and upgrade_all_city_extras().

◆ upgrade_all_city_extras()

void upgrade_all_city_extras ( struct player pplayer,
bool  discovery 
)

To be called when a player gains some better extra building tech for the first time. Sends a message, and upgrades all city squares to new extras. "discovery" just affects the message: set to 1 if the tech is a "discovery", 0 if otherwise acquired (conquer/trade/GLib). –dwp

Definition at line 276 of file maphand.c.

Referenced by found_new_tech().

◆ upgrade_city_extras()

bool upgrade_city_extras ( struct city pcity,
struct extra_type **  gained 
)

Check city for extra upgrade. Returns whether anything was done. gained will be set if there's exactly one kind of extra added.

Definition at line 241 of file maphand.c.

Referenced by create_city(), result_defense_bonus(), terrain_changed(), transfer_city(), and upgrade_all_city_extras().

◆ vision_change_sight()

void vision_change_sight ( struct vision vision,
const v_radius_t  radius_sq 
)

Change the sight points for the vision source, fogging or unfogging tiles as needed.

See documentation in vision.h.

Definition at line 2521 of file maphand.c.

Referenced by city_refresh_vision(), transfer_city(), unit_move_by_data(), unit_refresh_vision(), and vision_clear_sight().

◆ vision_clear_sight()

void vision_clear_sight ( struct vision vision)

Clear all sight points from this vision source.

See documentation in vision.h.

Definition at line 2533 of file maphand.c.

Referenced by remove_city(), server_remove_unit_full(), transfer_city(), unit_change_homecity_handling(), and unit_move().