git.maemo.org Git - lordsawar/blob - src/Ownable.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 OWNABLE_H
  19 #define OWNABLE_H
  20
  21
  22 class Player;
  23 class XML_Helper;
  24
  25 //! A game object that has an owner.
  26 /**
  27  * An Ownable is a map object that can be owned by a Player.
  28  */
  29
  30 class Ownable
  31 {
  32  public:
  33
  34      //! Default constructor.
  35      Ownable(Player *owner);
  36
  37      //! Copy constructor.
  38      Ownable(const Ownable&);
  39
  40      //! Loading constructor.
  41      Ownable(XML_Helper* helper);
  42
  43      //! Destructor.
  44     virtual ~Ownable();
  45
  46     // Get Methods
  47
  48     //! Return a pointer to the Player who owns an object.
  49     Player *getOwner() const {return d_owner;}
  50
  51     //! Return true if the player parameter matches the owner.
  52     bool isFriend (Player *player) const;
  53
  54     // Set Methods
  55
  56     //! Set the Player who owns an object.
  57     void setOwner(Player *player){d_owner = player;}
  58
  59     // Statics
  60
  61     //! Callback for loading an Ownable object from an opened saved-game file.
  62     static Ownable load(XML_Helper *helper);
  63
  64  protected:
  65
  66     // A pointer to the player owning this object.
  67     Player *d_owner;
  68 };
  69
  70 #endif