1. Epic GamesDeveloper
  3. UBlueprintGeneratedClass

UBlueprintGeneratedClass

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/BlueprintGeneratedClass.h
Include #include "Engine/BlueprintGeneratedClass.h"

Syntax

class UBlueprintGeneratedClass :  
    public UClass,  
    public IBlueprintPropertyGuidProvider

Variables

  Type Name Description
Public variable uint8: 1 bHasCookedComponentInstancingData Flag used to indicate if this class has data to support the component instancing fast path.
Public variable uint8: 1 bIsSparseClassDataSerializable Used to check if this class has sparse data that can be serialized.
Public variable TArray< TObjectPtr< UFunction > > CalledFunctions  
Public variable TArray< FBPComponentClassOverride > ComponentClassOverrides Array of blueprint overrides of component classes in parent classes
Public variable TArray< TObjectPtr< class UActorComponent > > ComponentTemplates Array of component template objects, used by AddComponent function
Public variable TMap< FName, struct FBlueprintCookedComponentInstancingData > CookedComponentInstancingData Mapping of changed properties & data to apply when instancing components in a cooked build (one entry per named AddComponent node template for fast lookup at runtime).
Public variable TMap< FName, FGuid > CookedPropertyGuids Property guid map (if any), for use only when this BP is cooked
Public variable FBlueprintDebugData DebugData  
Public variable TArray< TObjectPtr< class UDynamicBlueprintBinding > > DynamicBindingObjects Array of objects containing information for dynamically binding delegates to functions in this blueprint
Public variable TArray< FFieldNotificationId > FieldNotifies The name of the properties with FieldNotify
Public variable int32 FieldNotifiesStartBitNumber  
Public variable TObjectPtr< class UInheritableComponentHandler > InheritableComponentHandler Stores data to override (in children classes) components (created by SCS) from parent classes
Public variable int32 NumReplicatedProperties  
Public variable TObjectPtr< UObject > OverridenArchetypeForCDO  
Public variable TMap< FName, FGuid > PropertyGuids Property guid map
Public variable TObjectPtr< class USimpleConstructionScript > SimpleConstructionScript 'Simple' construction script - graph of components to instance
Public variable TArray< TObjectPtr< class UTimelineTemplate > > Timelines Array of templates for timelines that should be created
Public variable FStructProperty * UberGraphFramePointerProperty  
Public variable TObjectPtr< UFunction > UberGraphFunction  
Public variable uint32 UberGraphFunctionKey  

Constructors

  Type Name Description
Public function  

UBlueprintGeneratedClass ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void  
Public function Static void

BindDynamicDelegates ( const UClass* ThisClass,
UObject* InInstance
)

 Bind functions on supplied actor to delegates
Protected function bool

BuildCustomArrayPropertyListForPostConstruction ( FArrayProperty* ArrayProperty,
FCustomPropertyListNode*& InPropertyList,
const uint8* DataPtr,
const uint8* DefaultDataPtr,
int32 StartIndex
)

 Internal helper method used to recursively build a custom property list from an array property used for post-construct initialization.
Protected function bool

BuildCustomPropertyListForPostConstruction ( FCustomPropertyListNode*& InPropertyList,
UStruct* InStruct,
const uint8* DataPtr,
const uint8* DefaultDataPtr
)

 Internal helper method used to recursively build the custom property list that's used for post-construct initialization.
Public function Virtual void Called to conform any pending sparse class data stashed by PrepareToConformSparseClassData.
Public function Static void

CreateComponentsForActor ( const UClass* ThisClass,
AActor* Actor
)

 Create Timeline objects for this Actor based on the Timelines array
Public function Static void

CreateTimelineComponent ( AActor* Actor,
const UTimelineTemplate* TimelineTemplate
)

  
Public function Const UActorComponent *

FindComponentTemplateByName ( const FName& TemplateName
)

 Find the object in the TemplateObjects array with the supplied name
Public function Const void

ForEachFieldNotify ( TFunctionRef< bool(::UE::FieldNotification::FFieldId FieldId)> Callback,
bool bIncludeSuper
)

 Called by the UE::FieldNotification::IClassDescriptor.
Public function Static bool Iterate over all BPGCs used to generate this class and its parents, calling InFunc on them.
Protected function Virtual Const TSubclassOf< UClassCookedMetaData >  
Protected function Const const FCustomPropertyListNode * Returns a linked list of properties with default values that differ from the parent default object.
Public function FBlueprintDebugData &  
Public function Static UDynamicBlueprintBinding *

GetDynamicBindingObject ( const UClass* ThisClass,
UClass* BindingClass
)

 Finds the desired dynamic binding object for this blueprint generated class.
Public function Static bool

GetGeneratedClassesHierarchy ( const UClass* InClass,
TArray< const UBlueprintGeneratedClass* >& OutBPGClasses
)

 Gets an array of all BPGeneratedClasses (including InClass as 0th element) parents of given generated class
Public function UInheritableComponentHandler *

GetInheritableComponentHandler ( const bool bCreateIfNecessary
)

  
Public function Virtual Const void Called to gather blueprint replicated properties
Public function Static FName  
Protected function Static void

InitArrayPropertyFromCustomList ( const FArrayProperty* ArrayProperty,
const FCustomPropertyListNode* InPropertyList,
uint8* DataPtr,
const uint8* DefaultDataPtr
)

 Helper method to assist with initializing from an array property with an explicit item list.
Public function void  
Protected function Static void

InitPropertiesFromCustomList ( const FCustomPropertyListNode* InPropertyList,
UStruct* InStruct,
uint8* DataPtr,
const uint8* DefaultDataPtr
)

 Helper method to assist with initializing object properties from an explicit list.
Protected function Static bool

InitPropertyFromSubPropertyList ( const FProperty* Property,
const FCustomPropertyListNode* SubPropertyList,
uint8* PropertyValue,
const uint8* DefaultPropertyValue
)

 Helper method to assist with initializing a property from sub property list
Public function Virtual void

PrepareToConformSparseClassData ( UScriptStruct* SparseClassDataArchetypeStruct
)

 Called during serialization to allow the class to stash any sparse class data that needs to be conformed against the archetype once the CDO is available.
Public function Static void

UnbindDynamicDelegates ( const UClass* ThisClass,
UObject* InInstance
)

 Unbind functions on supplied actor from delegates
Public function void

UnbindDynamicDelegatesForProperty ( UObject* InInstance,
const FObjectProperty* InObjectProperty
)

 Unbind functions on supplied actor from delegates tied to a specific property
Public function void Called when the custom list of properties used during post-construct initialization needs to be rebuilt (e.g. after serialization and recompilation).
Public function bool Whether or not to use "fast path" component instancing.
Public function Static bool  

Overridden from UClass

  Type Name Description
Public function Virtual void Conditionally recompiles the class after loading, in case any dependencies were also newly loaded
Public function Virtual Const void

CreatePersistentUberGraphFrame ( UObject* Obj,
bool bCreateOnlyIfEmpty,
bool bSkipSuperClass,
UClass* OldClass
)

 Creates memory to store temporary data
Public function Virtual Const void

DestroyPersistentUberGraphFrame ( UObject* Obj,
bool bSkipSuperClass
)

 Clears memory to store temporary data
Public function Virtual Const UObject *

FindArchetype ( const UClass* ArchetypeClass,
const FName ArchetypeName
)

 Finds the object that is used as the parent object when serializing properties, overridden for blueprints
Public function Virtual void  
Public function Virtual Const UObject * Returns archetype object for CDO
Public function Virtual UClass * If there are potentially multiple versions of this class (e.g. blueprint generated classes), this function will return the authoritative version, which should be used for references
Public function Virtual void Returns all objects that should be preloaded before the class default object is serialized at load time.
Public function Virtual Const uint8 * Returns memory used to store temporary data on an instance, used by blueprints
Public function Virtual void

InitPropertiesFromCustomList ( uint8* DataPtr,
const uint8* DefaultDataPtr
)

 Helper method to assist with initializing object properties from an explicit list.
Public function Virtual Const bool Determines if the specified function has been implemented in a Blueprint
Public function Virtual void Wraps the PostLoad() call for the class default object.
Public function Virtual void

PurgeClass ( bool bRecompilingOnLoad
)

 Purges out the properties of this class in preparation for it to be regenerated
Public function Virtual void Serializes the passed in object as this class's default object using the given archive slot
Public function Virtual Const void Allows class to provide data to the object initializer that can affect how native class subobjects are created.

Overridden from UStruct

  Type Name Description
Protected function Virtual Const bool Returns if we have access to property guids
Protected function Virtual Const FGuid

FindPropertyGuidFromName ( const FName InName
)

 Find property guid
Protected function Virtual Const FName

FindPropertyNameFromGuid ( const FGuid& PropertyGuid
)

 Returns the property name from the guid
Public function Virtual void

Link ( FArchive& Ar,
bool bRelinkExistingProperties
)

 Creates the field/property links and gets structure ready for use at runtime

Overridden from UField

  Type Name Description
Public function Virtual void

Bind ()

 Find the class's native constructor.

Overridden from UObject

  Type Name Description
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void Called during cooking.
Public function Virtual Const FPrimaryAssetId Returns an Type:Name pair representing the PrimaryAssetId for this object.
Public function Virtual Const bool

IsAsset ()

 Returns true if this object is considered an asset.
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual Const bool Called during saving to include this object in client/servers running in editor builds, even if they wouldn't normally be.
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual Const void

PostLoadAssetRegistryTags ( const FAssetData& InAssetData,
TArray< FAssetRegistryTag >& OutTagsAndValuesToUpdate
)

 Performs fixup on loaded asset registry data.
Public function Virtual void Called from within SavePackage on the passed in base/root object.
Public function Virtual void

PreSaveRoot ( FObjectPreSaveRootContext ObjectSaveContext
)

 Called from within SavePackage on the passed in base/root object.
Public function Virtual UClass *

RegenerateClass ( UClass* ClassToRegenerate,
UObject* PreviousCDO
)

 Called on the target when a class is loaded with ClassGeneratedBy is loaded.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from UObjectBaseUtility

  Type Name Description
Public function Virtual Const bool Called after load to determine if the object can be a cluster root

Overridden from IBlueprintPropertyGuidProvider

  Type Name Description
Public function Virtual Const FGuid

FindBlueprintPropertyGuidFromName ( const FName PropertyName
)

 Returns the property GUID for the given name, if any. Does not recurse into parents.
Public function Virtual Const FName

FindBlueprintPropertyNameFromGuid ( const FGuid& PropertyGuid
)

 Returns the property name for the given GUID, if any. Does not recurse into parents.

Typedefs

Name Description
FEditorTags  

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bHasNativizedParent_DEPRECATED This flag is no longer in use and will be removed.
Public variable TArray< FEventGraphFastCallPair > FastCallPairs_DEPRECATED This is a list of event graph call function nodes that are simple (no argument) thunks into the event graph (typically used for animation delegates, etc...) It is a deprecated list only used for backwards compatibility prior to VER_UE4_SERIALIZE_BLUEPRINT_EVENTGRAPH_FASTCALLS_IN_UFUNCTION.
Public variable TObjectPtr< class UStructProperty > UberGraphFramePointerProperty_DEPRECATED  

Deprecated Functions

  Type Name Description
Protected function Static void This API is no longer in use and will be removed.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page