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