1
// Copyright (C) 2008 Ben Asselstine
3
// This program is free software; you can redistribute it and/or modify
4
// it under the terms of the GNU General Public License as published by
5
// the Free Software Foundation; either version 2 of the License, or
6
// (at your option) any later version.
8
// This program is distributed in the hope that it will be useful,
9
// but WITHOUT ANY WARRANTY; without even the implied warranty of
10
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
// GNU Library General Public License for more details.
13
// You should have received a copy of the GNU General Public License
14
// along with this program; if not, write to the Free Software
15
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23
#include "rectangle.h"
24
#include "Renamable.h"
25
#include "xmlhelper.h"
27
//! An object that is given to a player that defogs a portion of the fog map.
29
* This class describes a sightmap. It is similar to an item except is not
30
* carried by a hero, and it is not retained in a backpack. The sightmap is
31
* used once by a player to defog a portion of the hidden map.
34
class SightMap: public Rectangle, public Renamable
37
//! The xml tag of this object in a saved-game file.
38
static std::string d_tag;
40
//! Loading constructor.
41
SightMap(XML_Helper* helper);
44
SightMap(const SightMap& orig);
46
//! Creates a new sightmap from scratch.
48
* @param pos The top-left corner of the sightmap on the game map.
50
SightMap(std::string name, Vector<int> pos, Uint32 height, Uint32 width);
55
//! Save the sightmap to the opened saved-game file.
56
bool save(XML_Helper* helper) const;