This class wraps around a map to provide a concise interface for the editor to work with. More...
#include <map_context.hpp>
Public Member Functions | |
map_context (const map_context &)=delete | |
map_context & | operator= (const map_context &)=delete |
map_context (const editor_map &map, bool pure_map, const config &schedule) | |
Create a map context from an existing map. More... | |
map_context (const game_config_view &game_config, const std::string &filename) | |
Create map_context from a map file. More... | |
virtual | ~map_context () |
Map context destructor. More... | |
bool | select_area (int index) |
Select the nth tod area. More... | |
void | new_side () |
Adds a new side to the map. More... | |
void | remove_side () |
removes the last side from the scenario More... | |
void | save_area (const std::set< map_location > &area) |
void | new_area (const std::set< map_location > &area) |
void | remove_area (int index) |
map_labels & | get_labels () |
void | replace_schedule (const std::vector< time_of_day > &schedule) |
virtual const unit_map & | units () const override |
Const units accessor. More... | |
unit_map & | units () |
Local non-const overload of units. More... | |
virtual const std::vector< team > & | teams () const override |
Const teams accessor. More... | |
std::vector< team > & | teams () |
Local non-const overload of teams. More... | |
virtual const editor_map & | map () const override |
Const map accessor. More... | |
editor_map & | map () |
Local non-const overload of map. More... | |
virtual const std::vector< std::string > & | hidden_label_categories () const override |
virtual std::vector< std::string > & | hidden_label_categories () override |
void | replace_local_schedule (const std::vector< time_of_day > &schedule) |
Replace the [time]s of the currently active area. More... | |
void | set_starting_time (int time) |
TODO. More... | |
void | set_local_starting_time (int time) |
TODO. More... | |
const tod_manager * | get_time_manager () const |
tod_manager * | get_time_manager () |
mp_game_settings & | get_mp_settings () |
game_classification & | get_classification () |
int | get_active_area () const |
void | set_active_area (int index) |
bool | is_in_playlist (std::string track_id) |
void | add_to_playlist (const sound::music_track &track) |
void | draw_terrain (const t_translation::terrain_code &terrain, const map_location &loc, bool one_layer_only=false) |
Draw a terrain on a single location on the map. More... | |
void | draw_terrain_actual (const t_translation::terrain_code &terrain, const map_location &loc, bool one_layer_only=false) |
Actual drawing function used by both overloaded variants of draw_terrain. More... | |
void | draw_terrain (const t_translation::terrain_code &terrain, const std::set< map_location > &locs, bool one_layer_only=false) |
Draw a terrain on a set of locations on the map. More... | |
bool | needs_reload () const |
Getter for the reload flag. More... | |
void | set_needs_reload (bool value=true) |
Setter for the reload flag. More... | |
bool | needs_terrain_rebuild () const |
Getter for the terrain rebuild flag. More... | |
void | set_needs_terrain_rebuild (bool value=true) |
Setter for the terrain rebuild flag. More... | |
void | set_scenario_setup (const std::string &id, const std::string &name, const std::string &description, int turns, int xp_mod, bool victory_defeated, bool random_time) |
TODO. More... | |
void | set_side_setup (editor_team_info &info) |
TODO. More... | |
bool | needs_labels_reset () const |
Getter for the labels reset flag. More... | |
void | set_needs_labels_reset (bool value=true) |
Setter for the labels reset flag. More... | |
const std::set< map_location > | changed_locations () const |
void | clear_changed_locations () |
void | add_changed_location (const map_location &loc) |
void | add_changed_location (const std::set< map_location > &locs) |
void | set_everything_changed () |
bool | everything_changed () const |
void | set_labels (display &disp) |
void | clear_starting_position_labels (display &disp) |
void | set_starting_position_labels (display &disp) |
void | reset_starting_position_labels (display &disp) |
const std::string & | get_filename () const |
void | set_filename (const std::string &fn) |
const std::string & | get_map_data_key () const |
const std::string & | get_id () const |
const std::string & | get_description () const |
const std::string & | get_name () const |
const t_string | get_default_context_name () const |
std::optional< int > | get_xp_mod () const |
bool | random_start_time () const |
bool | victory_defeated () const |
bool | is_embedded () const |
bool | is_pure_map () const |
void | set_embedded (bool v) |
bool | save_map () |
Saves the map under the current filename. More... | |
bool | save_scenario () |
Saves the scenario under the current filename. More... | |
void | load_scenario () |
config | to_config () |
void | set_map (const editor_map &map) |
void | perform_action (const editor_action &action) |
Performs an action (thus modifying the map). More... | |
void | perform_partial_action (const editor_action &action) |
Performs a partial action, assumes that the top undo action has been modified to maintain coherent state of the undo stacks, and so a new undo action is not created. More... | |
bool | modified () const |
void | clear_modified () |
Clear the modified state. More... | |
void | add_to_recent_files () |
Adds the map to the editor's recent files list. More... | |
bool | can_undo () const |
bool | can_redo () const |
editor_action * | last_undo_action () |
editor_action * | last_redo_action () |
const editor_action * | last_undo_action () const |
const version of last_undo_action More... | |
const editor_action * | last_redo_action () const |
const version of last_redo_action More... | |
void | undo () |
Un-does the last action, and puts it in the redo stack for a possible redo. More... | |
void | redo () |
Re-does a previously undid action, and puts it back in the undo stack. More... | |
void | partial_undo () |
Un-does a single step from a undo action chain. More... | |
void | clear_undo_redo () |
Clear the undo and redo stacks. More... | |
overlay_map & | get_overlays () |
![]() | |
const team & | get_team (int side) const |
template<typename T = void> | |
bool | has_team (int side) const |
bool | would_be_discovered (const map_location &loc, int side_num, bool see_all=true) |
Given a location and a side number, indicates whether an invisible unit of that side at that location would be revealed (perhaps ambushed), based on what team side_num can see. More... | |
const unit * | get_visible_unit (const map_location &loc, const team ¤t_team, bool see_all=false) const |
unit_const_ptr | get_visible_unit_shared_ptr (const map_location &loc, const team ¤t_team, bool see_all=false) const |
can_move_result | unit_can_move (const unit &u) const |
Work out what u can do - this does not check which player's turn is currently active, the result is calculated assuming that the unit's owner is currently active. More... | |
orb_status | unit_orb_status (const unit &u) const |
Returns an enumurated summary of whether this unit can move and/or attack. More... | |
int | village_owner (const map_location &loc) const |
Given the location of a village, will return the 1-based number of the team that currently owns it, and 0 if it is unowned. More... | |
int | side_units (int side_num) const |
Returns the number of units of the side side_num. More... | |
int | side_units_cost (int side_num) const |
Returns the total cost of units of side side_num. More... | |
int | side_upkeep (int side_num) const |
bool | is_observer () const |
Check if we are an observer in this game. More... | |
virtual | ~display_context () |
Protected Member Functions | |
void | trim_stack (action_stack &stack) |
Checks if an action stack reached its capacity and removes the front element if so. More... | |
void | perform_action_between_stacks (action_stack &from, action_stack &to) |
Perform an action at the back of one stack, and then move it to the back of the other stack. More... | |
Protected Attributes | |
std::string | filename_ |
The actual filename of this map. More... | |
std::string | map_data_key_ |
When a scenario file is loaded, the referenced map is loaded instead. More... | |
bool | embedded_ |
Whether the map context refers to a map embedded in a scenario file. More... | |
bool | pure_map_ |
Whether the map context refers to a file containing only the pure map data. More... | |
editor_map | map_ |
The map object of this map_context. More... | |
action_stack | undo_stack_ |
The undo stack. More... | |
action_stack | redo_stack_ |
The redo stack. More... | |
int | actions_since_save_ |
Number of actions performed since the map was saved. More... | |
std::set< map_location > | starting_position_label_locs_ |
Cache of set starting position labels. More... | |
bool | needs_reload_ |
Refresh flag indicating the map in this context should be completely reloaded by the display. More... | |
bool | needs_terrain_rebuild_ |
Refresh flag indicating the terrain in the map has changed and requires a rebuild. More... | |
bool | needs_labels_reset_ |
Refresh flag indicating the labels in the map have changed. More... | |
std::set< map_location > | changed_locations_ |
bool | everything_changed_ |
Static Protected Attributes | |
static const std::size_t | max_action_stack_size_ = 100 |
Action stack (i.e. More... | |
Private Types | |
typedef std::map< std::string, sound::music_track > | music_map |
typedef std::map< map_location, std::vector< overlay > > | overlay_map |
Private Attributes | |
std::string | scenario_id_ |
std::string | scenario_name_ |
std::string | scenario_description_ |
std::optional< int > | xp_mod_ |
std::optional< bool > | victory_defeated_ |
bool | random_time_ |
int | active_area_ |
map_labels | labels_ |
unit_map | units_ |
std::vector< team > | teams_ |
std::vector< std::string > | lbl_categories_ |
std::unique_ptr< tod_manager > | tod_manager_ |
mp_game_settings | mp_settings_ |
game_classification | game_classification_ |
music_map | music_tracks_ |
overlay_map | overlays_ |
This class wraps around a map to provide a concise interface for the editor to work with.
The actual map object can change rapidly (be assigned to), the map context persists data (like the undo stacks) in this case. The functionality is here, not in editor_controller as e.g. the undo stack is part of the map, not the editor as a whole. This might allow many maps to be open at the same time.
Definition at line 61 of file map_context.hpp.
|
private |
Definition at line 513 of file map_context.hpp.
|
private |
Definition at line 516 of file map_context.hpp.
|
delete |
|
explicit |
Create a map context from an existing map.
The filename is set to be empty, indicating a new map. Marked "explicit" to avoid automatic conversions.
Definition at line 58 of file map_context.cpp.
editor::map_context::map_context | ( | const game_config_view & | game_config, |
const std::string & | filename | ||
) |
Create map_context from a map file.
If the map cannot be loaded, an exception will be thrown and the object will not be constructed. If the map file is a scenario, the map specified in its map_data key will be loaded, and the stored filename updated accordingly. Maps embedded inside scenarios do not change the filename, but set the "embedded" flag instead.
Definition at line 90 of file map_context.cpp.
References _(), add_to_recent_files(), filesystem::directory_name(), e, embedded_, filesystem::file_exists(), filename_, editor::editor_map::from_string(), filesystem::get_short_wml_path(), filesystem::get_wml_location(), filesystem::is_directory(), load_scenario(), LOG_ED, log_editor, log_scope2, map_, game::error::message, pure_map_, and filesystem::read_file().
|
virtual |
Map context destructor.
Definition at line 226 of file map_context.cpp.
References redo_stack_, and undo_stack_.
void editor::map_context::add_changed_location | ( | const map_location & | loc | ) |
Definition at line 430 of file map_context.cpp.
References changed_locations_, and everything_changed().
Referenced by draw_terrain_actual(), editor::editor_action_select::perform(), editor::editor_action_deselect::perform(), editor::editor_action_select::perform_without_undo(), editor::editor_action_unit::perform_without_undo(), editor::editor_action_deselect::perform_without_undo(), editor::editor_action_village_delete::perform_without_undo(), editor::editor_action_unit_delete::perform_without_undo(), editor::editor_action_unit_replace::perform_without_undo(), and editor::editor_action_paste::perform_without_undo().
void editor::map_context::add_changed_location | ( | const std::set< map_location > & | locs | ) |
Definition at line 437 of file map_context.cpp.
References changed_locations_, and everything_changed().
|
inline |
Definition at line 222 of file map_context.hpp.
References sound::music_track::id().
Referenced by editor::editor_controller::do_execute_command().
void editor::map_context::add_to_recent_files | ( | ) |
Adds the map to the editor's recent files list.
Definition at line 739 of file map_context.cpp.
References preferences::editor::add_recent_files_entry(), and get_filename().
Referenced by map_context(), and save_map().
bool editor::map_context::can_redo | ( | ) | const |
Definition at line 749 of file map_context.cpp.
References redo_stack_.
Referenced by editor::editor_controller::can_execute_command(), and redo().
bool editor::map_context::can_undo | ( | ) | const |
Definition at line 744 of file map_context.cpp.
References undo_stack_.
Referenced by editor::editor_controller::can_execute_command(), partial_undo(), perform_partial_action(), and undo().
|
inline |
Definition at line 291 of file map_context.hpp.
Referenced by editor::context_manager::refresh_after_action().
void editor::map_context::clear_changed_locations | ( | ) |
Definition at line 424 of file map_context.cpp.
References changed_locations_, and everything_changed_.
Referenced by editor::context_manager::refresh_after_action(), and editor::context_manager::refresh_all().
void editor::map_context::clear_modified | ( | ) |
Clear the modified state.
Definition at line 734 of file map_context.cpp.
References actions_since_save_.
Referenced by save_map(), and save_scenario().
void editor::map_context::clear_starting_position_labels | ( | display & | disp | ) |
Definition at line 454 of file map_context.cpp.
References map_labels::clear_all(), display::labels(), and starting_position_label_locs_.
Referenced by reset_starting_position_labels().
void editor::map_context::clear_undo_redo | ( | ) |
Clear the undo and redo stacks.
Definition at line 826 of file map_context.cpp.
References redo_stack_, and undo_stack_.
void editor::map_context::draw_terrain | ( | const t_translation::terrain_code & | terrain, |
const map_location & | loc, | ||
bool | one_layer_only = false |
||
) |
Draw a terrain on a single location on the map.
Sets the refresh flags accordingly.
Definition at line 378 of file map_context.cpp.
References draw_terrain_actual(), gamemap::get_terrain_info(), map_, and terrain_type::terrain_with_default_base().
Referenced by editor::editor_action_paint_area::perform_without_undo(), editor::editor_action_fill::perform_without_undo(), and editor::editor_action_shuffle_area::perform_without_undo().
void editor::map_context::draw_terrain | ( | const t_translation::terrain_code & | terrain, |
const std::set< map_location > & | locs, | ||
bool | one_layer_only = false |
||
) |
Draw a terrain on a set of locations on the map.
Sets the refresh flags accordingly.
Definition at line 412 of file map_context.cpp.
References draw_terrain_actual(), gamemap::get_terrain_info(), map_, and terrain_type::terrain_with_default_base().
void editor::map_context::draw_terrain_actual | ( | const t_translation::terrain_code & | terrain, |
const map_location & | loc, | ||
bool | one_layer_only = false |
||
) |
Actual drawing function used by both overloaded variants of draw_terrain.
Definition at line 387 of file map_context.cpp.
References add_changed_location(), t_translation::terrain_code::base, terrain_type_data::BASE, gamemap_base::get_terrain(), LOG_ED, map_, t_translation::NO_LAYER, gamemap_base::on_board_with_border(), terrain_type_data::OVERLAY, and gamemap::set_terrain().
Referenced by draw_terrain().
bool editor::map_context::everything_changed | ( | ) | const |
Definition at line 449 of file map_context.cpp.
References everything_changed_.
Referenced by add_changed_location().
|
inline |
Definition at line 210 of file map_context.hpp.
Referenced by editor::context_manager::expand_areas_menu(), editor::editor_controller::get_action_state(), and editor::context_manager::rename_area_dialog().
|
inline |
Definition at line 202 of file map_context.hpp.
Referenced by editor::context_manager::refresh_on_context_change().
const t_string editor::map_context::get_default_context_name | ( | ) | const |
Definition at line 854 of file map_context.cpp.
References _(), and is_pure_map().
Referenced by editor::context_manager::expand_open_maps_menu(), and editor::context_manager::set_window_title().
|
inline |
Definition at line 313 of file map_context.hpp.
Referenced by editor::context_manager::edit_scenario_dialog().
|
inline |
Definition at line 306 of file map_context.hpp.
References filename_.
Referenced by add_to_recent_files(), editor::context_manager::apply_mask_dialog(), editor::editor_controller::can_execute_command(), editor::context_manager::create_mask_to_dialog(), editor::context_manager::expand_open_maps_menu(), editor::context_manager::load_map(), editor::context_manager::revert_map(), editor::context_manager::save_all_maps(), editor::context_manager::save_map(), save_map(), editor::context_manager::save_map_as(), editor::context_manager::save_map_as_dialog(), save_scenario(), editor::context_manager::save_scenario_as(), and editor::context_manager::save_scenario_as_dialog().
|
inline |
Definition at line 312 of file map_context.hpp.
Referenced by editor::context_manager::edit_scenario_dialog().
|
inline |
Definition at line 116 of file map_context.hpp.
References display_context::map(), display_context::teams(), and display_context::units().
Referenced by editor::editor_controller::display_redraw_callback(), editor::editor_controller::do_execute_command(), editor::mouse_action_map_label::drag_end_left(), editor::editor_action_label::perform_without_undo(), editor::editor_action_label_delete::perform_without_undo(), editor::context_manager::refresh_on_context_change(), editor::context_manager::switch_context(), and editor::mouse_action_map_label::up_left().
|
inline |
Definition at line 310 of file map_context.hpp.
Referenced by editor::context_manager::load_map().
|
inline |
Definition at line 199 of file map_context.hpp.
|
inline |
Definition at line 314 of file map_context.hpp.
Referenced by editor::context_manager::edit_scenario_dialog(), editor::context_manager::expand_open_maps_menu(), and editor::context_manager::set_window_title().
|
inline |
Definition at line 521 of file map_context.hpp.
Referenced by editor::editor_display::get_overlays().
|
inline |
Definition at line 191 of file map_context.hpp.
Referenced by editor::editor_controller::can_execute_command(), editor::editor_controller::custom_tods_dialog(), editor::editor_controller::do_execute_command(), editor::context_manager::edit_scenario_dialog(), editor::context_manager::expand_areas_menu(), editor::context_manager::expand_local_time_menu(), editor::context_manager::expand_time_menu(), editor::editor_controller::get_action_state(), editor::editor_display::get_time_of_day(), editor::context_manager::get_tod_man(), editor::context_manager::refresh_on_context_change(), and editor::context_manager::rename_area_dialog().
|
inline |
Definition at line 195 of file map_context.hpp.
|
inline |
Definition at line 318 of file map_context.hpp.
Referenced by editor::context_manager::edit_scenario_dialog().
|
inlineoverridevirtual |
Implements display_context.
Definition at line 163 of file map_context.hpp.
|
inlineoverridevirtual |
Implements display_context.
Definition at line 168 of file map_context.hpp.
|
inline |
Definition at line 323 of file map_context.hpp.
Referenced by editor::context_manager::expand_open_maps_menu(), save_map(), editor::context_manager::save_map_as(), save_scenario(), and editor::context_manager::save_scenario_as().
|
inline |
Definition at line 218 of file map_context.hpp.
Referenced by editor::editor_controller::get_action_state().
|
inline |
Definition at line 325 of file map_context.hpp.
Referenced by editor::editor_controller::can_execute_command(), editor::context_manager::expand_open_maps_menu(), get_default_context_name(), and editor::context_manager::save_map().
editor_action * editor::map_context::last_redo_action | ( | ) |
Definition at line 759 of file map_context.cpp.
References redo_stack_.
const editor_action * editor::map_context::last_redo_action | ( | ) | const |
const version of last_redo_action
Definition at line 769 of file map_context.cpp.
References redo_stack_.
editor_action * editor::map_context::last_undo_action | ( | ) |
Definition at line 754 of file map_context.cpp.
References undo_stack_.
Referenced by editor::editor_controller::mouse_motion(), partial_undo(), and perform_partial_action().
const editor_action * editor::map_context::last_undo_action | ( | ) | const |
const version of last_undo_action
Definition at line 764 of file map_context.cpp.
References undo_stack_.
void editor::map_context::load_scenario | ( | ) |
Definition at line 317 of file map_context.cpp.
References config::child_range(), unit::create(), e, filename_, editor::editor_map::from_string(), config::get(), i, unit_map::insert(), labels_, LOG_ED, map_, game::error::message, music_tracks_, overlays_, preprocess_file(), random_time_, map_labels::read(), read(), scenario_description_, scenario_id_, scenario_name_, teams_, resources::tod_manager, tod_manager_, units_, victory_defeated_, and xp_mod_.
Referenced by map_context().
|
inlineoverridevirtual |
Const map accessor.
Implements display_context.
Definition at line 152 of file map_context.hpp.
Referenced by editor::editor_controller::add_area(), editor::editor_controller::allow_mouse_wheel_scroll(), editor::editor_controller::can_execute_command(), editor::context_manager::expand_areas_menu(), editor::editor_controller::export_selection_coords(), editor::editor_controller::get_action_state(), editor::context_manager::new_map_dialog(), editor::context_manager::new_scenario_dialog(), new_side(), editor::editor_action::perform(), editor::editor_action_deselect::perform(), editor::editor_action_paste::perform(), editor::editor_action_select::perform_without_undo(), editor::editor_action_deselect::perform_without_undo(), editor::editor_action_select_all::perform_without_undo(), editor::editor_action_select_none::perform_without_undo(), editor::editor_action_select_inverse::perform_without_undo(), editor::editor_action_paste::perform_without_undo(), editor::editor_action_fill::perform_without_undo(), editor::editor_action_starting_position::perform_without_undo(), editor::editor_action_shuffle_area::perform_without_undo(), editor::context_manager::resize_map_dialog(), editor::editor_controller::save_area(), set_map(), and editor::editor_controller::terrain_description().
|
inline |
Local non-const overload of map.
Definition at line 158 of file map_context.hpp.
bool editor::map_context::modified | ( | ) | const |
Definition at line 729 of file map_context.cpp.
References actions_since_save_.
Referenced by editor::editor_controller::can_execute_command(), and editor::context_manager::expand_open_maps_menu().
|
inline |
Getter for the labels reset flag.
Set when the labels need to be refreshed.
Definition at line 284 of file map_context.hpp.
|
inline |
Getter for the reload flag.
Reload is the highest level of required refreshing, set when the map size has changed or the map was reassigned.
Definition at line 253 of file map_context.hpp.
|
inline |
Getter for the terrain rebuild flag.
Set whenever any terrain has changed.
Definition at line 263 of file map_context.hpp.
|
inline |
Definition at line 108 of file map_context.hpp.
Referenced by editor::editor_controller::add_area().
void editor::map_context::new_side | ( | ) |
Adds a new side to the map.
Definition at line 232 of file map_context.cpp.
References actions_since_save_, map(), and teams_.
Referenced by editor::editor_controller::do_execute_command(), and editor::context_manager::new_scenario().
|
delete |
void editor::map_context::partial_undo | ( | ) |
Un-does a single step from a undo action chain.
The action is separated from the chain and it's undo (the redo) is added as a stand-alone action to the redo stack. Precondition: the last undo action has to actually be an action chain.
Definition at line 802 of file map_context.cpp.
References actions_since_save_, can_undo(), editor::editor_action_chain::empty(), last_undo_action(), editor::editor_action_chain::pop_first_action(), redo_stack_, and undo_stack_.
Referenced by editor::editor_controller::do_execute_command().
void editor::map_context::perform_action | ( | const editor_action & | action | ) |
Performs an action (thus modifying the map).
An appropriate undo action is added to the undo stack. The redo stack is cleared. Note that this may throw, use caution when calling this with a dereferenced pointer that you own (i.e. use a smart pointer).
Definition at line 688 of file map_context.cpp.
References actions_since_save_, editor::editor_action::get_id(), editor::editor_action::get_instance_count(), editor::editor_action::get_name(), LOG_ED, editor::editor_action::perform(), redo_stack_, trim_stack(), undo(), and undo_stack_.
Referenced by editor::editor_controller::mouse_motion(), editor::editor_controller::perform_delete(), and editor::context_manager::perform_refresh().
|
protected |
Perform an action at the back of one stack, and then move it to the back of the other stack.
This is the implementation of both undo and redo which only differ in the direction.
Definition at line 839 of file map_context.cpp.
References trim_stack().
void editor::map_context::perform_partial_action | ( | const editor_action & | action | ) |
Performs a partial action, assumes that the top undo action has been modified to maintain coherent state of the undo stacks, and so a new undo action is not created.
Definition at line 708 of file map_context.cpp.
References can_undo(), editor::editor_action::get_id(), editor::editor_action::get_instance_count(), editor::editor_action::get_name(), last_undo_action(), LOG_ED, editor::editor_action::perform(), editor::editor_action_chain::prepend_action(), redo_stack_, and undo().
Referenced by editor::editor_controller::mouse_motion().
|
inline |
Definition at line 320 of file map_context.hpp.
Referenced by editor::context_manager::edit_scenario_dialog().
void editor::map_context::redo | ( | ) |
Re-does a previously undid action, and puts it back in the undo stack.
Definition at line 788 of file map_context.cpp.
References actions_since_save_, can_redo(), LOG_ED, perform_action_between_stacks(), redo_stack_, undo_stack_, and WRN_ED.
Referenced by editor::editor_controller::redo().
void editor::map_context::remove_area | ( | int | index | ) |
Definition at line 294 of file map_context.cpp.
References actions_since_save_, active_area_, and tod_manager_.
Referenced by editor::editor_controller::do_execute_command().
|
inline |
removes the last side from the scenario
Definition at line 99 of file map_context.hpp.
Referenced by editor::editor_controller::do_execute_command().
void editor::map_context::replace_local_schedule | ( | const std::vector< time_of_day > & | schedule | ) |
Replace the [time]s of the currently active area.
Definition at line 309 of file map_context.cpp.
References actions_since_save_, active_area_, pure_map_, and tod_manager_.
Referenced by editor::editor_controller::do_execute_command().
void editor::map_context::replace_schedule | ( | const std::vector< time_of_day > & | schedule | ) |
Definition at line 301 of file map_context.cpp.
References actions_since_save_, pure_map_, and tod_manager_.
Referenced by editor::editor_controller::do_execute_command().
void editor::map_context::reset_starting_position_labels | ( | display & | disp | ) |
Definition at line 466 of file map_context.cpp.
References clear_starting_position_labels(), set_needs_labels_reset(), and set_starting_position_labels().
Referenced by editor::context_manager::refresh_after_action(), and editor::context_manager::reload_map().
|
inline |
Definition at line 104 of file map_context.hpp.
Referenced by editor::editor_controller::save_area().
bool editor::map_context::save_map | ( | ) |
Saves the map under the current filename.
Filename must be valid. May throw an exception on failure.
Definition at line 635 of file map_context.cpp.
References _(), add_to_recent_files(), clear_modified(), e, get_filename(), is_embedded(), map_, wfl::msg(), filesystem::read_file(), VGETTEXT, game::error::what(), gamemap::write(), and filesystem::write_file().
Referenced by editor::context_manager::write_map().
bool editor::map_context::save_scenario | ( | ) |
Saves the scenario under the current filename.
Filename must be valid. May throw an exception on failure.
Definition at line 587 of file map_context.cpp.
References filesystem::base_name(), clear_modified(), e, filename_, get_filename(), is_embedded(), wfl::msg(), pure_map_, scenario_id_, scenario_name_, to_config(), VGETTEXT, game::error::what(), config_writer::write(), and filesystem::write_file().
Referenced by editor::context_manager::write_scenario().
bool editor::map_context::select_area | ( | int | index | ) |
Select the nth tod area.
index | of the tod area to select. |
Definition at line 373 of file map_context.cpp.
References map_, editor::editor_map::set_selection(), and tod_manager_.
Referenced by editor::editor_controller::do_execute_command().
|
inline |
Definition at line 214 of file map_context.hpp.
References utf8::index().
Referenced by editor::editor_controller::do_execute_command().
|
inline |
Definition at line 327 of file map_context.hpp.
Referenced by editor::context_manager::save_map_as(), and editor::context_manager::save_scenario_as().
void editor::map_context::set_everything_changed | ( | ) |
Definition at line 444 of file map_context.cpp.
References everything_changed_.
Referenced by editor::editor_action_select_all::perform_without_undo(), editor::editor_action_select_none::perform_without_undo(), and editor::editor_action_select_inverse::perform_without_undo().
|
inline |
Definition at line 308 of file map_context.hpp.
References filename_.
Referenced by editor::context_manager::save_all_maps(), editor::context_manager::save_map_as(), and editor::context_manager::save_scenario_as().
void editor::map_context::set_labels | ( | display & | disp | ) |
|
inline |
TODO.
Definition at line 186 of file map_context.hpp.
Referenced by editor::editor_controller::do_execute_command().
void editor::map_context::set_map | ( | const editor_map & | map | ) |
Definition at line 677 of file map_context.cpp.
References gamemap_base::h(), map(), map_, set_needs_reload(), set_needs_terrain_rebuild(), and gamemap_base::w().
|
inline |
Setter for the labels reset flag.
Definition at line 289 of file map_context.hpp.
Referenced by editor::context_manager::generate_map_dialog(), editor::editor_action_starting_position::perform_without_undo(), and reset_starting_position_labels().
|
inline |
Setter for the reload flag.
Definition at line 258 of file map_context.hpp.
Referenced by editor::context_manager::reload_map(), and set_map().
|
inline |
Setter for the terrain rebuild flag.
Definition at line 268 of file map_context.hpp.
References lg::info(), editor::editor_team_info::name, and preferences::turns().
Referenced by editor::editor_action_paste::perform_without_undo(), editor::editor_action_paint_area::perform_without_undo(), editor::editor_action_fill::perform_without_undo(), editor::editor_action_shuffle_area::perform_without_undo(), editor::context_manager::refresh_after_action(), editor::context_manager::refresh_all(), and set_map().
void editor::map_context::set_scenario_setup | ( | const std::string & | id, |
const std::string & | name, | ||
const std::string & | description, | ||
int | turns, | ||
int | xp_mod, | ||
bool | victory_defeated, | ||
bool | random_time | ||
) |
TODO.
Definition at line 268 of file map_context.cpp.
References actions_since_save_, id, random_time_, scenario_description_, scenario_id_, scenario_name_, tod_manager_, victory_defeated(), victory_defeated_, and xp_mod_.
Referenced by editor::context_manager::edit_scenario_dialog().
void editor::map_context::set_side_setup | ( | editor_team_info & | info | ) |
TODO.
Definition at line 246 of file map_context.cpp.
References actions_since_save_, team::change_controller(), team::change_team(), editor::editor_team_info::controller, editor::editor_team_info::fog, editor::editor_team_info::gold, team::have_leader(), editor::editor_team_info::hidden, editor::editor_team_info::id, editor::editor_team_info::income, editor::editor_team_info::name, editor::editor_team_info::no_leader, team::set_base_income(), team::set_fog(), team::set_gold(), team::set_hidden(), team::set_share_vision(), team::set_shroud(), team::set_village_gold(), team::set_village_support(), editor::editor_team_info::share_vision, editor::editor_team_info::shroud, editor::editor_team_info::side, t, teams_, editor::editor_team_info::village_income, and editor::editor_team_info::village_support.
Referenced by editor::context_manager::edit_side_dialog().
void editor::map_context::set_starting_position_labels | ( | display & | disp | ) |
Definition at line 460 of file map_context.cpp.
References map_, editor::editor_map::set_starting_position_labels(), and starting_position_label_locs_.
Referenced by editor::editor_controller::editor_controller(), and reset_starting_position_labels().
void editor::map_context::set_starting_time | ( | int | time | ) |
TODO.
Definition at line 286 of file map_context.cpp.
References actions_since_save_, pure_map_, and tod_manager_.
Referenced by editor::editor_controller::do_execute_command().
|
inlineoverridevirtual |
Const teams accessor.
Implements display_context.
Definition at line 140 of file map_context.hpp.
Referenced by editor::editor_controller::can_execute_command(), editor::editor_controller::do_execute_command(), editor::context_manager::edit_side_dialog(), editor::context_manager::expand_sides_menu(), editor::editor_action_village::perform_without_undo(), editor::editor_action_village_delete::perform_without_undo(), and editor::context_manager::refresh_all().
|
inline |
Local non-const overload of teams.
Definition at line 146 of file map_context.hpp.
config editor::map_context::to_config | ( | ) |
Definition at line 473 of file map_context.cpp.
References config::add_child(), config::append(), unit_map::begin(), unit_map::end(), string_enums::enum_base< Definition >::get_string(), overlay::halo, i, overlay::id, overlay::image, utils::join(), labels_, map_, music_tracks_, overlay::name, overlays_, random_time_, config::remove_attribute(), scenario_description_, scenario_id_, scenario_name_, overlay::submerge, t, overlay::team_name, teams_, tod_manager_, units_, victory_defeated_, overlay::visible_in_fog, map_labels::write(), gamemap::write(), map_location::write_direction(), and xp_mod_.
Referenced by save_scenario().
|
protected |
Checks if an action stack reached its capacity and removes the front element if so.
Definition at line 832 of file map_context.cpp.
References max_action_stack_size_.
Referenced by perform_action(), and perform_action_between_stacks().
void editor::map_context::undo | ( | ) |
Un-does the last action, and puts it in the redo stack for a possible redo.
Definition at line 774 of file map_context.cpp.
References actions_since_save_, can_undo(), LOG_ED, perform_action_between_stacks(), redo_stack_, undo_stack_, and WRN_ED.
Referenced by perform_action(), perform_partial_action(), and editor::editor_controller::undo().
|
inlineoverridevirtual |
Const units accessor.
Implements display_context.
Definition at line 128 of file map_context.hpp.
Referenced by editor::editor_controller::can_execute_command(), editor::editor_controller::change_unit_id(), editor::editor_controller::do_execute_command(), editor::editor_controller::get_action_state(), editor::editor_action_unit::perform_without_undo(), editor::editor_action_unit_delete::perform_without_undo(), editor::editor_action_unit_replace::perform_without_undo(), editor::editor_action_unit_facing::perform_without_undo(), editor::editor_controller::rename_unit(), and editor::editor_controller::unit_description().
|
inline |
Local non-const overload of units.
Definition at line 134 of file map_context.hpp.
|
inline |
Definition at line 321 of file map_context.hpp.
Referenced by editor::context_manager::edit_scenario_dialog(), and set_scenario_setup().
|
protected |
Number of actions performed since the map was saved.
Zero means the map was not modified.
Definition at line 470 of file map_context.hpp.
Referenced by clear_modified(), modified(), new_side(), partial_undo(), perform_action(), redo(), remove_area(), replace_local_schedule(), replace_schedule(), set_scenario_setup(), set_side_setup(), set_starting_time(), and undo().
|
private |
Definition at line 503 of file map_context.hpp.
Referenced by remove_area(), and replace_local_schedule().
|
protected |
Definition at line 492 of file map_context.hpp.
Referenced by add_changed_location(), and clear_changed_locations().
|
protected |
Whether the map context refers to a map embedded in a scenario file.
This distinction is important in order to avoid overwriting the scenario.
Definition at line 423 of file map_context.hpp.
Referenced by map_context().
|
protected |
Definition at line 493 of file map_context.hpp.
Referenced by clear_changed_locations(), everything_changed(), and set_everything_changed().
|
protected |
The actual filename of this map.
An empty string indicates a new map.
Definition at line 411 of file map_context.hpp.
Referenced by load_scenario(), map_context(), and save_scenario().
|
private |
Definition at line 511 of file map_context.hpp.
|
private |
Definition at line 505 of file map_context.hpp.
Referenced by load_scenario(), and to_config().
|
private |
Definition at line 508 of file map_context.hpp.
|
protected |
The map object of this map_context.
Definition at line 433 of file map_context.hpp.
Referenced by draw_terrain(), draw_terrain_actual(), load_scenario(), map_context(), save_map(), select_area(), set_map(), set_starting_position_labels(), and to_config().
|
protected |
When a scenario file is loaded, the referenced map is loaded instead.
The verbatim form of the reference is kept here.
Definition at line 417 of file map_context.hpp.
|
staticprotected |
Action stack (i.e.
undo and redo) maximum size
Definition at line 465 of file map_context.hpp.
Referenced by editor::editor_team_info::editor_team_info(), and trim_stack().
|
private |
Definition at line 510 of file map_context.hpp.
|
private |
Definition at line 514 of file map_context.hpp.
Referenced by load_scenario(), and to_config().
|
protected |
Refresh flag indicating the labels in the map have changed.
Definition at line 490 of file map_context.hpp.
|
protected |
Refresh flag indicating the map in this context should be completely reloaded by the display.
Definition at line 480 of file map_context.hpp.
|
protected |
Refresh flag indicating the terrain in the map has changed and requires a rebuild.
Definition at line 485 of file map_context.hpp.
|
private |
Definition at line 517 of file map_context.hpp.
Referenced by load_scenario(), and to_config().
|
protected |
Whether the map context refers to a file containing only the pure map data.
Definition at line 428 of file map_context.hpp.
Referenced by map_context(), replace_local_schedule(), replace_schedule(), save_scenario(), and set_starting_time().
|
private |
Definition at line 501 of file map_context.hpp.
Referenced by load_scenario(), set_scenario_setup(), and to_config().
|
protected |
The redo stack.
Definition at line 460 of file map_context.hpp.
Referenced by can_redo(), clear_undo_redo(), last_redo_action(), partial_undo(), perform_action(), perform_partial_action(), redo(), undo(), and ~map_context().
|
private |
Definition at line 497 of file map_context.hpp.
Referenced by load_scenario(), set_scenario_setup(), and to_config().
|
private |
Definition at line 497 of file map_context.hpp.
Referenced by load_scenario(), save_scenario(), set_scenario_setup(), and to_config().
|
private |
Definition at line 497 of file map_context.hpp.
Referenced by load_scenario(), save_scenario(), set_scenario_setup(), and to_config().
|
protected |
Cache of set starting position labels.
Necessary for removing them.
Definition at line 475 of file map_context.hpp.
Referenced by clear_starting_position_labels(), and set_starting_position_labels().
|
private |
Definition at line 507 of file map_context.hpp.
Referenced by load_scenario(), new_side(), set_side_setup(), and to_config().
|
private |
Definition at line 509 of file map_context.hpp.
Referenced by load_scenario(), remove_area(), replace_local_schedule(), replace_schedule(), select_area(), set_scenario_setup(), set_starting_time(), and to_config().
|
protected |
The undo stack.
A double-ended queues due to the need to add items to one end, and remove from both when performing the undo or when trimming the size. This container owns all contents, i.e. no action in the stack shall be deleted, and unless otherwise noted the contents could be deleted at an time during normal operation of the stack. To work on an action, either remove it from the container or make a copy. Actions are inserted at the back of the container and disappear from the front when the capacity is exceeded.
Definition at line 455 of file map_context.hpp.
Referenced by can_undo(), clear_undo_redo(), last_undo_action(), partial_undo(), perform_action(), redo(), undo(), and ~map_context().
|
private |
Definition at line 506 of file map_context.hpp.
Referenced by load_scenario(), and to_config().
|
private |
Definition at line 500 of file map_context.hpp.
Referenced by load_scenario(), set_scenario_setup(), and to_config().
|
private |
Definition at line 499 of file map_context.hpp.
Referenced by load_scenario(), set_scenario_setup(), and to_config().