1. Epic GamesDeveloper
  3. FGuid

FGuid

Implements a globally unique identifier.

API > API/Runtime > API/Runtime/Core

Implements a globally unique identifier.

   
Name FGuid
Type struct
Header File /Engine/Source/Runtime/Core/Public/Misc/Guid.h
Include Path #include "Misc/Guid.h"

Syntax

struct FGuid

Constructors

Name Remarks Include Path Unreal Specifiers

FGuid ( const FString& InGuidStr
)

   Misc/Guid.h  

constexpr FGuid ( uint32 InA,
uint32 InB,
uint32 InC,
uint32 InD
)

 Creates and initializes a new GUID from the specified components. Misc/Guid.h  

constexpr FGuid ()

 Default constructor. Misc/Guid.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
A uint32 Private: Misc/Guid.h  
B uint32 Holds the second component. Misc/Guid.h  
C uint32 Holds the third component. Misc/Guid.h  
D uint32 Holds the fourth component. Misc/Guid.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AppendString ( FUtf8StringBuilderBase& Builder,
EGuidFormats Format
) const

   Misc/Guid.h  

void AppendString ( FWideStringBuilderBase& Builder,
EGuidFormats Format
) const

   Misc/Guid.h  

void AppendString ( FAnsiStringBuilderBase& Builder,
EGuidFormats Format
) const

 Appends this GUID to the string builder using the specified format. Misc/Guid.h  

void AppendString ( FString& Out,
EGuidFormats Format
) const

 Converts this GUID to its string representation using the specified format. Misc/Guid.h  

bool ExportTextItem ( FString& ValueStr,
FGuid const& DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
) const

 Exports the GUIDs value to a string. Misc/Guid.h  

bool ImportTextItem ( const TCHAR*& Buffer,
int32 PortFlags,
UObject* Parent,
FOutputDevice* ErrorText
)

 Imports the GUIDs value from a text buffer. Misc/Guid.h  

void Invalidate ()

 Invalidates the GUID. Misc/Guid.h  

bool IsValid ()

 Checks whether this GUID is valid or not. Misc/Guid.h  

bool Serialize ( FArchive& Ar
)

   Misc/Guid.h  

bool Serialize ( FStructuredArchive::FSlot Slot
)

   Misc/Guid.h  

FString ToString ( EGuidFormats Format
) const

 Converts this GUID to its string representation. Misc/Guid.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AutoRTFMAssignFromOpenToClosed ( FGuid& Closed,
FGuid Open
)

 Allows a FGuid to be returned from AutoRTFM::Open(). Misc/Guid.h  

static FGuid Combine ( const FGuid& GuidA,
const FGuid& GuidB
)

 Returns a GUID which is a combinationof the two provided ones. Misc/Guid.h  

static FGuid NewDeterministicGuid ( FStringView ObjectPath,
uint64 Seed
)

 Create a guid by hashing the given path; this guid will be deterministic when called in multiple cook processes and will thus avoid cook indeterminism caused by FGuid::NewGuid. Misc/Guid.h  

static FGuid NewGuid()

 Returns a new GUID. Misc/Guid.h  

static FGuid NewGuidFromHash ( const FBlake3Hash& Hash
)

 Create a guid from a calculated Blake3 Hash Misc/Guid.h  

static FGuid NewGuidFromHashBytes ( const void* HashData,
int64 DataLen
)

 Uses the first 16 bytes from HashData to create a Guid. Misc/Guid.h  

static bool Parse ( const TCHAR* GuidString,
FGuid& OutGuid
)

 Converts a string to a GUID. Misc/Guid.h  

static bool Parse ( const FString& GuidString,
FGuid& OutGuid
)

   Misc/Guid.h  

static bool Parse ( FStringView GuidString,
FGuid& OutGuid
)

   Misc/Guid.h  

static bool ParseExact ( const TCHAR* GuidString,
EGuidFormats Format,
FGuid& OutGuid
)

 Converts a string with the specified format to a GUID. Misc/Guid.h  

static bool ParseExact ( const FString& GuidString,
EGuidFormats Format,
FGuid& OutGuid
)

   Misc/Guid.h  

static bool ParseExact ( FStringView GuidString,
EGuidFormats Format,
FGuid& OutGuid
)

   Misc/Guid.h  

Operators

Name Remarks Include Path Unreal Specifiers

uint32 & operator[] ( int32 Index
)

 Provides access to the GUIDs components. Misc/Guid.h  

const uint32 & operator[] ( int32 Index
) const

 Provides read-only access to the GUIDs components. Misc/Guid.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page