ryzom/server/src/ai_service/ai_entity.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef RYAI_ENTITY_H
  18 #define RYAI_ENTITY_H
  19
  20 #include <string>
  21 #include <vector>
  22
  23 //--------------------------------------------------------------------------
  24 // The CAIEntiy class
  25 //--------------------------------------------------------------------------
  26 class CAIEntity;
  27 class CAIInstance;
  28
  29 extern void removeFromWatch(CAIEntity* entity);
  30
  31 class CAIEntity
  32 {
  33 public:
  34         /// @name Destructor
  35         //@{
  36         virtual ~CAIEntity();
  37         //@}
  38
  39         /// @name Virtual interface
  40         //@{
  41         virtual CAIInstance* getAIInstance() const = 0;
  42         // display verbose status information regarding the entity
  43 //      virtual void display(CStringWriter& stringWriter) const;
  44 //      virtual std::string getIndexString() const = 0;
  45         virtual std::string     getOneLineInfoString() const;
  46         virtual std::vector<std::string> getMultiLineInfoString() const;
  47         //@}
  48
  49 public:
  50         /// @name Debug info display methods
  51         //@{
  52         // public interface for the 'buildDebugString' virtual
  53         // method set - it is safe, returning cleanly if called on a NULL pointer
  54 //      std::string debugString(uint idx = 0) const;
  55         //@}
  56 };
  57
  58 inline
  59 CAIEntity::~CAIEntity()
  60 {
  61         removeFromWatch(this);
  62 }
  63
  64 inline
  65 std::string     CAIEntity::getOneLineInfoString() const
  66 {
  67         return std::string("<no debug info available for this entity>");
  68 }
  69
  70 inline
  71 std::vector<std::string> CAIEntity::getMultiLineInfoString() const
  72 {
  73         std::vector<std::string> container;
  74         MULTI_LINE_FORMATER::pushTitle(container, "CAIEntity");
  75         MULTI_LINE_FORMATER::pushEntry(container, "<default multi line info>");
  76         MULTI_LINE_FORMATER::pushEntry(container, getOneLineInfoString());
  77         MULTI_LINE_FORMATER::pushFooter(container);
  78         return container;
  79 }
  80
  81 #endif