ryzom/server/src/ai_service/bot_chat_interface.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
  18
  19 #error "Deprecated"
  20
  21 #ifndef RYAI_BOT_CHAT_INTERFACE_H
  22 #define RYAI_BOT_CHAT_INTERFACE_H
  23
  24 // Nel Misc
  25 #include "nel/misc/types_nl.h"
  26 #include "nel/misc/entity_id.h"
  27 #include "game_share/news_types.h"
  28 #include "game_share/bot_chat_types.h"
  29
  30 // the class
  31 class CBotChatInterface
  32 {
  33 public:
  34         // the callback type for user callbacks for start of bot chat
  35         // returns the name of the bot chat automaton to use
  36         // if an empty string is returned no bot chat is launched
  37         typedef std::string (*TCallbackBegin)(NLMISC::CEntityId player,NLMISC::CEntityId bot);
  38
  39         // the callback types for user callback for end of bot chat
  40         // called just after the chat session has been closed
  41         typedef void (*TCallbackEnd)(NLMISC::CEntityId player,NLMISC::CEntityId bot);
  42
  43 public:
  44         // classic init() and release()
  45         static void init(TCallbackBegin cbBegin=NULL,TCallbackEnd cbEnd=NULL);
  46         static void release();
  47
  48         // build a vector of the players currently chatting with a given bot
  49         // this routine may not be very fast as the entire bot chat map is
  50         // parsed in order to build the vector
  51         static void getBotChatPartners(NLMISC::CEntityId bot,std::vector<NLMISC::CEntityId> &result);
  52
  53         // routines to force the end of a bot chat
  54         static void endChatForPlayer(NLMISC::CEntityId player);
  55         static void endAllChatForBot(NLMISC::CEntityId bot);
  56 };
  57
  58 #endif