2 * Copyright (C) 2005-2009 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
23 #include "ByteBuffer.h"
24 #include "UpdateFields.h"
25 #include "UpdateData.h"
26 #include "GameSystem/GridReference.h"
27 #include "ObjectDefines.h"
32 #define CONTACT_DISTANCE 0.5f
33 #define INTERACTION_DISTANCE 5.0f
34 #define ATTACK_DISTANCE 5.0f
35 #define MAX_VISIBILITY_DISTANCE (5*SIZE_OF_GRID_CELL/2.0f) // max distance for visible object show, limited by active zone for player based at cell size (active zone = 5x5 cells)
36 #define DEFAULT_VISIBILITY_DISTANCE (SIZE_OF_GRID_CELL) // default visible distance
38 #define DEFAULT_WORLD_OBJECT_SIZE 0.388999998569489f // player size, also currently used (correctly?) for any non Unit world objects
42 TYPEMASK_OBJECT
= 0x0001,
43 TYPEMASK_ITEM
= 0x0002,
44 TYPEMASK_CONTAINER
= 0x0006, // TYPEMASK_ITEM | 0x0004
45 TYPEMASK_UNIT
= 0x0008,
46 TYPEMASK_PLAYER
= 0x0010,
47 TYPEMASK_GAMEOBJECT
= 0x0020,
48 TYPEMASK_DYNAMICOBJECT
= 0x0040,
49 TYPEMASK_CORPSE
= 0x0080,
50 TYPEMASK_AIGROUP
= 0x0100,
51 TYPEMASK_AREATRIGGER
= 0x0200
61 TYPEID_GAMEOBJECT
= 5,
62 TYPEID_DYNAMICOBJECT
= 6,
65 TYPEID_AREATRIGGER
= 9
69 uint32
GuidHigh2TypeId(uint32 guid_hi
);
73 TEMPSUMMON_TIMED_OR_DEAD_DESPAWN
= 1, // despawns after a specified time OR when the creature disappears
74 TEMPSUMMON_TIMED_OR_CORPSE_DESPAWN
= 2, // despawns after a specified time OR when the creature dies
75 TEMPSUMMON_TIMED_DESPAWN
= 3, // despawns after a specified time
76 TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT
= 4, // despawns after a specified time after the creature is out of combat
77 TEMPSUMMON_CORPSE_DESPAWN
= 5, // despawns instantly after death
78 TEMPSUMMON_CORPSE_TIMED_DESPAWN
= 6, // despawns after a specified time after death
79 TEMPSUMMON_DEAD_DESPAWN
= 7, // despawns when the creature disappears
80 TEMPSUMMON_MANUAL_DESPAWN
= 8 // despawns when UnSummon() is called
85 PHASEMASK_NORMAL
= 0x00000001,
86 PHASEMASK_ANYWHERE
= 0xFFFFFFFF
99 typedef UNORDERED_MAP
<Player
*, UpdateData
> UpdateDataMapType
;
108 explicit WorldLocation(uint32 _mapid
= 0, float _x
= 0, float _y
= 0, float _z
= 0, float _o
= 0)
109 : mapid(_mapid
), x(_x
), y(_y
), z(_z
), o(_o
) {}
110 WorldLocation(WorldLocation
const &loc
)
111 : mapid(loc
.mapid
), x(loc
.x
), y(loc
.y
), z(loc
.z
), o(loc
.o
) {}
114 class MANGOS_DLL_SPEC Object
119 const bool& IsInWorld() const { return m_inWorld
; }
120 virtual void AddToWorld()
127 // synchronize values mirror with values array (changes will send in updatecreate opcode any way
128 ClearUpdateMask(true);
130 virtual void RemoveFromWorld()
132 // if we remove from world then sending changes not required
134 ClearUpdateMask(true);
138 const uint64
& GetGUID() const { return GetUInt64Value(0); }
139 uint32
GetGUIDLow() const { return GUID_LOPART(GetUInt64Value(0)); }
140 uint32
GetGUIDMid() const { return GUID_ENPART(GetUInt64Value(0)); }
141 uint32
GetGUIDHigh() const { return GUID_HIPART(GetUInt64Value(0)); }
142 const ByteBuffer
& GetPackGUID() const { return m_PackGUID
; }
143 uint32
GetEntry() const { return GetUInt32Value(OBJECT_FIELD_ENTRY
); }
144 void SetEntry(uint32 entry
) { SetUInt32Value(OBJECT_FIELD_ENTRY
, entry
); }
146 uint8
GetTypeId() const { return m_objectTypeId
; }
147 bool isType(uint16 mask
) const { return (mask
& m_objectType
); }
149 virtual void BuildCreateUpdateBlockForPlayer( UpdateData
*data
, Player
*target
) const;
150 void SendUpdateToPlayer(Player
* player
);
152 void BuildValuesUpdateBlockForPlayer( UpdateData
*data
, Player
*target
) const;
153 void BuildOutOfRangeUpdateBlock( UpdateData
*data
) const;
154 void BuildMovementUpdateBlock( UpdateData
* data
, uint32 flags
= 0 ) const;
155 void BuildUpdate(UpdateDataMapType
&);
157 virtual void DestroyForPlayer( Player
*target
) const;
159 const int32
& GetInt32Value( uint16 index
) const
161 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false) );
162 return m_int32Values
[ index
];
165 const uint32
& GetUInt32Value( uint16 index
) const
167 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false) );
168 return m_uint32Values
[ index
];
171 const uint64
& GetUInt64Value( uint16 index
) const
173 ASSERT( index
+ 1 < m_valuesCount
|| PrintIndexError( index
, false) );
174 return *((uint64
*)&(m_uint32Values
[ index
]));
177 const float& GetFloatValue( uint16 index
) const
179 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false ) );
180 return m_floatValues
[ index
];
183 uint8
GetByteValue( uint16 index
, uint8 offset
) const
185 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false) );
186 ASSERT( offset
< 4 );
187 return *(((uint8
*)&m_uint32Values
[ index
])+offset
);
190 uint8
GetUInt16Value( uint16 index
, uint8 offset
) const
192 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false) );
193 ASSERT( offset
< 2 );
194 return *(((uint16
*)&m_uint32Values
[ index
])+offset
);
197 void SetInt32Value( uint16 index
, int32 value
);
198 void SetUInt32Value( uint16 index
, uint32 value
);
199 void SetUInt64Value( uint16 index
, const uint64
&value
);
200 void SetFloatValue( uint16 index
, float value
);
201 void SetByteValue( uint16 index
, uint8 offset
, uint8 value
);
202 void SetUInt16Value( uint16 index
, uint8 offset
, uint16 value
);
203 void SetInt16Value( uint16 index
, uint8 offset
, int16 value
) { SetUInt16Value(index
,offset
,(uint16
)value
); }
204 void SetStatFloatValue( uint16 index
, float value
);
205 void SetStatInt32Value( uint16 index
, int32 value
);
207 void ApplyModUInt32Value(uint16 index
, int32 val
, bool apply
);
208 void ApplyModInt32Value(uint16 index
, int32 val
, bool apply
);
209 void ApplyModUInt64Value(uint16 index
, int32 val
, bool apply
);
210 void ApplyModPositiveFloatValue( uint16 index
, float val
, bool apply
);
211 void ApplyModSignedFloatValue( uint16 index
, float val
, bool apply
);
213 void ApplyPercentModFloatValue(uint16 index
, float val
, bool apply
)
215 val
= val
!= -100.0f
? val
: -99.9f
;
216 SetFloatValue(index
, GetFloatValue(index
) * (apply
?(100.0f
+val
)/100.0f
: 100.0f
/ (100.0f
+val
)) );
219 void SetFlag( uint16 index
, uint32 newFlag
);
220 void RemoveFlag( uint16 index
, uint32 oldFlag
);
222 void ToggleFlag( uint16 index
, uint32 flag
)
224 if(HasFlag(index
, flag
))
225 RemoveFlag(index
, flag
);
227 SetFlag(index
, flag
);
230 bool HasFlag( uint16 index
, uint32 flag
) const
232 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false ) );
233 return (m_uint32Values
[ index
] & flag
) != 0;
236 void SetByteFlag( uint16 index
, uint8 offset
, uint8 newFlag
);
237 void RemoveByteFlag( uint16 index
, uint8 offset
, uint8 newFlag
);
239 void ToggleFlag( uint16 index
, uint8 offset
, uint8 flag
)
241 if(HasByteFlag(index
, offset
, flag
))
242 RemoveByteFlag(index
, offset
, flag
);
244 SetByteFlag(index
, offset
, flag
);
247 bool HasByteFlag( uint16 index
, uint8 offset
, uint8 flag
) const
249 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false ) );
250 ASSERT( offset
< 4 );
251 return (((uint8
*)&m_uint32Values
[index
])[offset
] & flag
) != 0;
254 void ApplyModFlag( uint16 index
, uint32 flag
, bool apply
)
256 if(apply
) SetFlag(index
,flag
); else RemoveFlag(index
,flag
);
259 void SetFlag64( uint16 index
, uint64 newFlag
)
261 uint64 oldval
= GetUInt64Value(index
);
262 uint64 newval
= oldval
| newFlag
;
263 SetUInt64Value(index
,newval
);
266 void RemoveFlag64( uint16 index
, uint64 oldFlag
)
268 uint64 oldval
= GetUInt64Value(index
);
269 uint64 newval
= oldval
& ~oldFlag
;
270 SetUInt64Value(index
,newval
);
273 void ToggleFlag64( uint16 index
, uint64 flag
)
275 if(HasFlag64(index
, flag
))
276 RemoveFlag64(index
, flag
);
278 SetFlag64(index
, flag
);
281 bool HasFlag64( uint16 index
, uint64 flag
) const
283 ASSERT( index
< m_valuesCount
|| PrintIndexError( index
, false ) );
284 return (GetUInt64Value( index
) & flag
) != 0;
287 void ApplyModFlag64( uint16 index
, uint64 flag
, bool apply
)
289 if(apply
) SetFlag64(index
,flag
); else RemoveFlag64(index
,flag
);
292 void ClearUpdateMask(bool remove
);
293 void SendUpdateObjectToAllExcept(Player
* exceptPlayer
);
295 bool LoadValues(const char* data
);
297 uint16
GetValuesCount() const { return m_valuesCount
; }
299 void InitValues() { _InitValues(); }
301 virtual bool hasQuest(uint32
/* quest_id */) const { return false; }
302 virtual bool hasInvolvedQuest(uint32
/* quest_id */) const { return false; }
308 void _Create (uint32 guidlow
, uint32 entry
, HighGuid guidhigh
);
310 virtual void _SetUpdateBits(UpdateMask
*updateMask
, Player
*target
) const;
312 virtual void _SetCreateBits(UpdateMask
*updateMask
, Player
*target
) const;
313 void _BuildMovementUpdate(ByteBuffer
* data
, uint8 flags
, uint32 flags2
) const;
314 void _BuildValuesUpdate(uint8 updatetype
, ByteBuffer
*data
, UpdateMask
*updateMask
, Player
*target
) const;
318 uint8 m_objectTypeId
;
323 int32
*m_int32Values
;
324 uint32
*m_uint32Values
;
325 float *m_floatValues
;
328 uint32
*m_uint32Values_mirror
;
330 uint16 m_valuesCount
;
332 bool m_objectUpdated
;
337 ByteBuffer m_PackGUID
;
339 // for output helpfull error messages from asserts
340 bool PrintIndexError(uint32 index
, bool set
) const;
341 Object(const Object
&); // prevent generation copy constructor
342 Object
& operator=(Object
const&); // prevent generation assigment operator
345 class MANGOS_DLL_SPEC WorldObject
: public Object
348 virtual ~WorldObject ( ) {}
350 virtual void Update ( uint32
/*time_diff*/ ) { }
352 void _Create( uint32 guidlow
, HighGuid guidhigh
, uint32 mapid
);
354 void Relocate(float x
, float y
, float z
, float orientation
)
359 m_orientation
= orientation
;
362 void Relocate(float x
, float y
, float z
)
369 void Relocate(WorldLocation
const & loc
)
372 Relocate(loc
.x
, loc
.y
, loc
.z
, loc
.o
);
375 void SetOrientation(float orientation
) { m_orientation
= orientation
; }
377 float GetPositionX( ) const { return m_positionX
; }
378 float GetPositionY( ) const { return m_positionY
; }
379 float GetPositionZ( ) const { return m_positionZ
; }
380 void GetPosition( float &x
, float &y
, float &z
) const
381 { x
= m_positionX
; y
= m_positionY
; z
= m_positionZ
; }
382 void GetPosition( WorldLocation
&loc
) const
383 { loc
.mapid
= GetMapId(); GetPosition(loc
.x
, loc
.y
, loc
.z
); loc
.o
= GetOrientation(); }
384 float GetOrientation( ) const { return m_orientation
; }
385 void GetNearPoint2D( float &x
, float &y
, float distance
, float absAngle
) const;
386 void GetNearPoint( WorldObject
const* searcher
, float &x
, float &y
, float &z
, float searcher_size
, float distance2d
,float absAngle
) const;
387 void GetClosePoint(float &x
, float &y
, float &z
, float size
, float distance2d
= 0, float angle
= 0) const
389 // angle calculated from current orientation
390 GetNearPoint(NULL
,x
,y
,z
,size
,distance2d
,GetOrientation() + angle
);
392 void GetContactPoint( const WorldObject
* obj
, float &x
, float &y
, float &z
, float distance2d
= CONTACT_DISTANCE
) const
394 // angle to face `obj` to `this` using distance includes size of `obj`
395 GetNearPoint(obj
,x
,y
,z
,obj
->GetObjectSize(),distance2d
,GetAngle( obj
));
398 float GetObjectSize() const
400 return ( m_valuesCount
> UNIT_FIELD_BOUNDINGRADIUS
) ? m_floatValues
[UNIT_FIELD_BOUNDINGRADIUS
] : DEFAULT_WORLD_OBJECT_SIZE
;
402 bool IsPositionValid() const;
403 void UpdateGroundPositionZ(float x
, float y
, float &z
) const;
405 void GetRandomPoint( float x
, float y
, float z
, float distance
, float &rand_x
, float &rand_y
, float &rand_z
) const;
407 void SetMapId(uint32 newMap
) { m_mapId
= newMap
; }
408 uint32
GetMapId() const { return m_mapId
; }
410 void SetPhaseMask(uint32 newPhaseMask
) { m_phaseMask
= newPhaseMask
; }
411 uint32
GetPhaseMask() const { return m_phaseMask
; }
412 bool InSamePhase(WorldObject
const* obj
) const { return InSamePhase(obj
->GetPhaseMask()); }
413 bool InSamePhase(uint32 phasemask
) const { return GetPhaseMask()==0 && phasemask
==0 || (GetPhaseMask() & phasemask
); }
415 uint32
GetZoneId() const;
416 uint32
GetAreaId() const;
418 InstanceData
* GetInstanceData();
420 const char* GetName() const { return m_name
.c_str(); }
421 void SetName(const std::string
& newname
) { m_name
=newname
; }
423 virtual const char* GetNameForLocaleIdx(int32
/*locale_idx*/) const { return GetName(); }
425 float GetDistance( const WorldObject
* obj
) const;
426 float GetDistance(const float x
, const float y
, const float z
) const;
427 float GetDistance2d(const WorldObject
* obj
) const;
428 float GetDistance2d(const float x
, const float y
) const;
429 float GetDistanceZ(const WorldObject
* obj
) const;
430 bool IsInMap(const WorldObject
* obj
) const
432 return IsInWorld() && obj
->IsInWorld() && GetMapId()==obj
->GetMapId() &&
433 GetInstanceId()==obj
->GetInstanceId() && InSamePhase(obj
);
435 bool IsWithinDistInMap(const WorldObject
* obj
, const float dist2compare
, const bool is3D
= true) const;
436 bool IsWithinLOS(const float x
, const float y
, const float z
) const;
437 bool IsWithinLOSInMap(const WorldObject
* obj
) const;
439 float GetAngle( const WorldObject
* obj
) const;
440 float GetAngle( const float x
, const float y
) const;
441 bool HasInArc( const float arcangle
, const WorldObject
* obj
) const;
443 virtual void SendMessageToSet(WorldPacket
*data
, bool self
);
444 virtual void SendMessageToSetInRange(WorldPacket
*data
, float dist
, bool self
);
445 void BuildHeartBeatMsg( WorldPacket
*data
) const;
446 void BuildTeleportAckMsg( WorldPacket
*data
, float x
, float y
, float z
, float ang
) const;
447 bool IsBeingTeleported() { return mSemaphoreTeleport
; }
448 void SetSemaphoreTeleport(bool semphsetting
) { mSemaphoreTeleport
= semphsetting
; }
450 void MonsterSay(const char* text
, uint32 language
, uint64 TargetGuid
);
451 void MonsterYell(const char* text
, uint32 language
, uint64 TargetGuid
);
452 void MonsterTextEmote(const char* text
, uint64 TargetGuid
, bool IsBossEmote
= false);
453 void MonsterWhisper(const char* text
, uint64 receiver
, bool IsBossWhisper
= false);
454 void MonsterSay(int32 textId
, uint32 language
, uint64 TargetGuid
);
455 void MonsterYell(int32 textId
, uint32 language
, uint64 TargetGuid
);
456 void MonsterTextEmote(int32 textId
, uint64 TargetGuid
, bool IsBossEmote
= false);
457 void MonsterWhisper(int32 textId
, uint64 receiver
, bool IsBossWhisper
= false);
458 void BuildMonsterChat(WorldPacket
*data
, uint8 msgtype
, char const* text
, uint32 language
, char const* name
, uint64 TargetGuid
) const;
460 void SendObjectDeSpawnAnim(uint64 guid
);
462 virtual void SaveRespawnTime() {}
464 uint32
GetInstanceId() const { return m_InstanceId
; }
465 void SetInstanceId(uint32 val
) { m_InstanceId
= val
; }
467 void AddObjectToRemoveList();
469 // main visibility check function in normal case (ignore grey zone distance check)
470 bool isVisibleFor(Player
const* u
) const { return isVisibleForInState(u
,false); }
472 // low level function for visibility change code, must be define in all main world object subclasses
473 virtual bool isVisibleForInState(Player
const* u
, bool inVisibleList
) const = 0;
475 Map
* GetMap() const;
476 Map
const* GetBaseMap() const;
477 Creature
* SummonCreature(uint32 id
, float x
, float y
, float z
, float ang
,TempSummonType spwtype
,uint32 despwtime
);
480 explicit WorldObject();
484 uint32 m_mapId
; // object at map with map_id
485 uint32 m_InstanceId
; // in map copy with instance id
486 uint32 m_phaseMask
; // in area phase state
493 bool mSemaphoreTeleport
;