src/game/Map.h

   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 #ifndef MANGOS_MAP_H
  20 #define MANGOS_MAP_H
  21
  22 #include "Platform/Define.h"
  23 #include "Policies/ThreadingModel.h"
  24 #include "zthread/Lockable.h"
  25 #include "zthread/Mutex.h"
  26 #include "zthread/FairReadWriteLock.h"
  27 #include "Database/DBCStructure.h"
  28 #include "GridDefines.h"
  29 #include "Cell.h"
  30 #include "Object.h"
  31 #include "Timer.h"
  32 #include "SharedDefines.h"
  33 #include "GameSystem/GridRefManager.h"
  34 #include "MapRefManager.h"
  35
  36 #include <bitset>
  37 #include <list>
  38
  39 class Unit;
  40 class WorldPacket;
  41 class InstanceData;
  42 class Group;
  43 class InstanceSave;
  44
  45 namespace ZThread
  46 {
  47     class Lockable;
  48     class ReadWriteLock;
  49 }
  50
  51 typedef ZThread::FairReadWriteLock GridRWLock;
  52
  53 template<class MUTEX, class LOCK_TYPE>
  54 struct RGuard
  55 {
  56     RGuard(MUTEX &l) : i_lock(l.getReadLock()) {}
  57     MaNGOS::GeneralLock<LOCK_TYPE> i_lock;
  58 };
  59
  60 template<class MUTEX, class LOCK_TYPE>
  61 struct WGuard
  62 {
  63     WGuard(MUTEX &l) : i_lock(l.getWriteLock()) {}
  64     MaNGOS::GeneralLock<LOCK_TYPE> i_lock;
  65 };
  66
  67 typedef RGuard<GridRWLock, ZThread::Lockable> GridReadGuard;
  68 typedef WGuard<GridRWLock, ZThread::Lockable> GridWriteGuard;
  69 typedef MaNGOS::SingleThreaded<GridRWLock>::Lock NullGuard;
  70
  71 typedef struct
  72 {
  73     uint16 area_flag[16][16];
  74     uint8 terrain_type[16][16];
  75     float liquid_level[128][128];
  76     float Z[MAP_RESOLUTION][MAP_RESOLUTION];
  77 }GridMap;
  78
  79 struct CreatureMover
  80 {
  81     CreatureMover() : x(0), y(0), z(0), ang(0) {}
  82     CreatureMover(float _x, float _y, float _z, float _ang) : x(_x), y(_y), z(_z), ang(_ang) {}
  83
  84     float x, y, z, ang;
  85 };
  86
  87 // GCC have alternative #pragma pack(N) syntax and old gcc version not support pack(push,N), also any gcc version not support it at some platform
  88 #if defined( __GNUC__ )
  89 #pragma pack(1)
  90 #else
  91 #pragma pack(push,1)
  92 #endif
  93
  94 struct InstanceTemplate
  95 {
  96     uint32 map;
  97     uint32 parent;
  98     uint32 levelMin;
  99     uint32 levelMax;
 100     uint32 maxPlayers;
 101     uint32 reset_delay;
 102     float startLocX;
 103     float startLocY;
 104     float startLocZ;
 105     float startLocO;
 106     uint32 script_id;
 107 };
 108
 109 enum LevelRequirementVsMode
 110 {
 111     LEVELREQUIREMENT_HEROIC = 70
 112 };
 113
 114 #if defined( __GNUC__ )
 115 #pragma pack()
 116 #else
 117 #pragma pack(pop)
 118 #endif
 119
 120 typedef UNORDERED_MAP<Creature*, CreatureMover> CreatureMoveList;
 121
 122 #define MAX_HEIGHT            100000.0f                     // can be use for find ground height at surface
 123 #define INVALID_HEIGHT       -100000.0f                     // for check, must be equal to VMAP_INVALID_HEIGHT, real value for unknown height is VMAP_INVALID_HEIGHT_VALUE
 124 #define MIN_UNLOAD_DELAY      1                             // immediate unload
 125
 126 class MANGOS_DLL_SPEC Map : public GridRefManager<NGridType>, public MaNGOS::ObjectLevelLockable<Map, ZThread::Mutex>
 127 {
 128     public:
 129         Map(uint32 id, time_t, uint32 InstanceId, uint8 SpawnMode);
 130         virtual ~Map();
 131
 132         // currently unused for normal maps
 133         virtual bool CanUnload(const uint32& diff);
 134
 135         virtual bool Add(Player *);
 136         virtual void Remove(Player *, bool);
 137         template<class T> void Add(T *);
 138         template<class T> void Remove(T *, bool);
 139
 140         virtual void Update(const uint32&);
 141
 142         void MessageBroadcast(Player *, WorldPacket *, bool to_self);
 143         void MessageBroadcast(WorldObject *, WorldPacket *);
 144         void MessageDistBroadcast(Player *, WorldPacket *, float dist, bool to_self, bool own_team_only = false);
 145         void MessageDistBroadcast(WorldObject *, WorldPacket *, float dist);
 146
 147         void PlayerRelocation(Player *, float x, float y, float z, float angl);
 148         void CreatureRelocation(Creature *creature, float x, float y, float, float);
 149
 150         template<class LOCK_TYPE, class T, class CONTAINER> void Visit(const CellLock<LOCK_TYPE> &cell, TypeContainerVisitor<T, CONTAINER> &visitor);
 151
 152         inline bool IsRemovalGrid(float x, float y) const
 153         {
 154             GridPair p = MaNGOS::ComputeGridPair(x, y);
 155             return( !getNGrid(p.x_coord, p.y_coord) || getNGrid(p.x_coord, p.y_coord)->GetGridState() == GRID_STATE_REMOVAL );
 156         }
 157
 158         bool GetUnloadFlag(const GridPair &p) const { return getNGrid(p.x_coord, p.y_coord)->getUnloadFlag(); }
 159         void SetUnloadFlag(const GridPair &p, bool unload) { getNGrid(p.x_coord, p.y_coord)->setUnloadFlag(unload); }
 160         void LoadGrid(const Cell& cell, bool no_unload = false);
 161         bool UnloadGrid(const uint32 &x, const uint32 &y, bool pForce);
 162         virtual void UnloadAll(bool pForce);
 163
 164         void ResetGridExpiry(NGridType &grid, float factor = 1) const
 165         {
 166             grid.ResetTimeTracker((time_t)((float)i_gridExpiry*factor));
 167         }
 168
 169         time_t GetGridExpiry(void) const { return i_gridExpiry; }
 170         uint32 GetId(void) const { return i_id; }
 171
 172         static bool ExistMap(uint32 mapid, int x, int y);
 173         static bool ExistVMap(uint32 mapid, int x, int y);
 174         void LoadMapAndVMap(uint32 mapid, uint32 instanceid, int x, int y);
 175
 176         static void InitStateMachine();
 177         static void DeleteStateMachine();
 178
 179         // some calls like isInWater should not use vmaps due to processor power
 180         // can return INVALID_HEIGHT if under z+2 z coord not found height
 181         float GetHeight(float x, float y, float z, bool pCheckVMap=true) const;
 182         bool IsInWater(float x, float y, float z) const;    // does not use z pos. This is for future use
 183
 184         uint16 GetAreaFlag(float x, float y ) const;
 185         uint8 GetTerrainType(float x, float y ) const;
 186         float GetWaterLevel(float x, float y ) const;
 187         bool IsUnderWater(float x, float y, float z) const;
 188
 189         static uint32 GetAreaId(uint16 areaflag,uint32 map_id);
 190         static uint32 GetZoneId(uint16 areaflag,uint32 map_id);
 191
 192         uint32 GetAreaId(float x, float y) const
 193         {
 194             return GetAreaId(GetAreaFlag(x,y),i_id);
 195         }
 196
 197         uint32 GetZoneId(float x, float y) const
 198         {
 199             return GetZoneId(GetAreaFlag(x,y),i_id);
 200         }
 201
 202         virtual void MoveAllCreaturesInMoveList();
 203         virtual void RemoveAllObjectsInRemoveList();
 204
 205         bool CreatureRespawnRelocation(Creature *c);        // used only in MoveAllCreaturesInMoveList and ObjectGridUnloader
 206
 207         // assert print helper
 208         bool CheckGridIntegrity(Creature* c, bool moved) const;
 209
 210         uint32 GetInstanceId() { return i_InstanceId; }
 211         uint8 GetSpawnMode() { return (i_spawnMode); }
 212         virtual bool CanEnter(Player* /*player*/) { return true; }
 213         const char* GetMapName() const;
 214
 215         bool Instanceable() const { return i_mapEntry && i_mapEntry->Instanceable(); }
 216         // NOTE: this duplicate of Instanceable(), but Instanceable() can be changed when BG also will be instanceable
 217         bool IsDungeon() const { return i_mapEntry && i_mapEntry->IsDungeon(); }
 218         bool IsRaid() const { return i_mapEntry && i_mapEntry->IsRaid(); }
 219         bool IsHeroic() const { return i_spawnMode == DIFFICULTY_HEROIC; }
 220         bool IsBattleGround() const { return i_mapEntry && i_mapEntry->IsBattleGround(); }
 221         bool IsBattleArena() const { return i_mapEntry && i_mapEntry->IsBattleArena(); }
 222         bool IsBattleGroundOrArena() const { return i_mapEntry && i_mapEntry->IsBattleGroundOrArena(); }
 223
 224         void AddObjectToRemoveList(WorldObject *obj);
 225         void DoDelayedMovesAndRemoves();
 226
 227         virtual bool RemoveBones(uint64 guid, float x, float y);
 228
 229         void UpdateObjectVisibility(WorldObject* obj, Cell cell, CellPair cellpair);
 230         void UpdatePlayerVisibility(Player* player, Cell cell, CellPair cellpair);
 231         void UpdateObjectsVisibilityFor(Player* player, Cell cell, CellPair cellpair);
 232
 233         void resetMarkedCells() { marked_cells.reset(); }
 234         bool isCellMarked(uint32 pCellId) { return marked_cells.test(pCellId); }
 235         void markCell(uint32 pCellId) { marked_cells.set(pCellId); }
 236
 237         bool HavePlayers() const { return !m_mapRefManager.isEmpty(); }
 238         uint32 GetPlayersCountExceptGMs() const;
 239         bool PlayersNearGrid(uint32 x,uint32 y) const;
 240
 241         void SendToPlayers(WorldPacket const* data) const;
 242
 243         MapRefManager m_mapRefManager;
 244
 245     private:
 246         void LoadVMap(int pX, int pY);
 247         void LoadMap(uint32 mapid, uint32 instanceid, int x,int y);
 248
 249         void SetTimer(uint32 t) { i_gridExpiry = t < MIN_GRID_DELAY ? MIN_GRID_DELAY : t; }
 250         //uint64 CalculateGridMask(const uint32 &y) const;
 251
 252         void SendInitSelf( Player * player );
 253
 254         void SendInitTransports( Player * player );
 255         void SendRemoveTransports( Player * player );
 256
 257         void PlayerRelocationNotify(Player* player, Cell cell, CellPair cellpair);
 258         void CreatureRelocationNotify(Creature *creature, Cell newcell, CellPair newval);
 259
 260         bool CreatureCellRelocation(Creature *creature, Cell new_cell);
 261
 262         void AddCreatureToMoveList(Creature *c, float x, float y, float z, float ang);
 263         CreatureMoveList i_creaturesToMove;
 264
 265         bool loaded(const GridPair &) const;
 266         void EnsureGridLoadedForPlayer(const Cell&, Player*, bool add_player);
 267         void  EnsureGridCreated(const GridPair &);
 268
 269         void buildNGridLinkage(NGridType* pNGridType) { pNGridType->link(this); }
 270
 271         template<class T> void AddType(T *obj);
 272         template<class T> void RemoveType(T *obj, bool);
 273
 274         NGridType* getNGrid(uint32 x, uint32 y) const
 275         {
 276             return i_grids[x][y];
 277         }
 278
 279         bool isGridObjectDataLoaded(uint32 x, uint32 y) const { return getNGrid(x,y)->isGridObjectDataLoaded(); }
 280         void setGridObjectDataLoaded(bool pLoaded, uint32 x, uint32 y) { getNGrid(x,y)->setGridObjectDataLoaded(pLoaded); }
 281
 282         inline void setNGrid(NGridType* grid, uint32 x, uint32 y);
 283
 284     protected:
 285         typedef MaNGOS::ObjectLevelLockable<Map, ZThread::Mutex>::Lock Guard;
 286
 287         MapEntry const* i_mapEntry;
 288         uint8 i_spawnMode;
 289         uint32 i_id;
 290         uint32 i_InstanceId;
 291         uint32 m_unloadTimer;
 292
 293     private:
 294         typedef GridReadGuard ReadGuard;
 295         typedef GridWriteGuard WriteGuard;
 296
 297         NGridType* i_grids[MAX_NUMBER_OF_GRIDS][MAX_NUMBER_OF_GRIDS];
 298         GridMap *GridMaps[MAX_NUMBER_OF_GRIDS][MAX_NUMBER_OF_GRIDS];
 299         std::bitset<TOTAL_NUMBER_OF_CELLS_PER_MAP*TOTAL_NUMBER_OF_CELLS_PER_MAP> marked_cells;
 300
 301         time_t i_gridExpiry;
 302
 303         std::set<WorldObject *> i_objectsToRemove;
 304
 305         // Type specific code for add/remove to/from grid
 306         template<class T>
 307             void AddToGrid(T*, NGridType *, Cell const&);
 308
 309         template<class T>
 310             void AddNotifier(T*, Cell const&, CellPair const&);
 311
 312         template<class T>
 313             void RemoveFromGrid(T*, NGridType *, Cell const&);
 314
 315         template<class T>
 316             void DeleteFromWorld(T*);
 317 };
 318
 319 enum InstanceResetMethod
 320 {
 321     INSTANCE_RESET_ALL,
 322     INSTANCE_RESET_CHANGE_DIFFICULTY,
 323     INSTANCE_RESET_GLOBAL,
 324     INSTANCE_RESET_GROUP_DISBAND,
 325     INSTANCE_RESET_GROUP_JOIN,
 326     INSTANCE_RESET_RESPAWN_DELAY
 327 };
 328
 329 class MANGOS_DLL_SPEC InstanceMap : public Map
 330 {
 331     public:
 332         typedef std::list<Player *> PlayerList;                 // online players only
 333
 334         InstanceMap(uint32 id, time_t, uint32 InstanceId, uint8 SpawnMode);
 335         ~InstanceMap();
 336         bool Add(Player *);
 337         void Remove(Player *, bool);
 338         void Update(const uint32&);
 339         void CreateInstanceData(bool load);
 340         bool Reset(uint8 method);
 341         uint32 GetScriptId() { return i_script_id; }
 342         InstanceData* GetInstanceData() { return i_data; }
 343         void PermBindAllPlayers(Player *player);
 344         time_t GetResetTime();
 345         void UnloadAll(bool pForce);
 346         bool CanEnter(Player* player);
 347         void SendResetWarnings(uint32 timeLeft);
 348         void SetResetSchedule(bool on);
 349     private:
 350         bool m_resetAfterUnload;
 351         bool m_unloadWhenEmpty;
 352         InstanceData* i_data;
 353         uint32 i_script_id;
 354 };
 355
 356 class MANGOS_DLL_SPEC BattleGroundMap : public Map
 357 {
 358     public:
 359         BattleGroundMap(uint32 id, time_t, uint32 InstanceId);
 360         ~BattleGroundMap();
 361
 362         bool Add(Player *);
 363         void Remove(Player *, bool);
 364         bool CanEnter(Player* player);
 365         void SetUnload();
 366         void UnloadAll(bool pForce);
 367 };
 368
 369 /*inline
 370 uint64
 371 Map::CalculateGridMask(const uint32 &y) const
 372 {
 373     uint64 mask = 1;
 374     mask <<= y;
 375     return mask;
 376 }
 377 */
 378
 379 template<class LOCK_TYPE, class T, class CONTAINER>
 380 inline void
 381 Map::Visit(const CellLock<LOCK_TYPE> &cell, TypeContainerVisitor<T, CONTAINER> &visitor)
 382 {
 383     const uint32 x = cell->GridX();
 384     const uint32 y = cell->GridY();
 385     const uint32 cell_x = cell->CellX();
 386     const uint32 cell_y = cell->CellY();
 387
 388     if( !cell->NoCreate() || loaded(GridPair(x,y)) )
 389     {
 390         EnsureGridLoadedForPlayer(cell, NULL, false);
 391         //LOCK_TYPE guard(i_info[x][y]->i_lock);
 392         getNGrid(x, y)->Visit(cell_x, cell_y, visitor);
 393     }
 394 }
 395 #endif