ryzom/server/src/ai_service/sheets.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2014  Jan BOON (Kaetemi) <jan.boon@kaetemi.be>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21
  22 #ifndef RYAI_SHEETS_H
  23 #define RYAI_SHEETS_H
  24
  25
  26 // Nel Misc
  27 #include "nel/misc/types_nl.h"
  28 #include "nel/misc/smart_ptr.h"
  29 #include "nel/misc/sheet_id.h"
  30
  31 ///Nel Georges
  32 #include "nel/georges/u_form.h"
  33 #include "nel/georges/u_form_elm.h"
  34
  35 #include "ai_share/ai_types.h"
  36 #include "game_share/fame.h"
  37
  38 #include "game_share/visual_slot_manager.h"
  39
  40 #include        "ai_script_comp.h"
  41
  42 #include "game_share/people_pd.h"
  43
  44 /**
  45  * Singleton containing database on information for actors
  46  * \author Sadge
  47  * \author Nevrax France
  48  * \date 2002
  49  */
  50
  51
  52 namespace AISHEETS
  53 {
  54
  55 enum TFightCfg
  56 {
  57         FIGHTCFG_MELEE=0,
  58                 FIGHTCFG_RANGE,
  59                 FIGHTCFG_NUKE,
  60                 FIGHTCFG_HEAL,
  61                 FIGHTCFG_MAX
  62 };
  63
  64 //////////////////////////////////////////////////////////////////////////////
  65 // CAIAction                                                                //
  66 //////////////////////////////////////////////////////////////////////////////
  67
  68 class IAIAction
  69 : public NLMISC::CRefCount
  70 //, public NLMISC::CDbgRefCount<IAIAction>
  71 {
  72 public:
  73         virtual ~IAIAction() { }
  74 public:
  75         virtual NLMISC::CSheetId SheetId() const = 0;
  76         virtual bool SelfAction() const = 0;
  77 };
  78 typedef NLMISC::CSmartPtr<IAIAction> IAIActionPtr;
  79 typedef NLMISC::CSmartPtr<IAIAction const> IAIActionCPtr;
  80
  81 class CAIAction
  82 : public IAIAction
  83 {
  84 public:
  85         CAIAction();
  86         virtual NLMISC::CSheetId SheetId() const { return _SheetId; }
  87         virtual bool SelfAction() const { return _SelfAction; }
  88
  89 public:
  90         void readGeorges(NLMISC::CSmartPtr<NLGEORGES::UForm> const& form, NLMISC::CSheetId const& sheetId);
  91         void serial(NLMISC::IStream& s);
  92         void removed() { }
  93         static uint getVersion();
  94
  95         virtual std::vector<std::string> getMultiLineInfoString() const;
  96
  97 private:
  98         NLMISC::CSheetId _SheetId;
  99         bool _SelfAction;
 100 };
 101 typedef NLMISC::CSmartPtr<CAIAction> CAIActionPtr;
 102 typedef NLMISC::CSmartPtr<CAIAction const> CAIActionCPtr;
 103
 104 //////////////////////////////////////////////////////////////////////////////
 105 // CActionList                                                              //
 106 //////////////////////////////////////////////////////////////////////////////
 107
 108 class CActionList
 109 : public NLMISC::CDbgRefCount<CActionList>
 110 {
 111 public:
 112         virtual ~CActionList() { }
 113
 114         NLMISC::CSheetId                        _SheetId;
 115         std::vector<IAIActionCPtr>      _Actions;
 116
 117         bool _HasNormalAction;
 118         bool _HasSelfAction;
 119
 120         void computeAbilities();
 121
 122         void readGeorges(NLMISC::CSmartPtr<NLGEORGES::UForm> const& form, NLMISC::CSheetId const& sheetId);
 123         void serial(NLMISC::IStream& s);
 124         void removed() { }
 125         static uint getVersion();
 126
 127         void addAction(NLMISC::CSheetId const& sheetId, std::string const& actionName);
 128
 129         virtual std::vector<std::string> getMultiLineInfoString() const;
 130 };
 131
 132 //////////////////////////////////////////////////////////////////////////////
 133 // CGroupProperties                                                         //
 134 //////////////////////////////////////////////////////////////////////////////
 135
 136 class CGroupProperties
 137 {
 138 public:
 139         CGroupProperties();
 140         virtual ~CGroupProperties() { }
 141         virtual void setAssist(bool assist) { _Assist = assist; }
 142         bool assist() const { return _Assist; }
 143         virtual void setAttack(bool attack) { _Attack = attack; }
 144         bool attack() const { return _Attack; }
 145 private:
 146         bool    _Assist;
 147         bool    _Attack;
 148 };
 149
 150 typedef std::vector<CGroupProperties> TGroupPropertiesLine;
 151
 152 //////////////////////////////////////////////////////////////////////////////
 153 // CDefaultGroupProperties                                                  //
 154 //////////////////////////////////////////////////////////////////////////////
 155
 156 class CDefaultGroupProperties
 157 : public CGroupProperties
 158 {
 159 public:
 160         virtual ~CDefaultGroupProperties() { }
 161         // avoid modification.
 162         virtual void setAssist(bool     assist) { }
 163         virtual void setAttack(bool     attack) { }
 164 };
 165
 166 //////////////////////////////////////////////////////////////////////////////
 167 // ICreature                                                                //
 168 //////////////////////////////////////////////////////////////////////////////
 169
 170 class ICreature
 171 : public NLMISC::CRefCount
 172 {
 173 public:
 174         typedef std::vector<NLMISC::CSmartPtr<CFightScriptComp> > TScriptCompList;
 175
 176 public:
 177         virtual ~ICreature() { }
 178
 179 public:
 180         virtual NLMISC::CSheetId const& SheetId() const = 0;
 181         virtual uint32 Level() const = 0;                               // Level of the creature
 182
 183         // colors from sheet
 184         virtual uint8 ColorHead() const = 0;
 185         virtual uint8 ColorArms() const = 0;
 186         virtual uint8 ColorHands() const = 0;
 187         virtual uint8 ColorBody() const = 0;
 188         virtual uint8 ColorLegs() const = 0;
 189         virtual uint8 ColorFeets() const = 0;
 190
 191         virtual float Radius() const = 0;                               // pacs primitive 's radius
 192         virtual float Height() const = 0;                               // pacs primitive 's height
 193         virtual float Width() const = 0;                                // pacs primitive 's width
 194         virtual float Length() const = 0;                               // pacs primitive 's length
 195         virtual float BoundingRadius() const = 0;               // fighting radius
 196
 197         // the entity is a bot object and cannot be traversed.
 198         virtual bool NotTraversable() const = 0;
 199
 200         // the entity is a fauna, even is used as npc, it keep it's fauna name
 201         virtual bool ForceDisplayCreatureName() const = 0;
 202
 203         virtual float BonusAggroHungry() const = 0;
 204         virtual float BonusAggroVeryHungry() const = 0;
 205
 206         virtual float AssistDist() const = 0;
 207
 208         virtual float AggroRadiusNotHungry() const = 0;
 209         virtual float AggroRadiusHungry() const = 0;
 210         virtual float AggroRadiusHunting() const = 0;
 211
 212         virtual float AggroReturnDistCheck() const = 0;
 213         virtual float AggroRadiusD1() const = 0; // large radius, for first hit place
 214         virtual float AggroRadiusD2() const = 0; // small radius, for last hit place
 215         virtual float AggroPrimaryGroupDist() const = 0;
 216         virtual float AggroPrimaryGroupCoef() const = 0;
 217         virtual float AggroSecondaryGroupDist() const = 0;
 218         virtual float AggroSecondaryGroupCoef() const = 0;
 219         virtual float AggroPropagationRadius() const = 0;
 220
 221         virtual AITYPES::TFaunaType FaunaType() const = 0;
 222
 223         virtual float Scale() const = 0;                                // 3d scale.
 224
 225         virtual float DistToFront() const = 0;
 226         virtual float DistToBack() const = 0;
 227         virtual float DistToSide() const = 0;
 228
 229         virtual float DistModulator() const = 0;        //              =       0.5f;   // (0) - (1) - (n).
 230         virtual float TargetModulator() const = 0;      //              =       1.f;    // (0) - (1).
 231         virtual float ScoreModulator() const = 0;       //              =       0.01f;  // (0) - (-1).
 232         virtual float FearModulator() const = 0;        //              =       0.01f;  // (0) - (1).
 233         virtual float LifeLevelModulator() const = 0;   //      =       0.5f;   // (0) - (1).
 234         virtual float CourageModulator() const = 0;     //      =       2.f;    // (-n) - (0) - (+n)
 235         virtual float GroupCohesionModulator() const = 0;
 236
 237         virtual float GroupDispersion() const = 0;      //      0.f 1.f
 238
 239         virtual uint32 XPLevel() const = 0;
 240         virtual uint32 NbPlayers() const = 0;
 241
 242         virtual uint32 EnergyValue() const = 0;
 243
 244         virtual bool CanTurn() const = 0;
 245
 246         virtual NLMISC::CDbgPtr<CActionList> const& FightConfig(TFightCfg fightCfg) const = 0;
 247
 248         virtual NLMISC::CSheetId const& LeftItem() const = 0;
 249         virtual NLMISC::CSheetId const& RightItem() const = 0;
 250
 251         virtual uint32 MinFightDist() const = 0;
 252
 253         virtual uint32 FactionIndex() const = 0;
 254         virtual sint32 FameForGuardAttack() const = 0;
 255
 256         virtual std::string const& AssistGroupIndexStr() const = 0;
 257         virtual std::string const& AttackGroupIndexStr() const = 0;
 258         virtual std::string const& GroupIndexStr() const = 0;
 259
 260         virtual uint32 GroupPropertiesIndex() const = 0;
 261
 262         /// the creature sheet can specify a multiplier that modulate the dynmaic groupe size
 263         virtual uint32 DynamicGroupCountMultiplier() const = 0;
 264
 265         virtual std::string const& BotName() const = 0;
 266
 267         virtual TScriptCompList const& ScriptCompList() const = 0;
 268
 269         virtual TScriptCompList const& UpdateScriptList() const = 0;
 270         virtual TScriptCompList const& DeathScriptList() const = 0;
 271         virtual TScriptCompList const& BirthScriptList() const = 0;
 272
 273         // Character Race
 274         virtual EGSPD::CPeople::TPeople Race() const = 0;
 275
 276         virtual CGroupProperties const& getPropertiesCst(uint32 groupIndex) const = 0;
 277
 278         virtual std::vector<std::string> getMultiLineInfoString() const = 0;
 279
 280         static sint32 InvalidFameForGuardAttack;
 281 };
 282 typedef NLMISC::CSmartPtr<ICreature> ICreaturePtr;
 283 typedef NLMISC::CSmartPtr<ICreature const> ICreatureCPtr;
 284
 285 //////////////////////////////////////////////////////////////////////////////
 286 // CCreatureProxy                                                           //
 287 //////////////////////////////////////////////////////////////////////////////
 288
 289 class CCreatureProxy
 290 : public ICreature
 291 {
 292 protected:
 293         AISHEETS::ICreatureCPtr _Sheet;
 294 public:
 295         CCreatureProxy(AISHEETS::ICreatureCPtr const& sheet)
 296         : _Sheet(sheet)
 297         {
 298         }
 299         virtual void setSheet(AISHEETS::ICreatureCPtr const& sheet) { _Sheet = sheet; }
 300         virtual bool isValid() const { return _Sheet!=NULL; }
 301
 302 public:
 303         virtual NLMISC::CSheetId const& SheetId() const { if (_Sheet) return _Sheet->SheetId(); else return NLMISC::CSheetId::Unknown; }
 304         virtual uint32 Level() const { return _Sheet->Level(); }
 305
 306         virtual uint8 ColorHead() const { return _Sheet->ColorHead(); }
 307         virtual uint8 ColorArms() const { return _Sheet->ColorArms(); }
 308         virtual uint8 ColorHands() const { return _Sheet->ColorHands(); }
 309         virtual uint8 ColorBody() const { return _Sheet->ColorBody(); }
 310         virtual uint8 ColorLegs() const { return _Sheet->ColorLegs(); }
 311         virtual uint8 ColorFeets() const { return _Sheet->ColorFeets(); }
 312
 313         virtual float Radius() const { return _Sheet->Radius(); }
 314         virtual float Height() const { return _Sheet->Height(); }
 315         virtual float Width() const { return _Sheet->Width(); }
 316         virtual float Length() const { return _Sheet->Length(); }
 317         virtual float BoundingRadius() const { return _Sheet->BoundingRadius(); }
 318
 319         virtual bool NotTraversable() const { return _Sheet->NotTraversable(); }
 320
 321         virtual bool ForceDisplayCreatureName() const { return _Sheet->ForceDisplayCreatureName(); }
 322
 323         virtual float BonusAggroHungry() const { return _Sheet->BonusAggroHungry(); }
 324         virtual float BonusAggroVeryHungry() const { return _Sheet->BonusAggroVeryHungry(); }
 325
 326         virtual float AssistDist() const { return _Sheet->AssistDist(); }
 327
 328         virtual float AggroRadiusNotHungry() const { return _Sheet->AggroRadiusNotHungry(); }
 329         virtual float AggroRadiusHungry() const { return _Sheet->AggroRadiusHungry(); }
 330         virtual float AggroRadiusHunting() const { return _Sheet->AggroRadiusHunting(); }
 331
 332         virtual float AggroReturnDistCheck() const { return _Sheet->AggroReturnDistCheck(); }
 333         virtual float AggroRadiusD1() const { return _Sheet->AggroRadiusD1(); }
 334         virtual float AggroRadiusD2() const { return _Sheet->AggroRadiusD2(); }
 335         virtual float AggroPrimaryGroupDist() const { return _Sheet->AggroPrimaryGroupDist(); }
 336         virtual float AggroPrimaryGroupCoef() const { return _Sheet->AggroPrimaryGroupCoef(); }
 337         virtual float AggroSecondaryGroupDist() const { return _Sheet->AggroSecondaryGroupDist(); }
 338         virtual float AggroSecondaryGroupCoef() const { return _Sheet->AggroSecondaryGroupCoef(); }
 339         virtual float AggroPropagationRadius() const { return _Sheet->AggroPropagationRadius(); }
 340
 341         virtual AITYPES::TFaunaType FaunaType() const { return _Sheet->FaunaType(); }
 342
 343         virtual float Scale() const { return _Sheet->Scale(); }
 344
 345         virtual float DistToFront() const { return _Sheet->DistToFront(); }
 346         virtual float DistToBack() const { return _Sheet->DistToBack(); }
 347         virtual float DistToSide() const { return _Sheet->DistToSide(); }
 348
 349         virtual float DistModulator() const { return _Sheet->DistModulator(); }
 350         virtual float TargetModulator() const { return _Sheet->TargetModulator(); }
 351         virtual float ScoreModulator() const { return _Sheet->ScoreModulator(); }
 352         virtual float FearModulator() const { return _Sheet->FearModulator(); }
 353         virtual float LifeLevelModulator() const { return _Sheet->LifeLevelModulator(); }
 354         virtual float CourageModulator() const { return _Sheet->CourageModulator(); }
 355         virtual float GroupCohesionModulator() const { return _Sheet->GroupCohesionModulator(); }
 356
 357         virtual float GroupDispersion() const { return _Sheet->GroupDispersion(); }
 358
 359         virtual uint32 XPLevel() const { return _Sheet->XPLevel(); }
 360         virtual uint32 NbPlayers() const { return _Sheet->NbPlayers(); }
 361
 362         virtual uint32 EnergyValue() const { return _Sheet->EnergyValue(); }
 363
 364         virtual bool CanTurn() const { return _Sheet->CanTurn(); }
 365
 366         virtual NLMISC::CDbgPtr<CActionList> const& FightConfig(TFightCfg fightCfg) const { return _Sheet->FightConfig(fightCfg); }
 367
 368         virtual NLMISC::CSheetId const& LeftItem() const { return _Sheet->LeftItem(); }
 369         virtual NLMISC::CSheetId const& RightItem() const { return _Sheet->RightItem(); }
 370
 371         virtual uint32 MinFightDist() const { return _Sheet->MinFightDist(); }
 372
 373         virtual uint32 FactionIndex() const { return _Sheet->FactionIndex(); }
 374         virtual sint32 FameForGuardAttack() const { return _Sheet->FameForGuardAttack(); }
 375
 376         virtual std::string const& AssistGroupIndexStr() const { return _Sheet->AssistGroupIndexStr(); }
 377         virtual std::string const& AttackGroupIndexStr() const { return _Sheet->AttackGroupIndexStr(); }
 378         virtual std::string const& GroupIndexStr() const { return _Sheet->GroupIndexStr(); }
 379
 380         virtual uint32 GroupPropertiesIndex() const { return _Sheet->GroupPropertiesIndex(); }
 381
 382         virtual uint32 DynamicGroupCountMultiplier() const { return _Sheet->DynamicGroupCountMultiplier(); }
 383
 384         virtual std::string const& BotName() const { return _Sheet->BotName(); }
 385
 386         virtual TScriptCompList const& ScriptCompList() const { return _Sheet->ScriptCompList(); }
 387
 388         virtual TScriptCompList const& UpdateScriptList() const { return _Sheet->UpdateScriptList(); }
 389         virtual TScriptCompList const& DeathScriptList() const { return _Sheet->DeathScriptList(); }
 390         virtual TScriptCompList const& BirthScriptList() const { return _Sheet->BirthScriptList(); }
 391
 392         virtual EGSPD::CPeople::TPeople Race() const { return _Sheet->Race(); }
 393
 394         virtual CGroupProperties const& getPropertiesCst(uint32 groupIndex) const { return _Sheet->getPropertiesCst(groupIndex); }
 395
 396         virtual std::vector<std::string> getMultiLineInfoString() const { return _Sheet->getMultiLineInfoString(); }
 397 };
 398
 399 //////////////////////////////////////////////////////////////////////////////
 400 // CCreature                                                                //
 401 //////////////////////////////////////////////////////////////////////////////
 402
 403 class CCreature
 404 : public ICreature
 405 {
 406 public:
 407         CCreature();
 408
 409 private:
 410         NLMISC::CSheetId _SheetId;
 411         uint32 _Level;
 412
 413         // colors from sheet
 414         uint8 _ColorHead;
 415         uint8 _ColorArms;
 416         uint8 _ColorHands;
 417         uint8 _ColorBody;
 418         uint8 _ColorLegs;
 419         uint8 _ColorFeets;
 420
 421         float _Radius;
 422         float _Height;
 423         float _Width;
 424         float _Length;
 425         float _BoundingRadius;
 426
 427         // the entity is a bot object and cannot be traversed.
 428         bool _NotTraversable;
 429
 430         // the entity is a fauna, even is used as npc, it keep it's fauna name
 431         bool _ForceDisplayCreatureName;
 432
 433         float _BonusAggroHungry;
 434         float _BonusAggroVeryHungry;
 435
 436         float _AssistDist;
 437
 438         float _AggroRadiusNotHungry;
 439         float _AggroRadiusHungry;
 440         float _AggroRadiusHunting;
 441
 442         float _AggroReturnDistCheck;
 443         float _AggroRadiusD1;
 444         float _AggroRadiusD2;
 445         float _AggroPrimaryGroupDist;
 446         float _AggroPrimaryGroupCoef;
 447         float _AggroSecondaryGroupDist;
 448         float _AggroSecondaryGroupCoef;
 449         float _AggroPropagationRadius;
 450
 451         AITYPES::TFaunaType _FaunaType;
 452
 453         float _Scale;
 454
 455         float _DistToFront;
 456         float _DistToBack;
 457         float _DistToSide;
 458
 459         float _DistModulator;
 460         float _TargetModulator;
 461         float _ScoreModulator;
 462         float _FearModulator;
 463         float _LifeLevelModulator;
 464         float _CourageModulator;
 465         float _GroupCohesionModulator;
 466
 467         float _GroupDispersion;
 468
 469         uint32 _XPLevel;
 470         uint32 _NbPlayers;
 471
 472         uint32 _EnergyValue;
 473
 474         bool _CanTurn;
 475
 476         NLMISC::CDbgPtr<CActionList> _FightConfig[FIGHTCFG_MAX];
 477
 478         NLMISC::CSheetId _LeftItem;
 479         NLMISC::CSheetId _RightItem;
 480
 481         uint32 _MinFightDist;
 482
 483         uint32 _FactionIndex;
 484         sint32 _FameForGuardAttack;
 485
 486         std::string _AssistGroupIndexStr;
 487         std::string _AttackGroupIndexStr;
 488         std::string _GroupIndexStr;
 489
 490         uint32 _GroupPropertiesIndex;
 491
 492         /// the creature sheet can specify a multiplier that modulate the dynmaic groupe size
 493         uint32 _DynamicGroupCountMultiplier;
 494
 495         std::string _BotName;
 496
 497         TScriptCompList _ScriptCompList;
 498
 499         TScriptCompList _UpdateScriptList;
 500         TScriptCompList _DeathScriptList;
 501         TScriptCompList _BirthScriptList;
 502
 503         // Character Race
 504         EGSPD::CPeople::TPeople _Race;
 505
 506 public:
 507         ///@name ICreature implementation
 508         //@{
 509         virtual NLMISC::CSheetId const& SheetId() const { return _SheetId; }
 510         virtual uint32 Level() const { return _Level; }
 511
 512         // colors from sheet
 513         virtual uint8 ColorHead() const { return _ColorHead; }
 514         virtual uint8 ColorArms() const { return _ColorArms; }
 515         virtual uint8 ColorHands() const { return _ColorHands; }
 516         virtual uint8 ColorBody() const { return _ColorBody; }
 517         virtual uint8 ColorLegs() const { return _ColorLegs; }
 518         virtual uint8 ColorFeets() const { return _ColorFeets; }
 519
 520         virtual float Radius() const { return _Radius; }
 521         virtual float Height() const { return _Height; }
 522         virtual float Width() const { return _Width; }
 523         virtual float Length() const { return _Length; }
 524         virtual float BoundingRadius() const { return _BoundingRadius; }
 525
 526         // the entity is a bot object and cannot be traversed.
 527         virtual bool NotTraversable() const { return _NotTraversable; }
 528
 529         // the entity is a fauna, even is used as npc, it keep it's fauna name
 530         virtual bool ForceDisplayCreatureName() const { return _ForceDisplayCreatureName; }
 531
 532         virtual float BonusAggroHungry() const { return _BonusAggroHungry; }
 533         virtual float BonusAggroVeryHungry() const { return _BonusAggroVeryHungry; }
 534
 535         virtual float AssistDist() const { return _AssistDist; }
 536
 537         virtual float AggroRadiusNotHungry() const { return _AggroRadiusNotHungry; }
 538         virtual float AggroRadiusHungry() const { return _AggroRadiusHungry; }
 539         virtual float AggroRadiusHunting() const { return _AggroRadiusHunting; }
 540
 541         virtual float AggroReturnDistCheck() const { return _AggroReturnDistCheck; }
 542         virtual float AggroRadiusD1() const { return _AggroRadiusD1; }
 543         virtual float AggroRadiusD2() const { return _AggroRadiusD2; }
 544         virtual float AggroPrimaryGroupDist() const { return _AggroPrimaryGroupDist; }
 545         virtual float AggroPrimaryGroupCoef() const { return _AggroPrimaryGroupCoef; }
 546         virtual float AggroSecondaryGroupDist() const { return _AggroSecondaryGroupDist; }
 547         virtual float AggroSecondaryGroupCoef() const { return _AggroSecondaryGroupCoef; }
 548         virtual float AggroPropagationRadius() const { return _AggroPropagationRadius; }
 549
 550         virtual AITYPES::TFaunaType FaunaType() const { return _FaunaType; }
 551
 552         virtual float Scale() const { return _Scale; }
 553
 554         virtual float DistToFront() const { return _DistToFront; }
 555         virtual float DistToBack() const { return _DistToBack; }
 556         virtual float DistToSide() const { return _DistToSide; }
 557
 558         virtual float DistModulator() const { return _DistModulator; }
 559         virtual float TargetModulator() const { return _TargetModulator; }
 560         virtual float ScoreModulator() const { return _ScoreModulator; }
 561         virtual float FearModulator() const { return _FearModulator; }
 562         virtual float LifeLevelModulator() const { return _LifeLevelModulator; }
 563         virtual float CourageModulator() const { return _CourageModulator; }
 564         virtual float GroupCohesionModulator() const { return _GroupCohesionModulator; }
 565
 566         virtual float GroupDispersion() const { return _GroupDispersion; }
 567
 568         virtual uint32 XPLevel() const { return _XPLevel; }
 569         virtual uint32 NbPlayers() const { return _NbPlayers; }
 570
 571         virtual uint32 EnergyValue() const { return _EnergyValue; }
 572
 573         virtual bool CanTurn() const { return _CanTurn; }
 574
 575         virtual NLMISC::CDbgPtr<CActionList> const& FightConfig(TFightCfg fightCfg) const { return _FightConfig[fightCfg]; }
 576
 577         virtual NLMISC::CSheetId const& LeftItem() const { return _LeftItem; }
 578         virtual NLMISC::CSheetId const& RightItem() const { return _RightItem; }
 579
 580         virtual uint32 MinFightDist() const { return _MinFightDist; }
 581
 582         virtual uint32 FactionIndex() const { return _FactionIndex; }
 583         virtual sint32 FameForGuardAttack() const { return _FameForGuardAttack; }
 584
 585         virtual std::string const& AssistGroupIndexStr() const { return _AssistGroupIndexStr; }
 586         virtual std::string const& AttackGroupIndexStr() const { return _AttackGroupIndexStr; }
 587         virtual std::string const& GroupIndexStr() const { return _GroupIndexStr; }
 588
 589         virtual uint32 GroupPropertiesIndex() const { return _GroupPropertiesIndex; }
 590
 591         /// the creature sheet can specify a multiplier that modulate the dynmaic groupe size
 592         virtual uint32 DynamicGroupCountMultiplier() const { return _DynamicGroupCountMultiplier; }
 593
 594         virtual std::string const& BotName() const { return _BotName; }
 595
 596         virtual TScriptCompList const& ScriptCompList() const { return _ScriptCompList; }
 597
 598         virtual TScriptCompList const& UpdateScriptList() const { return _UpdateScriptList; }
 599         virtual TScriptCompList const& DeathScriptList() const { return _DeathScriptList; }
 600         virtual TScriptCompList const& BirthScriptList() const { return _BirthScriptList; }
 601
 602         virtual EGSPD::CPeople::TPeople Race() const { return _Race; }
 603
 604         virtual CGroupProperties const& getPropertiesCst(uint32 groupIndex) const;
 605
 606         virtual std::vector<std::string> getMultiLineInfoString() const;
 607         //@}
 608
 609 public:
 610         void readGeorges(NLMISC::CSmartPtr<NLGEORGES::UForm> const& form, NLMISC::CSheetId const& sheetId);
 611         void serial(NLMISC::IStream& s);
 612
 613         uint32 minFightDist() const { return MinFightDist(); }
 614         void calcFightAndVisualValues(std::string* left = NULL, std::string* right = NULL);
 615         void parseFightConfig(NLGEORGES::UForm const* form, std::string const& fightConfigString, uint32 actionListIndex, NLMISC::CDbgPtr<CActionList>& fightConfig);
 616         void readFightConfig(NLMISC::IStream& s, NLMISC::CDbgPtr<CActionList>& fightConfig);
 617         void saveFightConfig(NLMISC::IStream& s, NLMISC::CDbgPtr<CActionList>& fightConfig);
 618         bool mustAssist(CCreature const& creature) const;
 619         void setAssisGroupIndexs();
 620         void setAttackGroupIndexs();
 621         void addActionConfig(std::string const& sheetIdName, NLMISC::CDbgPtr<CActionList>& actionConfigList);
 622         bool addActionConfig(NLMISC::CSheetId const& sheetId, NLMISC::CDbgPtr<CActionList>& actionConfigList);
 623         void removed() { }
 624         void registerScriptComp(CFightScriptComp* scriptComp);
 625
 626         TGroupPropertiesLine _GroupPropertiesTbl;
 627
 628 private:
 629         CGroupProperties& getProperties(uint32 groupIndex);
 630
 631 public:
 632         static uint getVersion();
 633
 634         template <class T>
 635         static void getVarListFromParents(NLGEORGES::UForm const* form, std::set<T>& varList, std::string const& varName);
 636
 637         static void getGroupStr(std::vector<uint32>& groupIndexStrList, std::string const& groupIndexStr);
 638 };
 639 typedef NLMISC::CSmartPtr<CCreature> CCreaturePtr;
 640 typedef NLMISC::CSmartPtr<CCreature const> CCreatureCPtr;
 641
 642 //////////////////////////////////////////////////////////////////////////////
 643 // CRaceStats                                                               //
 644 //////////////////////////////////////////////////////////////////////////////
 645
 646 class IRaceStats
 647 : public NLMISC::CRefCount
 648 {
 649 public:
 650         virtual ~IRaceStats() {}
 651         virtual NLMISC::CSheetId SheetId() const = 0;
 652         virtual std::string Race() const = 0;
 653 };
 654 typedef NLMISC::CSmartPtr<IRaceStats> IRaceStatsPtr;
 655 typedef NLMISC::CSmartPtr<IRaceStats const> IRaceStatsCPtr;
 656
 657 class CRaceStats
 658 : public IRaceStats
 659 {
 660 public:
 661         virtual NLMISC::CSheetId SheetId() const { return _SheetId; }
 662         virtual std::string Race() const { return _Race; }
 663
 664 public:
 665         void readGeorges(NLMISC::CSmartPtr<NLGEORGES::UForm> const& form, NLMISC::CSheetId const& sheetId);
 666         void serial(NLMISC::IStream& s);
 667         void removed() { }
 668
 669 private:
 670         NLMISC::CSheetId _SheetId;
 671         std::string _Race;
 672
 673 public:
 674         static uint getVersion();
 675 };
 676 typedef NLMISC::CSmartPtr<CRaceStats> CRaceStatsPtr;
 677 typedef NLMISC::CSmartPtr<CRaceStats const> CRaceStatsCPtr;
 678
 679 //////////////////////////////////////////////////////////////////////////////
 680 // CSheets                                                                  //
 681 //////////////////////////////////////////////////////////////////////////////
 682
 683 class CSheets
 684 {
 685 private:
 686         static CSheets* _Instance;
 687
 688 public:
 689         static CSheets* getInstance();
 690         static void destroyInstance();
 691
 692 public:
 693         // load the creature data from the george files
 694         void init();
 695         void packSheets(const std::string &writeFilesDirectoryName);
 696
 697         // display the creature data for all known creature types
 698         void display(NLMISC::CSmartPtr<CStringWriter> stringWriter, uint infoSelect = 0);
 699
 700         //
 701         void release();
 702
 703         // get a data record from the database
 704         ICreatureCPtr           lookup                  (NLMISC::CSheetId const& id);
 705         CActionList const*      lookupActionList(NLMISC::CSheetId const& id);
 706         IAIActionCPtr           lookupAction    (NLMISC::CSheetId const& id);
 707         IRaceStatsCPtr          lookupRaceStats (NLMISC::CSheetId const& id);
 708
 709         uint32  getGroupPropertiesIndex(const std::string &groupIndexName);
 710
 711         uint32 playerGroupIndex() { return _PlayerGroupIndex; }
 712
 713 private:
 714         friend class CCreature;
 715
 716 private:
 717         // prohibit cnstructor as this is a singleton
 718         CSheets();
 719
 720 private:
 721         CDefaultGroupProperties _DefaultGroupProp;
 722
 723         std::map<NLMISC::CSheetId, CCreaturePtr>        _Sheets;
 724         std::map<NLMISC::CSheetId, CActionList>         _ActionListSheets;
 725         std::map<NLMISC::CSheetId, CAIActionPtr>        _ActionSheets;
 726         std::map<NLMISC::CSheetId, CRaceStatsPtr>       _RaceStatsSheets;
 727
 728         std::map<std::string, uint32> _NameToGroupIndex;
 729
 730         uint32 _PlayerGroupIndex;
 731
 732         bool _Initialised;
 733 };
 734
 735 }
 736
 737 /****************************************************************************/
 738 /* Inline methods                                                           */
 739 /****************************************************************************/
 740
 741 //////////////////////////////////////////////////////////////////////////////
 742 // CCreature                                                                //
 743 //////////////////////////////////////////////////////////////////////////////
 744
 745 template <class T>
 746 void AISHEETS::CCreature::getVarListFromParents(NLGEORGES::UForm const* form, std::set<T>& varList, std::string const& varName)
 747 {
 748         uint32 nbParents = form->getNumParent ();
 749         while (nbParents>0)
 750         {
 751                 --nbParents;
 752                 NLGEORGES::UForm const* parentForm = form->getParentForm(nbParents);
 753                 if (parentForm)
 754                 {
 755                         getVarListFromParents(parentForm, varList,      varName);
 756                 }
 757                 NLGEORGES::UFormElm const& item = form->getRootNode();
 758                 T temp;
 759                 if (item.getValueByName(temp, varName.c_str()))
 760                 {
 761                         varList.insert (temp);
 762                 }
 763         }
 764 }
 765
 766 #endif