1. Epic GamesDeveloper
  3. FOptionalProperty

FOptionalProperty

A property corresponding to UE's optional type, TOptional.

API > API/Runtime > API/Runtime/CoreUObject

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.

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

Syntax

class FOptionalProperty :  
    public FProperty ,  
    public FOptionalPropertyLayout

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

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

   UObject/PropertyOptional.h  

FOptionalProperty ( FFieldVariant InOwner,
const UECodeGen_Private::FGenericPropertyParams& Prop
)

   UObject/PropertyOptional.h  

FOptionalProperty ( EInternal InInernal,
FFieldClass* InClass
)

   UObject/PropertyOptional.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FOptionalProperty()

   UObject/PropertyOptional.h  

Typedefs

Name Type Remarks Include Path
Super FProperty   UObject/PropertyOptional.h
ThisClass FOptionalProperty   UObject/PropertyOptional.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SetValueProperty ( FProperty* InValueProperty
)

 Sets the optional property's value property. UObject/PropertyOptional.h  

Overridden from FProperty

Name Remarks Include Path Unreal Specifiers

virtual bool CanSerializeFromTypeName ( UE::FPropertyTypeName Type
) const

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

virtual void ClearValueInternal ( void* Data
) const

   UObject/PropertyOptional.h  

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

   UObject/PropertyOptional.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/PropertyOptional.h  

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

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

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

   UObject/PropertyOptional.h  

virtual void DestroyValueInternal ( void* Data
) const

   UObject/PropertyOptional.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/PropertyOptional.h  

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

   UObject/PropertyOptional.h  

virtual void FinishDestroyInternal ( void* Data
) const

   UObject/PropertyOptional.h  

virtual FString GetCPPMacroType ( FString& ExtendedTypeText
) const

   UObject/PropertyOptional.h  

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

 Returns the text to use for exporting this property to header file. UObject/PropertyOptional.h  

virtual int32 GetMinAlignment()

   UObject/PropertyOptional.h  

virtual uint32 GetValueTypeHashInternal ( const void* Src
) const

   UObject/PropertyOptional.h  
Returns whether this type has a special state for an unset TOptional meaning the size TOptional and T are the same. UObject/PropertyOptional.h  

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

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

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

   UObject/PropertyOptional.h  

virtual void InitializeValueInternal ( void* Data
) const

   UObject/PropertyOptional.h  

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

 Creates new copies of components UObject/PropertyOptional.h  

virtual void LinkInternal ( FArchive& Ar
)

   UObject/PropertyOptional.h  

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

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

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

   UObject/PropertyOptional.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/PropertyOptional.h  

virtual bool SameType ( const FProperty* Other
) const

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

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

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

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

   UObject/PropertyOptional.h  

virtual bool SupportsNetSharedSerialization()

   UObject/PropertyOptional.h  

virtual bool UseBinaryOrNativeSerialization ( const FArchive& Ar
) const

   UObject/PropertyOptional.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/PropertyOptional.h  

Overridden from FField

Name Remarks Include Path Unreal Specifiers

virtual void AddCppProperty ( FProperty* Property
)

   UObject/PropertyOptional.h  

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   UObject/PropertyOptional.h  

virtual SIZE_T GetFieldSize()

   UObject/PropertyOptional.h  

virtual FField * GetInnerFieldByName ( const FName& InName
)

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

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

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

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

   UObject/PropertyOptional.h  

virtual void PostDuplicate ( const FField& InField
)

 Fixups after duplicating a Field UObject/PropertyOptional.h  

virtual void Serialize ( FArchive& Ar
)

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

Static

Name Remarks Include Path Unreal Specifiers

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

   UObject/PropertyOptional.h  

static UE_API FFieldClass * StaticClass()

   UObject/PropertyOptional.h  

static EClassCastFlags StaticClassCastFlags()

   UObject/PropertyOptional.h  

static EClassCastFlags StaticClassCastFlagsPrivate()

   UObject/PropertyOptional.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator delete ( void* InMem
)

   UObject/PropertyOptional.h  

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

   UObject/PropertyOptional.h  

void * operator new ( const size_t InSize
)

   UObject/PropertyOptional.h  
  UObject/PropertyOptional.h  
  UObject/PropertyOptional.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page