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         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_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         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() == TARGETED_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() == TARGETED_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             i_owner->addUnitState(UNIT_STAT_FOLLOW);
 236             DEBUG_LOG("Following %s (GUID: %u)",
 237                 target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 238                 target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 239             Mutate(new TargetedMovementGenerator<Creature>(*target,PET_FOLLOW_DIST,PET_FOLLOW_ANGLE));
 240         }
 241     }
 242     else
 243     {
 244         sLog.outError("Player (GUID: %u) attempt targeted home", i_owner->GetGUIDLow() );
 245     }
 246 }
 247
 248 void
 249 MotionMaster::MoveConfused()
 250 {
 251     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 252     {
 253         DEBUG_LOG("Player (GUID: %u) move confused", i_owner->GetGUIDLow() );
 254         Mutate(new ConfusedMovementGenerator<Player>());
 255     }
 256     else
 257     {
 258         DEBUG_LOG("Creature (Entry: %u GUID: %u) move confused",
 259             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 260         Mutate(new ConfusedMovementGenerator<Creature>());
 261     }
 262 }
 263
 264 void
 265 MotionMaster::MoveChase(Unit* target, float dist, float angle)
 266 {
 267     // ignore movement request if target not exist
 268     if(!target)
 269         return;
 270
 271     i_owner->clearUnitState(UNIT_STAT_FOLLOW);
 272     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 273     {
 274         DEBUG_LOG("Player (GUID: %u) chase to %s (GUID: %u)",
 275             i_owner->GetGUIDLow(),
 276             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 277             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 278         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 279     }
 280     else
 281     {
 282         DEBUG_LOG("Creature (Entry: %u GUID: %u) chase to %s (GUID: %u)",
 283             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 284             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 285             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 286         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 287     }
 288 }
 289
 290 void
 291 MotionMaster::MoveFollow(Unit* target, float dist, float angle)
 292 {
 293     Clear();
 294
 295     // ignore movement request if target not exist
 296     if(!target)
 297         return;
 298
 299     i_owner->addUnitState(UNIT_STAT_FOLLOW);
 300     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 301     {
 302         DEBUG_LOG("Player (GUID: %u) follow to %s (GUID: %u)", i_owner->GetGUIDLow(),
 303             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 304             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 305         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 306     }
 307     else
 308     {
 309         DEBUG_LOG("Creature (Entry: %u GUID: %u) follow to %s (GUID: %u)",
 310             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 311             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 312             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 313         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 314     }
 315 }
 316
 317 void
 318 MotionMaster::MovePoint(uint32 id, float x, float y, float z)
 319 {
 320     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 321     {
 322         DEBUG_LOG("Player (GUID: %u) targeted point (Id: %u X: %f Y: %f Z: %f)", i_owner->GetGUIDLow(), id, x, y, z );
 323         Mutate(new PointMovementGenerator<Player>(id,x,y,z));
 324     }
 325     else
 326     {
 327         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted point (ID: %u X: %f Y: %f Z: %f)",
 328             i_owner->GetEntry(), i_owner->GetGUIDLow(), id, x, y, z );
 329         Mutate(new PointMovementGenerator<Creature>(id,x,y,z));
 330     }
 331 }
 332
 333 void
 334 MotionMaster::MoveSeekAssistance(float x, float y, float z)
 335 {
 336     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 337     {
 338         sLog.outError("Player (GUID: %u) attempt to seek assistance",i_owner->GetGUIDLow());
 339     }
 340     else
 341     {
 342         DEBUG_LOG("Creature (Entry: %u GUID: %u) seek assistance (X: %f Y: %f Z: %f)",
 343             i_owner->GetEntry(), i_owner->GetGUIDLow(), x, y, z );
 344         Mutate(new AssistanceMovementGenerator(x,y,z));
 345     }
 346 }
 347
 348 void
 349 MotionMaster::MoveSeekAssistanceDistract(uint32 time)
 350 {
 351     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 352     {
 353         sLog.outError("Player (GUID: %u) attempt to call distract after assistance",i_owner->GetGUIDLow());
 354     }
 355     else
 356     {
 357         DEBUG_LOG("Creature (Entry: %u GUID: %u) is distracted after assistance call (Time: %u)",
 358             i_owner->GetEntry(), i_owner->GetGUIDLow(), time );
 359         Mutate(new AssistanceDistractMovementGenerator(time));
 360     }
 361 }
 362
 363 void
 364 MotionMaster::MoveFleeing(Unit* enemy, uint32 time)
 365 {
 366     if(!enemy)
 367         return;
 368
 369     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 370     {
 371         DEBUG_LOG("Player (GUID: %u) flee from %s (GUID: %u)", i_owner->GetGUIDLow(),
 372             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 373             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 374         Mutate(new FleeingMovementGenerator<Player>(enemy->GetGUID()));
 375     }
 376     else
 377     {
 378         DEBUG_LOG("Creature (Entry: %u GUID: %u) flee from %s (GUID: %u)%s",
 379             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 380             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 381             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow(),
 382             time ? " for a limited time" : "");
 383         if (time)
 384             Mutate(new TimedFleeingMovementGenerator(enemy->GetGUID(), time));
 385         else
 386             Mutate(new FleeingMovementGenerator<Creature>(enemy->GetGUID()));
 387     }
 388 }
 389
 390 void
 391 MotionMaster::MoveTaxiFlight(uint32 path, uint32 pathnode)
 392 {
 393     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 394     {
 395         DEBUG_LOG("Player (GUID: %u) taxi to (Path %u node %u)", i_owner->GetGUIDLow(), path, pathnode);
 396         FlightPathMovementGenerator* mgen = new FlightPathMovementGenerator(path,pathnode);
 397         Mutate(mgen);
 398     }
 399     else
 400     {
 401         sLog.outError("Creature (Entry: %u GUID: %u) attempt taxi to (Path %u node %u)",
 402             i_owner->GetEntry(), i_owner->GetGUIDLow(), path, pathnode );
 403     }
 404 }
 405
 406 void
 407 MotionMaster::MoveDistract(uint32 timer)
 408 {
 409     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 410     {
 411         DEBUG_LOG("Player (GUID: %u) distracted (timer: %u)", i_owner->GetGUIDLow(), timer);
 412     }
 413     else
 414     {
 415         DEBUG_LOG("Creature (Entry: %u GUID: %u) (timer: %u)",
 416             i_owner->GetEntry(), i_owner->GetGUIDLow(), timer);
 417     }
 418
 419     DistractMovementGenerator* mgen = new DistractMovementGenerator(timer);
 420     Mutate(mgen);
 421 }
 422
 423 void MotionMaster::Mutate(MovementGenerator *m)
 424 {
 425     if (!empty())
 426     {
 427         switch(top()->GetMovementGeneratorType())
 428         {
 429             // HomeMovement is not that important, delete it if meanwhile a new comes
 430             case HOME_MOTION_TYPE:
 431             // DistractMovement interrupted by any other movement
 432             case DISTRACT_MOTION_TYPE:
 433                 MovementExpired(false);
 434             default:
 435                 break;
 436         }
 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 }