1. Epic GamesDeveloper
  3. FOptionalProperty

FOptionalProperty

A property corresponding to UE's optional type, [TOptional](API\Runtime\Core\IO\TOptional).

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

Inheritance Hierarchy

References

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

Syntax

class FOptionalProperty :  
    public FProperty,  
    public FOptionalPropertyLayout

Remarks

A property corresponding to UE's optional type, TOptional. NOTE: this property is not yet handled by all UE subsystems that produce or consume properties.

Constructors

  Type Name Description
Public function  

FOptionalProperty ( EInternal InInernal,
FFieldClass* InClass
)

  
Public function  

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

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static FField *

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

  
Public function void

SetValueProperty ( FProperty* InValueProperty
)

 Sets the optional property's value property.
Public function Static FFieldClass *  
Public function Static constexpr uint64  
Public function Static constexpr uint64  

Overridden from FProperty

  Type Name Description
Public function Virtual Const void

ClearValueInternal ( void* Data
)

  
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* Data
)

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

ExportText_Internal ( FString& ValueStr,
const void* ContainerOrPropertyPtr,
EPropertyPointerType PropertyPointerType,
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  
Public function Virtual Const int32  
Public function Virtual Const uint32

GetValueTypeHashInternal ( const void* Src
)

  
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* ContainerOrPropertyPtr,
EPropertyPointerType PointerType,
UObject* OwnerObject,
int32 PortFlags,
FOutputDevice* ErrorText
)

  
Public function Virtual Const void

InitializeValueInternal ( void* Data
)

  
Public function Virtual void

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

 Creates new copies of components
Public function Virtual void  
Public function Virtual Const bool

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

  
Public function Virtual Const void

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

  

Overridden from FField

  Type Name Description
Public function Virtual void  
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  
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