ryzom/server/src/sabrina/sabrina_ai_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 #ifndef RY_SABRINA_AI_INTERFACE_H
  20 #define RY_SABRINA_AI_INTERFACE_H
  21
  22 // std
  23 #include <vector>
  24 // misc
  25 #include "nel/misc/types_nl.h"
  26 // game share
  27 #include "game_share/ai_event.h"
  28 #include "game_share/ai_event_report.h"
  29
  30 /**
  31  * The Sabrina AI Service Interface singleton
  32  * \author David Fleury
  33  * \author Nevrax France
  34  * \date 2003
  35  */
  36 class CSabrinaAIInterface
  37 {
  38 public:
  39         // init method called at service init by CSabrinaPhraseManager::init()
  40         static void init();
  41
  42         // update called each tick by CSabrinaPhraseManager::update() - dispatches events to the AI services
  43         static void flushEvents();
  44
  45         // release method called at service release     by CSabrinaPhraseManager::release()
  46         static void release();
  47
  48         /**
  49          * register a service to the event broadcast for AI
  50          * \param serviceName name of the registered service
  51          */
  52         static void registerAIService( uint8 serviceId );
  53
  54         /**
  55          * unregister a service to the event broadcast
  56          * \param serviceName name of the service to remove
  57          */
  58         static void unregisterAIService( uint8 serviceId );
  59
  60         /**
  61          * add an AI event report for the current tick
  62          * \param report the AI event report to add
  63          */
  64         static void addAiEventReport( const CAiEventReport &report );
  65
  66         /**
  67          * add an AI event for the current tick
  68          * \param report the event to add
  69          */
  70         static void addAIEvent( const IAIEvent *event );
  71
  72 private:
  73         // this is a singleton so prohibit construction
  74         CSabrinaAIInterface();
  75
  76         /// list of registered services for Event Broadcast for AI
  77         static std::vector<uint8>                       _RegisteredServices;
  78
  79         /// the list of ai events
  80         typedef std::list<IAIEvent*>            TAIEventList;
  81         static TAIEventList                                     _AIEvents;
  82
  83         /// the ai event reports
  84         static std::vector<CAiEventReport>      _AIEventReports;
  85 };
  86
  87
  88 #endif