ryzom/server/src/sabrina/sabrina_actor_creature.cpp

   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 //#include "stdpch.h"
  20 // nel
  21 #include "nel/misc/debug.h"
  22 // sabrina
  23 #include "sabrina_actor_creature.h"
  24
  25 using namespace std;
  26 using namespace NLMISC;
  27
  28
  29 //------------------------------------------------------------------------------------------------------
  30 // Constructor & destructor
  31
  32 //------------------------------------------------------------------------------------------------------
  33 // CSabrinaActorCreature - ctor
  34 //------------------------------------------------------------------------------------------------------
  35 CSabrinaActorCreature::CSabrinaActorCreature(CEntityBase *parent):
  36         ISabrinaActor(parent)
  37 {
  38         #ifdef NL_DEBUG
  39                 nlassert(parent!=NULL);
  40         #endif
  41
  42         _CreatureForm = CSheets::getCreaturesForm(parent->getSheetId());
  43         if ( _CreatureForm==NULL )
  44         {
  45                 nlwarning( "CSabrinaActorCreature::CSabrinaActorCreature(): invalid creature form %s in entity %s",
  46                         parent->getSheetId().toString().c_str(), parent->getId().toString().c_str() );
  47                 #ifdef NL_DEBUG
  48                         nlstop
  49                 #endif
  50                 return;
  51         }
  52
  53         _GlobalArmorStats.setQuality( _CreatureForm->Level );
  54
  55         for (int i=0;i<DMGTYPE::NBTYPES;++i)
  56         {
  57                 _GlobalArmorStats.setProtectionFactor(i,_CreatureForm->Protections[i].Factor);
  58                 _GlobalArmorStats.setProtectionLimit(i,_CreatureForm->Protections[i].Max);
  59         }
  60
  61         _GlobalArmorStats.setSkill( SKILLS::unknown );
  62         _GlobalArmorStats.setArmorType( ARMORTYPE::UNKNOWN );   // TODO: FIXME
  63
  64         _DefenseSkillValue= _CreatureForm->Level * 10;  // TODO: FIXME
  65         _AttackSkillValue= _CreatureForm->Level * 10;   // TODO: FIXME
  66
  67         _RightHandWeaponStats.setQuality( _CreatureForm->Level );                                                                                       // TODO: FIXME
  68         _RightHandWeaponStats.setDamage( _CreatureForm->CreatureDamagePerHit * 260/(10+10*_CreatureForm->Level) );      // TODO: FIXME
  69
  70         _RightHandWeaponStats.setDmgType( DMGTYPE::SLASHING );          // TODO: FIXME
  71         _RightHandWeaponStats.setSpeedInTicks( 30 );                                    // TODO: FIXME
  72         _RightHandWeaponStats.setFamily( ITEMFAMILY::MELEE_WEAPON );
  73         _RightHandWeaponStats.setSkill( SKILLS::SFM1H );                                // TODO: FIXME: WHY SFM1H????
  74
  75 //      INFOLOG("AttackerAi :_RightHandWeaponStats.Quality = %u, _RightHandWeaponStats.Damage = %u",
  76 //              _RightHandWeaponStats.getQuality(), _RightHandWeaponStats.getDamage() );
  77 }
  78
  79 CSabrinaActorCreature::CSabrinaActorCreature(const CSabrinaActorCreature& other):
  80         ISabrinaActor(_Parent)
  81 {
  82         _CreatureForm                   = other._CreatureForm;
  83         _AttackSkillValue               = other._AttackSkillValue;
  84         _DefenseSkillValue              = other._DefenseSkillValue;
  85         _DodgeSkillValue                = other._DodgeSkillValue;
  86         _GlobalArmorStats               = other._GlobalArmorStats;
  87         _RightHandWeaponStats   = other._RightHandWeaponStats;
  88         _LeftHandWeaponStats    = other._LeftHandWeaponStats;
  89 }
  90
  91 //------------------------------------------------------------------------------------------------------
  92 // ~CSabrinaActorCreature - dtor
  93 //------------------------------------------------------------------------------------------------------
  94 CSabrinaActorCreature::~CSabrinaActorCreature()
  95 {
  96 }
  97
  98 //------------------------------------------------------------------------------------------------------
  99 // Management of the actor's own actions
 100
 101 //------------------------------------------------------------------------------------------------------
 102 // cancelSabrinaAction - dtor
 103 //------------------------------------------------------------------------------------------------------
 104 void CSabrinaActorCreature::beginSabrinaAction(const ISabrinaPhraseModel* phrase)
 105 {
 106 // TODO
 107 //      _CurrentActionPhrase->beginPhrase(phrase);
 108 }
 109
 110 //------------------------------------------------------------------------------------------------------
 111 // cancelSabrinaAction - dtor
 112 //------------------------------------------------------------------------------------------------------
 113 void CSabrinaActorCreature::cancelSabrinaAction(SABRINA::TEventCode reason)
 114 {
 115 // TODO
 116 //      _CurrentActionPhrase->abortPhrase(reason);
 117 }
 118
 119
 120 //------------------------------------------------------------------------------------------------------
 121 // Virtual application of results of a Sabrina Action to a target
 122
 123 //------------------------------------------------------------------------------------------------------
 124 // cbSabrinaActionApplyBegin
 125 //------------------------------------------------------------------------------------------------------
 126 void CSabrinaActorCreature::cbSabrinaActionApplyBegin()
 127 {
 128 // callback at start of application of a set of effects from a sabrina action
 129 // eg: setup an event report record here
 130 }
 131
 132 //------------------------------------------------------------------------------------------------------
 133 // applyHeal
 134 //------------------------------------------------------------------------------------------------------
 135 void CSabrinaActorCreature::applyHeal(SABRINA::THealType healType,uint32 value)
 136 {
 137 // apply damage (to hp, sap or sta)
 138 }
 139
 140 //------------------------------------------------------------------------------------------------------
 141 // applyDamage
 142 //------------------------------------------------------------------------------------------------------
 143 void CSabrinaActorCreature::applyDamage(SABRINA::TDmgType damageType, uint32 value)
 144 {
 145 // apply damage (to hp, sap or sta)
 146 }
 147
 148 //------------------------------------------------------------------------------------------------------
 149 // applyBeginSecondaryEffect
 150 //------------------------------------------------------------------------------------------------------
 151 void CSabrinaActorCreature::applyBeginSecondaryEffect(SABRINA::TEffectType effectType, uint32 strength)
 152 {
 153 // apply secondary effects (eg Stun, debuff, etc)
 154 }
 155
 156 //------------------------------------------------------------------------------------------------------
 157 // applyEndSecondaryEffect
 158 //------------------------------------------------------------------------------------------------------
 159 void CSabrinaActorCreature::applyEndSecondaryEffect(SABRINA::TEffectType effectType)
 160 {
 161 // apply secondary effects (eg Stun, etc)
 162 }
 163
 164 //------------------------------------------------------------------------------------------------------
 165 // cbSabrinaActionApplyEnd
 166 //------------------------------------------------------------------------------------------------------
 167 void CSabrinaActorCreature::cbSabrinaActionApplyEnd()
 168 {
 169 // callback at end of application of a set of effects from a sabrina action
 170 // eg: dispatch the en=vent report record now that complete set of event elements have been dealt with
 171 }
 172
 173
 174 //------------------------------------------------------------------------------------------------------
 175 // Virtual Read Accessor Interface
 176
 177 //------------------------------------------------------------------------------------------------------
 178 // getSkillValue
 179 //------------------------------------------------------------------------------------------------------
 180 sint32 CSabrinaActorCreature::getSkillValue(SKILLS::ESkills skill) const
 181 {
 182         // lookup the value of a given skill
 183         nlwarning("Attempt to access specific skill '%s' for a creature - returning attack skill",SKILLS::toString(skill).c_str());
 184         return _AttackSkillValue;
 185 }
 186
 187 //------------------------------------------------------------------------------------------------------
 188 // getAttackSkillValue
 189 //------------------------------------------------------------------------------------------------------
 190 sint32 CSabrinaActorCreature::getAttackSkillValue() const
 191 {
 192         // get a value for the attack skill
 193         return _AttackSkillValue;
 194 }
 195
 196 //------------------------------------------------------------------------------------------------------
 197 // getDefenseSkillValue
 198 //------------------------------------------------------------------------------------------------------
 199 sint32 CSabrinaActorCreature::getDefenseSkillValue() const
 200 {
 201         // get a value for the defense skill
 202         return _DefenseSkillValue;
 203 }
 204
 205 //------------------------------------------------------------------------------------------------------
 206 // getDodgeSkillValue
 207 //------------------------------------------------------------------------------------------------------
 208 sint32 CSabrinaActorCreature::getDodgeSkillValue() const
 209 {
 210         // get a value for the didge skill
 211         return _DodgeSkillValue;
 212 }
 213
 214 //------------------------------------------------------------------------------------------------------
 215 // getRightHandWeaponStats
 216 //------------------------------------------------------------------------------------------------------
 217 bool CSabrinaActorCreature::getRightHandWeaponStats(CWeaponStats& stats) const
 218 {
 219         // get the combat stats for the item in right hand
 220         // note that in the case of bear hand combat a set of bear hand stats are filled in here
 221         // returns false if an item that is not usable for combat is present in right hand
 222         stats=_RightHandWeaponStats;
 223         return true;
 224 }
 225
 226 //------------------------------------------------------------------------------------------------------
 227 // getLeftHandWeaponStats
 228 //------------------------------------------------------------------------------------------------------
 229 bool CSabrinaActorCreature::getLeftHandWeaponStats(CWeaponStats& stats) const
 230 {
 231         // get the combat stats for the item in left hand
 232         // returns false if the left hand is empty or the item in left hand is not a weapon or the player
 233         // doesn't have a skill permitting use of the given weapon in the left hand
 234         stats=_LeftHandWeaponStats;
 235         return true;
 236 }
 237
 238 //------------------------------------------------------------------------------------------------------
 239 // getAmmoStats
 240 //------------------------------------------------------------------------------------------------------
 241 bool CSabrinaActorCreature::getAmmoStats(CWeaponStats& stats) const
 242 {
 243         // get stats for ammo in left hand
 244         // returns false if no ammo available or ammo is incompatible with weapon
 245         stats=_LeftHandWeaponStats;
 246         return true;
 247 }
 248
 249 //------------------------------------------------------------------------------------------------------
 250 // getArmorProtectionStats
 251 //------------------------------------------------------------------------------------------------------
 252 bool CSabrinaActorCreature::getArmorProtectionStats(SLOT_EQUIPMENT::TSlotEquipment slot,CArmorStats& protection) const
 253 {
 254         // get stats for a given piece of armor
 255         // in the case where no armor is found the stats are initialised accordingly
 256         // returns false if no armor is present on given location
 257         protection=_GlobalArmorStats;
 258         return true;
 259 }
 260
 261 //------------------------------------------------------------------------------------------------------
 262 // getLeftHandProtectionStats
 263 //------------------------------------------------------------------------------------------------------
 264 bool CSabrinaActorCreature::getLeftHandProtectionStats(CShieldStats& protection) const
 265 {
 266         // get stats for the shield     (or likewise)
 267         // in the case where no shield is found the stats are initalised accordingly
 268         // returns false if the left hand is empty or the left hand item offers no protection
 269         protection=CShieldStats();
 270         return false;
 271 }
 272
 273 //------------------------------------------------------------------------------------------------------
 274 // getTarget
 275 //------------------------------------------------------------------------------------------------------
 276 ISabrinaActor* CSabrinaActorCreature::getTarget() const
 277 {
 278         // get a pointer to the entity refferenced by this entity
 279         return NULL;
 280 }
 281
 282
 283 //------------------------------------------------------------------------------------------------------
 284 // Logical test routines
 285
 286 //------------------------------------------------------------------------------------------------------
 287 // isValidOffensiveTarget
 288 //------------------------------------------------------------------------------------------------------
 289 bool CSabrinaActorCreature::isValidOffensiveTarget(ISabrinaActor* target) const
 290 {
 291         // make sure that I'm allowed to perform offensive actions against the given target
 292         // take into account whether target is in PvP action with me, etc, etc
 293         return true;
 294 }
 295
 296 //------------------------------------------------------------------------------------------------------
 297 // isValidCurativeTarget
 298 //------------------------------------------------------------------------------------------------------
 299 bool CSabrinaActorCreature::isValidCurativeTarget(ISabrinaActor* target) const
 300 {
 301         // make sure I'm allowed to perform curative actions on target
 302         // take into account PvP rules with neutrals not allowed to assist, etc...
 303         return true;
 304 }
 305
 306
 307 //------------------------------------------------------------------------------------------------------
 308 // Virtual callbacks for message sending on activation/ cancelation of Sabrina actions
 309
 310 //------------------------------------------------------------------------------------------------------
 311 // cbSabrinaActionBegin
 312 //------------------------------------------------------------------------------------------------------
 313 void CSabrinaActorCreature::cbSabrinaActionBegin(const CSabrinaPhraseInstance* completedPhrase)
 314 {
 315         // this routine must lock the items that are used in the phrase...
 316 }
 317
 318 //------------------------------------------------------------------------------------------------------
 319 // cbSabrinaActionSuccess
 320 //------------------------------------------------------------------------------------------------------
 321 void CSabrinaActorCreature::cbSabrinaActionSuccess(const CSabrinaPhraseInstance* completedPhrase, SABRINA::TEventCode code)
 322 {
 323         // this routine is responsible for beginning a new sabrina action if a new action is lined up
 324         // this routine should deal with ammo & raw material consumption if need be...
 325 }
 326
 327 //------------------------------------------------------------------------------------------------------
 328 // cbSabrinaActionFailure
 329 //------------------------------------------------------------------------------------------------------
 330 void CSabrinaActorCreature::cbSabrinaActionFailure(const CSabrinaPhraseInstance* completedPhrase, SABRINA::TEventCode code)
 331 {
 332         // this routine is called either by 'cbSabrinaActionBegin()' or when the result of the action is to be applied
 333         // this routine is also responsible for beginning a new sabrina action if a new action is lined up
 334 }
 335
 336 //------------------------------------------------------------------------------------------------------
 337 // cbSabrinaActionCancel
 338 //------------------------------------------------------------------------------------------------------
 339 void CSabrinaActorCreature::cbSabrinaActionCancel(const CSabrinaPhraseInstance* completedPhrase, SABRINA::TEventCode code)
 340 {
 341         // this routine is called by cancelSabrinaAction()
 342         // this routine is also responsible for beginning a new sabrina action if a new action is lined up
 343 }
 344
 345 //------------------------------------------------------------------------------------------------------
 346 // cbSabrinaActionCancel
 347 //------------------------------------------------------------------------------------------------------
 348 void CSabrinaActorCreature::cbSabrinaActionEnd(const CSabrinaPhraseInstance* completedPhrase)
 349 {
 350 // this callback is called after the postActionTime has elapsed and the action is completely finished
 351 }
 352