Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
FMappedName Class Reference

#include <MappedName.h>

Public Types

enum class  EType { Package , Container , Global }
 

Public Member Functions

 FMappedName ()=default
 
FMinimalName ToUnresolvedMinimalName () const
 
bool IsValid () const
 
EType GetType () const
 
bool IsGlobal () const
 
uint32 GetIndex () const
 
uint32 GetNumber () const
 
bool operator!= (FMappedName Other) const
 
FName ResolveName (TConstArrayView< FDisplayNameEntryId > Names) const
 

Static Public Member Functions

static FMappedName Create (const uint32 InIndex, const uint32 InNumber, EType InType)
 
static FMappedName FromMinimalName (const FMinimalName &MinimalName)
 
static bool IsResolvedToMinimalName (const FMinimalName &MinimalName)
 
static FName SafeMinimalNameToName (const FMinimalName &MinimalName)
 

Private Member Functions

 FMappedName (const uint32 InIndex, const uint32 InNumber)
 

Private Attributes

uint32 Index = InvalidIndex
 
uint32 Number = InvalidIndex
 

Static Private Attributes

static constexpr uint32 InvalidIndex = ~uint32(0)
 
static constexpr uint32 IndexBits = 30u
 
static constexpr uint32 IndexMask = (1u << IndexBits) - 1u
 
static constexpr uint32 TypeMask = ~IndexMask
 
static constexpr uint32 TypeShift = IndexBits
 

Friends

FArchive & operator<< (FArchive &Ar, FMappedName &MappedName)
 

Detailed Description

Index and name number into a name map.

Definition at line 21 of file MappedName.h.

Member Enumeration Documentation

◆ EType

enum class FMappedName::EType
strong
Enumerator
Package 
Container 
Global 

Definition at line 30 of file MappedName.h.

Constructor & Destructor Documentation

◆ FMappedName() [1/2]

FMappedName::FMappedName ( )
inlinedefault

◆ FMappedName() [2/2]

FMappedName::FMappedName ( const uint32 InIndex,
const uint32 InNumber )
inlineprivate

Definition at line 105 of file MappedName.h.

+ Here is the caller graph for this function:

Member Function Documentation

◆ Create()

static FMappedName FMappedName::Create ( const uint32 InIndex,
const uint32 InNumber,
EType InType )
inlinestatic

Definition at line 39 of file MappedName.h.

+ Here is the call graph for this function:

◆ FromMinimalName()

static FMappedName FMappedName::FromMinimalName ( const FMinimalName & MinimalName)
inlinestatic

Definition at line 45 of file MappedName.h.

+ Here is the caller graph for this function:

◆ GetIndex()

uint32 FMappedName::GetIndex ( ) const
inline

Definition at line 82 of file MappedName.h.

+ Here is the caller graph for this function:

◆ GetNumber()

uint32 FMappedName::GetNumber ( ) const
inline

Definition at line 87 of file MappedName.h.

◆ GetType()

EType FMappedName::GetType ( ) const
inline

Definition at line 72 of file MappedName.h.

◆ IsGlobal()

bool FMappedName::IsGlobal ( ) const
inline

Definition at line 77 of file MappedName.h.

◆ IsResolvedToMinimalName()

static bool FMappedName::IsResolvedToMinimalName ( const FMinimalName & MinimalName)
inlinestatic

Definition at line 50 of file MappedName.h.

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

◆ IsValid()

bool FMappedName::IsValid ( ) const
inline

Definition at line 67 of file MappedName.h.

+ Here is the caller graph for this function:

◆ operator!=()

bool FMappedName::operator!= ( FMappedName Other) const
inline

Definition at line 92 of file MappedName.h.

◆ ResolveName()

FName FMappedName::ResolveName ( TConstArrayView< FDisplayNameEntryId > Names) const
inline

Definition at line 97 of file MappedName.h.

◆ SafeMinimalNameToName()

static FName FMappedName::SafeMinimalNameToName ( const FMinimalName & MinimalName)
inlinestatic

Definition at line 57 of file MappedName.h.

+ Here is the call graph for this function:

◆ ToUnresolvedMinimalName()

FMinimalName FMappedName::ToUnresolvedMinimalName ( ) const
inline

Definition at line 62 of file MappedName.h.

Friends And Related Symbol Documentation

◆ operator<<

FArchive & operator<< ( FArchive & Ar,
FMappedName & MappedName )
friend

Member Data Documentation

◆ Index

uint32 FMappedName::Index = InvalidIndex
private

Definition at line 109 of file MappedName.h.

◆ IndexBits

constexpr uint32 FMappedName::IndexBits = 30u
staticconstexprprivate

Definition at line 24 of file MappedName.h.

◆ IndexMask

constexpr uint32 FMappedName::IndexMask = (1u << IndexBits) - 1u
staticconstexprprivate

Definition at line 25 of file MappedName.h.

◆ InvalidIndex

constexpr uint32 FMappedName::InvalidIndex = ~uint32(0)
staticconstexprprivate

Definition at line 23 of file MappedName.h.

◆ Number

uint32 FMappedName::Number = InvalidIndex
private

Definition at line 110 of file MappedName.h.

◆ TypeMask

constexpr uint32 FMappedName::TypeMask = ~IndexMask
staticconstexprprivate

Definition at line 26 of file MappedName.h.

◆ TypeShift

constexpr uint32 FMappedName::TypeShift = IndexBits
staticconstexprprivate

Definition at line 27 of file MappedName.h.

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