Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > UObject > FSoftObjectProperty

Light Theme

Dark Theme

FSoftObjectProperty

Describes a reference variable to another object which may be nil, and will become valid or invalid at any point

Windows

MacOS

Linux

Inheritance Hierarchy

FObjectPropertyBase

TFObjectPropertyBase

FSoftObjectProperty

	FSoftClassProperty
	FSoftClassProperty

References

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

Syntax

class FSoftObjectProperty :
public FObjectPropertyBase,
public TFObjectPropertyBase< FSoftObjectPtr >

Remarks

Describes a reference variable to another object which may be nil, and will become valid or invalid at any point

Constructors

	Name	Description
	FSoftObjectProperty ( UField* InField )
	FSoftObjectProperty ( const FObjectInitializer& ObjectIn... )
	FSoftObjectProperty ( FVTableHelper& Helper )	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
	FSoftObjectProperty ( EInternal InInernal, FFieldClass* InClass )
	FSoftObjectProperty ( FFieldVariant InOwner, const FName& InName, EObjectFlags InObjectFlags )
	FSoftObjectProperty ( ECppProperty, int32 InOffset, EPropertyFlags InFlags, UClass* InClass )
	FSoftObjectProperty ( const FObjectInitializer& ObjectIn..., ECppProperty, int32 InOffset, EPropertyFlags InFlags, UClass* InClass )
	FSoftObjectProperty ( FFieldVariant InOwner, const FName& InName, EObjectFlags InObjectFlags, int32 InOffset, EPropertyFlags InFlags, UClass* InClass )

Functions

	Name	Description
void	__DefaultConstructor ( const FObjectInitializer& X )
UObject *...	__VTableCtorCaller ( FVTableHelper& Helper )
FField *	Construct ( const FFieldVariant& InOwner, const FName& InName, EObjectFlags InObjectFlags )
FFieldClass ...	StaticClass()
UClass *	StaticClass()	Returns a UClass object representing this class at runtime
uint64	StaticClassCastFlags()
EClassCastFl...	StaticClassCastFlags()	Returns the static cast flags for this class
uint64	StaticClassCastFlagsPrivate()
const TCHAR ...	StaticPackage()	Returns the package this class belongs in
void	StaticRegisterNativesFSoftObjectProperty()

Overridden from FObjectPropertyBase

		Name	Description
	bool	AllowCrossLevel()
	FString	GetCPPTypeCustom ( FString* ExtendedTypeText, uint32 CPPExportFlags, const FString& InnerNativeTypeName )
	UObject *...	GetObjectPropertyValue ( const void* PropertyValueAddre... )
	UObject *...	LoadObjectPropertyValue ( const void* PropertyValueAddre... )
	void	SetObjectPropertyValue ( void* PropertyValueAddress, UObject* Value )

Overridden from FProperty

	Name	Description
EConvertFrom...	ConvertFromType ( const FPropertyTag& Tag, FStructuredArchive::FSlot Slot, uint8* Data, UStruct* DefaultsStruct )	Allows a property to implement backwards compatibility handling for tagged properties
void	CopyCompleteValueFromScriptVM ( void* Dest, void const* Src )	Copy the value for all elements of this property. From the script VM.
void	CopyCompleteValueToScriptVM ( void* Dest, void const* Src )	Copy the value for all elements of this property. To the script VM.
void	CopySingleValueFromScriptVM ( void* Dest, void const* Src )	Copy the value for a single element of this property. From the script VM.
void	CopySingleValueToScriptVM ( void* Dest, void const* Src )	Copy the value for a single element of this property. To the script VM.
void	EmitReferenceInfo ( UClass& OwnerClass, int32 BaseOffset, TArray< const FStructProperty*... )	Emits tokens used by realtime garbage collection code to passed in ReferenceTokenStream.
void	ExportTextItem ( FString& ValueStr, const void* PropertyValue, const void* DefaultValue, UObject* Parent, int32 PortFlags, UObject* ExportRootScope )
FString	GetCPPMacroType ( FString& ExtendedTypeText )
FString	GetCPPTypeForwardDeclaration()
FName	GetID()
bool	Identical ( const void* A, const void* B, uint32 PortFlags )	Determines whether the property values are identical.
const TCHAR ...	ImportText_Internal ( const TCHAR* Buffer, void* Data, int32 PortFlags, UObject* OwnerObject, FOutputDevice* ErrorText )
bool	NetSerializeItem ( FArchive& Ar, UPackageMap* Map, void* Data, TArray< uint8 >* MetaData )
void	SerializeItem ( FStructuredArchive::FSlot Slot, void* Value, void const* Defaults )

Overridden from TProperty

		Name	Description
	FString	GetCPPType ( FString* ExtendedTypeText, uint32 CPPExportFlags )	TProperty::GetCPPType should not be used here.

Operators

	Name	Description
void	operator delete ( void* InMem )
void *	operator new ( const size_t InSize )
void *	operator new ( const size_t InSize, void* InMem )
void *	operator new ( const size_t InSize, EInternal* InMem )	For internal use only; use StaticConstructObject() to create new objects.
void *	operator new ( const size_t InSize, EInternal InInternalOnly, UObject* InOuter, FName InName, EObjectFlags InSetFlags )	For internal use only; use StaticConstructObject() to create new objects.

Typedefs

Name	Description
Super	Typedef for the base class (FObjectPropertyBase)
Super
ThisClass
ThisClass	Typedef for FSoftObjectProperty.

Constants

Name	Description
StaticClassFlags	Bitwise union of EClassFlags pertaining to this class.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss