ObjectGuid Class Reference

#include <ObjectGuid.h>

Public Types
typedef uint64	LowType

Public Member Functions
	ObjectGuid ()
std::vector< uint8 >	GetRawValue () const
void	SetRawValue (std::vector< uint8 > const &guid)
void	SetRawValue (uint64 high, uint64 low)
void	Clear ()
HighGuid	GetHigh () const
uint32	GetRealmId () const
uint32	GetMapId () const
uint32	GetEntry () const
LowType	GetCounter () const
LowType	GetMaxCounter () const
uint8 &	operator[] (uint32 index)
uint8 const &	operator[] (uint32 index) const
bool	IsEmpty () const
bool	IsCreature () const
bool	IsPet () const
bool	IsVehicle () const
bool	IsCreatureOrPet () const
bool	IsCreatureOrVehicle () const
bool	IsAnyTypeCreature () const
bool	IsPlayer () const
bool	IsUnit () const
bool	IsItem () const
bool	IsGameObject () const
bool	IsDynamicObject () const
bool	IsCorpse () const
bool	IsAreaTrigger () const
bool	IsMOTransport () const
bool	IsAnyTypeGameObject () const
bool	IsParty () const
bool	IsGuild () const
bool	IsSceneObject () const
bool	IsConversation () const
TypeID	GetTypeId () const
bool	operator! () const
bool	operator== (ObjectGuid const &guid) const
bool	operator!= (ObjectGuid const &guid) const
bool	operator< (ObjectGuid const &guid) const
char const *	GetTypeName () const
std::string	ToString () const

Static Public Member Functions
template<HighGuid type>
static std::enable_if < ObjectGuidTraits< type > ::Global, ObjectGuid >::type	Create (LowType counter)
template<HighGuid type>
static std::enable_if < ObjectGuidTraits< type > ::RealmSpecific, ObjectGuid > ::type	Create (LowType counter)
template<HighGuid type>
static std::enable_if < ObjectGuidTraits< type > ::MapSpecific, ObjectGuid > ::type	Create (uint16 mapId, uint32 entry, LowType counter)
static LowType	GetMaxCounter (HighGuid)
static TypeID	GetTypeId (HighGuid high)
static char const *	GetTypeName (HighGuid high)

Static Public Attributes
static ObjectGuid const	Empty = ObjectGuid()
static ObjectGuid const	TradeItem = ObjectGuid::Create<HighGuid::Uniq>(uint64(10))

Private Member Functions
bool	HasEntry () const
	ObjectGuid (uint64 high, uint64 low)
	ObjectGuid (uint32 const &)=delete

Static Private Member Functions
static bool	HasEntry (HighGuid high)
static ObjectGuid	Global (HighGuid type, LowType counter)
static ObjectGuid	RealmSpecific (HighGuid type, LowType counter)
static ObjectGuid	MapSpecific (HighGuid type, uint8 subType, uint16 mapId, uint32 serverId, uint32 entry, LowType counter)

Private Attributes
uint64	_low
uint64	_high

Friends
TC_GAME_API std::ostream &	operator<< (std::ostream &stream, ObjectGuid const &guid)
TC_GAME_API ByteBuffer &	operator<< (ByteBuffer &buf, ObjectGuid const &guid)
TC_GAME_API ByteBuffer &	operator>> (ByteBuffer &buf, ObjectGuid &guid)

Member Typedef Documentation

typedef uint64 ObjectGuid::LowType

Constructor & Destructor Documentation

ObjectGuid::ObjectGuid ( )

inline

: _low(0), _high(0) { }

Here is the caller graph for this function:

ObjectGuid::ObjectGuid ( uint64  high, uint64  low  )

inlineprivate

: _low(low), _high(high) { }

ObjectGuid::ObjectGuid ( uint32 const &  )

explicitprivatedelete

Member Function Documentation

void ObjectGuid::Clear ( )

inline

{ _high = 0; _low = 0; }

template<HighGuid type>

static std::enable_if<ObjectGuidTraits<type>::Global, ObjectGuid>::type ObjectGuid::Create ( LowType  counter )

inlinestatic

{ return Global(type, counter); }

template<HighGuid type>

static std::enable_if<ObjectGuidTraits<type>::RealmSpecific, ObjectGuid>::type ObjectGuid::Create ( LowType  counter )

inlinestatic

{ return RealmSpecific(type, counter); }

template<HighGuid type>

static std::enable_if<ObjectGuidTraits<type>::MapSpecific, ObjectGuid>::type ObjectGuid::Create ( uint16  mapId, uint32  entry, LowType  counter  )

inlinestatic

{ return MapSpecific(type, 0, mapId, 0, entry, counter); }

LowType ObjectGuid::GetCounter ( ) const

inline

{ return _low & UI64LIT(0x000000FFFFFFFFFF); }

uint32 ObjectGuid::GetEntry ( ) const

inline

{ return uint32((_high >> 6) & 0x7FFFFF); }

Here is the caller graph for this function:

HighGuid ObjectGuid::GetHigh ( ) const

inline

{ return HighGuid((_high >> 58) & 0x3F); }

Here is the caller graph for this function:

uint32 ObjectGuid::GetMapId ( ) const

inline

{ return uint32((_high >> 29) & 0x1FFF); }

static LowType ObjectGuid::GetMaxCounter ( HighGuid  )

inlinestatic

 {
 return UI64LIT(0xFFFFFFFFFF);
 }

LowType ObjectGuid::GetMaxCounter ( ) const

inline

{ return GetMaxCounter(GetHigh()); }

Here is the call graph for this function:

Here is the caller graph for this function:

std::vector< uint8 > ObjectGuid::GetRawValue

(

)

const

{
 std::vector<uint8> raw(16);
 memcpy(raw.data(), this, sizeof(*this));
 return raw;
}

Here is the caller graph for this function:

uint32 ObjectGuid::GetRealmId ( ) const

inline

{ return uint32((_high >> 42) & 0x1FFF); }

static TypeID ObjectGuid::GetTypeId ( HighGuid  high )

inlinestatic

 {
 switch (high)
 {
 case HighGuid::Item: return TYPEID_ITEM;
 case HighGuid::Creature:
 case HighGuid::Pet:
 case HighGuid::Vehicle: return TYPEID_UNIT;
 case HighGuid::Player: return TYPEID_PLAYER;
 case HighGuid::GameObject:
 case HighGuid::Transport: return TYPEID_GAMEOBJECT;
 case HighGuid::DynamicObject: return TYPEID_DYNAMICOBJECT;
 case HighGuid::Corpse: return TYPEID_CORPSE;
 case HighGuid::AreaTrigger: return TYPEID_AREATRIGGER;
 case HighGuid::SceneObject: return TYPEID_SCENEOBJECT;
 case HighGuid::Conversation: return TYPEID_CONVERSATION;
 default: return TYPEID_OBJECT;
 }
 }

Here is the caller graph for this function:

TypeID ObjectGuid::GetTypeId ( ) const

inline

{ return GetTypeId(GetHigh()); }

Here is the call graph for this function:

Here is the caller graph for this function:

char const * ObjectGuid::GetTypeName ( HighGuid  high )

static

{
 if (high >= HighGuid::Count)
 return "<unknown>";

 return Names.Values[uint32(high)];
}

Here is the caller graph for this function:

char const* ObjectGuid::GetTypeName ( ) const

inline

{ return !IsEmpty() ? GetTypeName(GetHigh()) : "None"; }

Here is the call graph for this function:

Here is the caller graph for this function:

ObjectGuid ObjectGuid::Global ( HighGuid  type, LowType  counter  )

staticprivate

{
 return ObjectGuid(uint64(uint64(type) << 58), counter);
}

Here is the call graph for this function:

static bool ObjectGuid::HasEntry ( HighGuid  high )

inlinestaticprivate

 {
 switch (high)
 {
 case HighGuid::GameObject:
 case HighGuid::Creature:
 case HighGuid::Pet:
 case HighGuid::Vehicle:
 default:
 return true;
 }
 }

bool ObjectGuid::HasEntry ( ) const

inlineprivate

{ return HasEntry(GetHigh()); }

Here is the call graph for this function:

Here is the caller graph for this function:

bool ObjectGuid::IsAnyTypeCreature ( ) const

inline

{ return IsCreature() || IsPet() || IsVehicle(); }

Here is the caller graph for this function:

bool ObjectGuid::IsAnyTypeGameObject ( ) const

inline

{ return IsGameObject() || IsMOTransport(); }

Here is the caller graph for this function:

bool ObjectGuid::IsAreaTrigger ( ) const

inline

{ return GetHigh() == HighGuid::AreaTrigger; }

bool ObjectGuid::IsConversation ( ) const

inline

{ return GetHigh() == HighGuid::Conversation; }

bool ObjectGuid::IsCorpse ( ) const

inline

{ return GetHigh() == HighGuid::Corpse; }

Here is the caller graph for this function:

bool ObjectGuid::IsCreature ( ) const

inline

{ return GetHigh() == HighGuid::Creature; }

bool ObjectGuid::IsCreatureOrPet ( ) const

inline

{ return IsCreature() || IsPet(); }

bool ObjectGuid::IsCreatureOrVehicle ( ) const

inline

{ return IsCreature() || IsVehicle(); }

Here is the caller graph for this function:

bool ObjectGuid::IsDynamicObject ( ) const

inline

{ return GetHigh() == HighGuid::DynamicObject; }

bool ObjectGuid::IsEmpty ( ) const

inline

{ return _low == 0 && _high == 0; }

bool ObjectGuid::IsGameObject ( ) const

inline

{ return GetHigh() == HighGuid::GameObject; }

Here is the caller graph for this function:

bool ObjectGuid::IsGuild ( ) const

inline

{ return GetHigh() == HighGuid::Guild; }

Here is the caller graph for this function:

bool ObjectGuid::IsItem ( ) const

inline

{ return GetHigh() == HighGuid::Item; }

Here is the caller graph for this function:

bool ObjectGuid::IsMOTransport ( ) const

inline

{ return GetHigh() == HighGuid::Transport; }

Here is the caller graph for this function:

bool ObjectGuid::IsParty ( ) const

inline

{ return GetHigh() == HighGuid::Party; }

Here is the caller graph for this function:

bool ObjectGuid::IsPet ( ) const

inline

{ return GetHigh() == HighGuid::Pet; }

Here is the caller graph for this function:

bool ObjectGuid::IsPlayer ( ) const

inline

{ return !IsEmpty() && GetHigh() == HighGuid::Player; }

Here is the caller graph for this function:

bool ObjectGuid::IsSceneObject ( ) const

inline

{ return GetHigh() == HighGuid::SceneObject; }

bool ObjectGuid::IsUnit ( ) const

inline

{ return IsAnyTypeCreature() || IsPlayer(); }

Here is the caller graph for this function:

bool ObjectGuid::IsVehicle ( ) const

inline

{ return GetHigh() == HighGuid::Vehicle; }

Here is the caller graph for this function:

ObjectGuid ObjectGuid::MapSpecific ( HighGuid  type, uint8  subType, uint16  mapId, uint32  serverId, uint32  entry, LowType  counter  )

staticprivate

{
 return ObjectGuid(uint64((uint64(type) << 58) | (uint64(realm.Id.Realm & 0x1FFF) << 42) | (uint64(mapId & 0x1FFF) << 29) | (uint64(entry & 0x7FFFFF) << 6) | (uint64(subType) & 0x3F)),
 uint64((uint64(serverId & 0xFFFFFF) << 40) | (counter & UI64LIT(0xFFFFFFFFFF))));
}

Here is the call graph for this function:

bool ObjectGuid::operator! ( ) const

inline

{ return IsEmpty(); }

bool ObjectGuid::operator!= ( ObjectGuid const &  guid ) const

inline

{ return !(*this == guid); }

bool ObjectGuid::operator< ( ObjectGuid const &  guid ) const

inline

 {
 if (_high < guid._high)
 return true;
 else if (_high > guid._high)
 return false;

 return _low < guid._low;
 }

bool ObjectGuid::operator== ( ObjectGuid const &  guid ) const

inline

{ return _low == guid._low && _high == guid._high; }

uint8& ObjectGuid::operator[] ( uint32  index )

inline

 {
 ASSERT(index < sizeof(uint64) * 2);
 return ((uint8*)&_low)[index];
 }

uint8 const& ObjectGuid::operator[] ( uint32  index ) const

inline

 {
 ASSERT(index < sizeof(uint64) * 2);
 return ((uint8 const*)&_low)[index];
 }

ObjectGuid ObjectGuid::RealmSpecific ( HighGuid  type, LowType  counter  )

staticprivate

{
 return ObjectGuid(uint64(uint64(type) << 58 | uint64(realm.Id.Realm) << 42), counter);
}

Here is the call graph for this function:

void ObjectGuid::SetRawValue

(

std::vector< uint8 > const &

guid

)

{
 ASSERT(guid.size() == sizeof(*this));
 memcpy(this, guid.data(), sizeof(*this));
}

Here is the caller graph for this function:

void ObjectGuid::SetRawValue ( uint64  high, uint64  low  )

inline

{ _high = high; _low = low; }

std::string ObjectGuid::ToString

(

)

const

{
 std::ostringstream str;
 str << "GUID Full: 0x" << std::hex << std::uppercase << std::setw(16) << std::setfill('0') << _high << std::setw(16) << _low << std::dec << std::nouppercase;
 str << " Type: " << GetTypeName();
 if (HasEntry())
 str << (IsPet() ? " Pet number: " : " Entry: ") << GetEntry();

 str << " Low: " << GetCounter();
 return str.str();
}

Here is the call graph for this function:

Friends And Related Function Documentation

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

friend

{
 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;
}

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

friend

{
 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;
}

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

friend

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

Member Data Documentation

uint64 ObjectGuid::_high

private

uint64 ObjectGuid::_low

private

ObjectGuid const ObjectGuid::Empty = ObjectGuid()

static

ObjectGuid const ObjectGuid::TradeItem = ObjectGuid::Create<HighGuid::Uniq>(uint64(10))

static

---

The documentation for this class was generated from the following files:

• src/server/game/Entities/Object/ObjectGuid.h
• src/server/game/Entities/Object/ObjectGuid.cpp