1. Epic GamesDeveloper
  3. FBlueprintCompileReinstancer

FBlueprintCompileReinstancer

Unreal Engine C++ API Reference > Editor > UnrealEd > Kismet2

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/Kismet2/KismetReinstanceUtilities.h
Include #include "Kismet2/KismetReinstanceUtilities.h"

Syntax

class FBlueprintCompileReinstancer :  
    public TSharedFromThis< FBlueprintCompileReinstancer >,  
    public FGCObject

Variables

  Type Name Description
Protected variable bool bAllowResaveAtTheEndIfRequested TRUE if this reinstancer should resave compiled Blueprints if the user has requested it
Protected variable bool bHasReinstanced Whether or not this resinstancer has already reinstanced
Protected variable bool bIsRootReinstancer TRUE if this is the root reinstancer that all other active reinstancing is spawned from
Protected variable bool bUseDeltaSerializationToCopyProperties TRUE if delta serialization should be forced during FBlueprintCompileReinstancer::CopyPropertiesForUnrelatedObjects
Protected variable TArray< UBlueprint * > Children Children of this blueprint, which will need to be recompiled and relinked temporarily to maintain the class layout
Protected variable UClass * ClassToReinstance Reference to the class we're actively reinstancing
Protected variable uint32 ClassToReinstanceDefaultValuesCRC  
Protected variable TObjectPtr< UClass > DuplicatedClass Reference to the duplicate of ClassToReinstance, which all previous instances are now instances of
Protected variable TMap< FName, TObjectPtr< UFunction > > FunctionMap  
Protected variable TSet< UObject * > ObjectsThatShouldUseOldStuff Objects that should keep reference to old class
Protected variable TObjectPtr< UObject > OriginalCDO The original CDO object for the class being actively reinstanced
Protected variable TMap< FName, FProperty * > PropertyMap Mappings from old fields before recompilation to their new equivalents
Protected variable EReinstClassType ReinstClassType  

Constructors

  Type Name Description
Protected function   Default constructor, can only be used by derived classes
Protected function  

FBlueprintCompileReinstancer ( UClass* InClassToReinstance,
EBlueprintCompileReinstancerFlags Flags
)

 Sets the reinstancer up to work on every object of the specified class

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void

BatchReplaceInstancesOfClass ( const TMap< UClass*, UClass* >& InOldToNewClassMap,
const FReplaceInstancesOfClassParameters& Params
)

 Batch replaces a mapping of one or more classes to their new class
Public function Virtual void

BlueprintWasRecompiled ( UBlueprint* BP,
bool bBytecodeOnly
)

  
Protected function void  
Protected function Static void

CopyPropertiesForUnrelatedObjects ( UObject* OldObject,
UObject* NewObject,
bool bClearExternalReferences,
bool bForceDeltaSerialization
)

 Attempts to copy as many properties as possible from the old object to the new.
Public function Static TSharedPtr< FBlueprintCompileReinstancer >

Create ( UClass* InClassToReinstance,
EBlueprintCompileReinstancerFlags Flags
)

  
Public function void

FinalizeFastReinstancing ( TArray< UObject* >& ObjectsToReplace
)

  
Public function Static void

FinishUpdateBytecodeReferences ( const TSet< UBlueprint* >& DependentBPs,
const TMap< FFieldVariant, FFieldVariant >& FieldMappings
)

 Consumes the set and map populated by calls to UpdateBytecodeReferences
Public function void Helper to gather mappings from the old class's fields to the new class's version
Public function Static void

GetSortedClassHierarchy ( UClass* ClassToSearch,
TArray< UClass* >& OutHierarchy,
UClass** OutNativeParent
)

 Gathers the full class Hierarchy of the ClassToSearch, sorted top down (0 index being UObject, n being the subclasses)
Public function Virtual Const bool  
Protected function Const bool  
Public function Static bool

IsReinstClass ( const UClass* Class
)

 Returns true if the given class is a REINST class (starts with the 'REINST_' prefix)
Public function Static UClass *

MoveCDOToNewClass ( UClass* OwnerClass,
const TMap< UClass*, UClass* >& OldToNewMap,
bool bAvoidCDODuplication
)

 Function used to safely discard a CDO, so that the class can have its layout changed, callers must move parent CDOs aside before moving child CDOs aside:
Public function Static void

MoveDependentSkelToReinst ( UClass* OwnerClass,
TMap< UClass*, UClass* >& OldToNewMap
)

 Moves CDOs aside to immutable versions of classes(`REINST_) so that the CDO's can safely be GC'd.
Public function Static void  
Public function Static void When re-instancing a component, we have to make sure all instance owners' construction scripts are re-ran (in-case modifying the component alters the construction of the actor).
Protected function TSharedPtr< FReinstanceFinalizer >  
Protected function TSharedPtr< FReinstanceFinalizer >

ReinstanceInner ( bool bForceAlwaysReinstance
)

  
Public function void

ReinstanceObjects ( bool bForceAlwaysReinstance
)

 Reinstances all objects in the ObjectReinstancingMap
Protected function void

ReparentChild ( UBlueprint* ChildBP
)

 Reparents the specified blueprint or class to be the duplicated class in order to allow properties to be copied from the previous CDO to the new one
Protected function void

ReparentChild ( UClass* ChildClass
)

 Reparents the specified blueprint or class to be the duplicated class in order to allow properties to be copied from the previous CDO to the new one
Public function Static void Replace all instances of OldClass with a new instance of NewClass
Public function void

SaveClassFieldMapping ( UClass* InClassToReinstance
)

 Saves a mapping of field names to their UField equivalents, so we can remap any bytecode that references them later
Protected function Virtual Const bool Determine whether reinstancing actors should preserve the root component of the new actor
Public function void

UpdateBytecodeReferences ( TSet< UBlueprint* >& OutDependentBlueprints,
TMap< FFieldVariant, FFieldVariant >& OutFieldMapping
)

 Updates references to properties and functions of the class that has in the bytecode of dependent blueprints
Public function void Verify that all instances of the duplicated class have been replaced and collected

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Enums

  Type Name Description
Protected enum EReinstClassType Cached value, mostly used to determine if we're explicitly targeting the skeleton class or not  

Constants

Name Description
CompiledBlueprintsToSave  
HotReloadedNewClass  
HotReloadedOldClass  

Deprecated Functions

  Type Name Description
Public function Static void

BatchReplaceInstancesOfClass ( TMap< UClass*, UClass* >& InOldToNewClassMap,
PRAGMA_DISABLE_DEPRECATION_WARNINGS const FBatchReplaceInstancesOfClassParameters& BatchParams
)

 Please use the version that takes an FReplaceInstancesOfClassParameters input instead.
Public function Virtual void

EnlistDependentBlueprintToRecompile ( UBlueprint* BP,
bool bBytecodeOnly
)

 This method performs no function and isn't invoked by the base class. Remove all calls to the base class method.
Public function Static void

ReplaceInstancesOfClass ( UClass* OldClass,
UClass* NewClass,
UObject* OriginalCDO,
TSet< UObject* >* ObjectsThatShouldUseOldStuff,
bool bClassObjectReplaced,
bool bPreserveRootComponent
)

 Please use the version that takes an FReplaceInstancesOfClassParameters input instead.
Public function Static void Please use ReplaceInstancesOfClass() instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page