Module |
|
Header |
/Engine/Source/Runtime/Core/Public/UObject/NameTypes.h |
Include |
#include "UObject/NameTypes.h" |
class FName
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 | Description | |
---|---|---|
|
FName() |
Default constructor, initialized to None |
|
FName ( |
Create an FName with a hardcoded string index. |
|
FName ( |
Create an FName from its component parts Only call this if you really know what you're doing |
|
FName |
Create FName from non-null string with known length |
|
FName |
|
|
FName |
Create an FName. |
|
FName |
|
|
FName ( |
|
|
FName ( |
|
|
FName |
|
|
FName |
|
|
FName ( |
Create an FName with a hardcoded string index. |
|
FName |
Create an FName. |
|
FName ( |
Scary no init constructor, used for something obscure in UObjectBase |
|
FName ( |
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. |
|
FName |
Create an FName with a hardcoded string index and (instance). |
|
FName |
Create an FName from an existing string, but with a different instance. |
|
FName |
Create an FName. |
|
FName |
|
|
FName ( |
Name | Description | ||
---|---|---|---|
|
AppendString ( |
Converts an FName to a readable format, in place, appending to an existing string (ala GetFullName) |
|
|
AppendString ( |
Converts an FName to a readable format, in place, appending to an existing string (ala GetFullName) |
|
|
AutoTest() |
Run autotest on FNames. |
|
|
Compare ( |
Compares name to passed in one. Sort is alphabetical ascending. |
|
|
CompareIndexes ( |
Fast compares name to passed in one using indexes. Sort is allocation order ascending. |
|
|
CreateFromDisplayId ( |
Only call this if you really know what you're doing |
|
|
TArray< cons... |
DebugDump() |
|
|
DisplayHash ( |
||
|
FastLess ( |
Fast non-alphabetical order that is only stable during this process' lifetime. |
|
|
GetComparisonIdFromDisplayId ( |
||
|
GetComparisonIndex() |
||
|
const FNameE... |
GetComparisonNameEntry() |
|
|
GetDisplayIndex() |
||
|
const FNameE... |
GetDisplayNameEntry() |
|
|
FNameEntry c... |
GetEntry ( |
|
|
FNameEntry c... |
GetEntry ( |
|
|
GetNameEntryMemorySize() |
||
|
GetNameTableMemorySize() |
||
|
GetNumAnsiNames() |
||
|
GetNumber() |
||
|
GetNumWideNames() |
||
|
GetPlainANSIString ( |
Copy ANSI name without number part. Must only be used for ANSI FNames. Doesn't allocate. |
|
|
GetPlainNameString ( |
Convert name without number part into TCHAR buffer and returns string length. Doesn't allocate. |
|
|
GetPlainNameString() |
Get name without number part as a dynamically allocated string |
|
|
GetPlainWIDEString ( |
Copy wide name without number part. Must only be used for wide FNames. Doesn't allocate. |
|
|
GetStringLength() |
Get the number of characters, excluding null-terminator, that ToString() would yield |
|
|
IsEqual |
Check to see if this FName matches the other FName, potentially also checking for any case variations |
|
|
IsNone() |
True for FName(), FName(NAME_None) and FName |
|
|
IsValid() |
Paranoid sanity check |
|
|
IsValidGroupName |
Takes an FName and checks to see that it follows the rules that Unreal requires for package or group names. |
|
|
IsValidIndexFast() |
Paranoid sanity check, same as IsValid() |
|
|
IsValidObjectName ( |
Takes an FName and checks to see that it follows the rules that Unreal requires for object names. |
|
|
IsValidXName |
Checks to see that a given name-like string follows the rules that Unreal requires. |
|
|
IsValidXName |
Checks to see that a FName follows the rules that Unreal requires. |
|
|
IsValidXName |
Takes an FName and checks to see that it follows the rules that Unreal requires. |
|
|
LexicalLess ( |
Slow alphabetical order that is stable / deterministic over process runs. |
|
|
NameToDisplayString |
Takes a string and breaks it down into a human readable string. |
|
|
SafeString ( |
||
|
SetNumber ( |
||
|
TearDown() |
Tear down system and free all allocated memory |
|
|
const EName ... |
ToEName() |
Get the EName that this FName represents or nullptr |
|
ToString() |
Converts an FName to a readable format |
|
|
ToString ( |
Converts an FName to a readable format, in place |
|
|
ToString ( |
Converts an FName to a readable format, in place |
|
|
ToString ( |
||
|
ToString |
Convert to string buffer to avoid dynamic allocations and returns string length |
|
|
TryAppendAnsiString ( |
Converts an ANSI FName to a readable format appended to the string builder. |
Name | Description | ||
---|---|---|---|
|
operator!= ( |
Inequality operator. |
|
|
operator!= ( |
||
|
operator!= ( |
||
|
operator== ( |
Equality operator. |
|
|
operator== ( |
||
|
operator== ( |
||
|
operator== ( |
Name |
Description |
---|---|
StringBufferSize |
Buffer size required for any null-terminated FName string, i.e. [name] '_' [digits] '\0' |
Name | Description | ||
---|---|---|---|
|
Default lexi... |
operator< ( |
Please use FastLess() / FNameFastLess or LexicalLess() / FNameLexicalLess instead. |
|
operator> ( |
Please use B.FastLess(A) or B.LexicalLess(A) instead of A > B. |