recall.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2010 - 2025
    by Gabriel Morin <gabrielmorin (at) gmail (dot) com>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
/**
 * @file
 */
 
#pragma once
 
#include "action.hpp"
#include "map/location.hpp"
 
namespace wb
{
 
class recall: public action
{
public:
    recall(std::size_t team_index, bool hidden, const unit& unit, const map_location& recall_hex);
    recall(const config&, bool hidden); // For deserialization
    virtual ~recall();
 
    virtual std::ostream& print(std::ostream& s) const;
 
    virtual void accept(visitor& v);
 
    virtual void execute(bool& success, bool& complete);
 
    /**
     * Check the validity of the action.
     *
     * @return the error preventing the action from being executed.
     * @retval OK if there isn't any error (the action can be executed.)
     */
    virtual error check_validity() const;
 
    /** Applies temporarily the result of this action to the specified unit map. */
    virtual void apply_temp_modifier(unit_map& unit_map);
    /** Removes the result of this action from the specified unit map. */
    virtual void remove_temp_modifier(unit_map& unit_map);
 
    /** Gets called by display when drawing a hex, to allow actions to draw to the screen. */
    virtual void draw_hex(const map_location& hex);
    /** Redrawing function, called each time the action situation might have changed. */
    virtual void redraw();
 
    /**
     * Indicates whether this hex is the preferred hex to draw the numbering for this action.
     */
    virtual map_location get_numbering_hex() const { return recall_hex_; }
 
    /** @return pointer to a copy of the recall unit. */
    virtual unit_ptr get_unit() const { return temp_unit_; }
    virtual bool places_new_unit() const { return true; }
    /** @return pointer to the fake unit used only for visuals */
    virtual fake_unit_ptr get_fake_unit() { return fake_unit_; }
 
    map_location const get_recall_hex() const { return recall_hex_; }
 
    virtual config to_config() const;
 
protected:
 
    std::shared_ptr<recall> shared_from_this() {
        return std::static_pointer_cast<recall>(action::shared_from_this());
    }
 
private:
    void init();
 
    virtual void do_hide();
    virtual void do_show();
 
    // This is the pointer to the real recall unit.
    unit_ptr temp_unit_;
    map_location recall_hex_;
    fake_unit_ptr fake_unit_;
 
    int original_mp_;
    int original_ap_;
    int original_recall_pos_;
};
 
std::ostream& operator<<(std::ostream& s, const recall_ptr& recall);
std::ostream& operator<<(std::ostream& s, const recall_const_ptr& recall);
 
}