Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FObjectProperty

FObjectProperty

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

API > API/Runtime > API/Runtime/CoreUObject

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

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

Syntax

class FObjectProperty : public TFObjectPropertyBase< TObjectPtr< UObject > >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

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

   UObject/UnrealType.h  

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

 Constructor used for constructing compiled in properties UObject/UnrealType.h  

FObjectProperty ( EInternal InInernal,
FFieldClass* InClass
)

   UObject/UnrealType.h  

FObjectProperty ( UField* InField
)

   UObject/UnrealType.h  

Typedefs

Name Type Remarks Include Path
Super TFObjectPropertyBase< TObjectPtr< UObject > >   UObject/UnrealType.h
ThisClass FObjectProperty   UObject/UnrealType.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AllowCrossLevel()

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

virtual void CopyCompleteValueFromScriptVM ( void* Dest,
void const* Src
) const

 Copy the value for all elements of this property. From the script VM. UObject/UnrealType.h  

virtual void CopyCompleteValueFromScriptVM_InContainer ( void* OutContainer,
void const* InValue
) const

   UObject/UnrealType.h  

virtual void CopyCompleteValueToScriptVM ( void* Dest,
void const* Src
) const

 Copy the value for all elements of this property. To the script VM. UObject/UnrealType.h  

virtual void CopyCompleteValueToScriptVM_InContainer ( void* OutValue,
void const* InContainer
) const

 Equivalent to the above functions, but using the container and aware of getters/setters when the container has them. UObject/UnrealType.h  

virtual void CopySingleValueFromScriptVM ( void* Dest,
void const* Src
) const

 Copy the value for a single element of this property. From the script VM. UObject/UnrealType.h  

virtual void CopySingleValueToScriptVM ( void* Dest,
void const* Src
) const

 Copy the value for a single element of this property. To the script VM. UObject/UnrealType.h  

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

virtual FString GetCPPMacroType ( FString& ExtendedTypeText
) const

   UObject/UnrealType.h  

virtual SIZE_T GetFieldSize()

   UObject/UnrealType.h  

virtual UObject * GetObjectPropertyValue ( const void* PropertyValueAddress
) const

   UObject/UnrealType.h  

virtual UObject * GetObjectPropertyValue_InContainer ( const void* ContainerAddress,
int32 ArrayIndex
) const

   UObject/UnrealType.h  

virtual TObjectPtr< UObject > GetObjectPtrPropertyValue ( const void* PropertyValueAddress
) const

   UObject/UnrealType.h  

virtual TObjectPtr< UObject > GetObjectPtrPropertyValue_InContainer ( const void* ContainerAddress,
int32 ArrayIndex
) const

   UObject/UnrealType.h  

TObjectPtr< UObject > * GetObjectPtrPropertyValuePtr ( const void* PropertyValueAddress
) const

   UObject/UnrealType.h  

TObjectPtr< UObject > & GetObjectPtrPropertyValueRef ( const void* PropertyValueAddress
) const

   UObject/UnrealType.h  

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

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

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

   UObject/UnrealType.h  

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

 Performs post serialization steps after loading a property value UObject/UnrealType.h  

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

   UObject/UnrealType.h  

Overridden from TProperty

Name Remarks Include Path Unreal Specifiers

virtual void ClearIntrusiveOptionalValue ( void* Data
) const

 Set the value to it's special unset state. UObject/UnrealType.h  

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

 Returns the text to use for exporting this property to header file. UObject/UnrealType.h  
Returns whether this type has a special state for an unset TOptional meaning the size TOptional and T are the same. UObject/UnrealType.h  

virtual void InitializeIntrusiveUnsetOptionalValue ( void* Data
) const

 Initialize the value at the given address to an unset TOptional using an intrusive state rather than a trailing boolean. UObject/UnrealType.h  

virtual bool IsIntrusiveOptionalValueSet ( const void* Data
) const

 Returns whether an optional value of this inner type is unset. UObject/UnrealType.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void SetObjectPropertyValueUnchecked ( void* PropertyValueAddress,
UObject* Value
) const

   UObject/UnrealType.h  

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

   UObject/UnrealType.h  

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

   UObject/UnrealType.h  

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

   UObject/UnrealType.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   UObject/UnrealType.h  

static UE_API FFieldClass * StaticClass()

   UObject/UnrealType.h  

static EClassCastFlags StaticClassCastFlags()

   UObject/UnrealType.h  

static EClassCastFlags StaticClassCastFlagsPrivate()

   UObject/UnrealType.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator delete ( void* InMem
)

   UObject/UnrealType.h  

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

   UObject/UnrealType.h  

void * operator new ( const size_t InSize
)

   UObject/UnrealType.h  
  UObject/UnrealType.h  
  UObject/UnrealType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page