src/DB/Savables/Chunk.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 #include "SavableHeaders.h"
  23 #include "SavableTypes.h"
  24 #include "Coordinate.h"
  25
  26 namespace mud
  27 {
  28         class ChunkManager;
  29
  30         class Chunk : public Savable
  31         {
  32         public:
  33                 /*
  34                  * Getters
  35                  */
  36                 value_type getID() const;
  37                 const std::string& getName() const;
  38                 const std::string& getDescription() const;
  39                 const std::string& getTags() const;
  40                 value_type getRoom() const;
  41
  42                 /**
  43                  * Returns the Exit in the specified direction, if there is one.
  44                  *
  45                  * The specified coordinate should be a direction, this is asserted with isDirection at runtime.
  46                  * When no room could be found in the specified direction, 0 is returned.
  47                  */
  48                 value_type getExitAt(Coordinate direction) const;
  49
  50                 /*
  51                  * Setters
  52                  */
  53                 void setName(const std::string& name);
  54                 void setDescription(const std::string& description);
  55                 void setTags(const std::string& tags);
  56                 void setRoom(value_type room);
  57
  58                 /*
  59                  * Utilities
  60                  */
  61                 SavableManagerPtr getManager() const;
  62                 TableImplPtr getTable() const;
  63
  64                 /*
  65                  * Room operations
  66                  */
  67                 void addCharacter(value_type characterid);
  68                 void removeCharacter(value_type characterid);
  69
  70                 /** Returns an iterator to the first character in the room. */
  71                 value_types::const_iterator firstCharactersInRoom() { return m_charactersInRoom.begin(); }
  72
  73                 /** Returns the 'end' iterator of the characters in the room. */
  74                 value_types::const_iterator lastCharactersInRoom() { return m_charactersInRoom.end(); }
  75
  76                 /** Returns the size of the characters in the room. */
  77                 value_type sizeCharactersInRoom() { return m_charactersInRoom.size(); }
  78
  79                 /** Sends a message to all characters in the room. */
  80                 void Send(const std::string& msg);
  81
  82                 /*
  83                  * Database operations
  84                  */
  85                 void Delete();
  86                 void Save();
  87                 void Discard();
  88                 bool Exists();
  89
  90         private:
  91                 friend class mud::ChunkManager; // For constructor
  92                 friend SmartPtrDelete(mud::Chunk);
  93
  94                 SavableManagerPtr m_chunk;
  95                 value_types m_charactersInRoom;
  96
  97                 /**
  98                  * \brief Constructor
  99                  * \param chunk The DB object
 100                  */
 101                 Chunk(SavableManagerPtr chunk);
 102
 103                 Chunk(const Chunk& rhs);
 104                 Chunk operator=(const Chunk& rhs);
 105
 106                 /** Destructor, unlocks the savable. */
 107                 ~Chunk(void);
 108         };
 109 }