The Battle for Wesnoth  1.19.0-dev
recall.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2010 - 2024
3  by Gabriel Morin <gabrielmorin (at) gmail (dot) com>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 /**
17  * @file
18  */
19 
20 #include "whiteboard/recall.hpp"
21 
23 #include "whiteboard/utility.hpp"
24 #include "whiteboard/visitor.hpp"
25 
26 #include "display.hpp"
27 #include "fake_unit_ptr.hpp"
28 #include "game_board.hpp"
29 #include "recall_list_manager.hpp"
30 #include "resources.hpp"
31 #include "replay_helper.hpp"
32 #include "synced_context.hpp"
33 #include "team.hpp"
34 #include "units/filter.hpp"
35 #include "units/unit.hpp"
37 
38 namespace wb
39 {
40 
41 std::ostream& operator<<(std::ostream& s, recall_ptr recall)
42 {
43  assert(recall);
44  return recall->print(s);
45 }
46 std::ostream& operator<<(std::ostream& s, recall_const_ptr recall)
47 {
48  assert(recall);
49  return recall->print(s);
50 }
51 
52 std::ostream& recall::print(std::ostream &s) const
53 {
54  s << "Recalling " << fake_unit_->name() << " [" << fake_unit_->id() << "] on hex " << recall_hex_;
55  return s;
56 }
57 
58 recall::recall(std::size_t team_index, bool hidden, const unit& u, const map_location& recall_hex)
59  : action(team_index,hidden)
60  , temp_unit_(u.clone())
61  , recall_hex_(recall_hex)
62  , fake_unit_(u.clone())
63  , original_mp_(0)
64  , original_ap_(0)
65  , original_recall_pos_(0)
66 {
67  this->init();
68 }
69 
70 recall::recall(const config& cfg, bool hidden)
71  : action(cfg,hidden)
72  , temp_unit_()
73  , recall_hex_(cfg.mandatory_child("recall_hex_")["x"],cfg.mandatory_child("recall_hex_")["y"], wml_loc())
74  , fake_unit_()
75  , original_mp_(0)
76  , original_ap_(0)
77  , original_recall_pos_(0)
78 {
79  // Construct and validate temp_unit_
80  std::size_t underlying_id = cfg["temp_unit_"];
81  for(const unit_ptr & recall_unit : resources::gameboard->teams().at(team_index()).recall_list())
82  {
83  if(recall_unit->underlying_id()==underlying_id)
84  {
86  break;
87  }
88  }
89  if(!temp_unit_.get()) {
90  throw action::ctor_err("recall: Invalid underlying_id");
91  }
92 
93  fake_unit_.reset(temp_unit_->clone()); //makes copy of temp_unit_
94 
95  this->init();
96 }
97 
99 {
100  fake_unit_->set_location(recall_hex_);
101  fake_unit_->set_movement(0, true);
102  fake_unit_->set_attacks(0);
103  fake_unit_->anim_comp().set_ghosted(false);
105 }
106 
108 {
109 }
110 
112 {
113  v.visit(shared_from_this());
114 }
115 
116 void recall::execute(bool& success, bool& complete)
117 {
118  team & current_team = resources::gameboard->teams().at(team_index());
119 
120  assert(valid());
121  assert(temp_unit_.get());
122  temporary_unit_hider const raii(*fake_unit_);
123  //Give back the spent gold so we don't get "not enough gold" message
124  int cost = current_team.recall_cost();
125  if (temp_unit_->recall_cost() > -1) {
126  cost=temp_unit_->recall_cost();
127  }
128  current_team.get_side_actions()->change_gold_spent_by(-cost);
129  bool const result = synced_context::run_and_throw("recall",
131  true,
132  true,
134 
135  if (!result) {
136  current_team.get_side_actions()->change_gold_spent_by(cost);
137  }
138  success = complete = result;
139 }
140 
142 {
143  assert(valid());
144 
145 
146  DBG_WB << "Inserting future recall " << temp_unit_->name() << " [" << temp_unit_->id()
147  << "] at position " << temp_unit_->get_location() << ".";
148 
149  //temporarily remove unit from recall list
150  unit_ptr it = resources::gameboard->teams().at(team_index()).recall_list().extract_if_matches_id(temp_unit_->id(), &original_recall_pos_);
151  assert(it);
152 
153  //Usually (temp_unit_ == it) is true here, but wml might have changed the original unit in which case not doing 'temp_unit_ = it' would result in a gamestate change.
154  temp_unit_ = it;
155  original_mp_ = temp_unit_->movement_left(true);
156  original_ap_ = temp_unit_->attacks_left(true);
157 
158  temp_unit_->set_movement(0, true);
159  temp_unit_->set_attacks(0);
160  temp_unit_->set_location(recall_hex_);
161 
162  //Add cost to money spent on recruits.
163  int cost = resources::gameboard->teams().at(team_index()).recall_cost();
164  if (it->recall_cost() > -1) {
165  cost = it->recall_cost();
166  }
167 
168  // Temporarily insert unit into unit_map
169  //unit map takes ownership of temp_unit
171 
172  resources::gameboard->teams().at(team_index()).get_side_actions()->change_gold_spent_by(cost);
173  // Update gold in top bar
175 }
176 
178 {
180  assert(temp_unit_.get());
181 
182  temp_unit_->set_movement(original_mp_, true);
183  temp_unit_->set_attacks(original_ap_);
184 
185  original_mp_ = 0;
186  original_ap_ = 0;
187  //Put unit back into recall list
189 }
190 
192 {
193  if (hex == recall_hex_)
194  {
195  const double x_offset = 0.5;
196  const double y_offset = 0.7;
197  //position 0,0 in the hex is the upper left corner
198  std::stringstream number_text;
199  unit &it = *get_unit();
200  int cost = it.recall_cost();
201  if (cost < 0) {
202  number_text << font::unicode_minus << resources::gameboard->teams().at(team_index()).recall_cost();
203  }
204  else {
205  number_text << font::unicode_minus << cost;
206  }
207  std::size_t font_size = 16;
208  color_t color {255, 0, 0}; //red
210  number_text.str(), font_size, color, x_offset, y_offset);
211  }
212 }
213 
215 {
217 }
218 
220 {
221  //Check that destination hex is still free
222  if(resources::gameboard->units().find(recall_hex_) != resources::gameboard->units().end()) {
223  return LOCATION_OCCUPIED;
224  }
225  //Check that unit to recall is still in side's recall list
226  if( !resources::gameboard->teams()[team_index()].recall_list().find_if_matches_id(temp_unit_->id()) ) {
227  return UNIT_UNAVAILABLE;
228  }
229  //Check that there is still enough gold to recall this unit
230  if(resources::gameboard->teams()[team_index()].recall_cost() > resources::gameboard->teams()[team_index()].gold()) {
231  return NOT_ENOUGH_GOLD;
232  }
233  //Check that there is a leader available to recall this unit
234  bool has_recruiter = any_recruiter(team_index() + 1, get_recall_hex(), [&](unit& leader) {
235  const unit_filter ufilt(vconfig(leader.recall_filter()));
236  return ufilt(*temp_unit_, map_location::null_location());
237  });
238 
239  if(!has_recruiter) {
240  return NO_LEADER;
241  }
242 
243  return OK;
244 }
245 
246 /** @todo Find a better way to serialize unit_ because underlying_id isn't cutting it */
248 {
249  config final_cfg = action::to_config();
250 
251  final_cfg["type"] = "recall";
252  final_cfg["temp_unit_"] = static_cast<int>(temp_unit_->underlying_id());
253 // final_cfg["temp_cost_"] = temp_cost_; //Unnecessary
254 
255  config loc_cfg;
256  loc_cfg["x"]=recall_hex_.wml_x();
257  loc_cfg["y"]=recall_hex_.wml_y();
258  final_cfg.add_child("recall_hex_", std::move(loc_cfg));
259 
260  return final_cfg;
261 }
262 
263 void recall::do_hide() {fake_unit_->set_hidden(true);}
264 void recall::do_show() {fake_unit_->set_hidden(false);}
265 
266 } //end namespace wb
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
config & add_child(config_key_type key)
Definition: config.cpp:441
void draw_text_in_hex(const map_location &loc, const drawing_layer layer, const std::string &text, std::size_t font_size, color_t color, double x_in_hex=0.5, double y_in_hex=0.5)
Draw text on a hex.
Definition: display.cpp:1476
bool invalidate(const map_location &loc)
Function to invalidate a specific tile for redrawing.
Definition: display.cpp:3137
@ LAYER_ACTIONS_NUMBERING
Move numbering for the whiteboard.
Definition: display.hpp:833
void invalidate_game_status()
Function to invalidate the game status displayed on the sidebar.
Definition: display.hpp:307
static display * get_singleton()
Returns the display object if a display object exists.
Definition: display.hpp:95
void reset()
Reset the internal unit pointer, and deregister from the manager.
void place_on_fake_unit_manager(fake_unit_manager *d)
Place this on manager's fake_units_ dequeue.
virtual const std::vector< team > & teams() const override
Definition: game_board.hpp:79
static config get_recall(const std::string &unit_id, const map_location &loc, const map_location &from)
static void ignore_error_function(const std::string &message)
A function to be passed to run_in_synced_context to ignore the error.
static bool run_and_throw(const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
This class stores all the data for a single 'side' (in game nomenclature).
Definition: team.hpp:74
int recall_cost() const
Definition: team.hpp:179
std::shared_ptr< wb::side_actions > get_side_actions() const
get the whiteboard planned actions for this team
Definition: team.hpp:371
Container associating units to locations.
Definition: map.hpp:98
unit_ptr extract(const map_location &loc)
Extracts a unit from the map.
Definition: map.cpp:259
umap_retval_pair_t insert(unit_ptr p)
Inserts the unit pointed to by p into the map.
Definition: map.cpp:135
This class represents a single unit of a specific type.
Definition: unit.hpp:133
A variable-expanding proxy for the config class.
Definition: variable.hpp:45
Abstract base class for all the whiteboard planned actions.
Definition: action.hpp:34
bool valid()
Returns whether this action is valid or not.
Definition: action.hpp:135
std::size_t team_index() const
Returns the index of the team that owns this action.
Definition: action.hpp:84
virtual config to_config() const
Constructs and returns a config object representing this object.
Definition: action.cpp:51
error
Possible errors.
Definition: action.hpp:107
@ NOT_ENOUGH_GOLD
Definition: action.hpp:118
@ LOCATION_OCCUPIED
Definition: action.hpp:112
@ UNIT_UNAVAILABLE
Definition: action.hpp:117
std::shared_ptr< recall > shared_from_this()
Definition: recall.hpp:76
unit_ptr temp_unit_
Definition: recall.hpp:87
virtual void remove_temp_modifier(unit_map &unit_map)
Removes the result of this action from the specified unit map.
Definition: recall.cpp:177
virtual void execute(bool &success, bool &complete)
Output parameters: success: Whether or not to continue an execute-all after this execution complete: ...
Definition: recall.cpp:116
virtual ~recall()
Definition: recall.cpp:107
map_location recall_hex_
Definition: recall.hpp:88
virtual void apply_temp_modifier(unit_map &unit_map)
Applies temporarily the result of this action to the specified unit map.
Definition: recall.cpp:141
int original_mp_
Definition: recall.hpp:91
virtual void do_hide()
Called by the non-virtual hide() and show(), respectively.
Definition: recall.cpp:263
virtual void redraw()
Redrawing function, called each time the action situation might have changed.
Definition: recall.cpp:214
int original_recall_pos_
Definition: recall.hpp:93
void init()
Definition: recall.cpp:98
virtual std::ostream & print(std::ostream &s) const
Definition: recall.cpp:52
virtual void do_show()
Definition: recall.cpp:264
virtual error check_validity() const
Check the validity of the action.
Definition: recall.cpp:219
map_location const get_recall_hex() const
Definition: recall.hpp:70
recall(std::size_t team_index, bool hidden, const unit &unit, const map_location &recall_hex)
Definition: recall.cpp:58
virtual void draw_hex(const map_location &hex)
Gets called by display when drawing a hex, to allow actions to draw to the screen.
Definition: recall.cpp:191
virtual unit_ptr get_unit() const
Definition: recall.hpp:65
virtual void accept(visitor &v)
Definition: recall.cpp:111
virtual config to_config() const
Definition: recall.cpp:247
int original_ap_
Definition: recall.hpp:92
fake_unit_ptr fake_unit_
Definition: recall.hpp:89
Abstract base class for all the visitors (cf GoF Visitor Design Pattern) the whiteboard uses.
Definition: visitor.hpp:33
virtual void visit(move_ptr move)=0
const config & recall_filter() const
Gets the filter constraints upon which units this unit may recall, if able.
Definition: unit.hpp:652
int recall_cost() const
How much gold it costs to recall this unit, or -1 if the side's default recall cost is used.
Definition: unit.hpp:640
bool recall_unit(const std::string &id, team &current_team, const map_location &loc, const map_location &from, map_location::DIRECTION facing, bool show, bool use_undo)
Recalls the unit with the indicated ID for the provided team.
Definition: create.cpp:744
const std::string unicode_minus
Definition: constants.cpp:42
game_board * gameboard
Definition: resources.cpp:20
fake_unit_manager * fake_units
Definition: resources.cpp:30
static std::string at(const std::string &file, int line)
Definition: display.hpp:45
std::shared_ptr< recall const > recall_const_ptr
Definition: typedefs.hpp:75
std::ostream & operator<<(std::ostream &s, action_ptr action)
Definition: action.cpp:34
bool any_recruiter(int team_num, const map_location &loc, std::function< bool(unit &)> func)
executes func for each unti of side of side_num that can recruit on loc.
Definition: utility.cpp:90
std::shared_ptr< recall > recall_ptr
Definition: typedefs.hpp:74
std::shared_ptr< unit > unit_ptr
Definition: ptr.hpp:26
The basic class for representing 8-bit RGB or RGBA colour values.
Definition: color.hpp:59
Encapsulates the map of the game.
Definition: location.hpp:38
int wml_y() const
Definition: location.hpp:154
static const map_location & null_location()
Definition: location.hpp:81
int wml_x() const
Definition: location.hpp:153
static map_location::DIRECTION s
#define DBG_WB
Definition: typedefs.hpp:28
visitor is an abstract interface : action.accept(visitor) calls visitor.visit(action)