ryzom/server/src/ai_service/ai_grp_npc.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_GRP_NPC_H
  18 #define RYAI_GRP_NPC_H
  19
  20 #include "ai_grp.h"
  21 #include "timer.h"
  22 #include "ai_vision.h"
  23 #include "ai_keywords.h"
  24 #include "state_instance.h"
  25 #include "named_entity_manager.h"
  26 #include "nel/misc/string_mapper.h"
  27
  28 class CMgrNpc;
  29 class CBotNpc;
  30 class CSpawnBotNpc;
  31
  32 //////////////////////////////////////////////////////////////////////////////
  33 // CSpawnGroupNpc                                                           //
  34 //////////////////////////////////////////////////////////////////////////////
  35
  36 class CSpawnGroupNpc
  37 : public NLMISC::CDbgRefCount<CSpawnGroupNpc>
  38 , public CSpawnGroup
  39 {
  40 public:
  41         CSpawnGroupNpc(CPersistent<CSpawnGroup>& owner);
  42
  43         virtual ~CSpawnGroupNpc() { }
  44
  45         CGroupNpc& getPersistent() const;
  46
  47         virtual void spawnBots();
  48         virtual void spawnBots(const std::string &name);
  49         virtual void despawnBots(bool immediately);
  50
  51         void update();
  52
  53         void sendInfoToEGS() const;
  54
  55         std::string buildDebugString(uint idx) const;
  56
  57         void stateChange(CAIState const* oldState, CAIState const* newState);
  58
  59         void botHaveDied(CBotNpc* bot);
  60         void botHaveDespawn(CBotNpc* bot);
  61         void botHaveSpawn(CBotNpc* bot);
  62
  63 public:
  64         void resetSlowUpdateCycle();
  65         static void setSlowUpdatePeriod(uint32 ticks);
  66         static uint32 getSlowUpdatePeriod();
  67         static void displaySlowUpdateBuckets();
  68
  69         void noMoreHandle(uint32 nNbTickBeforeDespawn);
  70         void handlePresent();
  71
  72         // set the cell
  73         void setCell(sint32 cell) { _Cell = cell; }
  74         sint32 getCell() { return _Cell; }
  75
  76 private:
  77         bool _GroupInVision;
  78         CAITimer _BotUpdateTimer;
  79         uint32 _LastUpdate;     // gamecycle at which update() last called
  80         uint32 _LastBotUpdate;
  81         uint32 _SlowUpdateCycle;
  82         sint32 _Cell;
  83         static uint32 _SlowUpdatePeriod;
  84         static std::vector<uint32> _SlowUpdateBuckets;
  85
  86         bool _DespawnBotsWhenNoMoreHandleTimerActive;
  87         CAITimer        _DespawnBotsWhenNoMoreHandleTimer;
  88 };
  89
  90 //////////////////////////////////////////////////////////////////////////////
  91 // CGroupNpc                                                                //
  92 //////////////////////////////////////////////////////////////////////////////
  93
  94 class CGroupNpc
  95 : public NLMISC::CDbgRefCount<class CGroupNpc>
  96 , public CGroup
  97 , public CDynGrpBase
  98 , public CPersistentStateInstance
  99 {
 100 public:
 101         typedef std::set<std::pair<std::string, sint32> > TFactionAttackableSet;
 102
 103 public:
 104         CGroupNpc(CMgrNpc* mgr, CAIAliasDescriptionNode* aliasTree, RYAI_MAP_CRUNCH::TAStarFlag denyFlags);
 105         CGroupNpc(CMgrNpc* mgr, uint32 alias, std::string const& name, RYAI_MAP_CRUNCH::TAStarFlag denyFlags);
 106
 107         virtual ~CGroupNpc();
 108
 109         /// @name CChild implementation
 110         //@{
 111 //      virtual std::string getIndexString() const;
 112         virtual std::string getOneLineInfoString() const;
 113         virtual std::vector<std::string> getMultiLineInfoString() const;
 114 //      virtual std::string getFullName() const;
 115         //@}
 116
 117         CDynGrpBase* getGrpDynBase() { return this; }
 118
 119         //////////////////////////////////////////////////////////////////////////
 120         //      PersistentStateInstance
 121
 122         CAliasTreeOwner* aliasTreeOwner() { return this; }
 123
 124         void stateChange(CAIState const* oldState, CAIState const* newState);
 125
 126         CGroup* getGroup() { return this; }
 127
 128         //////////////////////////////////////////////////////////////////////////
 129
 130         virtual void lastBotDespawned();
 131         virtual void firstBotSpawned();
 132
 133         // debugging stuff
 134         CDebugHistory* getDebugHistory() { return this; }
 135
 136         CAIS::CCounter& getSpawnCounter();
 137
 138         RYZOMID::TTypeId getRyzomType() { return RYZOMID::npc; }
 139
 140         NLMISC::CSmartPtr<CSpawnGroup> createSpawnGroup();
 141
 142         CSpawnGroupNpc* getSpawnObj() const { return NLMISC::type_cast<CSpawnGroupNpc*>(CGroup::getSpawnObj()); }
 143
 144         CPersistentStateInstance* getPersistentStateInstance() { return this; }
 145
 146         void setEvent(uint eventId);
 147
 148         virtual void serviceEvent (const CServiceEvent &info);
 149
 150         void init() { }
 151
 152         void release() { }
 153
 154
 155         // inheritted virtual interface ------------------------------------
 156         virtual bool spawn();
 157         virtual void despawnGrp();
 158
 159         virtual std::string buildDebugString(uint idx) const;
 160         virtual void display(CStringWriter& stringWriter) const;
 161
 162         void updateDependencies(CAIAliasDescriptionNode const& aliasTree, CAliasTreeOwner* aliasTreeOwner);
 163         IAliasCont* getAliasCont(AITYPES::TAIType type);
 164         CAliasTreeOwner* createChild(IAliasCont* cont, CAIAliasDescriptionNode* aliasTree);
 165
 166         // basic utilities -------------------------------------------------
 167         CMgrNpc& mgr() const;
 168
 169         // management of the bot population --------------------------------
 170         // allocator for allocating new bot objects
 171         CGroupNpc* newBot();
 172
 173         bool botsAreNamed() { return _BotsAreNamed; }
 174         void setBotsAreNamedFlag() { _BotsAreNamed = true; }
 175         void clrBotsAreNamedFlag() { _BotsAreNamed = false; }
 176
 177         // States to Alias
 178         void setStateAlias(const std::string &state, uint32 alias);
 179         uint32 getStateAlias(const std::string &state);
 180
 181         // States Events to Alias
 182         void setStateEventAlias(const std::string &stateEvent, uint32 alias);
 183         uint32 getStateEventAlias(const std::string &stateEvent);
 184
 185
 186         // Parameter management -------------------------------------
 187         void clearParameters();
 188         // Parse a paremeter for this group.
 189         void addParameter(const std::string &parameter);
 190
 191         // set if the bots of the group are attackable by players
 192         void setPlayerAttackable(bool playerAttackable) { _PlayerAttackable = playerAttackable; }
 193         bool getPlayerAttackable() { return _PlayerAttackable; }
 194
 195         // set if the bots of the group are attackable by other bots
 196         void setBotAttackable(bool botAttackable) { _BotAttackable = botAttackable; }
 197         bool getBotAttackable() { return _BotAttackable; }
 198
 199         void setFactionAttackableAbove(std::string faction, sint32 threshold, bool botAttackable);
 200         TFactionAttackableSet const& getFactionAttackableAbove() const { return _FactionAttackableAbove; }
 201         void setFactionAttackableBelow(std::string faction, sint32 threshold, bool botAttackable);
 202         TFactionAttackableSet const& getFactionAttackableBelow() const { return _FactionAttackableBelow; }
 203         bool isFactionAttackable(std::string faction, sint32 fame);
 204
 205         uint32 getAggroDist() { return _AggroDist; }
 206
 207         uint32& despawnTime() { return _DespawnTime; }
 208         uint32& respawnTime() { return _RespawnTime; }
 209
 210         AITYPES::CPropertySetWithExtraList<TAllianceId>& faction() { return _faction; }
 211         AITYPES::CPropertySetWithExtraList<TAllianceId>& ennemyFaction() { return _ennemyFaction; }
 212         AITYPES::CPropertySetWithExtraList<TAllianceId>& friendFaction() { return _friendFaction; }
 213
 214         AITYPES::CPropertySetWithExtraList<TAllianceId> const& faction() const { return _faction; }
 215         AITYPES::CPropertySetWithExtraList<TAllianceId> const& ennemyFaction() const { return _ennemyFaction; }
 216         AITYPES::CPropertySetWithExtraList<TAllianceId> const& friendFaction() const { return _friendFaction; }
 217
 218 public:
 219         void addHpUpTrigger(float threshold, int eventId);
 220         void delHpUpTrigger(float threshold, int eventId);
 221         void addHpUpTrigger(float threshold, std::string cbFunc);
 222         void delHpUpTrigger(float threshold, std::string cbFunc);
 223
 224         void addHpDownTrigger(float threshold, int eventId);
 225         void delHpDownTrigger(float threshold, int eventId);
 226         void addHpDownTrigger(float threshold, std::string cbFunc);
 227         void delHpDownTrigger(float threshold, std::string cbFunc);
 228
 229         bool haveHpTriggers();
 230         void hpTriggerCb(float oldVal, float newVal);
 231
 232         void addNamedEntityListener(std::string const& name, std::string const& prop, int event);
 233         void delNamedEntityListener(std::string const& name, std::string const& prop, int event);
 234         void addNamedEntityListener(std::string const& name, std::string const& prop, std::string functionName);
 235         void delNamedEntityListener(std::string const& name, std::string const& prop, std::string functionName);
 236         void namedEntityListenerCb(std::string const& name, std::string const& prop);
 237
 238         void addHandle(TDataSetRow playerRowId, uint32 missionAlias, uint32 DespawnTimeInTick);
 239         void delHandle(TDataSetRow playerRowId, uint32 missionAlias);
 240
 241         void addHealGroup(CGroupNpc *healGroups) { _HealGroups.push_back(healGroups); }
 242         std::vector<CGroupNpc*> getHealGroups() { return _HealGroups; }
 243         void resetHealGroups() { _HealGroups.clear(); }
 244
 245         uint32 getTimerWhenNoMoreHandle();
 246
 247         void setSpawnZone(const CNpcZone *zone) { _SpawnZone = zone; }
 248         const CNpcZone *getSpawnZone() const { return _SpawnZone; }
 249
 250
 251         void setColour(uint8 colour);
 252
 253         void setOutpostSide(OUTPOSTENUMS::TPVPSide side);
 254         void setOutpostFactions(std::string const& alias, OUTPOSTENUMS::TPVPSide side);
 255         bool isRingGrp() const { return _RingGrp;}
 256
 257 private:
 258         /// group basics
 259         bool _BotsAreNamed;     // true if the bots in the group are explicitly placed in level editor tool - false otherwise
 260         /// NPCs are attackable by player ?
 261         bool _PlayerAttackable;
 262         /// NPCs are attackable by npcs
 263         bool _BotAttackable;
 264         /// NPCs are attackable by players with fame for faction (string) above threshold (float)
 265         TFactionAttackableSet _FactionAttackableAbove;
 266         /// NPCs are attackable by players with fame for faction (string) below threshold (float)
 267         TFactionAttackableSet _FactionAttackableBelow;
 268         /// Aggro distance : any player passing at less this distance will be attacked
 269         uint32 _AggroDist;
 270         /// Respawn time in ticks
 271         uint32 _RespawnTime;
 272         /// Despawn time in ticks
 273         uint32 _DespawnTime;
 274
 275
 276
 277         AITYPES::CPropertySetWithExtraList<TAllianceId> _faction;
 278         AITYPES::CPropertySetWithExtraList<TAllianceId> _ennemyFaction;
 279         AITYPES::CPropertySetWithExtraList<TAllianceId> _friendFaction;
 280
 281         typedef std::multimap<float, int> THpTriggerList;
 282         typedef std::multimap<float, std::string> THpTriggerList2;
 283         THpTriggerList _hpUpTriggers;
 284         THpTriggerList _hpDownTriggers;
 285         THpTriggerList2 _hpUpTriggers2;
 286         THpTriggerList2 _hpDownTriggers2;
 287
 288         typedef std::multimap<std::pair<std::string, std::string>, int> TNamedEntityListenerList;
 289         TNamedEntityListenerList _namedEntityListeners;
 290         typedef std::multimap<std::pair<std::string, std::string>, std::string> TNamedEntityListenerList2;
 291         TNamedEntityListenerList2 _namedEntityListeners2;
 292         typedef std::map <std::string, uint32> TStatesToAlias;
 293         TStatesToAlias  _StatesToAlias;
 294         TStatesToAlias  _StateEventToAlias;
 295
 296         struct SHandle
 297         {
 298                 TDataSetRow     PlayerRowId;
 299                 uint32          MissionAlias;
 300
 301                 bool operator < (const SHandle &h) const
 302                 {
 303                         if (PlayerRowId < h.PlayerRowId) return true;
 304
 305                         if (PlayerRowId == h.PlayerRowId)
 306                                 if (MissionAlias < h.MissionAlias)
 307                                         return true;
 308
 309                         return false;
 310                 }
 311         };
 312
 313         std::set<SHandle>       _Handles;
 314         uint32                          _DespawnTimeWhenNoMoreHandle;
 315         bool                            _AutoSpawnWhenNoMoreHandle;
 316         NLMISC::CVirtualRefPtr<const CNpcZone> _SpawnZone;
 317         bool                            _RingGrp;//Ring rulez: like a override bandit profile
 318         std::vector<CGroupNpc*> _HealGroups;
 319
 320 };
 321
 322 #endif