vcs.maemo.org Git - lordsawar/blob - src/Namable.h

   1 //  Copyright (C) 2008, 2009 Ben Asselstine
   2 //
   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 3 of the License, or
   6 //  (at your option) any later version.
   7 //
   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.
  12 //
  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
  16 //  02110-1301, USA.
  17
  18 #ifndef NAMABLE_H
  19 #define NAMABLE_H
  20
  21 #include "defs.h"
  22 #include "vector.h"
  23 #include "Named.h"
  24
  25 class XML_Helper;
  26
  27 //! A game object that has an unchanging name.
  28 /**
  29  * An Namable is a game object that has a name that can't be changed.
  30  */
  31 class Namable: private Named
  32 {
  33  public:
  34      //! Default constructor.
  35      /**
  36       * @note After the name is set in the constructor, it cannot be altered.
  37       */
  38      Namable(std::string name);
  39
  40      //! Copy constructor.
  41      Namable(const Namable&);
  42
  43      //! Loading constructor.
  44      Namable(XML_Helper* helper);
  45
  46      //! Destructor.
  47     ~Namable();
  48
  49     //! Return the name of the object on the game map.
  50     std::string getName(bool translate = false) const
  51       {
  52         if (translate == true)
  53           return _(d_name.c_str());
  54         else
  55           return d_name;
  56       }
  57
  58 };
  59
  60 #endif