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         sLog.outError("Pet or controlled creature (Entry: %u GUID: %u) attempt targeted home",
 154             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 155     }
 156     else
 157     {
 158         sLog.outError("Player (GUID: %u) attempt targeted home", i_owner->GetGUIDLow() );
 159     }
 160 }
 161
 162 void
 163 MotionMaster::MoveConfused()
 164 {
 165     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 166     {
 167         DEBUG_LOG("Player (GUID: %u) move confused", i_owner->GetGUIDLow() );
 168         Mutate(new ConfusedMovementGenerator<Player>());
 169     }
 170     else
 171     {
 172         DEBUG_LOG("Creature (Entry: %u GUID: %u) move confused",
 173             i_owner->GetEntry(), i_owner->GetGUIDLow() );
 174         Mutate(new ConfusedMovementGenerator<Creature>());
 175     }
 176 }
 177
 178 void
 179 MotionMaster::MoveChase(Unit* target, float dist, float angle)
 180 {
 181     // ignore movement request if target not exist
 182     if(!target)
 183         return;
 184
 185     i_owner->clearUnitState(UNIT_STAT_FOLLOW);
 186     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 187     {
 188         DEBUG_LOG("Player (GUID: %u) chase to %s (GUID: %u)",
 189             i_owner->GetGUIDLow(),
 190             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 191             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 192         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 193     }
 194     else
 195     {
 196         DEBUG_LOG("Creature (Entry: %u GUID: %u) chase to %s (GUID: %u)",
 197             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 198             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 199             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 200         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 201     }
 202 }
 203
 204 void
 205 MotionMaster::MoveFollow(Unit* target, float dist, float angle)
 206 {
 207     Clear();
 208
 209     // ignore movement request if target not exist
 210     if(!target)
 211         return;
 212
 213     i_owner->addUnitState(UNIT_STAT_FOLLOW);
 214     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 215     {
 216         DEBUG_LOG("Player (GUID: %u) follow to %s (GUID: %u)", i_owner->GetGUIDLow(),
 217             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 218             target->GetTypeId()==TYPEID_PLAYER ? i_owner->GetGUIDLow() : ((Creature*)i_owner)->GetDBTableGUIDLow() );
 219         Mutate(new TargetedMovementGenerator<Player>(*target,dist,angle));
 220     }
 221     else
 222     {
 223         DEBUG_LOG("Creature (Entry: %u GUID: %u) follow to %s (GUID: %u)",
 224             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 225             target->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 226             target->GetTypeId()==TYPEID_PLAYER ? target->GetGUIDLow() : ((Creature*)target)->GetDBTableGUIDLow() );
 227         Mutate(new TargetedMovementGenerator<Creature>(*target,dist,angle));
 228     }
 229 }
 230
 231 void
 232 MotionMaster::MovePoint(uint32 id, float x, float y, float z)
 233 {
 234     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 235     {
 236         DEBUG_LOG("Player (GUID: %u) targeted point (Id: %u X: %f Y: %f Z: %f)", i_owner->GetGUIDLow(), id, x, y, z );
 237         Mutate(new PointMovementGenerator<Player>(id,x,y,z));
 238     }
 239     else
 240     {
 241         DEBUG_LOG("Creature (Entry: %u GUID: %u) targeted point (ID: %u X: %f Y: %f Z: %f)",
 242             i_owner->GetEntry(), i_owner->GetGUIDLow(), id, x, y, z );
 243         Mutate(new PointMovementGenerator<Creature>(id,x,y,z));
 244     }
 245 }
 246
 247 void
 248 MotionMaster::MoveFleeing(Unit* enemy)
 249 {
 250     if(!enemy)
 251         return;
 252
 253     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 254     {
 255         DEBUG_LOG("Player (GUID: %u) flee from %s (GUID: %u)", i_owner->GetGUIDLow(),
 256             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 257             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 258         Mutate(new FleeingMovementGenerator<Player>(enemy->GetGUID()));
 259     }
 260     else
 261     {
 262         DEBUG_LOG("Creature (Entry: %u GUID: %u) flee from %s (GUID: %u)",
 263             i_owner->GetEntry(), i_owner->GetGUIDLow(),
 264             enemy->GetTypeId()==TYPEID_PLAYER ? "player" : "creature",
 265             enemy->GetTypeId()==TYPEID_PLAYER ? enemy->GetGUIDLow() : ((Creature*)enemy)->GetDBTableGUIDLow() );
 266         Mutate(new FleeingMovementGenerator<Creature>(enemy->GetGUID()));
 267     }
 268 }
 269
 270 void
 271 MotionMaster::MoveTaxiFlight(uint32 path, uint32 pathnode)
 272 {
 273     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 274     {
 275         DEBUG_LOG("Player (GUID: %u) taxi to (Path %u node %u)", i_owner->GetGUIDLow(), path, pathnode);
 276         FlightPathMovementGenerator* mgen = new FlightPathMovementGenerator(path,pathnode);
 277         Mutate(mgen);
 278     }
 279     else
 280     {
 281         sLog.outError("Creature (Entry: %u GUID: %u) attempt taxi to (Path %u node %u)",
 282             i_owner->GetEntry(), i_owner->GetGUIDLow(), path, pathnode );
 283     }
 284 }
 285
 286 void
 287 MotionMaster::MoveDistract(uint32 timer)
 288 {
 289     if(i_owner->GetTypeId()==TYPEID_PLAYER)
 290     {
 291         DEBUG_LOG("Player (GUID: %u) distracted (timer: %u)", i_owner->GetGUIDLow(), timer);
 292     }
 293     else
 294     {
 295         DEBUG_LOG("Creature (Entry: %u GUID: %u) (timer: %u)",
 296             i_owner->GetEntry(), i_owner->GetGUIDLow(), timer);
 297     }
 298
 299     DistractMovementGenerator* mgen = new DistractMovementGenerator(timer);
 300     Mutate(mgen);
 301 }
 302
 303 void MotionMaster::Mutate(MovementGenerator *m)
 304 {
 305     if (!empty())
 306     {
 307         switch(top()->GetMovementGeneratorType())
 308         {
 309             // HomeMovement is not that important, delete it if meanwhile a new comes
 310             case HOME_MOTION_TYPE:
 311             // DistractMovement interrupted by any other movement
 312             case DISTRACT_MOTION_TYPE:
 313                 MovementExpired(false);
 314         }
 315     }
 316     m->Initialize(*i_owner);
 317     push(m);
 318 }
 319
 320 void MotionMaster::propagateSpeedChange()
 321 {
 322     Impl::container_type::iterator it = Impl::c.begin();
 323     for ( ;it != end(); ++it)
 324     {
 325         (*it)->unitSpeedChanged();
 326     }
 327 }
 328
 329 MovementGeneratorType MotionMaster::GetCurrentMovementGeneratorType() const
 330 {
 331    if(empty())
 332        return IDLE_MOTION_TYPE;
 333
 334    return top()->GetMovementGeneratorType();
 335 }
 336
 337 bool MotionMaster::GetDestination(float &x, float &y, float &z)
 338 {
 339    if(empty())
 340        return false;
 341
 342    return top()->GetDestination(x,y,z);
 343 }