1. Epic GamesDeveloper
  3. FObjectPropertyBase

FObjectPropertyBase

Describes a reference variable to another object which may be nil.

Unreal Engine C++ API Reference > Runtime > CoreUObject > UObject

Inheritance Hierarchy

References

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

Syntax

class FObjectPropertyBase : public FProperty

Remarks

Describes a reference variable to another object which may be nil.

Variables

  Type Name Description
Public variable TObjectPtr< class UClass > PropertyClass Variables.

Constructors

  Type Name Description
Public function    
Public function  

FObjectPropertyBase ( EInternal InInernal,
FFieldClass* InClass
)

  
Public function  

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

  
Public function  

FObjectPropertyBase ( FFieldVariant InOwner,
const UECodeGen_Private::FObjectPropertyParams& Prop,
EPropertyFlags AdditionalPropertyFlags
)

 Constructor used for constructing compiled-in properties
Public function  

FObjectPropertyBase ( FFieldVariant InOwner,
const UECodeGen_Private::FObjectPropertyParamsWithoutClass& Prop,
EPropertyFlags AdditionalPropertyFlags
)

  

Functions

  Type Name Description
Protected function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const void

CheckValidObject ( void* ValueAddress,
TObjectPtr< UObject > OldValue
)

  
Public function Static FField *

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

  
Protected function Const UObject * Constructs a new object if the existing one is missing or is not compatible with the property class Used for making sure non-nullable properties have valid values.
Public function Static TObjectPtr< UObject >

FindImportedObject ( const FProperty* Property,
UObject* OwnerObject,
UClass* ObjectClass,
UClass* RequiredMetaClass,
const TCHAR* Text,
uint32 PortFlags,
FUObjectSerializeContext* InSerializeContext,
bool bAllowAnyPackage
)

  
Public function Virtual Const FString

GetCPPTypeCustom ( FString* ExtendedTypeText,
uint32 CPPExportFlags,
const FString& InnerNativeTypeName
)

  
Public function Static FString

GetExportPath ( FTopLevelAssetPath ClassPathName,
const FString& ObjectPathName
)

 Returns the qualified export path given a class path name and object path name
Public function Static FString

GetExportPath ( const TObjectPtr< const UObject >& Object,
const UObject* Parent,
const UObject* ExportRootScope,
const uint32 PortFlags
)

 Returns the qualified export path for a given object, parent, and export root scope
Public function Virtual Const UObject *

GetObjectPropertyValue ( const void* PropertyValueAddress
)

  
Public function Virtual Const UObject *

GetObjectPropertyValue_InContainer ( const void* ContainerAddress,
int32 ArrayIndex
)

  
Public function Virtual Const TObjectPtr< UObject >

GetObjectPtrPropertyValue ( const void* PropertyValueAddress
)

  
Public function Virtual Const TObjectPtr< UObject >

GetObjectPtrPropertyValue_InContainer ( const void* ContainerAddress,
int32 ArrayIndex
)

  
Protected function Const PRAGMA_DISABLE_BUFFER_OVERRUN_WARNING void

GetWrappedUObjectPtrValues ( OutType* OutObjects,
const void* SrcAddress,
EPropertyMemoryAccess SrcAccess,
int32 ArrayIndex,
int32 ArrayCount
)

 Disable false positive buffer overrun warning during pgoprofile linking step.
Public function Virtual Const UObject *

LoadObjectPropertyValue ( const void* PropertyValueAddress
)

  
Public function Const UObject *

LoadObjectPropertyValue_InContainer ( const void* PropertyValueAddress,
int32 ArrayIndex
)

  
Public function Static bool

ParseObjectPropertyValue ( const FProperty* Property,
UObject* OwnerObject,
UClass* RequiredMetaClass,
uint32 PortFlags,
const TCHAR*& Buffer,
TObjectPtr< UObject >& out_ResolvedValue,
FUObjectSerializeContext* InSerializeContext,
bool bAllowAnyPackage
)

 Parses a text buffer into an object reference.Parses a text buffer into an object reference.
Public function Const void

SetObjectPropertyValue ( void* PropertyValueAddress,
UObject* Value
)

  
Public function Const void

SetObjectPropertyValue_InContainer ( void* ContainerAddress,
UObject* Value,
int32 ArrayIndex
)

  
Protected function Virtual Const void

SetObjectPropertyValueUnchecked ( void* PropertyValueAddress,
UObject* Value
)

  
Protected function Virtual Const void

SetObjectPropertyValueUnchecked_InContainer ( void* ContainerAddress,
UObject* Value,
int32 ArrayIndex
)

  
Public function Const void

SetObjectPtrPropertyValue ( void* PropertyValueAddress,
TObjectPtr< UObject > Ptr
)

  
Public function Const void

SetObjectPtrPropertyValue_InContainer ( void* ContainerAddress,
TObjectPtr< UObject > Ptr,
int32 ArrayIndex
)

  
Protected function Virtual Const void

SetObjectPtrPropertyValueUnchecked ( void* PropertyValueAddress,
TObjectPtr< UObject > Ptr
)

  
Protected function Virtual Const void

SetObjectPtrPropertyValueUnchecked_InContainer ( void* ContainerAddress,
TObjectPtr< UObject > Ptr,
int32 ArrayIndex
)

  
Public function void

SetPropertyClass ( UClass* NewPropertyClass
)

 Setter function for this property's PropertyClass member.
Protected function Const PRAGMA_ENABLE_BUFFER_OVERRUN_WARNING void

SetWrappedUObjectPtrValues ( void* DestAddress,
EPropertyMemoryAccess DestAccess,
ValueType* InValues,
int32 ArrayIndex,
int32 ArrayCount
)

 Enable back buffer overrun warning.
Public function Static FFieldClass *  
Public function Static uint64  
Public function Static uint64  
Public function Static bool

StaticIdentical ( UObject* A,
UObject* B,
uint32 PortFlags
)

 Helper method for sharing code with FObjectPtrProperty even though one doesn't inherit from the other.

Overridden from FProperty

  Type Name Description
Protected function Virtual Const void

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

  
Public function Virtual Const FName

GetID ()

  
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 void

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

 Creates new copies of components
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 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 void  
Public function Virtual Const SIZE_T  
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,
void* InMem
)

  
Public function void *

operator new ( const size_t InSize
)

  

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