1. Epic GamesDeveloper
  3. FObjectProperty

FObjectProperty

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

  

Functions

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

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.
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 SIZE_T  
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
)

  
Public function Const TObjectPtr< UObject > *

GetObjectPtrPropertyValuePtr ( const void* PropertyValueAddress
)

  
Public function Const TObjectPtr< UObject > &

GetObjectPtrPropertyValueRef ( const void* PropertyValueAddress
)

  
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 PropertyPointerType,
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
)

  
Protected function Virtual Const void

SetObjectPropertyValueUnchecked ( void* PropertyValueAddress,
UObject* Value
)

  
Protected function Virtual Const void

SetObjectPropertyValueUnchecked_InContainer ( void* ContainerAddress,
UObject* Value,
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 Static FFieldClass *  
Public function Static uint64  
Public function Static uint64  

Overridden from TProperty

  Type Name Description
Public function Virtual Const void Set the value to it's special unset state.
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 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 bool

IsIntrusiveOptionalValueSet ( const void* Data
)

 Returns whether an optional value of this inner type is unset.

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