ObjectGuid.h File Reference

#include "Common.h"
#include "ByteBuffer.h"
#include <type_traits>
#include <functional>

Include dependency graph for ObjectGuid.h:

Go to the source code of this file.

Classes
struct	ObjectGuidTraits< high >
class	ObjectGuid
class	PackedGuid
class	ObjectGuidGeneratorBase
class	ObjectGuidGenerator< high >
struct	std::hash< ObjectGuid >

Macros
#define	NUM_CLIENT_OBJECT_TYPES   11
#define	GUID_TRAIT_GLOBAL(highguid)
#define	GUID_TRAIT_REALM_SPECIFIC(highguid)
#define	GUID_TRAIT_MAP_SPECIFIC(highguid)
#define	PACKED_GUID_MIN_BUFFER_SIZE   18

Typedefs
typedef std::set< ObjectGuid >	GuidSet
typedef std::list< ObjectGuid >	GuidList
typedef std::deque< ObjectGuid >	GuidDeque
typedef std::vector< ObjectGuid >	GuidVector
typedef std::unordered_set < ObjectGuid >	GuidUnorderedSet

Enumerations
enum	TypeID {   TYPEID_OBJECT = 0, TYPEID_ITEM = 1, TYPEID_CONTAINER = 2, TYPEID_UNIT = 3,   TYPEID_PLAYER = 4, TYPEID_GAMEOBJECT = 5, TYPEID_DYNAMICOBJECT = 6, TYPEID_CORPSE = 7,   TYPEID_AREATRIGGER = 8, TYPEID_SCENEOBJECT = 9, TYPEID_CONVERSATION = 10 }
enum	TypeMask {   TYPEMASK_OBJECT = 0x0001, TYPEMASK_ITEM = 0x0002, TYPEMASK_CONTAINER = 0x0004, TYPEMASK_UNIT = 0x0008,   TYPEMASK_PLAYER = 0x0010, TYPEMASK_GAMEOBJECT = 0x0020, TYPEMASK_DYNAMICOBJECT = 0x0040, TYPEMASK_CORPSE = 0x0080,   TYPEMASK_AREATRIGGER = 0x0100, TYPEMASK_SCENEOBJECT = 0x0200, TYPEMASK_CONVERSATION = 0x0400, TYPEMASK_SEER = TYPEMASK_PLAYER | TYPEMASK_UNIT | TYPEMASK_DYNAMICOBJECT }
enum	HighGuid {   HighGuid::Null = 0, HighGuid::Uniq = 1, HighGuid::Player = 2, HighGuid::Item = 3,   HighGuid::WorldTransaction = 4, HighGuid::StaticDoor = 5, HighGuid::Transport = 6, HighGuid::Conversation = 7,   HighGuid::Creature = 8, HighGuid::Vehicle = 9, HighGuid::Pet = 10, HighGuid::GameObject = 11,   HighGuid::DynamicObject = 12, HighGuid::AreaTrigger = 13, HighGuid::Corpse = 14, HighGuid::LootObject = 15,   HighGuid::SceneObject = 16, HighGuid::Scenario = 17, HighGuid::AIGroup = 18, HighGuid::DynamicDoor = 19,   HighGuid::ClientActor = 20, HighGuid::Vignette = 21, HighGuid::CallForHelp = 22, HighGuid::AIResource = 23,   HighGuid::AILock = 24, HighGuid::AILockTicket = 25, HighGuid::ChatChannel = 26, HighGuid::Party = 27,   HighGuid::Guild = 28, HighGuid::WowAccount = 29, HighGuid::BNetAccount = 30, HighGuid::GMTask = 31,   HighGuid::MobileSession = 32, HighGuid::RaidGroup = 33, HighGuid::Spell = 34, HighGuid::Mail = 35,   HighGuid::WebObj = 36, HighGuid::LFGObject = 37, HighGuid::LFGList = 38, HighGuid::UserRouter = 39,   HighGuid::PVPQueueGroup = 40, HighGuid::UserClient = 41, HighGuid::PetBattle = 42, HighGuid::UniqUserClient = 43,   HighGuid::BattlePet = 44, HighGuid::CommerceObj = 45, HighGuid::ClientSession = 46, HighGuid::Count }

Functions
	GUID_TRAIT_REALM_SPECIFIC (HighGuid::Item) class ObjectGuid
TC_GAME_API ByteBuffer &	operator<< (ByteBuffer &buf, ObjectGuid const &guid)
TC_GAME_API ByteBuffer &	operator>> (ByteBuffer &buf, ObjectGuid &guid)
TC_GAME_API ByteBuffer &	operator<< (ByteBuffer &buf, PackedGuid const &guid)
TC_GAME_API std::ostream &	operator<< (std::ostream &stream, ObjectGuid const &guid)

Macro Definition Documentation

#define GUID_TRAIT_GLOBAL

(

highguid

)

Value:

template<> struct ObjectGuidTraits<highguid> \
 { \
 static bool const Global = true; \
 static bool const RealmSpecific = false; \
 static bool const MapSpecific = false; \
 };

#define GUID_TRAIT_MAP_SPECIFIC

(

highguid

)

Value:

template<> struct ObjectGuidTraits<highguid> \
 { \
 static bool const Global = false; \
 static bool const RealmSpecific = false; \
 static bool const MapSpecific = true; \
 };

#define GUID_TRAIT_REALM_SPECIFIC

(

highguid

)

Value:

template<> struct ObjectGuidTraits<highguid> \
 { \
 static bool const Global = false; \
 static bool const RealmSpecific = true; \
 static bool const MapSpecific = false; \
 };

#define NUM_CLIENT_OBJECT_TYPES   11

#define PACKED_GUID_MIN_BUFFER_SIZE   18

Typedef Documentation

typedef std::deque<ObjectGuid> GuidDeque

typedef std::list<ObjectGuid> GuidList

typedef std::set<ObjectGuid> GuidSet

typedef std::unordered_set<ObjectGuid> GuidUnorderedSet

typedef std::vector<ObjectGuid> GuidVector

Enumeration Type Documentation

enum HighGuid

strong

Enumerator
Null
Uniq
Player
Item
WorldTransaction
StaticDoor
Transport
Conversation
Creature
Vehicle
Pet
GameObject
DynamicObject
AreaTrigger
Corpse
LootObject
SceneObject
Scenario
AIGroup
DynamicDoor
ClientActor
Vignette
CallForHelp
AIResource
AILock
AILockTicket
ChatChannel
Party
Guild
WowAccount
BNetAccount
GMTask
MobileSession
RaidGroup
Spell
Mail
WebObj
LFGObject
LFGList
UserRouter
PVPQueueGroup
UserClient
PetBattle
UniqUserClient
BattlePet
CommerceObj
ClientSession
Count

{
 Null = 0,
 Uniq = 1,
 Player = 2,
 Item = 3,
 WorldTransaction = 4,
 StaticDoor = 5, //NYI
 Transport = 6,
 Conversation = 7,
 Creature = 8,
 Vehicle = 9,
 Pet = 10,
 GameObject = 11,
 DynamicObject = 12,
 AreaTrigger = 13,
 Corpse = 14,
 LootObject = 15,
 SceneObject = 16,
 Scenario = 17,
 AIGroup = 18,
 DynamicDoor = 19,
 ClientActor = 20, //NYI
 Vignette = 21,
 CallForHelp = 22,
 AIResource = 23,
 AILock = 24,
 AILockTicket = 25,
 ChatChannel = 26,
 Party = 27,
 Guild = 28,
 WowAccount = 29,
 BNetAccount = 30,
 GMTask = 31,
 MobileSession = 32, //NYI
 RaidGroup = 33,
 Spell = 34,
 Mail = 35,
 WebObj = 36, //NYI
 LFGObject = 37, //NYI
 LFGList = 38, //NYI
 UserRouter = 39,
 PVPQueueGroup = 40,
 UserClient = 41,
 PetBattle = 42, //NYI
 UniqUserClient = 43,
 BattlePet = 44,
 CommerceObj = 45,
 ClientSession = 46,

 Count,
};

enum TypeID

Enumerator
TYPEID_OBJECT
TYPEID_ITEM
TYPEID_CONTAINER
TYPEID_UNIT
TYPEID_PLAYER
TYPEID_GAMEOBJECT
TYPEID_DYNAMICOBJECT
TYPEID_CORPSE
TYPEID_AREATRIGGER
TYPEID_SCENEOBJECT
TYPEID_CONVERSATION

{
 TYPEID_OBJECT = 0,
 TYPEID_ITEM = 1,
 TYPEID_CONTAINER = 2,
 TYPEID_UNIT = 3,
 TYPEID_PLAYER = 4,
 TYPEID_GAMEOBJECT = 5,
 TYPEID_DYNAMICOBJECT = 6,
 TYPEID_CORPSE = 7,
 TYPEID_AREATRIGGER = 8,
 TYPEID_SCENEOBJECT = 9,
 TYPEID_CONVERSATION = 10
};

enum TypeMask

Enumerator
TYPEMASK_OBJECT
TYPEMASK_ITEM
TYPEMASK_CONTAINER
TYPEMASK_UNIT
TYPEMASK_PLAYER
TYPEMASK_GAMEOBJECT
TYPEMASK_DYNAMICOBJECT
TYPEMASK_CORPSE
TYPEMASK_AREATRIGGER
TYPEMASK_SCENEOBJECT
TYPEMASK_CONVERSATION
TYPEMASK_SEER

{
 TYPEMASK_OBJECT = 0x0001,
 TYPEMASK_ITEM = 0x0002,
 TYPEMASK_CONTAINER = 0x0004,
 TYPEMASK_UNIT = 0x0008,
 TYPEMASK_PLAYER = 0x0010,
 TYPEMASK_GAMEOBJECT = 0x0020,
 TYPEMASK_DYNAMICOBJECT = 0x0040,
 TYPEMASK_CORPSE = 0x0080,
 TYPEMASK_AREATRIGGER = 0x0100,
 TYPEMASK_SCENEOBJECT = 0x0200,
 TYPEMASK_CONVERSATION = 0x0400,
 TYPEMASK_SEER = TYPEMASK_PLAYER | TYPEMASK_UNIT | TYPEMASK_DYNAMICOBJECT
};

Function Documentation

GUID_TRAIT_REALM_SPECIFIC

(

HighGuid::Item

)

TC_GAME_API ByteBuffer& operator<<	(	ByteBuffer &	buf,
		ObjectGuid const &	guid
	)

{
 uint8 lowMask = 0;
 uint8 highMask = 0;
 buf.FlushBits(); // flush any unwritten bits to make wpos return a meaningful value
 std::size_t pos = buf.wpos();
 buf << uint8(lowMask);
 buf << uint8(highMask);

 uint8 packed[8];
 if (size_t packedSize = ByteBuffer::PackUInt64(guid._low, &lowMask, packed))
 buf.append(packed, packedSize);
 if (size_t packedSize = ByteBuffer::PackUInt64(guid._high, &highMask, packed))
 buf.append(packed, packedSize);

 buf.put(pos, lowMask);
 buf.put(pos + 1, highMask);

 return buf;
}

Here is the call graph for this function:

TC_GAME_API ByteBuffer& operator<<	(	ByteBuffer &	buf,
		PackedGuid const &	guid
	)

{
 buf.append(guid._packedGuid);
 return buf;
}

Here is the call graph for this function:

TC_GAME_API std::ostream& operator<<	(	std::ostream &	stream,
		ObjectGuid const &	guid
	)

{
 std::ostringstream tmp;
 tmp << std::hex << std::setw(16) << std::setfill('0') << guid._high << std::setw(16) << std::setfill('0') << guid._low;
 stream << tmp.str();
 return stream;
}

Here is the call graph for this function:

TC_GAME_API ByteBuffer& operator>>	(	ByteBuffer &	buf,
		ObjectGuid &	guid
	)

{
 uint8 lowMask, highMask;
 buf >> lowMask >> highMask;
 buf.ReadPackedUInt64(lowMask, guid._low);
 buf.ReadPackedUInt64(highMask, guid._high);
 return buf;
}

Here is the call graph for this function: