Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. FObjectInitializer

FObjectInitializer

Internal class to finalize [UObject](API\Runtime\CoreUObject\UObject) creation (initialize properties) after the real C++ constructor is called.

API > API/Runtime > API/Runtime/CoreUObject

Internal class to finalize UObject creation (initialize properties) after the real C++ constructor is called.

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

Syntax

class FObjectInitializer

Constructors

Name Remarks Include Path Unreal Specifiers

FObjectInitializer ( UObject* InObj,
UObject* InObjectArchetype,
EObjectInitializerOptions InOptions,
FObjectInstancingGraph* InInstanceGraph
)

 Constructor UObject/UObjectGlobals.h  

FObjectInitializer ( UObject* InObj,
const FStaticConstructObjectParameters& StaticConstructParams,
UE::RemoteObject::Serialization::FRemoteObjectConstructionOverrides* RemoteObjectOverides
)

   UObject/UObjectGlobals.h  
Default Constructor, used when you are using the C++ "new" syntax. UObject/UObjectGlobals.h  

FObjectInitializer ( UObject* InObj,
const FStaticConstructObjectParameters& StaticConstructParams
)

 Special constructor for static construct object internal that passes along the params block directly UObject/UObjectGlobals.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FObjectInitializer()

 Destructor for internal class to finalize UObject creation (initialize properties) after the real C++ constructor is called. UObject/UObjectGlobals.h  

Structs

Name Remarks
FOverrides Little helper struct to manage overrides from derived classes
FSubobjectsToInit Little helper struct to manage overrides from derived classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCopyTransientsFromClassDefaults bool If true, copy the transients from the DefaultsClass defaults, otherwise copy the transients from DefaultData UObject/UObjectGlobals.h  
bIsDeferredInitializer bool   UObject/UObjectGlobals.h  
bShouldInitializePropsFromArchetype bool If true, initialize the properties UObject/UObjectGlobals.h  
bSubobjectClassInitializationAllowed bool Only true until ObjectInitializer has not reached the base UObject class UObject/UObjectGlobals.h  
ComponentInits FSubobjectsToInit List of component classes to initialize after the C++ constructors UObject/UObjectGlobals.h  
ConstructedSubobjects TArray< FName, TInlineAllocator< 8 > > List of all subobject names constructed for this object UObject/UObjectGlobals.h  
CreatedGCObjects TArray< FGCObject * > List of FGCObjects created during UObject construction UObject/UObjectGlobals.h  
InstanceGraph FObjectInstancingGraph * Instance graph UObject/UObjectGlobals.h  
LastConstructedObject UObject * Previously constructed object in the callstack UObject/UObjectGlobals.h  
Obj UObject * Object to initialize, from static allocate object, after construction UObject/UObjectGlobals.h  
ObjectArchetype UObject * Object to copy properties from UObject/UObjectGlobals.h  
OnGCObjectCreatedHandle FDelegateHandle Delegate handle for OnGCObjectCreated callback UObject/UObjectGlobals.h  
PropertyInitCallback TFunction< void()> Callbacks for custom property initialization before PostInitProperties gets called UObject/UObjectGlobals.h  
PropertyPostInitCallbacks TArray< TFunction< void()> >   UObject/UObjectGlobals.h  
SubobjectOverrides FOverrides List of component classes to override from derived classes UObject/UObjectGlobals.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddPropertyPostInitCallback ( TFunction< void()>&& Callback
)

   UObject/UObjectGlobals.h  

TReturnType * CreateDefaultSubobject ( UObject* Outer,
FName SubobjectName,
bool bTransient
) const

 Create a component or subobject that will be instanced inside all instances of this class. UObject/UObjectGlobals.h  

UObject * CreateDefaultSubobject ( UObject* Outer,
FName SubobjectFName,
const UClass* ReturnType,
const UClass* ClassToCreateByDefault,
bool bIsRequired,
bool bIsTransient
) const

 Create a component or subobject that will be instanced inside all instances of this class. UObject/UObjectGlobals.h  

TReturnType * CreateDefaultSubobject ( UObject* Outer,
FName SubobjectName,
bool bTransient
) const

 Create a component or subobject, allows creating a child class and returning the parent class. UObject/UObjectGlobals.h  

UObject * CreateEditorOnlyDefaultSubobject ( UObject* Outer,
FName SubobjectName,
const UClass* ReturnType,
bool bTransient
) const

 Create a component or subobject only to be used with the editor. UObject/UObjectGlobals.h  

TReturnType * CreateEditorOnlyDefaultSubobject ( UObject* Outer,
FName SubobjectName,
bool bTransient
) const

 Create a component or subobject only to be used with the editor. UObject/UObjectGlobals.h  

TReturnType * CreateOptionalDefaultSubobject ( UObject* Outer,
FName SubobjectName,
bool bTransient
) const

 Create optional component or subobject. UObject/UObjectGlobals.h  

const FObjectInitializer & DoNotCreateDefaultSubobject ( FName SubobjectName
) const

 Indicates that a base class should not create a component UObject/UObjectGlobals.h  

const FObjectInitializer & DoNotCreateNestedDefaultSubobject ( TArrayView< const FName > SubobjectNames
) const

 Indicates that a subobject should not create a component if created using CreateOptionalDefaultSubobject UObject/UObjectGlobals.h  

const FObjectInitializer & DoNotCreateNestedDefaultSubobject ( FStringView SubobjectName
) const

 Indicates that a subobject should not create a component if created using CreateOptionalDefaultSubobject UObject/UObjectGlobals.h  

void FinalizeSubobjectClassInitialization()

   UObject/UObjectGlobals.h  

UObject * GetArchetype()

 Return the archetype that this object will copy properties from later UObject/UObjectGlobals.h  

UClass * GetClass()

 Return the class of the object that is being constructed UObject/UObjectGlobals.h  

FObjectInstancingGraph * GetInstancingGraph()

   UObject/UObjectGlobals.h  

UObject * GetObj()

 Return the object that is being constructed UObject/UObjectGlobals.h  

const FObjectInitializer & SetDefaultSubobjectClass ( FName SubobjectName
) const

 Sets the class to use for a subobject defined in a base class, the class must be a subclass of the class used by the base class. UObject/UObjectGlobals.h  

const FObjectInitializer & SetDefaultSubobjectClass ( FName SubobjectName,
const UClass* Class
) const

 Sets the class to use for a subobject defined in a base class, the class must be a subclass of the class used by the base class. UObject/UObjectGlobals.h  

const FObjectInitializer & SetNestedDefaultSubobjectClass ( FStringView SubobjectName
) const

 Sets the class to use for a subobject defined in a nested subobject, the class must be a subclass of the class used when calling CreateDefaultSubobject. UObject/UObjectGlobals.h  

const FObjectInitializer & SetNestedDefaultSubobjectClass ( TArrayView< const FName > SubobjectNames
) const

 Sets the class to use for a subobject defined in a nested subobject, the class must be a subclass of the class used when calling CreateDefaultSubobject. UObject/UObjectGlobals.h  

const FObjectInitializer & SetNestedDefaultSubobjectClass ( FStringView SubobjectName,
const UClass* Class
) const

 Sets the class to use for a subobject defined in a nested subobject, the class must be a subclass of the class used when calling CreateDefaultSubobject. UObject/UObjectGlobals.h  

const FObjectInitializer & SetNestedDefaultSubobjectClass ( TArrayView< const FName > SubobjectNames,
const UClass* Class
) const

 Sets the class to use for a subobject defined in a nested subobject, the class must be a subclass of the class used when calling CreateDefaultSubobject. UObject/UObjectGlobals.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AssertIfInConstructor ( UObject* Outer,
const TCHAR* ErrorMessage
)

 Asserts with the specified message if code is executed inside UObject constructor UObject/UObjectGlobals.h  

static FObjectInitializer & Get ()

 Gets ObjectInitializer for the currently constructed object. UObject/UObjectGlobals.h  

static bool InitNonNativeProperty ( FProperty* Property,
UObject* Data
)

 Initializes a non-native property, according to the initialization rules. UObject/UObjectGlobals.h  

static void InitProperties ( UObject* Obj,
UClass* DefaultsClass,
UObject* DefaultData,
bool bCopyTransientsFromClassDefaults
)

 Binary initialize object properties to zero or defaults. UObject/UObjectGlobals.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page