src/game/MotionMaster.cpp

   1 /*
   2  * Copyright (C) 2005-2008 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(const uint32 &diff)
  78 {
  79     if( i_owner->hasUnitState(UNIT_STAT_ROOT | UNIT_STAT_STUNNED) )
  80         return;
  81     assert( !empty() );
  82     if (!top()->Update(*i_owner, diff))
  83         MovementExpired();
  84 }
  85
  86 void
  87 MotionMaster::Clear(bool reset)
  88 {
  89     while( !empty() && size() > 1 )
  90     {
  91         MovementGenerator *curr = top();
  92         curr->Finalize(*i_owner);
  93         pop();
  94         if( !isStatic( curr ) )
  95             delete curr;
  96     }
  97
  98     if (reset)
  99     {
 100         assert( !empty() );
 101         top()->Reset(*i_owner);
 102     }
 103 }
 104
 105 void
 106 MotionMaster::MovementExpired(bool reset)
 107 {
 108     if( empty() || size() == 1 )
 109         return;
 110
 111     MovementGenerator *curr = top();
 112     curr->Finalize(*i_owner);
 113     pop();
 114
 115     if( !isStatic(curr) )
 116         delete curr;
 117
 118     assert( !empty() );
 119     while( !empty() && top()->GetMovementGeneratorType() == TARGETED_MOTION_TYPE )
 120     {
 121         // Should check if target is still valid? If not valid it will crash.
 122         curr = top();
 123         curr->Finalize(*i_owner);
 124         pop();
 125         delete curr;
 126     }
 127     if( empty() )
 128         Initialize();
 129     if (reset) top()->Reset(*i_owner);
 130 }
 131
 132 void MotionMaster::MoveIdle()
 133 {
 134     if( empty() || !isStatic( top() ) )
 135         push( &si_idleMovement );
 136 }
 137
 138 void
 139 MotionMaster::MoveTargetedHome()
 140 {
 141     if(i_owner->hasUnitState(UNIT_STAT_FLEEING))
 142         return;
 143
 144     Clear(false);
 145
 146     if(i_owner->GetTypeId()==TYPEID_UNIT && !((Creature*)i_owner)->GetCharmerOrOwnerGUID())
 147     {
 148         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted home", i_owner->GetEntry(), i_owner->GetGUIDLow());
 149         Mutate(new HomeMovementGenerator<Creature>());
 150     }
 151     else if(i_owner->GetTypeId()==TYPEID_UNIT && ((Creature*)i_owner)->GetCharmerOrOwnerGUID())
 152     {
 153         DEBUG_LOG("Pet or controlled creature (Entry: %u GUID: %u) targeting home",
 154             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 155         Unit *target = ((Creature*)i_owner)->GetCharmerOrOwner();
 156         if(target)
 157         {
 158             i_owner->addUnitState(UNIT_STAT_FOLLOW);
 159             DEBUG_LOG("Following %s (GUID: %u)",
 160                 target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 161                 target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 162             Mutate(new TargetedMovementGenerator<Creature>(*target,PET_FOLLOW_DIST,PET_FOLLOW_ANGLE));
 163         }
 164     }
 165     else
 166     {
 167         sLog.outError("Player (GUID: %u) attempt targeted home", i_owner->GetGUIDLow() );
 168     }
 169 }
 170
 171 void
 172 MotionMaster::MoveConfused()
 173 {
 174     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 175     {
 176         DEBUG_LOG("Player (GUID: %u) move confused", i_owner->GetGUIDLow() );
 177         Mutate(new ConfusedMovementGenerator<Player>());
 178     }
 179     else
 180     {
 181         DEBUG_LOG("Creature (Entry: %u GUID: %u) move confused",
 182             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 183         Mutate(new ConfusedMovementGenerator<Creature>());
 184     }
 185 }
 186
 187 void
 188 MotionMaster::MoveChase(Unit* target, float dist, float angle)
 189 {
 190     // ignore movement request if target not exist
 191     if(!target)
 192         return;
 193
 194     i_owner->clearUnitState(UNIT_STAT_FOLLOW);
 195     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 196     {
 197         DEBUG_LOG("Player (GUID: %u) chase to %s (GUID: %u)",
 198             i_owner->GetGUIDLow(),
 199             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 200             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 201         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 202     }
 203     else
 204     {
 205         DEBUG_LOG("Creature (Entry: %u GUID: %u) chase to %s (GUID: %u)",
 206             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 207             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 208             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 209         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 210     }
 211 }
 212
 213 void
 214 MotionMaster::MoveFollow(Unit* target, float dist, float angle)
 215 {
 216     Clear();
 217
 218     // ignore movement request if target not exist
 219     if(!target)
 220         return;
 221
 222     i_owner->addUnitState(UNIT_STAT_FOLLOW);
 223     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 224     {
 225         DEBUG_LOG("Player (GUID: %u) follow to %s (GUID: %u)", i_owner->GetGUIDLow(),
 226             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 227             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 228         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 229     }
 230     else
 231     {
 232         DEBUG_LOG("Creature (Entry: %u GUID: %u) follow to %s (GUID: %u)",
 233             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 234             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 235             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 236         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 237     }
 238 }
 239
 240 void
 241 MotionMaster::MovePoint(uint32 id, float x, float y, float z)
 242 {
 243     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 244     {
 245         DEBUG_LOG("Player (GUID: %u) targeted point (Id: %u X: %f Y: %f Z: %f)", i_owner->GetGUIDLow(), id, x, y, z );
 246         Mutate(new PointMovementGenerator<Player>(id,x,y,z));
 247     }
 248     else
 249     {
 250         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted point (ID: %u X: %f Y: %f Z: %f)",
 251             i_owner->GetEntry(), i_owner->GetGUIDLow(), id, x, y, z );
 252         Mutate(new PointMovementGenerator<Creature>(id,x,y,z));
 253     }
 254 }
 255
 256 void
 257 MotionMaster::MoveFleeing(Unit* enemy)
 258 {
 259     if(!enemy)
 260         return;
 261
 262     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 263     {
 264         DEBUG_LOG("Player (GUID: %u) flee from %s (GUID: %u)", i_owner->GetGUIDLow(),
 265             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 266             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 267         Mutate(new FleeingMovementGenerator<Player>(enemy->GetGUID()));
 268     }
 269     else
 270     {
 271         DEBUG_LOG("Creature (Entry: %u GUID: %u) flee from %s (GUID: %u)",
 272             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 273             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 274             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 275         Mutate(new FleeingMovementGenerator<Creature>(enemy->GetGUID()));
 276     }
 277 }
 278
 279 void
 280 MotionMaster::MoveTaxiFlight(uint32 path, uint32 pathnode)
 281 {
 282     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 283     {
 284         DEBUG_LOG("Player (GUID: %u) taxi to (Path %u node %u)", i_owner->GetGUIDLow(), path, pathnode);
 285         FlightPathMovementGenerator* mgen = new FlightPathMovementGenerator(path,pathnode);
 286         Mutate(mgen);
 287     }
 288     else
 289     {
 290         sLog.outError("Creature (Entry: %u GUID: %u) attempt taxi to (Path %u node %u)",
 291             i_owner->GetEntry(), i_owner->GetGUIDLow(), path, pathnode );
 292     }
 293 }
 294
 295 void
 296 MotionMaster::MoveDistract(uint32 timer)
 297 {
 298     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 299     {
 300         DEBUG_LOG("Player (GUID: %u) distracted (timer: %u)", i_owner->GetGUIDLow(), timer);
 301     }
 302     else
 303     {
 304         DEBUG_LOG("Creature (Entry: %u GUID: %u) (timer: %u)",
 305             i_owner->GetEntry(), i_owner->GetGUIDLow(), timer);
 306     }
 307
 308     DistractMovementGenerator* mgen = new DistractMovementGenerator(timer);
 309     Mutate(mgen);
 310 }
 311
 312 void MotionMaster::Mutate(MovementGenerator *m)
 313 {
 314     if (!empty())
 315     {
 316         switch(top()->GetMovementGeneratorType())
 317         {
 318             // HomeMovement is not that important, delete it if meanwhile a new comes
 319             case HOME_MOTION_TYPE:
 320             // DistractMovement interrupted by any other movement
 321             case DISTRACT_MOTION_TYPE:
 322                 MovementExpired(false);
 323         }
 324     }
 325     m->Initialize(*i_owner);
 326     push(m);
 327 }
 328
 329 void MotionMaster::propagateSpeedChange()
 330 {
 331     Impl::container_type::iterator it = Impl::c.begin();
 332     for ( ;it != end(); ++it)
 333     {
 334         (*it)->unitSpeedChanged();
 335     }
 336 }
 337
 338 MovementGeneratorType MotionMaster::GetCurrentMovementGeneratorType() const
 339 {
 340    if(empty())
 341        return IDLE_MOTION_TYPE;
 342
 343    return top()->GetMovementGeneratorType();
 344 }
 345
 346 bool MotionMaster::GetDestination(float &x, float &y, float &z)
 347 {
 348    if(empty())
 349        return false;
 350
 351    return top()->GetDestination(x,y,z);
 352 }