src/game/Map.h

   1 /*
   2  * Copyright (C) 2005,2006 MaNGOS <http://www.mangosproject.org/>
   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 "GridDefines.h"
  28 #include "Cell.h"
  29 #include "Object.h"
  30 #include "Timer.h"
  31
  32 class Unit;
  33 class WorldPacket;
  34
  35 namespace ZThread
  36 {
  37     class Lockable;
  38     class ReadWriteLock;
  39 }
  40
  41 typedef ZThread::FairReadWriteLock GridRWLock;
  42
  43 template<class MUTEX, class LOCK_TYPE>
  44 struct RGuard
  45 {
  46     RGuard(MUTEX &l) : i_lock(l.getReadLock()) {}
  47     MaNGOS::GeneralLock<LOCK_TYPE> i_lock;
  48 };
  49
  50 template<class MUTEX, class LOCK_TYPE>
  51 struct WGuard
  52 {
  53     WGuard(MUTEX &l) : i_lock(l.getWriteLock()) {}
  54     MaNGOS::GeneralLock<LOCK_TYPE> i_lock;
  55 };
  56
  57 typedef RGuard<GridRWLock, ZThread::Lockable> GridReadGuard;
  58 typedef WGuard<GridRWLock, ZThread::Lockable> GridWriteGuard;
  59 typedef MaNGOS::SingleThreaded<GridRWLock>::Lock NullGuard;
  60
  61 struct GridInfo
  62 {
  63     GridInfo(time_t expiry, bool unload = true ) : i_timer(expiry), i_unloadflag(unload) {}
  64     GridRWLock i_lock;
  65     TimeTracker i_timer;
  66     bool i_unloadflag;
  67 };
  68
  69 typedef struct
  70 {
  71     uint16 area_flag[16][16];
  72     uint8 terrain_type[16][16];
  73     float liquid_level[128][128];
  74     float Z[MAP_RESOLUTION][MAP_RESOLUTION];
  75 }GridMap;
  76
  77 struct CreatureMover
  78 {
  79     CreatureMover() : x(0), y(0), z(0), ang(0) {}
  80     CreatureMover(float _x, float _y, float _z, float _ang) : x(_x), y(_y), z(_z), ang(_ang) {}
  81
  82     float x, y, z, ang;
  83 };
  84
  85 typedef HM_NAMESPACE::hash_map<Creature*, CreatureMover> CreatureMoveList;
  86
  87 class MANGOS_DLL_DECL Map : public MaNGOS::ObjectLevelLockable<Map, ZThread::Mutex>
  88 {
  89     public:
  90
  91         Map(uint32 id, time_t);
  92
  93         void Add(Player *);
  94         void Remove(Player *, bool);
  95         template<class T> void Add(T *);
  96         template<class T> void Remove(T *, bool);
  97         template<class T> bool Find(T *) const;
  98
  99         template<class T> T* GetObjectNear(Object const &obj, OBJECT_HANDLE hdl);
 100         template<class T> T* GetObjectNear(float x, float y, OBJECT_HANDLE hdl);
 101
 102         void Update(const uint32&);
 103         uint64 CalculateGridMask(const uint32 &y) const;
 104
 105         void MessageBoardcast(Player *, WorldPacket *, bool to_self, bool own_team_only = false);
 106
 107         void MessageBoardcast(Object *, WorldPacket *);
 108
 109         void PlayerRelocation(Player *, float x, float y, float z, float angl, bool visibilityChanges = false);
 110
 111         void CreatureRelocation(Creature *creature, float x, float y, float, float);
 112
 113         template<class LOCK_TYPE, class T, class CONTAINER> void Visit(const CellLock<LOCK_TYPE> &cell, TypeContainerVisitor<T, CONTAINER> &visitor);
 114
 115         void SetTimer(uint32 t)
 116         {
 117             i_gridExpiry = t < MIN_GRID_DELAY ? MIN_GRID_DELAY : t;
 118         }
 119
 120         inline bool IsActiveGrid(Object *obj) const
 121         {
 122             return IsActiveGrid(obj->GetPositionX(),obj->GetPositionY());
 123         }
 124
 125         inline bool IsActiveGrid(float x, float y) const
 126         {
 127             GridPair p = MaNGOS::ComputeGridPair(x, y);
 128             return( i_grids[p.x_coord][p.y_coord]->GetGridState() == GRID_STATE_ACTIVE );
 129         }
 130
 131         inline bool IsRemovalGrid(float x, float y) const
 132         {
 133             GridPair p = MaNGOS::ComputeGridPair(x, y);
 134             return( !i_grids[p.x_coord][p.y_coord] || i_grids[p.x_coord][p.y_coord]->GetGridState() == GRID_STATE_REMOVAL );
 135         }
 136
 137         bool GetUnloadFlag(const GridPair &p) const { return i_info[p.x_coord][p.y_coord]->i_unloadflag; }
 138         void SetUnloadFlag(const GridPair &p, bool unload) { i_info[p.x_coord][p.y_coord]->i_unloadflag = unload; }
 139         void LoadGrid(const Cell& cell, bool no_unload = false);
 140         bool UnloadGrid(const uint32 &x, const uint32 &y);
 141
 142         void GetUnitList(float x, float y, std::list<Unit*> &unlist);
 143
 144         void ResetGridExpiry(GridInfo &info) const
 145         {
 146             info.i_timer.Reset(i_gridExpiry);
 147         }
 148
 149         time_t GetGridExpiry(void) const { return i_gridExpiry; }
 150         uint32 GetId(void) const { return i_id; }
 151
 152         static bool ExistMAP(int mapid, int x, int y);
 153         GridMap * LoadMAP(int mapid, int x, int y);
 154
 155         static void InitStateMachine();
 156         static void DeleteStateMachine();
 157
 158         float GetHeight(float x, float y);
 159         uint16 GetAreaFlag(float x, float y );
 160         uint8 GetTerrainType(float x, float y );
 161         float GetWaterLevel(float x, float y );
 162         float IsInWater(float x, float y);
 163         float IsUnderWater(float x, float y, float z);
 164
 165         uint32 GetAreaId(uint16 areaflag);
 166         uint32 GetZoneId(uint16 areaflag);
 167
 168         uint32 GetAreaId(float x, float y)
 169         {
 170             return GetAreaId(GetAreaFlag(x,y));
 171         }
 172
 173         uint32 GetZoneId(float x, float y)
 174         {
 175             return GetZoneId(GetAreaFlag(x,y));
 176         }
 177
 178         void MoveAllCreaturesInMoveList();
 179
 180         bool CreatureRespawnRelocation(Creature *c);        // used only in MoveAllCreaturesInMoveList and ObjectGridUnloader
 181
 182         // assert print helper
 183         bool CheckGridIntegrity(Creature* c, bool moved) const;
 184     private:
 185         bool CreatureCellRelocation(Creature *creature, Cell new_cell);
 186         void CreatureRelocationNotifying(Creature *creature, Cell newcell, CellPair newval);
 187
 188         void AddCreatureToMoveList(Creature *c, float x, float y, float z, float ang);
 189         CreatureMoveList i_creaturesToMove;
 190
 191         bool loaded(const GridPair &) const;
 192         void EnsureGridLoadedForPlayer(const Cell&, Player*, bool add_player);
 193         void NotifyPlayerVisibility(const Cell &, const CellPair &, Player *);
 194         uint64  EnsureGridCreated(const GridPair &);
 195
 196         template<class T> void AddType(T *obj);
 197         template<class T> void RemoveType(T *obj, bool);
 198
 199         uint32 i_id;
 200
 201         GridMap *GridMaps[MAX_NUMBER_OF_GRIDS][MAX_NUMBER_OF_GRIDS];
 202         volatile uint64 i_gridMask[MAX_NUMBER_OF_GRIDS];
 203         volatile uint64 i_gridStatus[MAX_NUMBER_OF_GRIDS];
 204
 205         typedef MaNGOS::ObjectLevelLockable<Map, ZThread::Mutex>::Lock Guard;
 206         typedef GridReadGuard ReadGuard;
 207         typedef GridWriteGuard WriteGuard;
 208
 209         NGridType* i_grids[MAX_NUMBER_OF_GRIDS][MAX_NUMBER_OF_GRIDS];
 210         GridInfo *i_info[MAX_NUMBER_OF_GRIDS][MAX_NUMBER_OF_GRIDS];
 211
 212         time_t i_gridExpiry;
 213 };
 214
 215 inline
 216 uint64
 217 Map::CalculateGridMask(const uint32 &y) const
 218 {
 219     uint64 mask = 1;
 220     mask <<= y;
 221     return mask;
 222 }
 223
 224 template<class LOCK_TYPE, class T, class CONTAINER>
 225 inline void
 226 Map::Visit(const CellLock<LOCK_TYPE> &cell, TypeContainerVisitor<T, CONTAINER> &visitor)
 227 {
 228     const uint32 x = cell->GridX();
 229     const uint32 y = cell->GridY();
 230     const uint32 cell_x = cell->CellX();
 231     const uint32 cell_y = cell->CellY();
 232
 233     if( !cell->NoCreate() || loaded(GridPair(x,y)) )
 234     {
 235         EnsureGridLoadedForPlayer(cell, NULL, false);
 236         LOCK_TYPE guard(i_info[x][y]->i_lock);
 237         i_grids[x][y]->Visit(cell_x, cell_y, visitor);
 238     }
 239 }
 240 #endif