ObjectGuid Class Reference

#include <ObjectGuid.h>

Public Types
using	LowType = uint64

Public Member Functions
	ObjectGuid ()
uint64	GetRawValue (std::size_t i) const
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
uint32	GetSubType () const
LowType	GetCounter () const
LowType	GetMaxCounter () 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
bool	IsCast () 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
std::string	ToHexString () const
std::size_t	GetHash () const

Static Public Member Functions
static LowType	GetMaxCounter (HighGuid high)
static char const *	GetTypeName (HighGuid high)
static ObjectGuid	FromString (std::string const &guidString)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Null, ObjectGuid >	Create ()
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Uniq, ObjectGuid >	Create (ObjectGuid::LowType id)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Player, ObjectGuid >	Create (ObjectGuid::LowType dbId)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Item, ObjectGuid >	Create (ObjectGuid::LowType dbId)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WorldObject, ObjectGuid >	Create (uint16 mapId, uint32 entry, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WorldObject, ObjectGuid >	Create (uint8 subType, uint16 mapId, uint32 entry, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Transport, ObjectGuid >	Create (uint32 counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ClientActor, ObjectGuid >	Create (uint16 ownerType, uint16 ownerId, uint32 counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ChatChannel, ObjectGuid >	Create (bool builtIn, bool trade, uint16 zoneId, uint8 factionGroupMask, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Global, ObjectGuid >	Create (ObjectGuid::LowType dbId)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Guild, ObjectGuid >	Create (ObjectGuid::LowType dbId)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::MobileSession, ObjectGuid >	Create (uint16 arg1, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WebObj, ObjectGuid >	Create (uint8 arg1, uint8 arg2, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::LFGObject, ObjectGuid >	Create (uint8 arg1, uint8 arg2, uint8 arg3, uint8 arg4, bool arg5, uint8 arg6, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::LFGList, ObjectGuid >	Create (uint8 arg1, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Client, ObjectGuid >	Create (uint32 arg1, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ClubFinder, ObjectGuid >	Create (uint8 clubType, uint32 clubFinderId, ObjectGuid::LowType dbId)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ToolsClient, ObjectGuid >	Create (uint16 mapId, uint32 serverId, ObjectGuid::LowType counter)
template<HighGuid type>
static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WorldLayer, ObjectGuid >	Create (uint32 arg1, uint16 arg2, uint8 arg3, uint32 arg4)

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

Protected Member Functions
	ObjectGuid (uint64 high, uint64 low)

Protected Attributes
uint64	_data [2]

Friends
class	ObjectGuidFactory
TC_GAME_API ByteBuffer &	operator<< (ByteBuffer &buf, ObjectGuid const &guid)
TC_GAME_API ByteBuffer &	operator>> (ByteBuffer &buf, ObjectGuid &guid)

Member Typedef Documentation

LowType

using ObjectGuid::LowType = uint64

Constructor & Destructor Documentation

ObjectGuid() [1/2]

ObjectGuid::ObjectGuid ( )

inline

{ Clear(); }

ObjectGuid() [2/2]

ObjectGuid::ObjectGuid ( uint64  high, uint64  low  )

inlineprotected

 {
 _data[0] = low;
 _data[1] = high;
 }

Member Function Documentation

Clear()

void ObjectGuid::Clear ( )

inline

{ std::fill(std::begin(_data), std::end(_data), UI64LIT(0)); }

Create() [1/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Null, ObjectGuid > ObjectGuid::Create ( )

inlinestatic

{ return ObjectGuidFactory::CreateNull(); }

Here is the call graph for this function:

Create() [2/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ChatChannel, ObjectGuid > ObjectGuid::Create ( bool  builtIn, bool  trade, uint16  zoneId, uint8  factionGroupMask, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateChatChannel(0, builtIn, trade, zoneId, factionGroupMask, counter); }

Here is the call graph for this function:

Create() [3/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Player, ObjectGuid > ObjectGuid::Create ( ObjectGuid::LowType  dbId )

inlinestatic

{ return ObjectGuidFactory::CreatePlayer(0, dbId); }

Here is the call graph for this function:

Create() [4/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Item, ObjectGuid > ObjectGuid::Create ( ObjectGuid::LowType  dbId )

inlinestatic

{ return ObjectGuidFactory::CreateItem(0, dbId); }

Here is the call graph for this function:

Create() [5/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Global, ObjectGuid > ObjectGuid::Create ( ObjectGuid::LowType  dbId )

inlinestatic

{ return ObjectGuidFactory::CreateGlobal(type, UI64LIT(0), dbId); }

Here is the call graph for this function:

Create() [6/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Guild, ObjectGuid > ObjectGuid::Create ( ObjectGuid::LowType  dbId )

inlinestatic

{ return ObjectGuidFactory::CreateGuild(type, 0, dbId); }

Here is the call graph for this function:

Create() [7/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Uniq, ObjectGuid > ObjectGuid::Create ( ObjectGuid::LowType  id )

inlinestatic

{ return ObjectGuidFactory::CreateUniq(id); }

Here is the call graph for this function:

Create() [8/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::MobileSession, ObjectGuid > ObjectGuid::Create ( uint16  arg1, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateMobileSession(0, arg1, counter); }

Here is the call graph for this function:

Create() [9/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WorldObject, ObjectGuid > ObjectGuid::Create ( uint16  mapId, uint32  entry, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateWorldObject(type, 0, 0, mapId, 0, entry, counter); }

Here is the call graph for this function:

Create() [10/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ToolsClient, ObjectGuid > ObjectGuid::Create ( uint16  mapId, uint32  serverId, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateToolsClient(mapId, serverId, counter); }

Here is the call graph for this function:

Create() [11/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ClientActor, ObjectGuid > ObjectGuid::Create ( uint16  ownerType, uint16  ownerId, uint32  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateClientActor(ownerType, ownerId, counter); }

Here is the call graph for this function:

Create() [12/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Client, ObjectGuid > ObjectGuid::Create ( uint32  arg1, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateClient(type, 0, arg1, counter); }

Here is the call graph for this function:

Create() [13/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WorldLayer, ObjectGuid > ObjectGuid::Create ( uint32  arg1, uint16  arg2, uint8  arg3, uint32  arg4  )

inlinestatic

{ return ObjectGuidFactory::CreateWorldLayer(arg1, arg2, arg3, arg4); }

Here is the call graph for this function:

Create() [14/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::Transport, ObjectGuid > ObjectGuid::Create ( uint32  counter )

inlinestatic

{ return ObjectGuidFactory::CreateTransport(type, counter); }

Here is the call graph for this function:

Create() [15/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::LFGList, ObjectGuid > ObjectGuid::Create ( uint8  arg1, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateLFGList(arg1, counter); }

Here is the call graph for this function:

Create() [16/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WebObj, ObjectGuid > ObjectGuid::Create ( uint8  arg1, uint8  arg2, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateWebObj(0, arg1, arg2, counter); }

Here is the call graph for this function:

Create() [17/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::LFGObject, ObjectGuid > ObjectGuid::Create ( uint8  arg1, uint8  arg2, uint8  arg3, uint8  arg4, bool  arg5, uint8  arg6, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateLFGObject(arg1, arg2, arg3, arg4, arg5, arg6, counter); }

Here is the call graph for this function:

Create() [18/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::ClubFinder, ObjectGuid > ObjectGuid::Create ( uint8  clubType, uint32  clubFinderId, ObjectGuid::LowType  dbId  )

inlinestatic

{ return ObjectGuidFactory::CreateClubFinder(0, clubType, clubFinderId, dbId); }

Here is the call graph for this function:

Create() [19/19]

template<HighGuid type>

static std::enable_if_t< ObjectGuidTraits< type >::Format::value==ObjectGuidFormatType::WorldObject, ObjectGuid > ObjectGuid::Create ( uint8  subType, uint16  mapId, uint32  entry, ObjectGuid::LowType  counter  )

inlinestatic

{ return ObjectGuidFactory::CreateWorldObject(type, subType, 0, mapId, 0, entry, counter); }

Here is the call graph for this function:

FromString()

ObjectGuid ObjectGuid::FromString ( std::string const &  guidString )

static

{
 return Info.Parse(guidString);
}

Here is the caller graph for this function:

GetCounter()

LowType ObjectGuid::GetCounter ( ) const

inline

 {
 switch (GetHigh())
 {
 case HighGuid::Transport:
 return (_data[1] >> 38) & UI64LIT(0xFFFFF);
 default:
 break;
 }
 return _data[0] & UI64LIT(0x000000FFFFFFFFFF);
 }

GetEntry()

uint32 ObjectGuid::GetEntry ( ) const

inline

{ return uint32((_data[1] >> 6) & 0x7FFFFF); }

Here is the caller graph for this function:

GetHash()

std::size_t ObjectGuid::GetHash

(

)

const

{
 std::size_t hashVal = 0;
 Trinity::hash_combine(hashVal, _data[0]);
 Trinity::hash_combine(hashVal, _data[1]);
 return hashVal;
}

Here is the call graph for this function:

GetHigh()

HighGuid ObjectGuid::GetHigh ( ) const

inline

{ return HighGuid((_data[1] >> 58) & 0x3F); }

Here is the caller graph for this function:

GetMapId()

uint32 ObjectGuid::GetMapId ( ) const

inline

{ return uint32((_data[1] >> 29) & 0x1FFF); }

GetMaxCounter() [1/2]

LowType ObjectGuid::GetMaxCounter ( ) const

inline

{ return GetMaxCounter(GetHigh()); }

Here is the call graph for this function:

Here is the caller graph for this function:

GetMaxCounter() [2/2]

static LowType ObjectGuid::GetMaxCounter ( HighGuid  high )

inlinestatic

 {
 switch (high)
 {
 case HighGuid::Transport:
 return UI64LIT(0xFFFFF);
 default:
 break;
 }
 return UI64LIT(0xFFFFFFFFFF);
 }

GetRawValue() [1/2]

std::vector< uint8 > ObjectGuid::GetRawValue

(

)

const

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

GetRawValue() [2/2]

uint64 ObjectGuid::GetRawValue ( std::size_t  i ) const

inline

{ return _data[i]; }

Here is the caller graph for this function:

GetRealmId()

uint32 ObjectGuid::GetRealmId ( ) const

inline

{ return uint32((_data[1] >> 42) & 0xFFFF); }

GetSubType()

uint32 ObjectGuid::GetSubType ( ) const

inline

{ return uint32(_data[1] & 0x3F); }

GetTypeName() [1/2]

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:

GetTypeName() [2/2]

char const * ObjectGuid::GetTypeName ( HighGuid  high )

static

{
 if (high >= HighGuid::Count)
 return "<unknown>";
 
 return Info.Names[uint32(high)].c_str();
}

Here is the caller graph for this function:

IsAnyTypeCreature()

bool ObjectGuid::IsAnyTypeCreature ( ) const

inline

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

Here is the caller graph for this function:

IsAnyTypeGameObject()

bool ObjectGuid::IsAnyTypeGameObject ( ) const

inline

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

Here is the caller graph for this function:

IsAreaTrigger()

bool ObjectGuid::IsAreaTrigger ( ) const

inline

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

IsCast()

bool ObjectGuid::IsCast ( ) const

inline

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

IsConversation()

bool ObjectGuid::IsConversation ( ) const

inline

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

IsCorpse()

bool ObjectGuid::IsCorpse ( ) const

inline

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

Here is the caller graph for this function:

IsCreature()

bool ObjectGuid::IsCreature ( ) const

inline

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

Here is the caller graph for this function:

IsCreatureOrPet()

bool ObjectGuid::IsCreatureOrPet ( ) const

inline

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

IsCreatureOrVehicle()

bool ObjectGuid::IsCreatureOrVehicle ( ) const

inline

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

Here is the caller graph for this function:

IsDynamicObject()

bool ObjectGuid::IsDynamicObject ( ) const

inline

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

IsEmpty()

bool ObjectGuid::IsEmpty ( ) const

inline

{ return _data[0] == 0 && _data[1] == 0; }

IsGameObject()

bool ObjectGuid::IsGameObject ( ) const

inline

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

Here is the caller graph for this function:

IsGuild()

bool ObjectGuid::IsGuild ( ) const

inline

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

Here is the caller graph for this function:

IsItem()

bool ObjectGuid::IsItem ( ) const

inline

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

Here is the caller graph for this function:

IsMOTransport()

bool ObjectGuid::IsMOTransport ( ) const

inline

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

Here is the caller graph for this function:

IsParty()

bool ObjectGuid::IsParty ( ) const

inline

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

Here is the caller graph for this function:

IsPet()

bool ObjectGuid::IsPet ( ) const

inline

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

Here is the caller graph for this function:

IsPlayer()

bool ObjectGuid::IsPlayer ( ) const

inline

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

Here is the caller graph for this function:

IsSceneObject()

bool ObjectGuid::IsSceneObject ( ) const

inline

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

IsUnit()

bool ObjectGuid::IsUnit ( ) const

inline

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

Here is the caller graph for this function:

IsVehicle()

bool ObjectGuid::IsVehicle ( ) const

inline

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

Here is the caller graph for this function:

operator!()

bool ObjectGuid::operator! ( ) const

inline

{ return IsEmpty(); }

operator!=()

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

inline

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

operator<()

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

inline

 {
 if (_data[1] < guid._data[1])
 return true;
 else if (_data[1] > guid._data[1])
 return false;
 
 return _data[0] < guid._data[0];
 }

operator==()

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

inline

{ return _data[0] == guid._data[0] && _data[1] == guid._data[1]; }

SetRawValue() [1/2]

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:

SetRawValue() [2/2]

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

inline

{ _data[0] = low; _data[1] = high; }

ToHexString()

std::string ObjectGuid::ToHexString

(

)

const

{
 return Trinity::StringFormat("0x%016llX%016llX", _data[1], _data[0]);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ToString()

std::string ObjectGuid::ToString

(

)

const

{
 return Info.Format(*this);
}

Friends And Related Function Documentation

ObjectGuidFactory

friend class ObjectGuidFactory

friend

operator<<

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._data[0], &lowMask, packed))
 buf.append(packed, packedSize);
 if (size_t packedSize = ByteBuffer::PackUInt64(guid._data[1], &highMask, packed))
 buf.append(packed, packedSize);
 
 buf.put(pos, lowMask);
 buf.put(pos + 1, highMask);
 
 return buf;
}

operator>>

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

friend

{
 uint8 lowMask, highMask;
 buf >> lowMask >> highMask;
 buf.ReadPackedUInt64(lowMask, guid._data[0]);
 buf.ReadPackedUInt64(highMask, guid._data[1]);
 return buf;
}

Member Data Documentation

_data

uint64 ObjectGuid::_data[2]

protected

Empty

ObjectGuid const ObjectGuid::Empty = ObjectGuid()

static

FromStringFailed

ObjectGuid const ObjectGuid::FromStringFailed = ObjectGuid::Create<HighGuid::Uniq>(UI64LIT(4))

static

TradeItem

ObjectGuid const ObjectGuid::TradeItem = ObjectGuid::Create<HighGuid::Uniq>(UI64LIT(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