src/DB/Savables/Character.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
  25 namespace mud
  26 {
  27         class CharacterManager;
  28
  29         class Character : public Savable
  30         {
  31         public:
  32                 virtual void OnSend(const std::string& msg);
  33                 virtual void OnSendf(const char* format, ...);
  34
  35                 /*
  36                  * Start of Commands
  37                  */
  38                 virtual void OnLook(const std::string& msg);
  39                 virtual void OnScore(const std::string& msg);
  40                 virtual void OnSay(const std::string& msg);
  41                 /*
  42                  * End of commands
  43                  */
  44
  45                 /*
  46                  * Getters
  47                  */
  48                 value_type getID() const;
  49                 const std::string& getName() const;
  50                 const std::string& getDescription() const;
  51                 value_type getRace() const;
  52                 value_type getChunk() const;
  53
  54                 /*
  55                  * Setters
  56                  */
  57                 void setName(const std::string& name);
  58                 void setDescription(const std::string& description);
  59                 void setRace(value_type race);
  60                 void setChunk(value_type chunk);
  61
  62                 /*
  63                  * Operations
  64                  */
  65                 void MoveToChunk(value_type chunk);
  66
  67                 /*
  68                  * Database operations
  69                  */
  70                 void Delete();
  71                 void Save();
  72                 void Discard();
  73                 bool Exists();
  74
  75                 /*
  76                  * Utilities
  77                  */
  78                 SavableManagerPtr getManager() const;
  79                 TableImplPtr getTable() const;
  80
  81         protected:
  82                 SavableManagerPtr m_character; /**< The manager associated with this Character. */
  83
  84                 Character(SavableManagerPtr character);
  85                 virtual ~Character(void);
  86
  87                 friend class mud::CharacterManager; // for constructor
  88                 friend SmartPtrDelete(mud::Character);
  89
  90         private:
  91                 Character(const Character& rhs);
  92                 Character operator=(const Character& rhs);
  93         };
  94 }