src/game/MotionMaster.cpp

   1 /*
   2  * Copyright (C) 2005-2009 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         curr->Finalize(*i_owner);
  47         pop();
  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         curr->Finalize(*i_owner);
  70         pop();
  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_ROOT | UNIT_STAT_STUNNED) )
  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 (int 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         curr->Finalize(*i_owner);
 121         pop();
 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     m_expList = new ExpireList();
 140     while( !empty() && size() > 1 )
 141     {
 142         MovementGenerator *curr = top();
 143         curr->Finalize(*i_owner);
 144         pop();
 145         if( !isStatic( curr ) )
 146             m_expList->push_back(curr);
 147     }
 148 }
 149
 150 void
 151 MotionMaster::DirectExpire(bool reset)
 152 {
 153     if( empty() || size() == 1 )
 154         return;
 155
 156     MovementGenerator *curr = top();
 157     curr->Finalize(*i_owner);
 158     pop();
 159
 160     if( !isStatic(curr) )
 161         delete curr;
 162
 163     assert( !empty() );
 164     while( !empty() && top()->GetMovementGeneratorType() == TARGETED_MOTION_TYPE )
 165     {
 166         // Should check if target is still valid? If not valid it will crash.
 167         curr = top();
 168         curr->Finalize(*i_owner);
 169         pop();
 170         delete curr;
 171     }
 172     if( empty() )
 173         Initialize();
 174     if (reset) top()->Reset(*i_owner);
 175 }
 176
 177 void
 178 MotionMaster::DelayedExpire()
 179 {
 180     if( empty() || size() == 1 )
 181         return;
 182
 183     MovementGenerator *curr = top();
 184     curr->Finalize(*i_owner);
 185     pop();
 186
 187     if( !isStatic(curr) )
 188         m_expList->push_back(curr);
 189
 190     m_expList = new ExpireList();
 191     while( !empty() && top()->GetMovementGeneratorType() == TARGETED_MOTION_TYPE )
 192     {
 193         // Should check if target is still valid? If not valid it will crash.
 194         curr = top();
 195         curr->Finalize(*i_owner);
 196         pop();
 197         m_expList->push_back(curr);
 198     }
 199 }
 200
 201 void MotionMaster::MoveIdle()
 202 {
 203     if( empty() || !isStatic( top() ) )
 204         push( &si_idleMovement );
 205 }
 206
 207 void
 208 MotionMaster::MoveTargetedHome()
 209 {
 210     if(i_owner->hasUnitState(UNIT_STAT_FLEEING))
 211         return;
 212
 213     Clear(false);
 214
 215     if(i_owner->GetTypeId()==TYPEID_UNIT && !((Creature*)i_owner)->GetCharmerOrOwnerGUID())
 216     {
 217         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted home", i_owner->GetEntry(), i_owner->GetGUIDLow());
 218         Mutate(new HomeMovementGenerator<Creature>());
 219     }
 220     else if(i_owner->GetTypeId()==TYPEID_UNIT && ((Creature*)i_owner)->GetCharmerOrOwnerGUID())
 221     {
 222         DEBUG_LOG("Pet or controlled creature (Entry: %u GUID: %u) targeting home",
 223             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 224         Unit *target = ((Creature*)i_owner)->GetCharmerOrOwner();
 225         if(target)
 226         {
 227             i_owner->addUnitState(UNIT_STAT_FOLLOW);
 228             DEBUG_LOG("Following %s (GUID: %u)",
 229                 target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 230                 target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 231             Mutate(new TargetedMovementGenerator<Creature>(*target,PET_FOLLOW_DIST,PET_FOLLOW_ANGLE));
 232         }
 233     }
 234     else
 235     {
 236         sLog.outError("Player (GUID: %u) attempt targeted home", i_owner->GetGUIDLow() );
 237     }
 238 }
 239
 240 void
 241 MotionMaster::MoveConfused()
 242 {
 243     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 244     {
 245         DEBUG_LOG("Player (GUID: %u) move confused", i_owner->GetGUIDLow() );
 246         Mutate(new ConfusedMovementGenerator<Player>());
 247     }
 248     else
 249     {
 250         DEBUG_LOG("Creature (Entry: %u GUID: %u) move confused",
 251             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 252         Mutate(new ConfusedMovementGenerator<Creature>());
 253     }
 254 }
 255
 256 void
 257 MotionMaster::MoveChase(Unit* target, float dist, float angle)
 258 {
 259     // ignore movement request if target not exist
 260     if(!target)
 261         return;
 262
 263     i_owner->clearUnitState(UNIT_STAT_FOLLOW);
 264     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 265     {
 266         DEBUG_LOG("Player (GUID: %u) chase to %s (GUID: %u)",
 267             i_owner->GetGUIDLow(),
 268             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 269             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 270         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 271     }
 272     else
 273     {
 274         DEBUG_LOG("Creature (Entry: %u GUID: %u) chase to %s (GUID: %u)",
 275             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 276             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 277             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 278         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 279     }
 280 }
 281
 282 void
 283 MotionMaster::MoveFollow(Unit* target, float dist, float angle)
 284 {
 285     Clear();
 286
 287     // ignore movement request if target not exist
 288     if(!target)
 289         return;
 290
 291     i_owner->addUnitState(UNIT_STAT_FOLLOW);
 292     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 293     {
 294         DEBUG_LOG("Player (GUID: %u) follow to %s (GUID: %u)", i_owner->GetGUIDLow(),
 295             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 296             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 297         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 298     }
 299     else
 300     {
 301         DEBUG_LOG("Creature (Entry: %u GUID: %u) follow to %s (GUID: %u)",
 302             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 303             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 304             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 305         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 306     }
 307 }
 308
 309 void
 310 MotionMaster::MovePoint(uint32 id, float x, float y, float z)
 311 {
 312     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 313     {
 314         DEBUG_LOG("Player (GUID: %u) targeted point (Id: %u X: %f Y: %f Z: %f)", i_owner->GetGUIDLow(), id, x, y, z );
 315         Mutate(new PointMovementGenerator<Player>(id,x,y,z));
 316     }
 317     else
 318     {
 319         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted point (ID: %u X: %f Y: %f Z: %f)",
 320             i_owner->GetEntry(), i_owner->GetGUIDLow(), id, x, y, z );
 321         Mutate(new PointMovementGenerator<Creature>(id,x,y,z));
 322     }
 323 }
 324
 325 void
 326 MotionMaster::MoveFleeing(Unit* enemy)
 327 {
 328     if(!enemy)
 329         return;
 330
 331     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 332     {
 333         DEBUG_LOG("Player (GUID: %u) flee from %s (GUID: %u)", i_owner->GetGUIDLow(),
 334             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 335             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 336         Mutate(new FleeingMovementGenerator<Player>(enemy->GetGUID()));
 337     }
 338     else
 339     {
 340         DEBUG_LOG("Creature (Entry: %u GUID: %u) flee from %s (GUID: %u)",
 341             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 342             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 343             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 344         Mutate(new FleeingMovementGenerator<Creature>(enemy->GetGUID()));
 345     }
 346 }
 347
 348 void
 349 MotionMaster::MoveTaxiFlight(uint32 path, uint32 pathnode)
 350 {
 351     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 352     {
 353         DEBUG_LOG("Player (GUID: %u) taxi to (Path %u node %u)", i_owner->GetGUIDLow(), path, pathnode);
 354         FlightPathMovementGenerator* mgen = new FlightPathMovementGenerator(path,pathnode);
 355         Mutate(mgen);
 356     }
 357     else
 358     {
 359         sLog.outError("Creature (Entry: %u GUID: %u) attempt taxi to (Path %u node %u)",
 360             i_owner->GetEntry(), i_owner->GetGUIDLow(), path, pathnode );
 361     }
 362 }
 363
 364 void
 365 MotionMaster::MoveDistract(uint32 timer)
 366 {
 367     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 368     {
 369         DEBUG_LOG("Player (GUID: %u) distracted (timer: %u)", i_owner->GetGUIDLow(), timer);
 370     }
 371     else
 372     {
 373         DEBUG_LOG("Creature (Entry: %u GUID: %u) (timer: %u)",
 374             i_owner->GetEntry(), i_owner->GetGUIDLow(), timer);
 375     }
 376
 377     DistractMovementGenerator* mgen = new DistractMovementGenerator(timer);
 378     Mutate(mgen);
 379 }
 380
 381 void MotionMaster::Mutate(MovementGenerator *m)
 382 {
 383     if (!empty())
 384     {
 385         switch(top()->GetMovementGeneratorType())
 386         {
 387             // HomeMovement is not that important, delete it if meanwhile a new comes
 388             case HOME_MOTION_TYPE:
 389             // DistractMovement interrupted by any other movement
 390             case DISTRACT_MOTION_TYPE:
 391                 MovementExpired(false);
 392         }
 393     }
 394     m->Initialize(*i_owner);
 395     push(m);
 396 }
 397
 398 void MotionMaster::propagateSpeedChange()
 399 {
 400     Impl::container_type::iterator it = Impl::c.begin();
 401     for ( ;it != end(); ++it)
 402     {
 403         (*it)->unitSpeedChanged();
 404     }
 405 }
 406
 407 MovementGeneratorType MotionMaster::GetCurrentMovementGeneratorType() const
 408 {
 409    if(empty())
 410        return IDLE_MOTION_TYPE;
 411
 412    return top()->GetMovementGeneratorType();
 413 }
 414
 415 bool MotionMaster::GetDestination(float &x, float &y, float &z)
 416 {
 417    if(empty())
 418        return false;
 419
 420    return top()->GetDestination(x,y,z);
 421 }