1. Epic GamesDeveloper
  3. FMapProperty

FMapProperty

API > API/Runtime > API/Runtime/CoreUObject

   
Name FMapProperty
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h
Include Path #include "UObject/UnrealType.h"

Syntax

class FMapProperty : public TProperty< FScriptMap, FProperty >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMapProperty ( UField* InField
)

   UObject/UnrealType.h  

FMapProperty ( FFieldVariant InOwner,
const UECodeGen_Private::FMapPropertyParams& Prop
)

 Constructor used for constructing compiled in properties UObject/UnrealType.h  

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

   UObject/UnrealType.h  

FMapProperty ( EInternal InInernal,
FFieldClass* InClass
)

   UObject/UnrealType.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMapProperty()

   UObject/UnrealType.h  

Typedefs

Name Type Remarks Include Path
Super TProperty< FScriptMap, FProperty >   UObject/UnrealType.h
TCppType TTypeFundamentals::TCppType   UObject/UnrealType.h
ThisClass FMapProperty   UObject/UnrealType.h
TTypeFundamentals Super::TTypeFundamentals   UObject/UnrealType.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
KeyProp FProperty * Properties representing the key type and value type of the contained pairs. UObject/UnrealType.h  
MapFlags EMapPropertyFlags   UObject/UnrealType.h  
MapLayout FScriptMapLayout   UObject/UnrealType.h  
ValueProp FProperty *   UObject/UnrealType.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddCppProperty ( FProperty* Property
)

   UObject/UnrealType.h  

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   UObject/UnrealType.h  

virtual void AppendSchemaHash ( FBlake3& Builder,
bool bSkipEditorOnly
) const

 Updates the given HashBuilder with name and type information of this Property. UObject/UnrealType.h  

virtual bool CanSerializeFromTypeName ( UE::FPropertyTypeName Type
) const

 Returns true if the type of this property matches the type name. UObject/UnrealType.h  

virtual bool ContainsObjectReference ( TArray< const FStructProperty* >& EncounteredStructProps,
EPropertyObjectReferenceType InReferenceType
) const

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

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

 Allows a property to implement backwards compatibility handling for tagged properties UObject/UnrealType.h  

virtual void EmitIntrusiveOptionalReferenceInfo ( UE::GC::FSchemaBuilder& Schema,
int32 BaseOffset,
TArray< const FStructProperty* >& EncounteredStructProps,
UE::GC::FPropertyStack& DebugPath
)

 For properties returning true from HasIntrusiveUnsetOptionalState which also contain object references, emit information for the garbage collector to safely gather the references from the value whether the optional value is set or unset. UObject/UnrealType.h  

virtual void EmitReferenceInfo ( UE::GC::FSchemaBuilder& Schema,
int32 BaseOffset,
TArray< const FStructProperty* >& EncounteredStructProps,
UE::GC::FPropertyStack& DebugPath
)

 Emits tokens used by realtime garbage collection code to passed in ReferenceTokenStream. UObject/UnrealType.h  

virtual FString GetCPPMacroType ( FString& ExtendedTypeText
) const

   UObject/UnrealType.h  

FString GetCPPTypeCustom ( FString* ExtendedTypeText,
uint32 CPPExportFlags,
const FString& KeyTypeText,
const FString& InKeyExtendedTypeText,
const FString& ValueTypeText,
const FString& InValueExtendedTypeText
) const

   UObject/UnrealType.h  

virtual SIZE_T GetFieldSize()

   UObject/UnrealType.h  

virtual FField * GetInnerFieldByName ( const FName& InName
)

 Returns an inner field by name if the field has any UObject/UnrealType.h  

virtual void GetInnerFields ( TArray< FField* >& OutFields
)

 Fills the provided array with all inner fields this field owns (recursively) UObject/UnrealType.h  

const FProperty * GetKeyProperty()

   UObject/UnrealType.h  

int32 GetNum ( void* InMap
) const

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

uint8 * GetPairPtr ( void* InMap,
int32 InternalIndex
) const

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

int32 GetPairStride()

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

virtual void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   UObject/UnrealType.h  

virtual void * GetValueAddressAtIndex_Direct ( const FProperty* Inner,
void* InValueAddress,
int32 Index
) const

 Gets value address at given index inside of a static array or container UObject/UnrealType.h  

const FProperty * GetValueProperty()

   UObject/UnrealType.h  

virtual bool Identical ( const void* A,
const void* B,
uint32 PortFlags
) const

 Determines whether the property values are identical. UObject/UnrealType.h  

virtual void InstanceSubobjects ( void* Data,
void const* DefaultData,
TNotNull< UObject* > Owner,
FObjectInstancingGraph* InstanceGraph
)

 Creates new copies of components UObject/UnrealType.h  

bool IsValidIndex ( void* InMap,
int32 InternalIndex
) const

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

virtual bool LoadTypeName ( UE::FPropertyTypeName Type,
const FPropertyTag* Tag
)

 Restores this property and its owned properties from the type name. UObject/UnrealType.h  

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

   UObject/UnrealType.h  

virtual void PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field UObject/UnrealType.h  

virtual void * ResolveVisitedPathInfo ( void* Data,
const FPropertyVisitorInfo& Info
) const

 Attempt to resolve the given inner path info against this outer property to get the inner property value. UObject/UnrealType.h  

virtual bool SameType ( const FProperty* Other
) const

 Returns true, if Other is property of exactly the same type UObject/UnrealType.h  

virtual void SaveTypeName ( UE::FPropertyTypeNameBuilder& Type
) const

 Saves the type name of this property and its owned properties. UObject/UnrealType.h  

virtual void Serialize ( FArchive& Ar
)

 Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties. UObject/UnrealType.h  

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

   UObject/UnrealType.h  

virtual bool UseBinaryOrNativeSerialization ( const FArchive& Ar
) const

   UObject/UnrealType.h  
Visits this property and allows recursion into the inner properties This method allows callers to visit inner properties without knowing about its container type as opposed to TPropertyIterator. UObject/UnrealType.h  

auto WithScriptMap ( void* InMap,
CallableType&& Callable
) const

   UObject/UnrealType.h  

Overridden from TProperty

Name Remarks Include Path Unreal Specifiers

virtual void ClearIntrusiveOptionalValue ( void* Data
) const

 Set the value to it's special unset state. UObject/UnrealType.h  

virtual void ClearValueInternal ( void* Data
) const

   UObject/UnrealType.h  

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

   UObject/UnrealType.h  

virtual void DestroyValueInternal ( void* Dest
) const

   UObject/UnrealType.h  

virtual FString GetCPPType ( FString* ExtendedTypeText,
uint32 CPPExportFlags
) const

 Returns the text to use for exporting this property to header file. UObject/UnrealType.h  
Returns whether this type has a special state for an unset TOptional meaning the size TOptional and T are the same. UObject/UnrealType.h  

virtual void InitializeIntrusiveUnsetOptionalValue ( void* Data
) const

 Initialize the value at the given address to an unset TOptional using an intrusive state rather than a trailing boolean. UObject/UnrealType.h  

virtual void InitializeValueInternal ( void* Dest
) const

   UObject/UnrealType.h  

virtual bool IsIntrusiveOptionalValueSet ( const void* Data
) const

 Returns whether an optional value of this inner type is unset. UObject/UnrealType.h  

virtual void LinkInternal ( FArchive& Ar
)

   UObject/UnrealType.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool ContainsClearOnFinishDestroyInternal ( TArray< const FStructProperty* >& EncounteredStructProps
) const

   UObject/UnrealType.h  

virtual void ExportText_Internal ( FString& ValueStr,
const void* PropertyValueOrContainer,
EPropertyPointerType PropertyPointerType,
const void* DefaultValue,
UObject* Parent,
int32 PortFlags,
UObject* ExportRootScope
) const

   UObject/UnrealType.h  

virtual void FinishDestroyInternal ( void* Data
) const

   UObject/UnrealType.h  

virtual const TCHAR * ImportText_Internal ( const TCHAR* Buffer,
void* ContainerOrPropertyPtr,
EPropertyPointerType PropertyPointerType,
UObject* OwnerObject,
int32 PortFlags,
FOutputDevice* ErrorText
) const

   UObject/UnrealType.h  

Static

Name Remarks Include Path Unreal Specifiers

static UE_API FField * Construct ( const FFieldVariant& InOwner,
const FName& InName,
EObjectFlags InObjectFlags
)

   UObject/UnrealType.h  

static UE_API FFieldClass * StaticClass()

   UObject/UnrealType.h  

static uint64 StaticClassCastFlags()

   UObject/UnrealType.h  

static uint64 StaticClassCastFlagsPrivate()

   UObject/UnrealType.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator delete ( void* InMem
)

   UObject/UnrealType.h  

void * operator new ( const size_t InSize,
void* InMem
)

   UObject/UnrealType.h  

void * operator new ( const size_t InSize
)

   UObject/UnrealType.h  
  UObject/UnrealType.h  
  UObject/UnrealType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page