The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
move.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2017 by David White <dave@whitevine.net>
3  Part of the Battle for Wesnoth Project http://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 /**
16  * @file
17  * Movement.
18  */
19 
20 #include "actions/move.hpp"
21 
22 #include "actions/undo.hpp"
23 #include "actions/vision.hpp"
24 
25 #include "game_events/pump.hpp"
26 #include "preferences/game.hpp"
27 #include "gettext.hpp"
28 #include "hotkey/hotkey_item.hpp"
30 #include "log.hpp"
31 #include "map/map.hpp"
32 #include "mouse_handler_base.hpp"
33 #include "pathfind/pathfind.hpp"
34 #include "pathfind/teleport.hpp"
35 #include "replay.hpp"
36 #include "replay_helper.hpp"
37 #include "synced_context.hpp"
38 #include "play_controller.hpp"
39 #include "resources.hpp"
40 #include "units/udisplay.hpp"
41 #include "font/standard_colors.hpp"
42 #include "formula/string_utils.hpp"
43 #include "team.hpp"
44 #include "units/unit.hpp"
46 #include "whiteboard/manager.hpp"
47 
48 #include <deque>
49 #include <map>
50 #include <set>
51 
52 static lg::log_domain log_engine("engine");
53 #define DBG_NG LOG_STREAM(debug, log_engine)
54 
55 
56 namespace actions {
57 
58 
60 {
61  seen_friends_.push_back(u);
62 }
63 
64 
66 {
67  seen_enemies_.push_back(u);
68 }
69 
70 
72 {
73  return ambusher_;
74 }
75 
76 
78 {
79  return failed_teleport_;
80 }
81 
82 
83 const std::vector<unit_map::const_iterator>& move_unit_spectator::get_seen_enemies() const
84 {
85  return seen_enemies_;
86 }
87 
88 
89 const std::vector<unit_map::const_iterator>& move_unit_spectator::get_seen_friends() const
90 {
91  return seen_friends_;
92 }
93 
94 
96 {
97  return unit_;
98 }
99 
100 
102  : ambusher_(units.end()),failed_teleport_(units.end()),seen_enemies_(),seen_friends_(),unit_(units.end())
103 {
104 }
105 
106 
108 {
109 }
110 
112 {
113  ambusher_ = units.end();
114  failed_teleport_ = units.end();
115  seen_enemies_.clear();
116  seen_friends_.clear();
117  unit_ = units.end();
118 }
119 
120 
122 {
123  ambusher_ = u;
124 }
125 
126 
128 {
129  failed_teleport_ = u;
130 }
131 
132 
134 {
135  unit_ = u;
136 }
137 
138 
139 game_events::pump_result_t get_village(const map_location& loc, int side, bool *action_timebonus, bool fire_event)
140 {
141  std::vector<team> &teams = resources::gameboard->teams();
142  team *t = unsigned(side - 1) < teams.size() ? &teams[side - 1] : nullptr;
143  if (t && t->owns_village(loc)) {
145  }
146 
147  bool not_defeated = t && !resources::gameboard->team_is_defeated(*t);
148 
149  bool grants_timebonus = false;
150 
151  int old_owner_side = 0;
152  // We strip the village off all other sides, unless it is held by an ally
153  // and our side is already defeated (and thus we can't occupy it)
154  for(std::vector<team>::iterator i = teams.begin(); i != teams.end(); ++i) {
155  int i_side = i - teams.begin() + 1;
156  if (!t || not_defeated || t->is_enemy(i_side)) {
157  if(i->owns_village(loc)) {
158  old_owner_side = i_side;
159  i->lose_village(loc);
160  }
161  if (side != i_side && action_timebonus) {
162  grants_timebonus = true;
163  }
164  }
165  }
166 
167  if (!t) {
169  }
170 
171  if(grants_timebonus) {
173  *action_timebonus = true;
174  }
175 
176  if(not_defeated) {
177  if (resources::screen != nullptr) {
179  }
180  return t->get_village(loc, old_owner_side, fire_event ? resources::gamedata : nullptr);
181  }
182 
184 }
185 
186 
187 namespace { // Private helpers for move_unit()
188 
189  /// Helper class for move_unit().
190  class unit_mover {
191  typedef std::vector<map_location>::const_iterator route_iterator;
192 
193  public:
194  unit_mover(const unit_mover&) = delete;
195  unit_mover& operator=(const unit_mover&) = delete;
196 
197  unit_mover(const std::vector<map_location> & route,
198  move_unit_spectator *move_spectator,
199  bool skip_sightings, bool skip_ally_sightings);
200  ~unit_mover();
201 
202  /// Determines how far along the route the unit can expect to move this turn.
203  bool check_expected_movement();
204  /// Attempts to move the unit along the expected path.
205  void try_actual_movement(bool show);
206  /// Does some bookkeeping and event firing, for use after movement.
207  void post_move(undo_list *undo_stack);
208  /// Shows the various on-screen messages, for use after movement.
209  void feedback() const;
210 
211  /// After checking expected movement, this is the expected path.
212  std::vector<map_location> expected_path() const
213  { return std::vector<map_location>(begin_, expected_end_); }
214  /// After moving, this is the final hex reached.
215  const map_location & final_hex() const
216  { return *move_loc_; }
217  /// The number of hexes actually entered.
218  size_t steps_travelled() const
219  { return move_loc_ - begin_; }
220  /// After moving, use this to detect if movement was less than expected.
221  bool stopped_early() const { return expected_end_ != real_end_; }
222  /// After moving, use this to detect if something happened that would
223  /// interrupt movement (even if movement ended for a different reason).
224  bool interrupted(bool include_end_of_move_events=true) const
225  {
226  return ambushed_ || blocked() || sighted_ || teleport_failed_ ||
227  (include_end_of_move_events ? (wml_removed_unit_ || wml_move_aborted_): event_mutated_mid_move_ ) ||
228  !move_it_.valid();
229  }
230 
231  private: // functions
232  /// Returns whether or not movement was blocked by a non-ambushing enemy.
233  bool blocked() const { return blocked_loc_ != map_location::null_location(); }
234  /// Checks the expected route for hidden units.
235  void cache_hidden_units(const route_iterator & start,
236  const route_iterator & stop);
237  /// Fires the enter_hex or exit_hex event and updates our data as needed.
238  void fire_hex_event(const std::string & event_name,
239  const route_iterator & current,
240  const route_iterator & other);
241  /// AI moves are supposed to not change the "goto" order.
242  bool is_ai_move() const { return spectator_ != nullptr; }
243  /// Checks how far it appears we can move this turn.
244  route_iterator plot_turn(const route_iterator & start,
245  const route_iterator & stop);
246  /// Updates our stored info after a WML event might have changed something.
247  void post_wml(game_events::pump_result_t pump_res, const route_iterator & step);
248  void post_wml(game_events::pump_result_t pump_res) { return post_wml(pump_res, full_end_); }
249  /// Fires the sighted events that were raised earlier.
250  void pump_sighted(const route_iterator & from);
251  /// Returns the ambush alert (if any) for the given unit.
252  static std::string read_ambush_string(const unit & ambusher);
253  /// Reveals the unit at the indicated location.
254  void reveal_ambusher(const map_location & hex, bool update_alert=true);
255 
256  /// Returns whether or not undoing this move should be blocked.
257  bool undo_blocked() const
258  { return ambushed_ || blocked() || wml_removed_unit_ || wml_undo_disabled_ || fog_changed_ ||
260 
261  // The remaining private functions are suggested to be inlined because
262  // each is used in only one place. (They are separate functions to ease
263  // code reading.)
264 
265  /// Checks for ambushers around @a hex, setting flags as appropriate.
266  inline void check_for_ambushers(const map_location & hex);
267  /// Makes sure the path is not obstructed by a unit.
268  inline bool check_for_obstructing_unit(const map_location & hex,
269  const map_location & prev_hex);
270  /// Moves the unit the next step.
271  inline bool do_move(const route_iterator & step_from,
272  const route_iterator & step_to,
273  unit_display::unit_mover & animator);
274  /// Clears fog/shroud and handles units being sighted.
275  inline void handle_fog(const map_location & hex, bool new_animation);
276  inline bool is_reasonable_stop(const map_location & hex) const;
277  /// Reveals the units stored in ambushers_ (and blocked_loc_).
278  inline void reveal_ambushers();
279  /// Makes sure the units in ambushers_ still exist.
280  inline void validate_ambushers();
281 
282  private: // data
283  // (The order of the fields is somewhat important for the constructor.)
284 
285  // Movement parameters (these decrease the number of parameters needed
286  // for individual functions).
287  move_unit_spectator * const spectator_;
288  const bool skip_sighting_;
291  // Needed to interface with unit_display::unit_mover.
292  const std::vector<map_location> & route_;
293 
294  // The route to traverse.
295  const route_iterator begin_;
296  const route_iterator full_end_; // The end of the plotted route.
297  route_iterator expected_end_; // The end of this turn's portion of the plotted route.
298  route_iterator ambush_limit_; // How far we can go before encountering hidden units, ignoring allied units.
299  route_iterator obstructed_; // Points to either full_end_ or a hex we cannot enter. This is used so that exit_hex can fire before we decide we cannot enter this hex.
300  route_iterator real_end_; // How far we actually can move this turn.
301 
302  // The unit that is moving.
304 
305  // This data stores the state from before the move started.
306  const int orig_side_;
307  const int orig_moves_;
310 
311  // This data tracks the current state as the move is in progress.
313  team * current_team_; // Will default to the original team if the moving unit becomes invalid.
315  route_iterator move_loc_; // Will point to the last moved-to location (in case the moving unit disappears).
316  // Data accumulated while making the move.
318  map_location ambush_stop_; // Could be inaccurate if ambushed_ is false.
319  map_location blocked_loc_; // Location of a blocking, enemy, non-ambusher unit.
320  bool ambushed_;
325  bool event_mutated_mid_move_; // Cache of wml_removed_unit_ || wml_move_aborted_ from just before the end-of-move handling.
327  bool sighted_; // Records if sightings were made that could interrupt movement.
328  bool sighted_stop_; // Records if sightings were made that did interrupt movement (the same as sighted_ unless movement ended for another reason).
330  size_t enemy_count_;
333  std::vector<map_location> ambushers_;
334  std::deque<int> moves_left_; // The front value is what the moving unit's remaining moves should be set to after the next step through the route.
335 
336  shroud_clearer clearer_;
337  };
338 
339 
340  /// This constructor assumes @a route is not empty, and it will assert() that
341  /// there is a unit at route.front().
342  /// Iterators into @a route must remain valid for the life of this object.
343  /// It is assumed that move_spectator is only supplied for AI moves (only
344  /// affects whether or not gotos are changed).
345  unit_mover::unit_mover(const std::vector<map_location> & route,
346  move_unit_spectator *move_spectator,
347  bool skip_sightings, bool skip_ally_sightings)
348  : spectator_(move_spectator)
349  , skip_sighting_(skip_sightings)
350  , skip_ally_sighting_(skip_ally_sightings)
351  , playing_team_is_viewing_(resources::screen->playing_team() == resources::screen->viewing_team() || resources::screen->show_everything())
352  , route_(route)
353  , begin_(route.begin())
354  , full_end_(route.end())
358  , real_end_(begin_)
359  // Unit information:
361  , orig_side_(( assert(move_it_ != resources::gameboard->units().end()), move_it_->side() ))
362  , orig_moves_(move_it_->movement_left())
363  , orig_dir_(move_it_->facing())
364  , goto_( is_ai_move() ? move_it_->get_goto() : route.back() )
367  , current_uses_fog_(current_team_->fog_or_shroud() && current_team_->auto_shroud_updates())
368  , move_loc_(begin_)
369  // The remaining fields are set to some sort of "zero state".
370  , zoc_stop_(map_location::null_location())
371  , ambush_stop_(map_location::null_location())
372  , blocked_loc_(map_location::null_location())
373  , ambushed_(false)
374  , show_ambush_alert_(false)
375  , wml_removed_unit_(false)
376  , wml_undo_disabled_(false)
377  , wml_move_aborted_(false)
378  , event_mutated_mid_move_(false)
379  , fog_changed_(false)
380  , sighted_(false)
381  , sighted_stop_(false)
382  , teleport_failed_(false)
383  , enemy_count_(0)
384  , friend_count_(0)
385  , ambush_string_()
386  , ambushers_()
387  , moves_left_()
388  , clearer_()
389  {
390  if ( !is_ai_move() )
391  // Clear the "goto" instruction during movement.
392  // (It will be reset in the destructor if needed.)
394  }
395 
396 
397  unit_mover::~unit_mover()
398  {
399  // Set the "goto" order? (Not if WML set it.)
400  if ( !is_ai_move() && move_it_.valid() &&
401  move_it_->get_goto() == map_location::null_location() )
402  {
403  // Only set the goto if movement was not complete and was not
404  // interrupted.
405  if (real_end_ != full_end_ && !interrupted(false)) {
406  // End-of-move-events do not cancel a goto. (Use case: tutorial S2.)
407  move_it_->set_goto(goto_);
408  }
409  }
410  }
411 
412 
413  // Private inlines:
414 
415  /**
416  * Checks for ambushers around @a hex, setting flags as appropriate.
417  */
418  inline void unit_mover::check_for_ambushers(const map_location & hex)
419  {
421 
422  // Need to check each adjacent hex for hidden enemies.
423  map_location adjacent[6];
424  get_adjacent_tiles(hex, adjacent);
425  for ( int i = 0; i != 6; ++i )
426  {
427  const unit_map::const_iterator neighbor_it = units.find(adjacent[i]);
428 
429  if ( neighbor_it != units.end() &&
430  current_team_->is_enemy(neighbor_it->side()) &&
431  neighbor_it->invisible(adjacent[i], *resources::gameboard) )
432  {
433  // Ambushed!
434  ambushed_ = true;
435  ambush_stop_ = hex;
436  ambushers_.push_back(adjacent[i]);
437  }
438  }
439  }
440 
441 
442  /**
443  * Makes sure the path is not obstructed by a unit.
444  * @param hex The hex to check.
445  * @param prev_hex The previous hex in the route (used to detect a teleport).
446  * @return true if @a hex is obstructed.
447  */
448  inline bool unit_mover::check_for_obstructing_unit(const map_location & hex,
449  const map_location & prev_hex)
450  {
451  const unit_map::const_iterator blocking_unit = resources::gameboard->units().find(hex);
452 
453  // If no unit, then the path is not obstructed.
454  if (blocking_unit == resources::gameboard->units().end()) {
455  return false;
456  }
457 
458  // Check for units blocking a teleport exit. This can now only happen
459  // if these units are not visible to the current side, as otherwise no
460  // valid path is found.
461  if ( !tiles_adjacent(hex, prev_hex) ) {
462  if ( current_team_->is_enemy(blocking_unit->side()) ) {
463  // Enemy units always block the tunnel.
464  teleport_failed_ = true;
465  return true;
466  } else {
467  // By contrast, allied units (of a side which does not share vision) only
468  // block the tunnel if pass_allied_units=true. Whether the teleport is possible
469  // is checked by getting the teleport map with the see_all flag set to true.
470  const pathfind::teleport_map teleports = pathfind::get_teleport_locations(*move_it_, *current_team_, true, false, false);
471  std::set<map_location> allowed_teleports;
472  teleports.get_adjacents(allowed_teleports, prev_hex);
473 
474  bool found_valid_teleport = false;
475  std::set<map_location>::const_iterator it = allowed_teleports.begin();
476  while( it!=allowed_teleports.end() && !found_valid_teleport ) {
477  if ( *it == hex ) {
478  found_valid_teleport = true;
479  }
480  ++it;
481  }
482 
483  if (!found_valid_teleport) {
484  teleport_failed_ = true;
485  return true;
486  }
487  }
488  }
489 
490  if ( current_team_->is_enemy(blocking_unit->side()) ) {
491  // Trying to go through an enemy.
492  blocked_loc_ = hex;
493  return true;
494  }
495 
496  // If we get here, the unit does not interfere with movement.
497  return false;
498  }
499 
500 
501  /**
502  * Moves the unit the next step.
503  * @a step_to is the hex being moved to.
504  * @a step_from is the hex before that in the route.
505  * (The unit is actually at *move_loc_.)
506  * @a animator is the unit_display::unit_mover being used.
507  * @return whether or not we started a new animation.
508  */
509  inline bool unit_mover::do_move(const route_iterator & step_from,
510  const route_iterator & step_to,
511  unit_display::unit_mover & animator)
512  {
514 
515  // Adjust the movement even if we cannot move yet.
516  // We will eventually be able to move if nothing unexpected
517  // happens, and if something does happen, this movement is the
518  // cost to discover it.
519  move_it_->set_movement(moves_left_.front(), true);
520  moves_left_.pop_front();
521 
522  // Invalidate before moving so we invalidate neighbor hexes if needed.
523  move_it_->anim_comp().invalidate(disp);
524 
525  // Attempt actually moving.
526  // (Fails if *step_to is occupied).
527  std::pair<unit_map::iterator, bool> move_result =
528  resources::gameboard->units().move(*move_loc_, *step_to);
529  if ( move_result.second )
530  {
531  // Update the moving unit.
532  move_it_ = move_result.first;
533  move_it_->set_facing(step_from->get_relative_dir(*step_to));
534  // Disable bars. The expectation here is that the animation
535  // unit_mover::finish() will clean after us at a later point. Ugly,
536  // but it works.
537  move_it_->anim_comp().set_standing(false);
538  disp.invalidate_unit_after_move(*move_loc_, *step_to);
539  disp.invalidate(*step_to);
540  move_loc_ = step_to;
541 
542  // Show this move.
543  animator.proceed_to(move_it_.get_shared_ptr(), step_to - begin_,
544  move_it_->appearance_changed(), false);
545  move_it_->set_appearance_changed(false);
546  disp.redraw_minimap();
547  }
548 
549  return move_result.second;
550  }
551 
552 
553  /**
554  * Clears fog/shroud and raises events for units being sighted.
555  * Only call this if the current team uses fog or shroud.
556  * @a hex is both the center of fog clearing and the filtered location of
557  * the moving unit when the sighted events will be fired.
558  */
559  inline void unit_mover::handle_fog(const map_location & hex,
560  bool new_animation)
561  {
562  // Clear the fog.
563  if ( clearer_.clear_unit(hex, *move_it_, *current_team_, nullptr,
565  !new_animation) )
566  {
567  clearer_.invalidate_after_clear();
568  fog_changed_ = true;
569  }
570 
571  // Check for sighted units?
572  if ( !skip_sighting_ ) {
573  sighted_ = enemy_count_ != 0 ;
574  }
576  {
577  sighted_ |= (friend_count_ != 0);
578  }
579  }
580 
581 
582  /**
583  * @return true if an unscheduled stop at @a hex is not likely to negatively
584  * impact the player's plans.
585  * (E.g. it would not kill movement by making an unintended village capture.)
586  */
587  inline bool unit_mover::is_reasonable_stop(const map_location & hex) const
588  {
589  // We cannot reasonably stop if move_it_ could not be moved to this
590  // hex (the hex was occupied by someone else).
591  if (*move_loc_ != hex) {
592  return false;
593  }
594 
595  // We can reasonably stop if the hex is not an unowned village.
596  return !resources::gameboard->map().is_village(hex) ||
598  }
599 
600 
601  /**
602  * Reveals the units stored in ambushers_ (and blocked_loc_).
603  * Also sets ambush_string_.
604  * May fire "sighted" events.
605  * Only call this if appropriate; this function does not itself check
606  * ambushed_ or blocked().
607  */
608  inline void unit_mover::reveal_ambushers()
609  {
610  // Reveal the blocking unit.
611  if (blocked()) {
612  reveal_ambusher(blocked_loc_, false);
613  }
614  // Reveal ambushers.
615  for(const map_location & reveal : ambushers_) {
616  reveal_ambusher(reveal, true);
617  }
618 
619  // Default "Ambushed!" message?
620  if (ambush_string_.empty()) {
621  ambush_string_ = _("Ambushed!");
622  }
623  }
624 
625 
626  /**
627  * Makes sure the units in ambushers_ still exist.
628  */
629  inline void unit_mover::validate_ambushers()
630  {
631  const unit_map &units = resources::gameboard->units();
632 
633  // Loop through the previously-detected ambushers.
634  size_t i = 0;
635  while ( i != ambushers_.size() ) {
636  if (units.count(ambushers_[i]) == 0) {
637  // Ambusher is gone.
638  ambushers_.erase(ambushers_.begin() + i);
639  }
640  else {
641  // Proceed to the next ambusher.
642  ++i;
643  }
644  }
645  }
646 
647 
648  // Private utilities:
649 
650  /**
651  * Checks the expected route for hidden units.
652  * This basically handles all the checks for surprises that can be done
653  * without visibly notifying a player. Thus this can be called at the
654  * start of movement and immediately after events, rather than tie up
655  * CPU time in the middle of animating a move.
656  *
657  * @param[in] start The beginning of the path to check.
658  * @param[in] stop The end of the path to check.
659  */
660  void unit_mover::cache_hidden_units(const route_iterator & start,
661  const route_iterator & stop)
662  {
663  // Clear the old cache.
666  teleport_failed_ = false;
667  // The ambush cache needs special treatment since we cannot re-detect
668  // an ambush if we are already at the ambushed location.
670  if ( ambushed_ ) {
671  validate_ambushers();
672  ambushed_ = !ambushers_.empty();
673  }
674  if ( !ambushed_ ) {
675  ambush_stop_ = map_location::null_location();
676  ambushers_.clear();
677  }
678 
679  // Update the shroud clearer.
680  clearer_.cache_units(current_uses_fog_ ? current_team_ : nullptr);
681 
682 
683  // Abort for null routes.
684  if ( start == stop ) {
686  return;
687  }
688 
689  // This loop will end with ambush_limit_ pointing one element beyond
690  // where the unit would be forced to stop by a hidden unit.
691  for ( ambush_limit_ = start+1; ambush_limit_ != stop; ++ambush_limit_ ) {
692  // Check if we need to stop in the previous hex.
693  if ( ambushed_ ) {
694  break;
695  }
696  // Check for being unable to enter this hex.
697  if ( check_for_obstructing_unit(*ambush_limit_, *(ambush_limit_-1)) ) {
698  // No replay check here? Makes some sense, I guess.
699  obstructed_ = ambush_limit_++; // The limit needs to be after obstructed_ in order for the latter to do anything.
700  break;
701  }
702 
703  // We can enter this hex.
704  // See if we are stopped in this hex.
705  check_for_ambushers(*ambush_limit_);
706  }
707  }
708 
709 
710  /**
711  * Fires the enter_hex or exit_hex event and updates our data as needed.
712  *
713  * @param[in] event_name The name of the event ("enter_hex" or "exit_hex").
714  * @param[in] current The currently occupied hex.
715  * @param[in] other The secondary hex to provide to the event.
716  *
717  */
718  void unit_mover::fire_hex_event(const std::string & event_name,
719  const route_iterator & current,
720  const route_iterator & other)
721  {
722 
723  const game_events::entity_location mover(*move_it_, *current);
724 
725  post_wml(resources::game_events->pump().fire(event_name, mover, *other), current);
726  }
727 
728 
729  /**
730  * Checks how far it appears we can move this turn.
731  *
732  * @param[in] start The beginning of the plotted path.
733  * @param[in] stop The end of the plotted path.
734  *
735  * @return An end iterator for the path that can be traversed this turn.
736  */
737  unit_mover::route_iterator unit_mover::plot_turn(const route_iterator & start,
738  const route_iterator & stop)
739  {
740  const gamemap &map = resources::gameboard->map();
741 
742  // Handle null routes.
743  if (start == stop) {
744  return start;
745  }
746 
747  int remaining_moves = move_it_->movement_left();
749  moves_left_.clear();
750 
751  if ( start != begin_ ) {
752  // Check for being unable to leave the current hex.
753  if ( !move_it_->get_ability_bool("skirmisher", *start, *resources::gameboard) &&
754  pathfind::enemy_zoc(*current_team_, *start, *current_team_) )
755  zoc_stop_ = *start;
756  }
757 
758  // This loop will end with end pointing one element beyond where the
759  // unit thinks it will stop (the usual notion of "end" for iterators).
760  route_iterator end = start + 1;
761  for ( ; end != stop; ++end )
762  {
763  // Break out of the loop if we cannot leave the previous hex.
765  break;
766  }
767  remaining_moves -= move_it_->movement_cost(map[*end]);
768  if ( remaining_moves < 0 ) {
769  break;
770  }
771 
772  // We can enter this hex. Record the cost.
773  moves_left_.push_back(remaining_moves);
774 
775  // Check for being unable to leave this hex.
776  if (!move_it_->get_ability_bool("skirmisher", *end, *resources::gameboard) &&
777  pathfind::enemy_zoc(*current_team_, *end, *current_team_))
778  {
779  zoc_stop_ = *end;
780  }
781  }
782 
783  route_iterator min_end = start == begin_ ? start : start + 1;
784  while (end != min_end && resources::gameboard->has_visible_unit(*(end - 1), *current_team_)) {
785  // Backtrack.
786  --end;
787  }
788 
789  return end;
790  }
791 
792 
793  /**
794  * Updates our stored info after a WML event might have changed something.
795  *
796  * @param step Indicates the position in the path where we might need to start recalculating movement.
797  * Set this to full_end_ (or do not supply it) to skip such recalculations (because movement has finished).
798  *
799  * @returns false if continuing is impossible (i.e. we lost the moving unit).
800  */
801  void unit_mover::post_wml(game_events::pump_result_t pump_res, const route_iterator & step)
802  {
803  wml_move_aborted_ |= std::get<1>(pump_res);
804  wml_undo_disabled_ |= std::get<0>(pump_res);
805 
806  // Re-find the moving unit.
808  const bool found = move_it_ != resources::gameboard->units().end();
809 
810  // Update the current unit data.
811  current_side_ = found ? move_it_->side() : orig_side_;
812  current_team_ = &resources::gameboard->get_team(current_side_);
813  current_uses_fog_ = current_team_->fog_or_shroud() &&
814  ( current_side_ != orig_side_ ||
815  current_team_->auto_shroud_updates() );
816 
817  // Update the path.
818  if ( found && step != full_end_ ) {
819  const route_iterator new_limit = plot_turn(step, expected_end_);
820  cache_hidden_units(step, new_limit);
821  // Just in case: length 0 paths become length 1 paths.
822  if (ambush_limit_ == step) {
823  ++ambush_limit_;
824  }
825  }
826 
827  wml_removed_unit_ |= !found;
828  }
829 
830 
831  /**
832  * Fires the sighted events that were raised earlier.
833  *
834  * @param[in] from Points to the hex the sighting unit currently occupies.
835  *
836  * @return sets event_mutated_ || wml_move_aborted_ to true if this event should interrupt movement.
837  */
838  void unit_mover::pump_sighted(const route_iterator & from)
839  {
840  const size_t track = resources::game_events->pump().wml_tracking();
841 
842  auto pump_res = clearer_.fire_events();
843 
844  if (track != resources::game_events->pump().wml_tracking()) {
845  // Some WML fired, so update our status.
846  post_wml(pump_res, from);
847  }
848  }
849 
850 
851  /**
852  * Returns the ambush alert (if any) for the given unit.
853  */
854  std::string unit_mover::read_ambush_string(const unit & ambusher)
855  {
856  for(const unit_ability &hide : ambusher.get_abilities("hides"))
857  {
858  const std::string & ambush_string = (*hide.first)["alert"].str();
859  if (!ambush_string.empty()) {
860  return ambush_string;
861  }
862  }
863 
864  // No string found.
865  return std::string();
866  }
867 
868 
869  /**
870  * Reveals the unit at the indicated location.
871  * Can also update the current ambushed alert.
872  * May fire "sighted" events.
873  */
874  void unit_mover::reveal_ambusher(const map_location & hex, bool update_alert)
875  {
876  // Convenient alias:
877  unit_map &units = resources::gameboard->units();
879 
880  // Find the unit at the indicated location.
881  unit_map::iterator ambusher = units.find(hex);
882  if ( ambusher != units.end() ) {
883  // Prepare for sighted events.
884  std::vector<int> sight_cache(get_sides_not_seeing(*ambusher));
885  // Make sure the unit is visible (during sighted events, and in case
886  // we had to backtrack).
887  ambusher->set_state(unit::STATE_UNCOVERED, true);
888 
889  // Record this in the move spectator.
890  if (spectator_) {
891  spectator_->set_ambusher(ambusher);
892  }
893  // Override the default ambushed messge?
894  if ( update_alert ) {
895  // Observers don't get extra information.
896  if ( playing_team_is_viewing_ || !disp.fogged(hex) ) {
897  show_ambush_alert_ = true;
898  // We only support one custom ambush message; use the first one.
899  if (ambush_string_.empty()) {
900  ambush_string_ = read_ambush_string(*ambusher);
901  }
902  }
903  }
904 
905  // Make sure this hex is drawn correctly.
906  disp.invalidate(hex);
907  // Fire sighted events.
908 
909  bool wml_undo_blocked = false;
910  bool wml_move_aborted = false;
911 
912  std::tie(wml_undo_blocked, wml_move_aborted) = actor_sighted(*ambusher, &sight_cache);
913  // TODO: should we call post_wml ?
914  wml_move_aborted_ |= wml_move_aborted;
915  wml_undo_disabled_ |= wml_undo_blocked;
916  }
917  }
918 
919 
920  // Public interface:
921 
922  /**
923  * Determines how far along the route the unit can expect to move this turn.
924  * This is based solely on data known to the player, and will not plot a move
925  * that ends on another (known) unit.
926  * (For example, this prevents a player from plotting a multi-turn move that
927  * has this turn's movement ending on a (slower) unit, and thereby clearing
928  * fog as if the moving unit actually made it on top of that other unit.)
929  *
930  * @returns false if the expectation is to not move at all.
931  */
932  bool unit_mover::check_expected_movement()
933  {
934  expected_end_ = plot_turn(begin_, full_end_);
935  return expected_end_ != begin_;
936  }
937 
938 
939  /**
940  * Attempts to move the unit along the expected path.
941  * (This will do nothing unless check_expected_movement() was called first.)
942  *
943  * @param[in] show Set to false to suppress animations.
944  */
945  void unit_mover::try_actual_movement(bool show)
946  {
947  static const std::string enter_hex_str("enter hex");
948  static const std::string exit_hex_str("exit hex");
949 
950 
951  bool obstructed_stop = false;
952 
953 
954  // Check for hidden units along the expected path before we start
955  // animating and firing events.
956  cache_hidden_units(begin_, expected_end_);
957 
958  if ( begin_ != ambush_limit_ ) {
959  // Cache the moving unit's visibility.
960  std::vector<int> not_seeing = get_sides_not_seeing(*move_it_);
961 
962  // Prepare to animate.
963  unit_display::unit_mover animator(route_, show);
964  animator.start(move_it_.get_shared_ptr());
965 
966  // Traverse the route to the hex where we need to stop.
967  // Each iteration performs the move from real_end_-1 to real_end_.
968  for ( real_end_ = begin_+1; real_end_ != ambush_limit_; ++real_end_ ) {
969  const route_iterator step_from = real_end_ - 1;
970 
971  // See if we can leave *step_from.
972  // Already accounted for: ambusher
974  break;
975  }
976  if ( sighted_ && is_reasonable_stop(*step_from) ) {
977  sighted_stop_ = true;
978  break;
979  }
980  // Already accounted for: ZoC
981  // Already accounted for: movement cost
982  fire_hex_event(exit_hex_str, step_from, real_end_);
984  break;
985  }
986  if ( real_end_ == obstructed_ ) {
987  // We did not check for being a replay when checking for an
988  // obstructed hex, so we do not check can_break here.
989  obstructed_stop = true;
990  break;
991  }
992 
993  // We can leave *step_from. Make the move to *real_end_.
994  bool new_animation = do_move(step_from, real_end_, animator);
995  // Update the fog.
996  if ( current_uses_fog_ )
997  handle_fog(*real_end_, new_animation);
998  animator.wait_for_anims();
999 
1000  // Fire the events for this step.
1001  // (These return values are not checked since real_end_ still
1002  // needs to be incremented. The wml_move_aborted_ check will break
1003  // us out of the loop if needed.)
1004  fire_hex_event(enter_hex_str, real_end_, step_from);
1005  // Sighted events only fire if we could stop due to sighting.
1006  if (is_reasonable_stop(*real_end_)) {
1007  pump_sighted(real_end_);
1008  }
1009  }//for
1010  // Make sure any remaining sighted events get fired.
1011  pump_sighted(real_end_-1);
1012 
1013  if ( move_it_.valid() ) {
1014  // Finish animating.
1015  animator.finish(move_it_.get_shared_ptr());
1016  // Check for the moving unit being seen.
1017 
1018  bool wml_undo_blocked = false;
1019  bool wml_move_aborted = false;
1020 
1021  std::tie(wml_undo_blocked, wml_move_aborted) = actor_sighted(*move_it_, &not_seeing);
1022  // TODO: should we call post_wml ?
1023  wml_move_aborted_ |= wml_move_aborted;
1024  wml_undo_disabled_ |= wml_undo_blocked;
1025  }
1026  }//if
1027 
1028  // Some flags were set to indicate why we might stop.
1029  // Update those to reflect whether or not we got to them.
1031  if (!obstructed_stop) {
1033  }
1034  teleport_failed_ = teleport_failed_ && obstructed_stop;
1035  // event_mutated_ does not get unset, regardless of other reasons
1036  // for stopping, but we do save its current value.
1038  }
1039 
1040 
1041  /**
1042  * Does some bookkeeping and event firing, for use after movement.
1043  * This includes village capturing and the undo stack.
1044  */
1045  void unit_mover::post_move(undo_list *undo_stack)
1046  {
1047  const map_location & final_loc = final_hex();
1048 
1049  int orig_village_owner = 0;
1050  bool action_time_bonus = false;
1051 
1052  // Reveal ambushers?
1053  if (ambushed_ || blocked()) {
1054  reveal_ambushers();
1055  }
1056  else if (teleport_failed_ && spectator_) {
1057  spectator_->set_failed_teleport(resources::gameboard->units().find(*obstructed_));
1058  }
1060 
1061  if ( move_it_.valid() ) {
1062  // Update the moving unit.
1063  move_it_->set_interrupted_move(
1064  sighted_stop_ && !resources::whiteboard->is_executing_actions() ?
1065  *(full_end_-1) :
1067  if (ambushed_ || final_loc == zoc_stop_) {
1068  move_it_->set_movement(0, true);
1069  }
1070 
1071  // Village capturing.
1072  if ( resources::gameboard->map().is_village(final_loc) ) {
1073  // Is this a capture?
1074  orig_village_owner = resources::gameboard->village_owner(final_loc) + 1;
1075  if ( orig_village_owner != current_side_) {
1076  // Captured. Zap movement and take over the village.
1077  move_it_->set_movement(0, true);
1078  post_wml(get_village(final_loc, current_side_, &action_time_bonus));
1079  }
1080  }
1081  }
1082 
1083  // Finally, the moveto event.
1084  post_wml(resources::game_events->pump().fire("moveto", final_loc, *begin_));
1085 
1086  // Record keeping.
1087  if (spectator_) {
1088  spectator_->set_unit(move_it_);
1089  }
1090  if ( undo_stack ) {
1091  const bool mover_valid = move_it_.valid();
1092 
1093  if ( mover_valid ) {
1094  // MP_COUNTDOWN: added param
1095  undo_stack->add_move(
1096  move_it_.get_shared_ptr(), begin_, real_end_, orig_moves_,
1097  action_time_bonus, orig_village_owner, orig_dir_);
1098  }
1099 
1100  if ( !mover_valid || undo_blocked() ||
1101  (resources::whiteboard->is_active() && resources::whiteboard->should_clear_undo()) || !synced_context::can_undo())
1102  {
1103  undo_stack->clear();
1104  }
1105  }
1106 
1107  // Update the screen.
1109  }
1110 
1111 
1112  /**
1113  * Shows the various on-screen messages, for use after movement.
1114  */
1115  void unit_mover::feedback() const
1116  {
1117  // Alias some resources.
1119 
1120  // Multiple messages may be displayed simultaneously
1121  // this variable is used to keep them from overlapping
1122  std::string message_prefix = "";
1123 
1124  // Ambush feedback?
1125  if ( ambushed_ && show_ambush_alert_ ) {
1126  disp.announce(message_prefix + ambush_string_, font::BAD_COLOR);
1127  message_prefix += " \n";
1128  }
1129 
1130  display::announce_options announce_options;
1131  announce_options.discard_previous = false;
1132 
1133  // Failed teleport feedback?
1135  std::string teleport_string = _("Failed teleport! Exit not empty");
1136  disp.announce(message_prefix + teleport_string, font::BAD_COLOR, announce_options);
1137  message_prefix += " \n";
1138  }
1139 
1140  // Sighted units feedback?
1141  if ( playing_team_is_viewing_ && (enemy_count_ != 0 || friend_count_ != 0) ) {
1142  // Create the message to display (depends on whether friends,
1143  // enemies, or both were sighted, and on how many of each).
1144  utils::string_map symbols;
1145  symbols["enemies"] = std::to_string(enemy_count_);
1146  symbols["friends"] = std::to_string(friend_count_);
1147  std::string message;
1148  color_t msg_color;
1149  if ( friend_count_ != 0 && enemy_count_ != 0 ) {
1150  // Both friends and enemies sighted -- neutral message.
1151  symbols["friendphrase"] = VNGETTEXT("Part of 'Units sighted! (...)' sentence^1 friendly", "$friends friendly", friend_count_, symbols);
1152  symbols["enemyphrase"] = VNGETTEXT("Part of 'Units sighted! (...)' sentence^1 enemy", "$enemies enemy", enemy_count_, symbols);
1153  message = vgettext("Units sighted! ($friendphrase, $enemyphrase)", symbols);
1154  msg_color = font::NORMAL_COLOR;
1155  } else if ( enemy_count_ != 0 ) {
1156  // Only enemies sighted -- bad message.
1157  message = VNGETTEXT("Enemy unit sighted!", "$enemies enemy units sighted!", enemy_count_, symbols);
1158  msg_color = font::BAD_COLOR;
1159  } else if ( friend_count_ != 0 ) {
1160  // Only friends sighted -- good message.
1161  message = VNGETTEXT("Friendly unit sighted", "$friends friendly units sighted", friend_count_, symbols);
1162  msg_color = font::GOOD_COLOR;
1163  }
1164 
1165  disp.announce(message_prefix + message, msg_color, announce_options);
1166  message_prefix += " \n";
1167  }
1168 
1169  // Suggest "continue move"?
1170  if ( playing_team_is_viewing_ && sighted_stop_ && !resources::whiteboard->is_executing_actions() ) {
1171  // See if the "Continue Move" action has an associated hotkey
1173  if ( !name.empty() ) {
1174  utils::string_map symbols;
1175  symbols["hotkey"] = name;
1176  std::string message = vgettext("(press $hotkey to keep moving)", symbols);
1177  disp.announce(message_prefix + message, font::NORMAL_COLOR, announce_options);
1178  message_prefix += " \n";
1179  }
1180  }
1181  }
1182 
1183 }//end anonymous namespace
1184 
1185 
1186 static size_t move_unit_internal(undo_list* undo_stack,
1187  bool show_move,
1188  bool* interrupted,
1189  unit_mover& mover)
1190 {
1191  const events::command_disabler disable_commands;
1192  // Default return value.
1193  if (interrupted) {
1194  *interrupted = false;
1195  }
1196 
1197  // Attempt moving.
1198  mover.try_actual_movement(show_move);
1199 
1200  config co;
1201  config cn {
1202  "stopped_early", mover.stopped_early(),
1203  "final_hex_x", mover.final_hex().wml_x(),
1204  "final_hex_y", mover.final_hex().wml_y(),
1205  };
1206  bool matches_replay = checkup_instance->local_checkup(cn,co);
1207  if(!matches_replay)
1208  {
1209  replay::process_error("calculated movement destination (x="+ cn["final_hex_x"].str() + " y=" + cn["final_hex_y"].str() +
1210  ") didn't match the original destination(x="+ co["final_hex_x"].str() + " y=" + co["final_hex_y"].str() + ")\n");
1211 
1212  //TODO: move the unit by force to the desired destination with something like mover.reset_final_hex(co["x"], co["y"]);
1213  }
1214 
1215  // Bookkeeping, etc.
1216  // also fires the moveto event
1217  mover.post_move(undo_stack);
1218  if (show_move) {
1219  mover.feedback();
1220  }
1221 
1222  // Set return value.
1223  if (interrupted) {
1224  *interrupted = mover.interrupted();
1225  }
1226 
1227  return mover.steps_travelled();
1228 }
1229 
1230 /**
1231  * Moves a unit across the board.
1232  *
1233  * This function handles actual movement, checking terrain costs as well as
1234  * things that might interrupt movement (e.g. ambushes). If the full path
1235  * cannot be reached this turn, the remainder is stored as the unit's "goto"
1236  * instruction. (The unit itself is whatever unit is at the beginning of the
1237  * supplied path.)
1238  *
1239  * @param[in] steps The route to be traveled. The unit to be moved is at the beginning of this route.
1240  * @param undo_stack If supplied, then either this movement will be added to the stack or the stack will be cleared.
1241  * @param[in] continued_move If set to true, this is a continuation of an earlier move (movement is not interrupted should units be spotted).
1242  * @param[in] show_move Controls whether or not the movement is animated for the player.
1243  * @param[out] interrupted If supplied, then this is set to true if information was uncovered that warrants interrupting a chain of actions (and set to false otherwise).
1244  * @param[out] move_spectator If supplied, this will be given the information uncovered by the move (and the unit's "goto" instruction will be preserved).
1245  *
1246  * @returns The number of hexes entered. This can safely be used as an index
1247  * into @a steps to get the location where movement ended, provided
1248  * @a steps is not empty (the return value is guaranteed to be less
1249  * than steps.size() ).
1250  */
1251 size_t move_unit_and_record(const std::vector<map_location> &steps,
1252  undo_list* undo_stack,
1253  bool continued_move, bool show_move,
1254  bool* interrupted,
1255  move_unit_spectator* move_spectator)
1256 {
1257 
1258  // Avoid some silliness.
1259  if ( steps.size() < 2 || (steps.size() == 2 && steps.front() == steps.back()) ) {
1260  DBG_NG << "Ignoring a unit trying to jump on its hex at " <<
1261  ( steps.empty() ? map_location::null_location() : steps.front() ) << ".\n";
1262  return 0;
1263  }
1264  //if we have no fog activated then we always skip sighted
1265  if(resources::gameboard->units().find(steps.front()) != resources::gameboard->units().end())
1266  {
1267  const team &current_team = resources::gameboard->teams()[
1268  resources::gameboard->units().find(steps.front())->side() - 1];
1269  continued_move |= !current_team.fog_or_shroud();
1270  }
1271  const bool skip_ally_sighted = !preferences::interrupt_when_ally_sighted();
1272 
1273  // Evaluate this move.
1274  unit_mover mover(steps, move_spectator, continued_move, skip_ally_sighted);
1275  if ( !mover.check_expected_movement() )
1276  return 0;
1278  {
1279  /*
1280  enter the synced mode and do the actual movement.
1281  */
1282  resources::recorder->add_synced_command("move",replay_helper::get_movement(steps, continued_move, skip_ally_sighted));
1283  set_scontext_synced sync;
1284  size_t r = move_unit_internal(undo_stack, show_move, interrupted, mover);
1287  sync.do_final_checkup();
1288  return r;
1289  }
1290  else
1291  {
1292  //we are already in synced mode and don't need to reenter it again.
1293  return move_unit_internal(undo_stack, show_move, interrupted, mover);
1294  }
1295 }
1296 
1297 size_t move_unit_from_replay(const std::vector<map_location> &steps,
1298  undo_list* undo_stack,
1299  bool continued_move,bool skip_ally_sighted, bool show_move)
1300 {
1301  // Evaluate this move.
1302  unit_mover mover(steps, nullptr, continued_move,skip_ally_sighted);
1303  if ( !mover.check_expected_movement() )
1304  {
1305  replay::process_error("found corrupt movement in replay.");
1306  return 0;
1307  }
1308 
1309  return move_unit_internal(undo_stack, show_move, nullptr, mover);
1310 }
1311 
1312 
1313 }//namespace actions
play_controller * controller
Definition: resources.cpp:21
bool fog_changed_
Definition: move.cpp:326
void invalidate_unit_after_move(const map_location &src, const map_location &dst)
Same as invalidate_unit() if moving the displayed unit.
bool discard_previous
An announcement according these options should replace the previous announce (typical of fast announc...
Definition: display.hpp:592
bool fogged(const map_location &loc) const
Returns true if location (x,y) is covered in fog.
Definition: display.cpp:735
bool fire_event(const ui_event event, std::vector< std::pair< widget *, ui_event >> &event_chain, widget *dispatcher, widget *w, F &&...params)
Helper function for fire_event.
bool ambushed_
Definition: move.cpp:320
virtual const unit_map & units() const
Definition: game_board.hpp:97
unit_iterator end()
Definition: map.hpp:415
map_location zoc_stop_
Definition: move.cpp:317
std::vector< char_t > string
move_unit_spectator *const spectator_
Definition: move.cpp:287
std::map< std::string, t_string > string_map
size_t move_unit_and_record(const std::vector< map_location > &steps, undo_list *undo_stack, bool continued_move, bool show_move, bool *interrupted, move_unit_spectator *move_spectator)
Moves a unit across the board.
Definition: move.cpp:1251
bool invalidate(const map_location &loc)
Function to invalidate a specific tile for redrawing.
Definition: display.cpp:3023
void reset(const unit_map &units)
reset all locations to empty values
Definition: move.cpp:111
This class represents a single unit of a specific type.
Definition: unit.hpp:100
bool sighted_stop_
Definition: move.cpp:328
Various functions implementing vision (through fog of war and shroud).
void do_final_checkup(bool dont_throw=false)
The unit is uncovered - it was hiding but has been spotted.
Definition: unit.hpp:723
size_t count(const map_location &loc) const
Definition: map.hpp:400
std::deque< int > moves_left_
Definition: move.cpp:334
const std::vector< unit_map::const_iterator > & get_seen_friends() const
get the locations of seen friends
Definition: move.cpp:89
const color_t GOOD_COLOR
bool owns_village(const map_location &loc) const
Definition: team.hpp:184
void get_adjacent_tiles(const map_location &a, map_location *res)
Function which, given a location, will place all adjacent locations in res.
Definition: location.hpp:299
bool is_village(const map_location &loc) const
Definition: map.cpp:66
game_display * screen
Definition: resources.cpp:27
bool is_enemy(int n) const
Definition: team.hpp:241
route_iterator real_end_
Definition: move.cpp:300
const int orig_moves_
Definition: move.cpp:307
static config get_movement(const std::vector< map_location > &steps, bool skip_sighted, bool skip_ally_sighted)
Records a move that follows the provided steps.
unit_map::iterator move_it_
Definition: move.cpp:303
unit_map::const_iterator failed_teleport_
Definition: move.hpp:89
int village_owner(const map_location &loc) const
Given the location of a village, will return the 0-based index of the team that currently owns it...
#define VNGETTEXT(msgid, msgid_plural, count,...)
virtual const std::vector< team > & teams() const
Definition: game_board.hpp:92
Replay control code.
void check_victory()
Checks to see if a side has won.
const unit * unit_
-file sdl_utils.hpp
bool team_is_defeated(const team &t) const
Calculates whether a team is defeated.
Definition: game_board.cpp:225
void redraw_minimap()
Schedule the minimap to be redrawn.
Definition: display.hpp:616
map_location ambush_stop_
Definition: move.cpp:318
void add_synced_command(const std::string &name, const config &command)
Definition: replay.cpp:237
static synced_state get_synced_state()
game_data * gamedata
Definition: resources.cpp:22
const std::vector< unit_map::const_iterator > & get_seen_enemies() const
get the locations of seen enemies
Definition: move.cpp:83
std::vector< unit_map::const_iterator > seen_friends_
Definition: move.hpp:91
const unit_map::const_iterator & get_failed_teleport() const
get the location of a failed teleport
Definition: move.cpp:77
size_t wml_tracking()
This function can be used to detect when no WML/Lua has been executed.
Definition: pump.cpp:645
bool wml_move_aborted_
Definition: move.cpp:324
std::string get_names(const std::string &id)
Returns a comma-separated string of hotkey names.
static void clear_status_caches()
Clear this unit status cache for all units.
Definition: unit.cpp:617
This class stores all the data for a single 'side' (in game nomenclature).
Definition: team.hpp:44
route_iterator expected_end_
Definition: move.cpp:297
bool fog_or_shroud() const
Definition: team.hpp:314
static UNUSEDNOWARN std::string _(const char *str)
Definition: gettext.hpp:89
team & get_team(int i)
Definition: game_board.hpp:94
bool event_mutated_mid_move_
Definition: move.cpp:325
bool sighted_
Definition: move.cpp:327
static lg::log_domain log_engine("engine")
bool tiles_adjacent(const map_location &a, const map_location &b)
Function which tells if two locations are adjacent.
Definition: location.hpp:339
void finish(unit_ptr u, map_location::DIRECTION dir=map_location::NDIRECTIONS)
Finishes the display of movement for the supplied unit.
Definition: udisplay.cpp:409
std::pair< const config *, map_location > unit_ability
Definition: unit.hpp:51
pointer get_shared_ptr() const
This is exactly the same as operator-> but it's slightly more readable, and can replace &*iter syntax...
Definition: map.hpp:220
void add_seen_enemy(const unit_map::const_iterator &u)
add the location of new seen enemy
Definition: move.cpp:65
void proceed_to(unit_ptr u, size_t path_index, bool update=false, bool wait=true)
Visually moves a unit from the last hex we drew to the one specified by path_index.
Definition: udisplay.cpp:297
void set_failed_teleport(const unit_map::const_iterator &u)
set the location of a failed teleport
Definition: move.cpp:127
game_board * gameboard
Definition: resources.cpp:20
route_iterator move_loc_
Definition: move.cpp:315
Encapsulates the map of the game.
Definition: map.hpp:34
team * current_team_
Definition: move.cpp:313
bool show_ambush_alert_
Definition: move.cpp:321
checkup * checkup_instance
unit_ability_list get_abilities(const std::string &tag_name, const map_location &loc) const
Gets the unit's active abilities of a particular type if it were on a specified location.
Definition: abilities.cpp:177
umap_retval_pair_t move(const map_location &src, const map_location &dst)
Moves a unit from location src to location dst.
Definition: map.cpp:94
A class to encapsulate the steps of drawing a unit's move.
Definition: udisplay.hpp:44
static bool can_undo()
replay * recorder
Definition: resources.cpp:29
void wait_for_anims()
Waits for the final animation of the most recent proceed_to() to finish.
Definition: udisplay.cpp:369
void set_ambusher(const unit_map::const_iterator &u)
set the location of an ambusher
Definition: move.cpp:121
static const map_location & null_location()
Definition: location.hpp:220
unit_map::const_iterator ambusher_
Definition: move.hpp:88
game_events::manager * game_events
Definition: resources.cpp:24
void pump()
Definition: events.cpp:409
const color_t NORMAL_COLOR
move_unit_spectator(const unit_map &units)
constructor
Definition: move.cpp:101
Encapsulates the map of the game.
Definition: location.hpp:40
std::vector< unit_map::const_iterator > seen_enemies_
Definition: move.hpp:90
Various functions related to moving units.
std::shared_ptr< wb::manager > whiteboard
Definition: resources.cpp:35
static void process_error(const std::string &msg)
Definition: replay.cpp:194
size_t friend_count_
Definition: move.cpp:331
const route_iterator begin_
Definition: move.cpp:295
std::vector< map_location > ambushers_
Definition: move.cpp:333
bool teleport_failed_
Definition: move.cpp:329
map_location blocked_loc_
Definition: move.cpp:319
const unit_map::const_iterator & get_ambusher() const
get the location of an ambusher
Definition: move.cpp:71
size_t move_unit_from_replay(const std::vector< map_location > &steps, undo_list *undo_stack, bool continued_move, bool skip_ally_sighted, bool show_move)
Moves a unit across the board.
Definition: move.cpp:1297
int current_side_
Definition: move.cpp:312
void announce(const std::string &msg, const color_t &color=font::GOOD_COLOR, const announce_options &options=announce_options())
Announce a message prominently.
Definition: display.cpp:1789
bool interrupt_when_ally_sighted()
Definition: game.cpp:805
Holds options for calls to function 'announce' (announce).
Definition: display.hpp:582
EXIT_STATUS start(const config &game_conf, const std::string &filename, bool take_screenshot, const std::string &screenshot_filename)
Main interface for launching the editor from the title screen.
Definition: editor_main.cpp:28
size_t enemy_count_
Definition: move.cpp:330
void maybe_throw_return_to_play_side() const
Define the game's event mechanism.
void start(unit_ptr u)
Initiates the display of movement for the supplied unit.
Definition: udisplay.cpp:240
std::string ambush_string_
Definition: move.cpp:332
const unit_map::const_iterator & get_unit() const
get new location of moved unit
Definition: move.cpp:95
size_t i
Definition: function.cpp:933
DIRECTION
Valid directions which can be moved in our hexagonal world.
Definition: location.hpp:42
const bool skip_sighting_
Definition: move.cpp:288
route_iterator ambush_limit_
Definition: move.cpp:298
std::string vgettext(const char *msgid, const utils::string_map &symbols)
virtual const gamemap & map() const
Definition: game_board.hpp:96
size_t erase(const map_location &l)
Erases the unit at location l, if any.
Definition: map.cpp:298
shroud_clearer clearer_
Definition: move.cpp:336
unit_map::const_iterator unit_
Definition: move.hpp:92
void set_unit(const unit_map::const_iterator &u)
set the iterator to moved unit
Definition: move.cpp:133
game_events::pump_result_t get_village(const map_location &, const int owner_side, game_data *fire_event)
Acquires a village from owner_side. Pointer fire_event should be the game_data for the game if it is ...
Definition: team.cpp:424
game_events::pump_result_t get_village(const map_location &loc, int side, bool *action_timebonus, bool fire_event)
Makes it so the village at the given location is owned by the given side.
Definition: move.cpp:139
Class to store the actions that a player can undo and redo.
Definition: undo.hpp:35
double t
Definition: astarsearch.cpp:64
void add_seen_friend(const unit_map::const_iterator &u)
add a location of a seen friend
Definition: move.cpp:59
bool find(E event, F functor)
Tests whether an event handler is available.
Various functions that implement the undoing (and redoing) of in-game commands.
void set_action_bonus_count(const int count)
Definition: team.hpp:213
Standard logging facilities (interface).
const teleport_map get_teleport_locations(const unit &u, const team &viewing_team, bool see_all, bool ignore_units, bool check_vision)
Definition: teleport.cpp:259
Container associating units to locations.
Definition: map.hpp:99
bool wml_undo_disabled_
Definition: move.cpp:323
static const char * name(const std::vector< SDL_Joystick * > &joysticks, const size_t index)
Definition: joystick.cpp:48
const bool playing_team_is_viewing_
Definition: move.cpp:290
const map_location goto_
Definition: move.cpp:309
route_iterator obstructed_
Definition: move.cpp:299
bool current_uses_fog_
Definition: move.cpp:314
actions::undo_list * undo_stack
Definition: resources.cpp:33
game_events::wml_event_pump & pump()
Definition: manager.cpp:226
unit_iterator find(size_t id)
Definition: map.cpp:311
bool valid() const
Definition: map.hpp:276
virtual bool local_checkup(const config &expected_data, config &real_data)=0
Compares data to the results calculated during the original game.
const route_iterator full_end_
Definition: move.cpp:296
std::tuple< bool, bool > pump_result_t
Definition: fwd.hpp:28
const map_location::DIRECTION orig_dir_
Definition: move.cpp:308
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:93
int action_bonus_count() const
Definition: team.hpp:212
static size_t move_unit_internal(undo_list *undo_stack, bool show_move, bool *interrupted, unit_mover &mover)
Definition: move.cpp:1186
std::vector< int > get_sides_not_seeing(const unit &target)
Returns the sides that cannot currently see target.
Definition: vision.cpp:595
#define DBG_NG
Definition: move.cpp:53
const bool skip_ally_sighting_
Definition: move.cpp:289
This module contains various pathfinding functions and utilities.
std::string::const_iterator iterator
Definition: tokenizer.hpp:24
unit_map * units
Definition: resources.cpp:34
const int orig_side_
Definition: move.cpp:306
Display units performing various actions: moving, attacking, and dying.
bool enemy_zoc(team const &current_team, map_location const &loc, team const &viewing_team, bool see_all)
Determines if a given location is in an enemy zone of control.
Definition: pathfind.cpp:136
bool wml_removed_unit_
Definition: move.cpp:322
const color_t BAD_COLOR
static const hotkey_command & get_command_by_command(HOTKEY_COMMAND command)
the execute_command argument was changed from HOTKEY_COMMAND to hotkey_command, to be able to call it...
game_events::pump_result_t actor_sighted(const unit &target, const std::vector< int > *cache)
Fires sighted events for the sides that can see target.
Definition: vision.cpp:622
void get_adjacents(std::set< map_location > &adjacents, map_location loc) const
Definition: teleport.cpp:228
const std::vector< map_location > & route_
Definition: move.cpp:292
void show(const std::string &window_id, const t_string &message, const point &mouse, const SDL_Rect &source_rect)
Shows a tip.
Definition: tooltip.cpp:153
virtual ~move_unit_spectator()
destructor
Definition: move.cpp:107