1. Epic GamesDeveloper
  3. FName

FName

Public name, available to the world.

API > API/Runtime > API/Runtime/Core

Public name, available to the world. Names are stored as a combination of an index into a table of unique strings and an instance number. Names are case-insensitive, but case-preserving (when WITH_CASE_PRESERVING_NAME is 1)

   
Name FName
Type class
Header File /Engine/Source/Runtime/Core/Public/UObject/NameTypes.h
Include Path #include "UObject/NameTypes.h"

Syntax

class FName

Constructors

Name Remarks Include Path Unreal Specifiers

FName ( const ANSICHAR* Name,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( const WIDECHAR* Name,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( FName Other,
int32 InNumber
)

 Create an FName from an existing string, but with a different instance. UObject/NameTypes.h  

FName ( EName Ename,
int32 InNumber
)

 Create an FName with a hardcoded string index and (instance). UObject/NameTypes.h  

FName ( const WIDECHAR* Name
)

 Create an FName. UObject/NameTypes.h  

FName ( const UTF8CHAR* Name
)

   UObject/NameTypes.h  

FName ( FMemoryImageName InName
)

   UObject/NameTypes.h  

constexpr FName ()

 Default constructor, initialized to None UObject/NameTypes.h  

FName ( EName Ename
)

 Create an FName with a hardcoded string index. UObject/NameTypes.h  

constexpr FName ( ENoInit
)

 Scary no init constructor, used for something obscure in UObjectBase UObject/NameTypes.h  
Special constructor used by TOptional UObject/NameTypes.h  

FName ( FMinimalName InName
)

   UObject/NameTypes.h  

FName ( FScriptName InName
)

   UObject/NameTypes.h  

FName ( const UTF8CHAR* Name,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( TStringView< ANSICHAR > View,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( const FNameEntrySerialized& LoadedEntry
)

 Constructor used by FLinkerLoad when loading its name table; Creates an FName with an instance number of 0 that does not attempt to split the FName into string and number portions. UObject/NameTypes.h  

FName ( TStringView< UTF8CHAR > View,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( const TCHAR* Name,
int32 InNumber,
bool bSplitName
)

 Create an FName. UObject/NameTypes.h  

FName ( int32 Len,
const UTF8CHAR* Name,
int32 Number
)

   UObject/NameTypes.h  

FName ( int32 Len,
const ANSICHAR* Name,
int32 Number
)

   UObject/NameTypes.h  

FName ( int32 Len,
const WIDECHAR* Name,
int32 Number
)

   UObject/NameTypes.h  

FName ( int32 Len,
const UTF8CHAR* Name,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( int32 Len,
const ANSICHAR* Name,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( int32 Len,
const WIDECHAR* Name,
EFindName FindType
)

 Create FName from non-null string with known length UObject/NameTypes.h  

FName ( FNameEntryId InComparisonIndex,
FNameEntryId InDisplayIndex,
int32 InNumber
)

 Create an FName from its component parts Only call this if you really know what you're doing UObject/NameTypes.h  

FName ( TStringView< WIDECHAR > View,
EFindName FindType
)

   UObject/NameTypes.h  

FName ( const ANSICHAR* Name
)

   UObject/NameTypes.h  

FName ( const WIDECHAR* Name,
int32 Number
)

 Create an FName. UObject/NameTypes.h  

FName ( const ANSICHAR* Name,
int32 Number
)

   UObject/NameTypes.h  

FName ( const UTF8CHAR* Name,
int32 Number
)

   UObject/NameTypes.h  

FName ( TStringView< UTF8CHAR > View,
int32 InNumber
)

   UObject/NameTypes.h  

FName ( TStringView< WIDECHAR > View,
int32 InNumber
)

   UObject/NameTypes.h  

FName ( TStringView< ANSICHAR > View,
int32 InNumber
)

   UObject/NameTypes.h  

Typedefs

Name Type Remarks Include Path
IntrusiveUnsetOptionalStateType FName   UObject/NameTypes.h

Constants

Name Type Remarks Include Path
bHasIntrusiveUnsetOptionalState bool   UObject/NameTypes.h
StringBufferSize uint32 Buffer size required for any null-terminated FName string, i.e. [name] '_' [digits] '\0' UObject/NameTypes.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ComparisonIndex FNameEntryId Index into the Names array (used to find String portion of the string/number pair used for comparison) UObject/NameTypes.h  
DisplayIndex FNameEntryId Index into the Names array (used to find String portion of the string/number pair used for display) UObject/NameTypes.h  
Number uint32 Number portion of the string/number pair (stored internally as 1 more than actual, so zero'd memory will be the default, no-instance case) UObject/NameTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AppendString ( FWideStringBuilderBase& Out
) const

 Converts an FName to a readable format, in place, appending to an existing string (ala GetFullName) UObject/NameTypes.h  

void AppendString ( FUtf8StringBuilderBase& Out
) const

   UObject/NameTypes.h  

void AppendString ( FUtf8String& Out
) const

   UObject/NameTypes.h  

void AppendString ( FWideString& Out
) const

 Converts an FName to a readable format, in place, appending to an existing string (ala GetFullName) UObject/NameTypes.h  

void AppendStringInternal ( StringBuilderType& Out
) const

      

int32 Compare ( const FName& Other
) const

 Compares name to passed in one. Sort is alphabetical ascending. UObject/NameTypes.h  

int32 CompareIndexes ( const FName& Other
) const

 Fast non-alphabetical order that is only stable during this process' lifetime. UObject/NameTypes.h  

bool FastLess ( const FName& Other
) const

 Fast non-alphabetical order that is only stable during this process' lifetime. UObject/NameTypes.h  

FNameEntryId GetComparisonIndex()

   UObject/NameTypes.h  

const FNameEntry * GetComparisonNameEntry()

   UObject/NameTypes.h  

FNameEntryId GetDisplayIndex()

   UObject/NameTypes.h  

const FNameEntry * GetDisplayNameEntry()

   UObject/NameTypes.h  

int32 GetNumber()

   UObject/NameTypes.h  

void GetPlainANSIString ( ANSICHAR(&) AnsiName
) const

 Copy ANSI name without number part. Must only be used for ANSI FNames. Doesn't allocate. UObject/NameTypes.h  

uint32 GetPlainNameString ( TCHAR(&) OutName
) const

 Convert name without number part into TCHAR buffer and returns string length. Doesn't allocate. UObject/NameTypes.h  
Get name without number part as a dynamically allocated string UObject/NameTypes.h  

void GetPlainWIDEString ( WIDECHAR(&) WideName
) const

 Copy wide name without number part. Must only be used for wide FNames. Doesn't allocate. UObject/NameTypes.h  

uint32 GetStringLength()

 Get the number of characters, excluding null-terminator, that ToString() would yield UObject/NameTypes.h  

bool IsEqual ( const FName& Other,
const ENameCase CompareMethod,
const bool bCompareNumber
) const

 Check to see if this FName matches the other FName, potentially also checking for any case variations UObject/NameTypes.h  

bool IsNone()

 True for FName(), FName(NAME_None) and FName("None") UObject/NameTypes.h  

bool IsValid ()

 Paranoid sanity check UObject/NameTypes.h  

bool IsValidGroupName ( FText& OutReason,
bool bIsGroupName
) const

 Takes an FName and checks to see that it follows the rules that Unreal requires for package or group names. UObject/NameTypes.h  

bool IsValidIndexFast()

 Paranoid sanity check, same as IsValid() UObject/NameTypes.h  

bool IsValidObjectName ( FText& OutReason
) const

 Takes an FName and checks to see that it follows the rules that Unreal requires for object names. UObject/NameTypes.h  

bool IsValidXName ( FText& OutReason,
const FString& InInvalidChars
) const

 Takes an FName and checks to see that it follows the rules that Unreal requires. UObject/NameTypes.h  

bool IsValidXName ( FText& OutReason
) const

   UObject/NameTypes.h  

bool IsValidXName ()

   UObject/NameTypes.h  

bool IsValidXName ( const FString& InInvalidChars,
FText* OutReason,
const FText* InErrorCtx
) const

 Checks to see that a FName follows the rules that Unreal requires. UObject/NameTypes.h  

bool LexicalLess ( const FName& Other
) const

 Slow alphabetical order that is stable / deterministic over process runs. UObject/NameTypes.h  

void SetNumber ( const int32 NewNumber
)

   UObject/NameTypes.h  

const EName * ToEName()

 Get the EName that this FName represents or nullptr UObject/NameTypes.h  
Converts an FName to a readable format UObject/NameTypes.h  

uint32 ToString ( TCHAR* Out,
uint32 OutSize
) const

 Convert to string buffer to avoid dynamic allocations and returns string length UObject/NameTypes.h  

void ToString ( FUtf8StringBuilderBase& Out
) const

   UObject/NameTypes.h  

uint32 ToString ( TCHAR(&) Out
) const

 Converts the FName to a string buffer, avoiding dynamic allocations. UObject/NameTypes.h  

void ToString ( FWideString& Out
) const

 Converts an FName to a readable format, in place UObject/NameTypes.h  

void ToString ( FWideStringBuilderBase& Out
) const

 Converts an FName to a readable format, in place UObject/NameTypes.h  

void ToString ( FUtf8String& Out
) const

   UObject/NameTypes.h  

uint32 ToStringTruncate ( TCHAR* Out,
uint32 OutSize
) const

 Converts the FName to a string buffer, avoiding dynamic allocations. UObject/NameTypes.h  

uint32 ToStringTruncate ( TCHAR(&) Out
) const

   UObject/NameTypes.h  

uint64 ToUnstableInt()

 Returns an integer that compares equal in the same way FNames do, only usable within the current process UObject/NameTypes.h  

FUtf8String ToUtf8String()

 Converts an FName to a readable format UObject/NameTypes.h  

bool TryAppendAnsiString ( FAnsiStringBuilderBase& Out
) const

 Converts an ANSI FName to a readable format appended to the string builder. UObject/NameTypes.h  

bool UEOpEquals ( FName Other
) const

   UObject/NameTypes.h  
Special comparison operator for TOptional::IsSet UObject/NameTypes.h  

decltype(FName::Equals(*this, Rhs)) UEOpEquals ( T Rhs
) const

   UObject/NameTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddNameToDisplayStringExemption ( const FString& InExemption
)

 Add/remove an exemption to the formatting applied by NameToDisplayString. UObject/NameTypes.h  

static void AutoTest()

 Run autotest on FNames. UObject/NameTypes.h  

static FName CreateFromDisplayId ( FNameEntryId DisplayId,
int32 Number
)

 Only call this if you really know what you're doing UObject/NameTypes.h  

static FName CreateNumberedNameIfNecessary ( FNameEntryId ComparisonId,
int32 Number
)

   UObject/NameTypes.h  

static FName CreateNumberedNameIfNecessary ( FNameEntryId ComparisonId,
FNameEntryId DisplayId,
int32 Number
)

 These FNameEntryIds are passed in from user code so they must be non-numbered if Number != NAME_NO_NUMBER_INTERNAL. UObject/NameTypes.h  

static TArray< const FNameEntry * > DebugDump()

   UObject/NameTypes.h  

static void DisplayHash ( FOutputDevice& Ar
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
FAnsiStringView B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
FWideStringView B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
EName B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
FMinimalName B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
FScriptName B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
FMemoryImageName B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
FName B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
const WIDECHAR* B
)

   UObject/NameTypes.h  

static bool Equals ( FName A,
const ANSICHAR* B
)

   UObject/NameTypes.h  

static FNameEntryId GetComparisonIdFromDisplayId ( FNameEntryId DisplayId
)

   UObject/NameTypes.h  

static FNameEntry const * GetEntry ( EName Ename
)

   UObject/NameTypes.h  

static FNameEntry const * GetEntry ( FNameEntryId Id
)

   UObject/NameTypes.h  

static int64 GetNameEntryMemoryEstimatedAvailable()

   UObject/NameTypes.h  

static int64 GetNameEntryMemorySize()

   UObject/NameTypes.h  

static int64 GetNameTableMemorySize()

   UObject/NameTypes.h  

static int32 GetNumAnsiNames()

   UObject/NameTypes.h  

static int32 GetNumWideNames()

   UObject/NameTypes.h  

static bool IsValidXName ( const TCHAR* InName,
const FString& InInvalidChars,
FText* OutReason,
const FText* InErrorCtx
)

   UObject/NameTypes.h  

static bool IsValidXName ( const FString& InName,
const FString& InInvalidChars,
FText* OutReason,
const FText* InErrorCtx
)

   UObject/NameTypes.h  

static bool IsValidXName ( const FStringView& InName,
const FString& InInvalidChars,
FText* OutReason,
const FText* InErrorCtx
)

   UObject/NameTypes.h  

static bool IsValidXName ( const FName InName,
const FString& InInvalidChars,
FText* OutReason,
const FText* InErrorCtx
)

 Checks to see that a given name-like string follows the rules that Unreal requires. UObject/NameTypes.h  

static bool IsWithinBounds ( FNameEntryId Id
)

   UObject/NameTypes.h  

static FString NameToDisplayString ( const FString& InDisplayName,
const bool bIsBool
)

 Takes a string and breaks it down into a human readable string. UObject/NameTypes.h  

static void RemoveNameToDisplayStringExemption ( const FString& InExemption
)

   UObject/NameTypes.h  

static void Reserve ( uint32 NumBytes,
uint32 NumNames
)

   UObject/NameTypes.h  

static const FNameEntry * ResolveEntry ( FNameEntryId LookupId
)

 Resolve the entry directly referred to by LookupId. UObject/NameTypes.h  

static const FNameEntry * ResolveEntryRecursive ( FNameEntryId LookupId
)

 Recursively resolve through the entry referred to by LookupId to reach the allocated string entry, in the case of UE_FNAME_OUTLINE_NUMBER=1. UObject/NameTypes.h  

static FString SafeString ( FNameEntryId InDisplayIndex,
int32 InstanceNumber
)

   UObject/NameTypes.h  

static FString SanitizeWhitespace ( const FString& FNameString
)

 Printing FNames in logging or on screen can be problematic when they contain Whitespace characters such as UObject/NameTypes.h  

static void TearDown ()

 Tear down system and free all allocated memory UObject/NameTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page