FStructProperty

Describes a structure variable embedded in (as opposed to referenced by) an object.

Windows
MacOS
Linux

Inheritance Hierarchy

FProperty

FProperty

FStructProperty

References

Module

CoreUObject

Header

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

Include

#include "UObject/UnrealType.h"

Syntax

class FStructProperty :
    public FProperty ,
    public FProperty

Remarks

Describes a structure variable embedded in (as opposed to referenced by) an object.

Variables

Name Description

Public variable

UScriptStruct &...

 

Struct

Variables.

Constructors

Name Description

Public function

FStructProperty

(
    UField * InField
)

Public function

FStructProperty

(
    const FObjectInitializer & ObjectIn...
)

Public function

FStructProperty

(
    FVTableHelper & Helper
)

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

Public function

FStructProperty

(
    EInternal InInernal,
    FFieldClass * InClass
)

Public function

FStructProperty

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

Public function

FStructProperty

(
    ECppProperty ,
    int32 InOffset,
    EPropertyFlags InFlags,
    UScriptStruct * InStruct
)

Public function

FStructProperty

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

Public function

FStructProperty

(
    FFieldVariant InOwner,
    const FName & InName,
    EObjectFlags InObjectFlags,
    int32 InOffset,
    EPropertyFlags InFlags,
    UScriptStruct * InStruct
)

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 Static

FFieldClass ...

 

StaticClass()

Public function Static

UClass *

 

StaticClass()

Returns a UClass object representing this class at runtime

Public function Static

uint64

 

StaticClassCastFlags()

Public function Static

EClassCastFl ...

 

StaticClassCastFlags()

Returns the static cast flags for this class

Public function Static

uint64

 

StaticClassCastFlagsPrivate()

Public function Static

const TCHAR ...

 

StaticPackage()

Returns the package this class belongs in

Public function Static

void

 

StaticRegisterNativesFStructProperty()

Public function Const

bool

 

UseBinaryOrNativeSerialization

(
    const FArchive & Ar
)

Overridden from FProperty

Name Description

Public function Virtual Const

void

 

ClearValueInternal

(
    void * Data
)

Public function Virtual Const

bool

 

ContainsObjectReference

(
    TArray < const FStructProperty *...
)

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 Const

bool

 

ContainsWeakObjectReference()

Returns true if this property, or in the case of e.g. array or struct properties any sub- property, contains a weak 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 *...
)

Emits tokens used by realtime garbage collection code to passed in 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

int32

 

GetMinAlignment()

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

 

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
)

Public function Virtual Const

bool

 

SupportsNetSharedSerialization()

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

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
)

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.

Public function

void *

 

operator new

(
    const size_t InSize
)

Typedefs

Name

Description

Super

Super

Typedef for the base class (FProperty )

ThisClass

Typedef for FStructProperty .

ThisClass

Constants

Name

Description

StaticClassFlags

Bitwise union of EClassFlags pertaining to this class.

Deprecated Functions

Name Description

Public function Static

void

 

ExportTextItem_Static

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

Use UScriptStruct::ExportText instead

Public function Static

const TCHAR ...

 

ImportText_Static

(
    UScriptStruct * InStruct,
    const FString & InName,
    const TCHAR * Buffer,
    void * Data,
    int32 PortFlags,
    UObject * OwnerObject,
    FOutputDevice * ErrorText
)

Use UScriptStruct::ImportText instead

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback