Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FScriptName Struct Reference

#include <NameTypes.h>

+ Collaboration diagram for FScriptName:

Public Member Functions

 FScriptName ()
 
 FScriptName (EName Ename)
 
FORCEINLINE FScriptName (const FName &Name)
 
FORCEINLINE bool IsNone () const
 
bool operator== (EName Name)
 
FString ToString () const
 

Public Attributes

friend FName
 

Private Attributes

FNameEntryId ComparisonIndex
 
FNameEntryId DisplayIndex
 
uint32 Number = NAME_NO_NUMBER_INTERNAL
 

Friends

FORCEINLINE bool operator== (FScriptName Lhs, FScriptName Rhs)
 
FORCEINLINE uint32 GetTypeHash (FScriptName Name)
 
FORCEINLINE bool operator!= (FScriptName Lhs, FScriptName Rhs)
 
FORCEINLINE bool operator== (FName Lhs, FScriptName Rhs)
 

Detailed Description

The full amount of data required to reconstruct a case-preserving name This will be the maximum size of an FName across all values of WITH_CASE_PRESERVING_NAME and UE_FNAME_OUTLINE_NUMBER and is used to store an FName in cases where the size of a name must be constant between build configurations (eg, blueprint bytecode) the layout is not guaranteed to be the same as FName even if the size is the same, so memory cannot be reinterpreted between the two. The layout here must be as expected by FScriptBytecodeWriter and XFER_NAME

Definition at line 466 of file NameTypes.h.

Constructor & Destructor Documentation

◆ FScriptName() [1/3]

FScriptName::FScriptName ( )
inline

Definition at line 470 of file NameTypes.h.

◆ FScriptName() [2/3]

FScriptName::FScriptName ( EName Ename)
inline

Definition at line 472 of file NameTypes.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FScriptName() [3/3]

FORCEINLINE FScriptName::FScriptName ( const FName & Name)
explicit

Definition at line 1598 of file NameTypes.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Function Documentation

◆ IsNone()

FORCEINLINE bool FScriptName::IsNone ( ) const

Definition at line 1626 of file NameTypes.h.

+ Here is the call graph for this function:

◆ operator==()

bool FScriptName::operator== ( EName Name)
inline

Definition at line 480 of file NameTypes.h.

+ Here is the call graph for this function:

◆ ToString()

FString FScriptName::ToString ( ) const

Friends And Related Symbol Documentation

◆ GetTypeHash

FORCEINLINE uint32 GetTypeHash ( FScriptName Name)
friend

Definition at line 512 of file NameTypes.h.

◆ operator!=

FORCEINLINE bool operator!= ( FScriptName Lhs,
FScriptName Rhs )
friend

Definition at line 517 of file NameTypes.h.

◆ operator== [1/2]

FORCEINLINE bool operator== ( FName Lhs,
FScriptName Rhs )
friend

◆ operator== [2/2]

Definition at line 508 of file NameTypes.h.

Member Data Documentation

◆ ComparisonIndex

FNameEntryId FScriptName::ComparisonIndex
private

Encoded address of name entry (used to find String portion of the string/number pair used for comparison)

Definition at line 487 of file NameTypes.h.

◆ DisplayIndex

FNameEntryId FScriptName::DisplayIndex
private

Encoded address of name entry (used to find String portion of the string/number pair used for display)

Definition at line 489 of file NameTypes.h.

◆ FName

friend FScriptName::FName

Definition at line 468 of file NameTypes.h.

◆ Number

uint32 FScriptName::Number = NAME_NO_NUMBER_INTERNAL
private

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)

Definition at line 494 of file NameTypes.h.


The documentation for this struct was generated from the following file: