1. Epic GamesDeveloper
  3. FStructProperty

FStructProperty

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

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/UnrealType.h
Include #include "UObject/UnrealType.h"

Syntax

class FStructProperty : public FProperty

Remarks

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

Variables

  Type Name Description
Public variable TObjectPtr< class UScriptStruct > Struct Variables.

Constructors

  Type Name Description
Public function  

FStructProperty ( UField* InField
)

  
Public function  

FStructProperty ( EInternal InInernal,
FFieldClass* InClass
)

  
Public function  

FStructProperty ( FFieldVariant InOwner,
const UECodeGen_Private::FStructPropertyParams& Prop
)

 Constructor used for constructing compiled in properties
Public function  

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

  

Functions

  Type Name Description
Public function Static FField *

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

  
Public function Const bool

FindInnerPropertyInstance ( FName PropertyName,
const void* Data,
const FProperty*& OutProp,
const void*& OutData
)

  
Public function Static FFieldClass *  
Public function Static uint64  
Public function Static uint64  

Overridden from FProperty

  Type 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 bool Returns true if the type of this property matches the type name.
Public function Virtual Const void Set the value to it's special unset state.
Public function Virtual Const void

ClearValueInternal ( void* Data
)

  
Protected function Virtual Const bool

ContainsClearOnFinishDestroyInternal ( TArray< const FStructProperty* >& EncounteredStructProps
)

  
Public function Virtual Const bool

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

 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 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
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

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.
Public function 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.
Protected function Virtual Const void

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

  
Protected function Virtual Const void

FinishDestroyInternal ( void* Data
)

  
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  
Public function Virtual Const int32  
Public function Virtual Const bool Returns whether this type has a special state for an unset TOptional meaning the size TOptional and T are the same.
Public function Virtual Const bool

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

 Determines whether the property values are identical.
Protected function Virtual Const const TCHAR *

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

  
Public function Virtual Const void Initialize the value at the given address to an unset TOptional using an intrusive state rather than a trailing boolean.
Public function Virtual Const void

InitializeValueInternal ( void* Dest
)

  
Public function Virtual void

InstanceSubobjects ( void* Data,
void const* DefaultData,
UObject* Owner,
FObjectInstancingGraph* InstanceGraph
)

 Creates new copies of components
Public function Virtual Const bool

IsIntrusiveOptionalValueSet ( const void* Data
)

 Returns whether an optional value of this inner type is unset.
Public function Virtual void  
Public function Virtual bool Restores this property and its owned properties from the type name.
Public function Virtual Const bool

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

  
Public function Virtual Const void *

ResolveVisitedPathInfo ( void* Data,
const FPropertyVisitorInfo& Info
)

 Attempt to resolve the given inner path info against this outer property to get the inner property value.
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 Saves the type name of this property and its owned properties.
Public function Virtual Const void

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

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const EPropertyVisitorControlFlow 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.

Overridden from FField

  Type Name Description
Public function Virtual void  
Public function Virtual Const SIZE_T  
Public function Virtual void  
Public function Virtual void

PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field
Public function Virtual void Begin UObject interface: the following functions mimic UObject interface for easier transition from UProperties to FProperties.

Operators

  Type Name Description
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
)

  

Typedefs

Name Description
Super  
ThisClass  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page