2 * Copyright (C) 2005-2008 MaNGOS <http://getmangos.com/>
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.
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.
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
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"
32 #include "SharedDefines.h"
33 #include "GameSystem/GridRefManager.h"
34 #include "MapRefManager.h"
51 typedef ZThread::FairReadWriteLock GridRWLock
;
53 template<class MUTEX
, class LOCK_TYPE
>
56 RGuard(MUTEX
&l
) : i_lock(l
.getReadLock()) {}
57 MaNGOS::GeneralLock
<LOCK_TYPE
> i_lock
;
60 template<class MUTEX
, class LOCK_TYPE
>
63 WGuard(MUTEX
&l
) : i_lock(l
.getWriteLock()) {}
64 MaNGOS::GeneralLock
<LOCK_TYPE
> i_lock
;
67 typedef RGuard
<GridRWLock
, ZThread::Lockable
> GridReadGuard
;
68 typedef WGuard
<GridRWLock
, ZThread::Lockable
> GridWriteGuard
;
69 typedef MaNGOS::SingleThreaded
<GridRWLock
>::Lock NullGuard
;
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
];
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
) {}
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__ )
94 struct InstanceTemplate
109 enum LevelRequirementVsMode
111 LEVELREQUIREMENT_HEROIC
= 70
114 #if defined( __GNUC__ )
120 typedef UNORDERED_MAP
<Creature
*, CreatureMover
> CreatureMoveList
;
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
126 class MANGOS_DLL_SPEC Map
: public GridRefManager
<NGridType
>, public MaNGOS::ObjectLevelLockable
<Map
, ZThread::Mutex
>
128 friend class MapReference
;
130 Map(uint32 id
, time_t, uint32 InstanceId
, uint8 SpawnMode
);
133 // currently unused for normal maps
134 virtual bool CanUnload(const uint32
& diff
);
136 virtual bool Add(Player
*);
137 virtual void Remove(Player
*, bool);
138 template<class T
> void Add(T
*);
139 template<class T
> void Remove(T
*, bool);
141 virtual void Update(const uint32
&);
143 void MessageBroadcast(Player
*, WorldPacket
*, bool to_self
);
144 void MessageBroadcast(WorldObject
*, WorldPacket
*);
145 void MessageDistBroadcast(Player
*, WorldPacket
*, float dist
, bool to_self
, bool own_team_only
= false);
146 void MessageDistBroadcast(WorldObject
*, WorldPacket
*, float dist
);
148 void PlayerRelocation(Player
*, float x
, float y
, float z
, float angl
);
149 void CreatureRelocation(Creature
*creature
, float x
, float y
, float, float);
151 template<class LOCK_TYPE
, class T
, class CONTAINER
> void Visit(const CellLock
<LOCK_TYPE
> &cell
, TypeContainerVisitor
<T
, CONTAINER
> &visitor
);
153 inline bool IsRemovalGrid(float x
, float y
) const
155 GridPair p
= MaNGOS::ComputeGridPair(x
, y
);
156 return( !getNGrid(p
.x_coord
, p
.y_coord
) || getNGrid(p
.x_coord
, p
.y_coord
)->GetGridState() == GRID_STATE_REMOVAL
);
159 bool GetUnloadFlag(const GridPair
&p
) const { return getNGrid(p
.x_coord
, p
.y_coord
)->getUnloadFlag(); }
160 void SetUnloadFlag(const GridPair
&p
, bool unload
) { getNGrid(p
.x_coord
, p
.y_coord
)->setUnloadFlag(unload
); }
161 void LoadGrid(const Cell
& cell
, bool no_unload
= false);
162 bool UnloadGrid(const uint32
&x
, const uint32
&y
, bool pForce
);
163 virtual void UnloadAll(bool pForce
);
165 void ResetGridExpiry(NGridType
&grid
, float factor
= 1) const
167 grid
.ResetTimeTracker((time_t)((float)i_gridExpiry
*factor
));
170 time_t GetGridExpiry(void) const { return i_gridExpiry
; }
171 uint32
GetId(void) const { return i_id
; }
173 static bool ExistMap(uint32 mapid
, int x
, int y
);
174 static bool ExistVMap(uint32 mapid
, int x
, int y
);
175 void LoadMapAndVMap(uint32 mapid
, uint32 instanceid
, int x
, int y
);
177 static void InitStateMachine();
178 static void DeleteStateMachine();
180 // some calls like isInWater should not use vmaps due to processor power
181 // can return INVALID_HEIGHT if under z+2 z coord not found height
182 float GetHeight(float x
, float y
, float z
, bool pCheckVMap
=true) const;
183 bool IsInWater(float x
, float y
, float z
) const; // does not use z pos. This is for future use
185 uint16
GetAreaFlag(float x
, float y
) const;
186 uint8
GetTerrainType(float x
, float y
) const;
187 float GetWaterLevel(float x
, float y
) const;
188 bool IsUnderWater(float x
, float y
, float z
) const;
190 static uint32
GetAreaId(uint16 areaflag
,uint32 map_id
);
191 static uint32
GetZoneId(uint16 areaflag
,uint32 map_id
);
193 uint32
GetAreaId(float x
, float y
) const
195 return GetAreaId(GetAreaFlag(x
,y
),i_id
);
198 uint32
GetZoneId(float x
, float y
) const
200 return GetZoneId(GetAreaFlag(x
,y
),i_id
);
203 virtual void MoveAllCreaturesInMoveList();
204 virtual void RemoveAllObjectsInRemoveList();
206 bool CreatureRespawnRelocation(Creature
*c
); // used only in MoveAllCreaturesInMoveList and ObjectGridUnloader
208 // assert print helper
209 bool CheckGridIntegrity(Creature
* c
, bool moved
) const;
211 uint32
GetInstanceId() { return i_InstanceId
; }
212 uint8
GetSpawnMode() { return (i_spawnMode
); }
213 virtual bool CanEnter(Player
* /*player*/) { return true; }
214 const char* GetMapName() const;
216 bool Instanceable() const { return i_mapEntry
&& i_mapEntry
->Instanceable(); }
217 // NOTE: this duplicate of Instanceable(), but Instanceable() can be changed when BG also will be instanceable
218 bool IsDungeon() const { return i_mapEntry
&& i_mapEntry
->IsDungeon(); }
219 bool IsRaid() const { return i_mapEntry
&& i_mapEntry
->IsRaid(); }
220 bool IsHeroic() const { return i_spawnMode
== DIFFICULTY_HEROIC
; }
221 bool IsBattleGround() const { return i_mapEntry
&& i_mapEntry
->IsBattleGround(); }
222 bool IsBattleArena() const { return i_mapEntry
&& i_mapEntry
->IsBattleArena(); }
223 bool IsBattleGroundOrArena() const { return i_mapEntry
&& i_mapEntry
->IsBattleGroundOrArena(); }
225 void AddObjectToRemoveList(WorldObject
*obj
);
226 void DoDelayedMovesAndRemoves();
228 virtual bool RemoveBones(uint64 guid
, float x
, float y
);
230 void UpdateObjectVisibility(WorldObject
* obj
, Cell cell
, CellPair cellpair
);
231 void UpdatePlayerVisibility(Player
* player
, Cell cell
, CellPair cellpair
);
232 void UpdateObjectsVisibilityFor(Player
* player
, Cell cell
, CellPair cellpair
);
234 void resetMarkedCells() { marked_cells
.reset(); }
235 bool isCellMarked(uint32 pCellId
) { return marked_cells
.test(pCellId
); }
236 void markCell(uint32 pCellId
) { marked_cells
.set(pCellId
); }
238 bool HavePlayers() const { return !m_mapRefManager
.isEmpty(); }
239 uint32
GetPlayersCountExceptGMs() const;
240 bool PlayersNearGrid(uint32 x
,uint32 y
) const;
242 void SendToPlayers(WorldPacket
const* data
) const;
244 typedef MapRefManager PlayerList
;
245 PlayerList
const& GetPlayers() const { return m_mapRefManager
; }
247 void LoadVMap(int pX
, int pY
);
248 void LoadMap(uint32 mapid
, uint32 instanceid
, int x
,int y
);
250 void SetTimer(uint32 t
) { i_gridExpiry
= t
< MIN_GRID_DELAY
? MIN_GRID_DELAY
: t
; }
251 //uint64 CalculateGridMask(const uint32 &y) const;
253 void SendInitSelf( Player
* player
);
255 void SendInitTransports( Player
* player
);
256 void SendRemoveTransports( Player
* player
);
258 void PlayerRelocationNotify(Player
* player
, Cell cell
, CellPair cellpair
);
259 void CreatureRelocationNotify(Creature
*creature
, Cell newcell
, CellPair newval
);
261 bool CreatureCellRelocation(Creature
*creature
, Cell new_cell
);
263 void AddCreatureToMoveList(Creature
*c
, float x
, float y
, float z
, float ang
);
264 CreatureMoveList i_creaturesToMove
;
266 bool loaded(const GridPair
&) const;
267 void EnsureGridLoadedForPlayer(const Cell
&, Player
*, bool add_player
);
268 void EnsureGridCreated(const GridPair
&);
270 void buildNGridLinkage(NGridType
* pNGridType
) { pNGridType
->link(this); }
272 template<class T
> void AddType(T
*obj
);
273 template<class T
> void RemoveType(T
*obj
, bool);
275 NGridType
* getNGrid(uint32 x
, uint32 y
) const
277 return i_grids
[x
][y
];
280 bool isGridObjectDataLoaded(uint32 x
, uint32 y
) const { return getNGrid(x
,y
)->isGridObjectDataLoaded(); }
281 void setGridObjectDataLoaded(bool pLoaded
, uint32 x
, uint32 y
) { getNGrid(x
,y
)->setGridObjectDataLoaded(pLoaded
); }
283 inline void setNGrid(NGridType
* grid
, uint32 x
, uint32 y
);
286 typedef MaNGOS::ObjectLevelLockable
<Map
, ZThread::Mutex
>::Lock Guard
;
288 MapEntry
const* i_mapEntry
;
292 uint32 m_unloadTimer
;
294 MapRefManager m_mapRefManager
;
295 MapRefManager::iterator m_mapRefIter
;
297 typedef GridReadGuard ReadGuard
;
298 typedef GridWriteGuard WriteGuard
;
300 NGridType
* i_grids
[MAX_NUMBER_OF_GRIDS
][MAX_NUMBER_OF_GRIDS
];
301 GridMap
*GridMaps
[MAX_NUMBER_OF_GRIDS
][MAX_NUMBER_OF_GRIDS
];
302 std::bitset
<TOTAL_NUMBER_OF_CELLS_PER_MAP
*TOTAL_NUMBER_OF_CELLS_PER_MAP
> marked_cells
;
306 std::set
<WorldObject
*> i_objectsToRemove
;
308 // Type specific code for add/remove to/from grid
310 void AddToGrid(T
*, NGridType
*, Cell
const&);
313 void AddNotifier(T
*, Cell
const&, CellPair
const&);
316 void RemoveFromGrid(T
*, NGridType
*, Cell
const&);
319 void DeleteFromWorld(T
*);
322 enum InstanceResetMethod
325 INSTANCE_RESET_CHANGE_DIFFICULTY
,
326 INSTANCE_RESET_GLOBAL
,
327 INSTANCE_RESET_GROUP_DISBAND
,
328 INSTANCE_RESET_GROUP_JOIN
,
329 INSTANCE_RESET_RESPAWN_DELAY
332 class MANGOS_DLL_SPEC InstanceMap
: public Map
335 InstanceMap(uint32 id
, time_t, uint32 InstanceId
, uint8 SpawnMode
);
338 void Remove(Player
*, bool);
339 void Update(const uint32
&);
340 void CreateInstanceData(bool load
);
341 bool Reset(uint8 method
);
342 uint32
GetScriptId() { return i_script_id
; }
343 InstanceData
* GetInstanceData() { return i_data
; }
344 void PermBindAllPlayers(Player
*player
);
345 time_t GetResetTime();
346 void UnloadAll(bool pForce
);
347 bool CanEnter(Player
* player
);
348 void SendResetWarnings(uint32 timeLeft
) const;
349 void SetResetSchedule(bool on
);
351 bool m_resetAfterUnload
;
352 bool m_unloadWhenEmpty
;
353 InstanceData
* i_data
;
357 class MANGOS_DLL_SPEC BattleGroundMap
: public Map
360 BattleGroundMap(uint32 id
, time_t, uint32 InstanceId
);
364 void Remove(Player
*, bool);
365 bool CanEnter(Player
* player
);
367 void UnloadAll(bool pForce
);
372 Map::CalculateGridMask(const uint32 &y) const
380 template<class LOCK_TYPE
, class T
, class CONTAINER
>
382 Map::Visit(const CellLock
<LOCK_TYPE
> &cell
, TypeContainerVisitor
<T
, CONTAINER
> &visitor
)
384 const uint32 x
= cell
->GridX();
385 const uint32 y
= cell
->GridY();
386 const uint32 cell_x
= cell
->CellX();
387 const uint32 cell_y
= cell
->CellY();
389 if( !cell
->NoCreate() || loaded(GridPair(x
,y
)) )
391 EnsureGridLoadedForPlayer(cell
, NULL
, false);
392 //LOCK_TYPE guard(i_info[x][y]->i_lock);
393 getNGrid(x
, y
)->Visit(cell_x
, cell_y
, visitor
);