1. Epic GamesDeveloper
  3. FObjectProperty

FObjectProperty

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

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 FObjectProperty : public TFObjectPropertyBase< TObjectPtr< UObject > >

Remarks

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

Constructors

  Type Name Description
Public function  

FObjectProperty ( UField* InField
)

  
Public function  

FObjectProperty ( EInternal InInernal,
FFieldClass* InClass
)

  
Public function  

FObjectProperty ( FFieldVariant InOwner,
const UECodeGen_Private::FObjectPropertyParams& Prop
)

 Constructor used for constructing compiled in properties
Public function  

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

  
Public function  

FObjectProperty ( FFieldVariant InOwner,
const FName& InName,
EObjectFlags InObjectFlags,
int32 InOffset,
EPropertyFlags InFlags,
UClass* InClass
)

 Compiled-in property constructor is deprecated, use other constructors instead.

Functions

  Type Name Description
Public function Static FField *

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

  
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

CopyCompleteValueFromScriptVM ( void* Dest,
void const* Src
)

 Copy the value for all elements of this property. From the script VM.
Public function Virtual Const void

CopyCompleteValueFromScriptVM_InContainer ( void* OutContainer,
void const* InValue
)

  
Public function Virtual Const void

CopyCompleteValueToScriptVM ( void* Dest,
void const* Src
)

 Copy the value for all elements of this property. To the script VM.
Public function Virtual Const void

CopyCompleteValueToScriptVM_InContainer ( void* OutValue,
void const* InContainer
)

 Equivalent to the above functions, but using the container and aware of getters/setters when the container has them.
Public function Virtual Const void

CopySingleValueFromScriptVM ( void* Dest,
void const* Src
)

 Copy the value for a single element of this property. From the script VM.
Public function Virtual Const void

CopySingleValueToScriptVM ( void* Dest,
void const* Src
)

 Copy the value for a single element of this property. To the script VM.
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 FString

GetCPPMacroType ( FString& ExtendedTypeText
)

  
Public function Virtual Const FString

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

  
Public function Virtual Const FString  
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 Const TObjectPtr< UObject > *

GetObjectPtrPropertyValuePtr ( const void* PropertyValueAddress
)

  
Public function Const TObjectPtr< UObject > &

GetObjectPtrPropertyValueRef ( const void* PropertyValueAddress
)

  
Public function Virtual Const const TCHAR *

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

  
Public function Const void

PostSerializeObjectItem ( FArchive& SerializingArchive,
void* Value,
UObject* CurrentValue,
UObject* ObjectValue,
EObjectPropertyOptions Options
)

 Performs post serialization steps after loading a property value
Public function Virtual Const void

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

  
Public function Virtual Const void

SetObjectPropertyValue ( void* PropertyValueAddress,
UObject* Value
)

  
Public function Virtual Const void

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

  
Public function Virtual Const void

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

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

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  

Deprecated Functions

  Type Name Description
Public function  

FObjectProperty ( FFieldVariant InOwner,
const FName& InName,
EObjectFlags InObjectFlags,
int32 InOffset,
EPropertyFlags InFlags,
UClass* InClass
)

 Compiled-in property constructor is deprecated, use other constructors instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page