src/game/MotionMaster.cpp

   1 /*
   2  * Copyright (C) 2005-2010 MaNGOS <http://getmangos.com/>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (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 General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #include "MotionMaster.h"
  20 #include "CreatureAISelector.h"
  21 #include "Creature.h"
  22 #include "Traveller.h"
  23
  24 #include "ConfusedMovementGenerator.h"
  25 #include "FleeingMovementGenerator.h"
  26 #include "HomeMovementGenerator.h"
  27 #include "IdleMovementGenerator.h"
  28 #include "PointMovementGenerator.h"
  29 #include "TargetedMovementGenerator.h"
  30 #include "WaypointMovementGenerator.h"
  31
  32 #include <cassert>
  33
  34 inline bool isStatic(MovementGenerator *mv)
  35 {
  36     return (mv == &si_idleMovement);
  37 }
  38
  39 void
  40 MotionMaster::Initialize()
  41 {
  42     // clear ALL movement generators (including default)
  43     while(!empty())
  44     {
  45         MovementGenerator *curr = top();
  46         pop();
  47         curr->Finalize(*i_owner);
  48         if( !isStatic( curr ) )
  49             delete curr;
  50     }
  51
  52     // set new default movement generator
  53     if(i_owner->GetTypeId() == TYPEID_UNIT)
  54     {
  55         MovementGenerator* movement = FactorySelector::selectMovementGenerator((Creature*)i_owner);
  56         push(  movement == NULL ? &si_idleMovement : movement );
  57         top()->Initialize(*i_owner);
  58     }
  59     else
  60         push(&si_idleMovement);
  61 }
  62
  63 MotionMaster::~MotionMaster()
  64 {
  65     // clear ALL movement generators (including default)
  66     while(!empty())
  67     {
  68         MovementGenerator *curr = top();
  69         pop();
  70         curr->Finalize(*i_owner);
  71         if( !isStatic( curr ) )
  72             delete curr;
  73     }
  74 }
  75
  76 void
  77 MotionMaster::UpdateMotion(uint32 diff)
  78 {
  79     if( i_owner->hasUnitState(UNIT_STAT_CAN_NOT_MOVE) )
  80         return;
  81     assert( !empty() );
  82     m_cleanFlag |= MMCF_UPDATE;
  83     if (!top()->Update(*i_owner, diff))
  84     {
  85         m_cleanFlag &= ~MMCF_UPDATE;
  86         MovementExpired();
  87     }
  88     else
  89         m_cleanFlag &= ~MMCF_UPDATE;
  90
  91     if (m_expList)
  92     {
  93         for (size_t i = 0; i < m_expList->size(); ++i)
  94         {
  95             MovementGenerator* mg = (*m_expList)[i];
  96             if (!isStatic(mg))
  97                 delete mg;
  98         }
  99
 100         delete m_expList;
 101         m_expList = NULL;
 102
 103         if (empty())
 104             Initialize();
 105
 106         if (m_cleanFlag & MMCF_RESET)
 107         {
 108             top()->Reset(*i_owner);
 109             m_cleanFlag &= ~MMCF_RESET;
 110         }
 111     }
 112 }
 113
 114 void
 115 MotionMaster::DirectClean(bool reset)
 116 {
 117     while( !empty() && size() > 1 )
 118     {
 119         MovementGenerator *curr = top();
 120         pop();
 121         curr->Finalize(*i_owner);
 122         if( !isStatic( curr ) )
 123             delete curr;
 124     }
 125
 126     if (reset)
 127     {
 128         assert( !empty() );
 129         top()->Reset(*i_owner);
 130     }
 131 }
 132
 133 void
 134 MotionMaster::DelayedClean()
 135 {
 136     if (empty() || size() == 1)
 137         return;
 138
 139     if(!m_expList)
 140         m_expList = new ExpireList();
 141
 142     while( !empty() && size() > 1 )
 143     {
 144         MovementGenerator *curr = top();
 145         pop();
 146         curr->Finalize(*i_owner);
 147         if( !isStatic( curr ) )
 148             m_expList->push_back(curr);
 149     }
 150 }
 151
 152 void
 153 MotionMaster::DirectExpire(bool reset)
 154 {
 155     if( empty() || size() == 1 )
 156         return;
 157
 158     MovementGenerator *curr = top();
 159     pop();
 160
 161     // also drop stored under top() targeted motions
 162     while (!empty() && (top()->GetMovementGeneratorType() == CHASE_MOTION_TYPE || top()->GetMovementGeneratorType() == FOLLOW_MOTION_TYPE))
 163     {
 164         MovementGenerator *temp = top();
 165         pop();
 166         temp ->Finalize(*i_owner);
 167         delete temp;
 168     }
 169
 170     // it can add another motions instead
 171     curr->Finalize(*i_owner);
 172
 173     if( !isStatic(curr) )
 174         delete curr;
 175
 176     if( empty() )
 177         Initialize();
 178
 179     if (reset) top()->Reset(*i_owner);
 180 }
 181
 182 void
 183 MotionMaster::DelayedExpire()
 184 {
 185     if( empty() || size() == 1 )
 186         return;
 187
 188     MovementGenerator *curr = top();
 189     pop();
 190
 191     if(!m_expList)
 192         m_expList = new ExpireList();
 193
 194     // also drop stored under top() targeted motions
 195     while (!empty() && (top()->GetMovementGeneratorType() == CHASE_MOTION_TYPE || top()->GetMovementGeneratorType() == FOLLOW_MOTION_TYPE))
 196     {
 197         MovementGenerator *temp = top();
 198         pop();
 199         temp ->Finalize(*i_owner);
 200         m_expList->push_back(temp );
 201     }
 202
 203     curr->Finalize(*i_owner);
 204
 205     if( !isStatic(curr) )
 206         m_expList->push_back(curr);
 207 }
 208
 209 void MotionMaster::MoveIdle()
 210 {
 211     if( empty() || !isStatic( top() ) )
 212         push( &si_idleMovement );
 213 }
 214
 215 void
 216 MotionMaster::MoveTargetedHome()
 217 {
 218     if(i_owner->hasUnitState(UNIT_STAT_FLEEING))
 219         return;
 220
 221     Clear(false);
 222
 223     if(i_owner->GetTypeId()==TYPEID_UNIT && !((Creature*)i_owner)->GetCharmerOrOwnerGUID())
 224     {
 225         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted home", i_owner->GetEntry(), i_owner->GetGUIDLow());
 226         Mutate(new HomeMovementGenerator<Creature>());
 227     }
 228     else if(i_owner->GetTypeId()==TYPEID_UNIT && ((Creature*)i_owner)->GetCharmerOrOwnerGUID())
 229     {
 230         DEBUG_LOG("Pet or controlled creature (Entry: %u GUID: %u) targeting home",
 231             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 232         Unit *target = ((Creature*)i_owner)->GetCharmerOrOwner();
 233         if(target)
 234         {
 235             DEBUG_LOG("Following %s (GUID: %u)",
 236                 target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 237                 target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 238             Mutate(new FollowMovementGenerator<Creature>(*target,PET_FOLLOW_DIST,PET_FOLLOW_ANGLE));
 239         }
 240     }
 241     else
 242     {
 243         sLog.outError("Player (GUID: %u) attempt targeted home", i_owner->GetGUIDLow() );
 244     }
 245 }
 246
 247 void
 248 MotionMaster::MoveConfused()
 249 {
 250     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 251     {
 252         DEBUG_LOG("Player (GUID: %u) move confused", i_owner->GetGUIDLow() );
 253         Mutate(new ConfusedMovementGenerator<Player>());
 254     }
 255     else
 256     {
 257         DEBUG_LOG("Creature (Entry: %u GUID: %u) move confused",
 258             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 259         Mutate(new ConfusedMovementGenerator<Creature>());
 260     }
 261 }
 262
 263 void
 264 MotionMaster::MoveChase(Unit* target, float dist, float angle)
 265 {
 266     // ignore movement request if target not exist
 267     if(!target)
 268         return;
 269
 270     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 271     {
 272         DEBUG_LOG("Player (GUID: %u) chase to %s (GUID: %u)",
 273             i_owner->GetGUIDLow(),
 274             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 275             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 276         Mutate(new ChaseMovementGenerator<Player>(*target,dist,angle));
 277     }
 278     else
 279     {
 280         DEBUG_LOG("Creature (Entry: %u GUID: %u) chase to %s (GUID: %u)",
 281             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 282             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 283             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 284         Mutate(new ChaseMovementGenerator<Creature>(*target,dist,angle));
 285     }
 286 }
 287
 288 void
 289 MotionMaster::MoveFollow(Unit* target, float dist, float angle)
 290 {
 291     Clear();
 292
 293     // ignore movement request if target not exist
 294     if(!target)
 295         return;
 296
 297     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 298     {
 299         DEBUG_LOG("Player (GUID: %u) follow to %s (GUID: %u)", i_owner->GetGUIDLow(),
 300             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 301             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 302         Mutate(new FollowMovementGenerator<Player>(*target,dist,angle));
 303     }
 304     else
 305     {
 306         DEBUG_LOG("Creature (Entry: %u GUID: %u) follow to %s (GUID: %u)",
 307             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 308             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 309             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 310         Mutate(new FollowMovementGenerator<Creature>(*target,dist,angle));
 311     }
 312 }
 313
 314 void
 315 MotionMaster::MovePoint(uint32 id, float x, float y, float z)
 316 {
 317     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 318     {
 319         DEBUG_LOG("Player (GUID: %u) targeted point (Id: %u X: %f Y: %f Z: %f)", i_owner->GetGUIDLow(), id, x, y, z );
 320         Mutate(new PointMovementGenerator<Player>(id,x,y,z));
 321     }
 322     else
 323     {
 324         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted point (ID: %u X: %f Y: %f Z: %f)",
 325             i_owner->GetEntry(), i_owner->GetGUIDLow(), id, x, y, z );
 326         Mutate(new PointMovementGenerator<Creature>(id,x,y,z));
 327     }
 328 }
 329
 330 void
 331 MotionMaster::MoveSeekAssistance(float x, float y, float z)
 332 {
 333     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 334     {
 335         sLog.outError("Player (GUID: %u) attempt to seek assistance",i_owner->GetGUIDLow());
 336     }
 337     else
 338     {
 339         DEBUG_LOG("Creature (Entry: %u GUID: %u) seek assistance (X: %f Y: %f Z: %f)",
 340             i_owner->GetEntry(), i_owner->GetGUIDLow(), x, y, z );
 341         Mutate(new AssistanceMovementGenerator(x,y,z));
 342     }
 343 }
 344
 345 void
 346 MotionMaster::MoveSeekAssistanceDistract(uint32 time)
 347 {
 348     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 349     {
 350         sLog.outError("Player (GUID: %u) attempt to call distract after assistance",i_owner->GetGUIDLow());
 351     }
 352     else
 353     {
 354         DEBUG_LOG("Creature (Entry: %u GUID: %u) is distracted after assistance call (Time: %u)",
 355             i_owner->GetEntry(), i_owner->GetGUIDLow(), time );
 356         Mutate(new AssistanceDistractMovementGenerator(time));
 357     }
 358 }
 359
 360 void
 361 MotionMaster::MoveFleeing(Unit* enemy, uint32 time)
 362 {
 363     if(!enemy)
 364         return;
 365
 366     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 367     {
 368         DEBUG_LOG("Player (GUID: %u) flee from %s (GUID: %u)", i_owner->GetGUIDLow(),
 369             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 370             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 371         Mutate(new FleeingMovementGenerator<Player>(enemy->GetGUID()));
 372     }
 373     else
 374     {
 375         DEBUG_LOG("Creature (Entry: %u GUID: %u) flee from %s (GUID: %u)%s",
 376             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 377             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 378             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow(),
 379             time ? " for a limited time" : "");
 380         if (time)
 381             Mutate(new TimedFleeingMovementGenerator(enemy->GetGUID(), time));
 382         else
 383             Mutate(new FleeingMovementGenerator<Creature>(enemy->GetGUID()));
 384     }
 385 }
 386
 387 void
 388 MotionMaster::MoveTaxiFlight(uint32 path, uint32 pathnode)
 389 {
 390     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 391     {
 392         DEBUG_LOG("Player (GUID: %u) taxi to (Path %u node %u)", i_owner->GetGUIDLow(), path, pathnode);
 393         FlightPathMovementGenerator* mgen = new FlightPathMovementGenerator(path,pathnode);
 394         Mutate(mgen);
 395     }
 396     else
 397     {
 398         sLog.outError("Creature (Entry: %u GUID: %u) attempt taxi to (Path %u node %u)",
 399             i_owner->GetEntry(), i_owner->GetGUIDLow(), path, pathnode );
 400     }
 401 }
 402
 403 void
 404 MotionMaster::MoveDistract(uint32 timer)
 405 {
 406     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 407     {
 408         DEBUG_LOG("Player (GUID: %u) distracted (timer: %u)", i_owner->GetGUIDLow(), timer);
 409     }
 410     else
 411     {
 412         DEBUG_LOG("Creature (Entry: %u GUID: %u) (timer: %u)",
 413             i_owner->GetEntry(), i_owner->GetGUIDLow(), timer);
 414     }
 415
 416     DistractMovementGenerator* mgen = new DistractMovementGenerator(timer);
 417     Mutate(mgen);
 418 }
 419
 420 void MotionMaster::Mutate(MovementGenerator *m)
 421 {
 422     if (!empty())
 423     {
 424         switch(top()->GetMovementGeneratorType())
 425         {
 426             // HomeMovement is not that important, delete it if meanwhile a new comes
 427             case HOME_MOTION_TYPE:
 428             // DistractMovement interrupted by any other movement
 429             case DISTRACT_MOTION_TYPE:
 430                 MovementExpired(false);
 431             default:
 432                 break;
 433         }
 434
 435         if (!empty())
 436             top()->Interrupt(*i_owner);
 437     }
 438     m->Initialize(*i_owner);
 439     push(m);
 440 }
 441
 442 void MotionMaster::propagateSpeedChange()
 443 {
 444     Impl::container_type::iterator it = Impl::c.begin();
 445     for ( ;it != end(); ++it)
 446     {
 447         (*it)->unitSpeedChanged();
 448     }
 449 }
 450
 451 MovementGeneratorType MotionMaster::GetCurrentMovementGeneratorType() const
 452 {
 453    if(empty())
 454        return IDLE_MOTION_TYPE;
 455
 456    return top()->GetMovementGeneratorType();
 457 }
 458
 459 bool MotionMaster::GetDestination(float &x, float &y, float &z)
 460 {
 461    if(empty())
 462        return false;
 463
 464    return top()->GetDestination(x,y,z);
 465 }
 466
 467 void MotionMaster::UpdateFinalDistanceToTarget(float fDistance)
 468 {
 469     if (!empty())
 470         top()->UpdateFinalDistance(fDistance);
 471 }