FMapProperty

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FProperty

TProperty

FMapProperty

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h

Include

#include "UObject/UnrealType.h"

Syntax

class FMapProperty :
    public FProperty,
    public TProperty< FScriptMap, FProperty >

Variables

Name Description

Public variable

FProperty *

 

KeyProp

Properties representing the key type and value type of the contained pairs.

Public variable

EMapPropertyFla...

 

MapFlags

Public variable

FScriptMapLayou...

 

MapLayout

Public variable

FProperty *

 

ValueProp

Constructors

Name Description

Public function

FMapProperty

(
    UField* InField
)

Public function

FMapProperty

(
    const FObjectInitializer& ObjectIn...
)

Public function

FMapProperty

(
    FVTableHelper& Helper
)

DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

Public function

FMapProperty

(
    EInternal InInernal,
    FFieldClass* InClass
)

Public function

FMapProperty

(
    FFieldVariant InOwner,
    const FName& InName,
    EObjectFlags InObjectFlags,
    EMapPropertyFlags InMapFlags
)

Public function

FMapProperty

(
    const FObjectInitializer& ObjectIn...,
    ECppProperty,
    int32 InOffset,
    EPropertyFlags InFlags
)

Public function

FMapProperty

(
    FFieldVariant InOwner,
    const FName& InName,
    EObjectFlags InObjectFlags,
    int32 InOffset,
    EPropertyFlags InFlags,
    EMapPropertyFlags InMapFlags
)

Destructors

Name Description

Public function Virtual

~FMapProperty()

Functions

Name Description

Public function Static

void

 

__DefaultConstructor

(
    const FObjectInitializer& X
)

Public function Static

UObject *...

 

__VTableCtorCaller

(
    FVTableHelper& Helper
)

Public function Static

void

 

AddReferencedObjects

(
    UObject* InThis,
    FReferenceCollector& Collector
)

Public function Static

FField *

 

Construct

(
    const FFieldVariant& InOwner,
    const FName& InName,
    EObjectFlags InObjectFlags
)

Public function Const

FString

 

GetCPPTypeCustom

(
    FString* ExtendedTypeText,
    uint32 CPPExportFlags,
    const FString& KeyTypeText,
    const FString& InKeyExtendedTypeTe...,
    const FString& ValueTypeText,
    const FString& InValueExtendedType...
)

Public function Const

const FPrope...

 

GetKeyProperty()

Public function Const

int32

 

GetNum

(
    void* InMap
)

Helper function to get the number of key/value pairs inside of a map.

Public function Const

uint8 *

 

GetPairPtr

(
    void* InMap,
    int32 Index
)

Helper function to get the pointer to a key/value pair at the specified index.

Public function Const

int32

 

GetPairStride()

Helper function to get the sizeof of the map's key/value pair. Used by the garbage collector.

Public function Const

const FPrope...

 

GetValueProperty()

Public function Const

bool

 

IsValidIndex

(
    void* InMap,
    int32 Index
)

Helper function to check if the specified index of a key/value pair in the underlying set is valid.

Public function Static

UClass *

 

StaticClass()

Returns a UClass object representing this class at runtime

Public function Static

FFieldClass ...

 

StaticClass()

Public function Static

EClassCastFl...

 

StaticClassCastFlags()

Returns the static cast flags for this class

Public function Static

uint64

 

StaticClassCastFlags()

Public function Static

uint64

 

StaticClassCastFlagsPrivate()

Public function Static

const TCHAR ...

 

StaticPackage()

Returns the package this class belongs in

Public function Static

void

 

StaticRegisterNativesFMapProperty()

Public function Const

auto

 

WithScriptMap

(
    void* InMap,
    CallableType&& Callable
)

Overridden from FProperty

Name Description

Public function Virtual Const

void

 

AppendSchemaHash

(
    FBlake3& Builder,
    bool bSkipEditorOnly
)

Updates the given HashBuilder with name and type information of this Property.

Public function Virtual Const

void

 

ClearValueInternal

(
    void* Data
)

Public function Virtual Const

bool

 

ContainsObjectReference

(
    TArray< const FStructProperty*...,
    EPropertyObjectReferenceType InRefe...
)

Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a UObject reference.

Public function Virtual

EConvertFrom...

 

ConvertFromType

(
    const FPropertyTag& Tag,
    FStructuredArchive::FSlot Slot,
    uint8* Data,
    UStruct* DefaultsStruct
)

Allows a property to implement backwards compatibility handling for tagged properties

Public function Virtual Const

void

 

CopyValuesInternal

(
    void* Dest,
    void const* Src,
    int32 Count
)

Public function Virtual Const

void

 

DestroyValueInternal

(
    void* Dest
)

Public function Virtual

void

 

EmitReferenceInfo

(
    UClass& OwnerClass,
    int32 BaseOffset,
    TArray< const FStructProperty*...,
    FGCStackSizeHelper& StackSizeHelpe...
)

Emits tokens used by realtime garbage collection code to passed in OwnerClass' ReferenceTokenStream.

Public function Virtual Const

void

 

ExportTextItem

(
    FString& ValueStr,
    const void* PropertyValue,
    const void* DefaultValue,
    UObject* Parent,
    int32 PortFlags,
    UObject* ExportRootScope
)

Public function Virtual Const

FString

 

GetCPPMacroType

(
    FString& ExtendedTypeText
)

Public function Virtual Const

FString

 

GetCPPType

(
    FString* ExtendedTypeText,
    uint32 CPPExportFlags
)

Returns the text to use for exporting this property to header file.

Public function Virtual Const

FString

 

GetCPPTypeForwardDeclaration()

Public function Virtual Const

bool

 

Identical

(
    const void* A,
    const void* B,
    uint32 PortFlags
)

Determines whether the property values are identical.

Public function Virtual Const

const TCHAR ...

 

ImportText_Internal

(
    const TCHAR* Buffer,
    void* Data,
    int32 PortFlags,
    UObject* OwnerObject,
    FOutputDevice* ErrorText
)

Public function Virtual Const

void

 

InitializeValueInternal

(
    void* Dest
)

Public function Virtual

void

 

InstanceSubobjects

(
    void* Data,
    void const* DefaultData,
    UObject* Owner,
    FObjectInstancingGraph* Instan...
)

Creates new copies of components

Public function Virtual

void

 

LinkInternal

(
    FArchive& Ar
)

Public function Virtual Const

bool

 

NetSerializeItem

(
    FArchive& Ar,
    UPackageMap* Map,
    void* Data,
    TArray< uint8 >* MetaData
)

Public function Virtual Const

bool

 

PassCPPArgsByRef()

Public function Virtual Const

bool

 

SameType

(
    const FProperty* Other
)

Returns true, if Other is property of exactly the same type

Public function Virtual Const

void

 

SerializeItem

(
    FStructuredArchive::FSlot Slot,
    void* Value,
    void const* Defaults
)

Overridden from UField

Name Description

Public function Virtual

void

 

AddCppProperty

(
    FProperty* Property
)

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Overridden from FField

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Public function Virtual

FField *

 

GetInnerFieldByName

(
    const FName& InName
)

Returns an inner field by name if the field has any

Public function Virtual

void

 

GetInnerFields

(
    TArray< FField* >& OutFields
)

Fills the provided array with all inner fields this field owns (recursively)

Public function Virtual

void

 

GetPreloadDependencies

(
    TArray< UObject* >& OutDeps
)

Public function Virtual

void

 

PostDuplicate

(
    const FField& InField
)

Fixups after duplicating a Field

Operators

Name Description

Public function

void

 

operator delete

(
    void* InMem
)

Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy.

Public function

void

 

operator delete

(
    void* InMem
)

Public function

void *

 

operator new

(
    const size_t InSize
)

Public function

void *

 

operator new

(
    const size_t InSize,
    void* InMem
)

Public function

void *

 

operator new

(
    const size_t InSize,
    EInternal* InMem
)

For internal use only; use StaticConstructObject() to create new objects.

Public function

void *

 

operator new

(
    const size_t InSize,
    EInternal InInternalOnly,
    UObject* InOuter,
    FName InName,
    EObjectFlags InSetFlags
)

For internal use only; use StaticConstructObject() to create new objects.

Typedefs

Name

Description

Super

Typedef for the base class (FProperty)

Super

TCppType

ThisClass

Typedef for FMapProperty.

ThisClass

TTypeFundamentals

Constants

Name

Description

StaticClassFlags

Bitwise union of EClassFlags pertaining to this class.