1. Epic GamesDeveloper
  3. UObject

UObject

The base class of all UE objects.

API > API/Runtime > API/Runtime/CoreUObject

The base class of all UE objects. The type of an object is defined by its UClass. This provides support functions for creating and using objects, and virtual functions that should be overridden in child classes.

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

Syntax

UCLASS (Abstract, MinimalAPI, Config=Engine)  
class UObject : public UObjectBaseUtility

Inheritance Hierarchy

Derived Classes

UObject derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UObject ()

 Default constructor UObject/Object.h  

UObject ( const FObjectInitializer& ObjectInitializer
)

 Constructor that takes an ObjectInitializer. UObject/Object.h  
DO NOT USE. This constructor is for internal usage only for statically-created objects. UObject/Object.h  

UObject ( FVTableHelper& Helper
)

 DO NOT USE. This constructor is for internal usage only for hot-reload purposes. UObject/Object.h  

Structs

Name Remarks
FAssetRegistryTag Struct used by GetAssetRegistryTags() to return tag info
FAssetRegistryTagMetadata Additional data pertaining to asset registry tags used by the editor
FSaveConfigContext  

Enums

Public

Name Remarks
ENetFields_Private  

Protected

Name Remarks
ETransactionAnnotationCreationMode Factory a new annotation object and optionally populate it with data

Typedefs

Name Type Remarks Include Path
FOnGetPreviewPlatform TBaseDelegate_OneParam< bool, FName & > Delegate to return the current preview platform name, or NAME_None if no preview platform is currently active. UObject/Object.h
FPostCDOCompiledContext FObjectPostCDOCompiledContext   UObject/Object.h
WithinClass UObject   UObject/Object.h

Constants

Name Type Remarks Include Path
OnGetPreviewPlatform FOnGetPreviewPlatform   UObject/Object.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
requirement Note that this function MUST be safe to call on a background thread If you have functionality that doesn t meet that   UObject/Object.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetData const FAssetData & The AssetData being considered UObject/Object.h  
bCanCreateObjects bool   UObject/Object.h  
bPostLoadCouldComplete bool   UObject/Object.h  
TagsAndValuesToUpdate TArray< FAssetRegistryTag > & The asset registry tags to be updated for this asset data UObject/Object.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AbortInsideMemberFunction()

 Abort with a member function call at the top of the callstack, helping to ensure that most platforms will stuff this object's memory into the resulting minidump. UObject/Object.h  

void AddTagToUpdate ( const FAssetRegistryTag& Tag
)

   UObject/Object.h  

virtual bool AreNativePropertiesIdenticalTo ( UObject* Other
) const

 Returns whether native properties are identical to the one of the passed in component. UObject/Object.h  

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

 Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects UObject/Object.h  

virtual void BeginDestroy ()

 Called before destroying the object. UObject/Object.h  

virtual void BuildSubobjectMapping ( UObject* OtherObject,
TMap< UObject*, UObject* >& ObjectMapping
) const

 Given OtherObject (which will be the same type as 'this'), recursively find any matching sub-objects from 'this' that also exist within OtherObject, and add the mappings to ObjectMapping. UObject/Object.h  

void CallAddReferencedObjects ( FReferenceCollector& Collector
)

 Helper function to call AddReferencedObjects for this object's class. UObject/Object.h  

void CallFunction ( FFrame& Stack,
void*const Z_Param__Result,
UFunction* Function
)

 Internal VM method for executing a function UObject/Object.h  

bool CallFunctionByNameWithArguments ( const TCHAR* Cmd,
FOutputDevice& Ar,
UObject* Executor,
bool bForceCallWithNonExec
)

 Handle calling a function by name when executed from the console or a command line UObject/Object.h  

virtual bool CallRemoteFunction ( UFunction* Function,
void* Parms,
FOutParmRec* OutParms,
FFrame* Stack
)

 Call the actor's function remotely UObject/Object.h  

bool CanCreateObjects()

   UObject/Object.h  

virtual bool CanEditChange ( const FEditPropertyChain& PropertyChain
) const

 Alternate version of CanEditChange that includes the full property chain leading to the property in question. UObject/Object.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

 Called by the editor to query whether a property of this object is allowed to be modified. UObject/Object.h  

bool CanModify()

 Utility to allow overrides of Modify to avoid doing work if this object cannot be safely modified UObject/Object.h  

bool CheckDefaultSubobjects ( bool bForceCheck
) const

 Checks default sub-object assumptions. UObject/Object.h  

virtual void ClearAllCachedCookedPlatformData()

 Clear all cached cooked platform data UObject/Object.h  

virtual void ClearCachedCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

 Clears cached cooked platform data for specific platform UObject/Object.h  

void CollectDefaultSubobjects ( TArray< UObject* >& OutDefaultSubobjects,
bool bIncludeNestedSubobjects
) const

 Gets all subobjects inside this object that return true for IsDefaultSubobject. UObject/Object.h  

virtual void CollectSaveOverrides ( FObjectCollectSaveOverridesContext SaveContext
)

 Collect any save override state. UObject/Object.h  
Called before destroying the object. UObject/Object.h  

bool ConditionalFinishDestroy()

 Called when an object is actually destroyed, memory should never be accessed again UObject/Object.h  

void ConditionalPostLoad()

 PostLoad if needed. UObject/Object.h  
Instances subobjects and components for objects being loaded from disk, if necessary. UObject/Object.h  

void ConditionalPreload()

 Preload if needed. Mostly used in the loader or loader threads. UObject/Object.h  

virtual bool ConformSparseClassDataStruct ( UScriptStruct* SourceSparseClassDataStruct,
void* SourceSparseClassData
) const

   UObject/Object.h  

void CookAdditionalFiles ( const TCHAR* PackageFilename,
const ITargetPlatform* TargetPlatform,
TFunctionRef< void(const TCHAR*Filename, void*Data, int64 Size)> WriteAdditionalFile
)

 Called during cook to allow objects to generate additional cooked files alongside their cooked package. UObject/Object.h  

TSharedPtr< ITransactionObjectAnnotation > CreateAndRestoreTransactionAnnotation ( FArchive& Ar
) const

 Create and restore a previously serialized annotation object with any external data required for applying a transaction UObject/Object.h  

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

 Utility function for templates below UObject/Object.h  

TReturnType * CreateDefaultSubobject ( FName SubobjectName,
bool bTransient
)

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

TReturnType * CreateDefaultSubobject ( FName SubobjectName,
bool bTransient
)

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

TReturnType * CreateEditorOnlyDefaultSubobject ( FName SubobjectName,
bool bTransient
)

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

TReturnType * CreateOptionalDefaultSubobject ( FName SubobjectName,
bool bTransient
)

 Create an optional component or subobject.Optional subobjects will not get created. UObject/Object.h  

TReturnType * CreateOptionalDefaultSubobject ( FName SubobjectName,
bool bTransient
)

 Create an optional component or subobject. UObject/Object.h  

void DestroyNonNativeProperties()

 Destroy properties that won't be destroyed by the native destructor UObject/Object.h  

void ExecuteUbergraph ( int32 EntryPoint
)

 Executes some portion of the ubergraph. UObject/Object.h
  • BlueprintImplementableEvent
  • Meta=(BlueprintInternalUseOnly="true")

virtual void ExportCustomProperties ( FOutputDevice& Out,
uint32 Indent
)

 Exports the property values for the specified object as text to the output device. UObject/Object.h  

UFunction * FindFunction ( FName InName
) const

 Returns a UFunction with the specified name, wrapper for UClass::FindFunctionByName() UObject/Object.h  

UFunction * FindFunctionChecked ( FName InName
) const

 Version of FindFunction() that will assert if the function was not found UObject/Object.h  

TSharedPtr< ITransactionObjectAnnotation > FindOrCreateTransactionAnnotation()

 Find or create and populate an annotation object with any external data required for applying a transaction UObject/Object.h  

virtual void FinishDestroy ()

 Called to finish destroying the object. UObject/Object.h  

virtual void GetAdditionalAssetDataObjectsForCook ( FArchiveCookContext& CookContext,
TArray< UObject* >& OutObjects
) const

 Get an additional object that should be added to the AssetDatas stored for a cooked package, to handle objects stripped from cooked packages. UObject/Object.h  

UObject * GetArchetype()

 Return the template this object is based on. UObject/Object.h  

void GetArchetypeInstances ( TArray< UObject* >& Instances
)

 Builds a list of objects which have this object in their archetype chain. UObject/Object.h  

virtual void GetAssetRegistryTagMetadata ( TMap< FName, FAssetRegistryTagMetadata >& OutMetadata
) const

 Gathers a collection of asset registry tag metadata UObject/Object.h  
Gathers a list of asset registry tags for an FAssetData. UObject/Object.h  

void GetAssetRegistryTags ( FAssetData& Out
) const

   UObject/Object.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   UObject/Object.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

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

virtual const TCHAR * GetConfigOverridePlatform()

 Returns the override config hierarchy platform (if NDAd platforms need defaults to not be in Base*.ini but still want editor to load them) UObject/Object.h  

FString GetDefaultConfigFilename()

 Get the default config filename for the specified UObject UObject/Object.h  

UObject * GetDefaultSubobjectByName ( FName ToFind
)

 Finds a default subobject associated with this object instance by its name. UObject/Object.h  

void GetDefaultSubobjects ( TArray< UObject* >& OutDefaultSubobjects
)

 Gets all directly nested default subobjects that are associated with this object instance. UObject/Object.h  

virtual FString GetDesc()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser UObject/Object.h  
This will return detail info about this specific object. UObject/Object.h  

virtual FName GetExporterName()

 Returns the name of the exporter factory used to export this object Used when multiple factories have the same extension UObject/Object.h  

virtual void GetExtendedAssetRegistryTagsForSave ( const ITargetPlatform* TargetPlatform,
TArray< FAssetRegistryTag >& OutTags
) const

 Temporary interim solution to gather asset registry data at save time only. UObject/Object.h  

virtual int32 GetFunctionCallspace ( UFunction* Function,
FFrame* Stack
)

 Return the space this function should be called. UObject/Object.h  

FString GetGlobalUserConfigFilename()

 Get the global user override config filename for the specified UObject UObject/Object.h  

virtual void GetLifetimeReplicatedProps ( TArray< class FLifetimeProperty >& OutLifetimeProps
) const

 Returns the list of replicated properties for the class and their replication configuration. UObject/Object.h  

virtual bool GetNativePropertyValues ( TMap< FString, FString >& out_PropertyValues,
uint32 ExportFlags
) const

 Callback for retrieving a textual representation of natively serialized properties. UObject/Object.h  

virtual uint64 GetNetPushIdDynamic()

 Should only ever be used by internal systems. UObject/Object.h  

virtual void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

 Called during cooking. UObject/Object.h  

virtual void GetPrestreamPackages ( TArray< UObject* >& OutPrestream
)

 Called during cooking. UObject/Object.h  
Returns an Type:Name pair representing the PrimaryAssetId for this object. UObject/Object.h  

FString GetProjectUserConfigFilename()

 Get the project user override config filename for the specified UObject UObject/Object.h  

virtual void GetReplicatedCustomConditionState ( FCustomPropertyConditionState& OutActiveState
) const

 Called when this object begins replicating to initialize the state of custom property conditions UObject/Object.h  

SIZE_T GetResourceSizeBytes ( EResourceSizeMode::Type Mode
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the simple version which just returns the total number of bytes used by this object. UObject/Object.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific). UObject/Object.h  
Save information for StaticAllocateObject in the case of overwriting an existing object. UObject/Object.h  

UScriptStruct * GetSparseClassDataStruct()

 Return the UStruct corresponding to the sidecar data structure that stores data that is constant for all instances of this class. UObject/Object.h  

virtual void GetSubobjectsWithStableNamesForNetworking ( TArray< UObject* >& ObjList
)

 Returns a list of sub-objects that have stable names for networking UObject/Object.h  

virtual bool HasNonEditorOnlyReferences()

 Called during saving to determine if the object's references are used in game even when the object itself is never loaded outside the editor (because e.g. its references are followed during cooking) UObject/Object.h  

bool Implements()

 Returns true if this object implements the interface T, false otherwise. UObject/Object.h  

virtual void ImportCustomProperties ( const TCHAR* SourceText,
FFeedbackContext* Warn
)

 Exports the property values for the specified object as text to the output device. UObject/Object.h  

void InstanceSubobjectTemplates ( FObjectInstancingGraph* InstanceGraph
)

 Wrapper for calling UClass::InstanceSubobjectTemplates() for this object. UObject/Object.h  

virtual bool IsAsset()

 Returns true if this object is considered an asset. UObject/Object.h  

bool IsBasedOnArchetype ( const UObject*const SomeObject
) const

 Determine if this object has SomeObject in its archetype chain. UObject/Object.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

 Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData UObject/Object.h  

virtual bool IsCapturingAsRootObjectForTransaction()

 Method to disable the sub object special handling in the transaction buffer for this object UObject/Object.h  

virtual EDataValidationResult IsDataValid ( TArray< FText >& ValidationErrors
)

 Generic function to validate objects during changelist validations, etc. UObject/Object.h  
Generic function to validate objects during changelist validations, etc. UObject/Object.h  
  UObject/Object.h  

virtual bool IsDestructionThreadSafe()

 Called during garbage collection to determine if an object can have its destructor called on a worker thread. UObject/Object.h  

virtual bool IsEditorOnly()

 Called during saving to determine if the object is forced to be editor only or not UObject/Object.h  

virtual bool IsFullNameStableForNetworking()

 IsFullNameStableForNetworking means an object can be referred to its full path name over the network UObject/Object.h  

bool IsInBlueprint()

 Returns whether this object is contained in or part of a blueprint object UObject/Object.h  

virtual bool IsLocalizedResource()

 Returns true if this object is considered a localized resource. UObject/Object.h  

virtual bool IsNameStableForNetworking()

 IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network UObject/Object.h  

virtual bool IsPostLoadThreadSafe()

 Called during async load to determine if PostLoad can be called on the loading thread. UObject/Object.h  

virtual bool IsReadyForAsyncPostLoad ()

 Called before calling PostLoad() in FAsyncPackage::PostLoadObjects(). UObject/Object.h  

virtual bool IsReadyForFinishDestroy ()

 Called to check if the object is ready for FinishDestroy. UObject/Object.h  

virtual bool IsSafeForRootSet()

 Returns true if this object is safe to add to the root set. UObject/Object.h  

bool IsSelected()

 Test the selection state of a UObject UObject/Object.h  

virtual bool IsSupportedForNetworking()

 IsSupportedForNetworking means an object can be referenced over the network UObject/Object.h  

void LoadConfig ( UClass* ConfigClass,
const TCHAR* Filename,
uint32 PropagationFlags,
FProperty* PropertyToLoad,
TArray< UE::ConfigAccessTracking::FConfigAccessData >* OutAccessedKeys
)

 Imports property values from an .ini file. UObject/Object.h  

virtual void LoadedFromAnotherClass ( const FName& OldClassName
)

 Called when the object was loaded from another class via active class redirects. UObject/Object.h  

virtual void MarkAsEditorOnlySubobject()

 Called during subobject creation to mark this component as editor only, which causes it to get stripped in packaged builds UObject/Object.h  

virtual bool Modify ( bool bAlwaysMarkDirty
)

 Note that the object will be modified. UObject/Object.h  

virtual void MoveDataToSparseClassDataStruct()

   UObject/Object.h  

virtual bool NeedsLoadForClient ()

 Called during saving to determine the load flags to save with the object. UObject/Object.h  

virtual bool NeedsLoadForEditorGame ()

 Called during saving to include this object in client/servers running in editor builds, even if they wouldn't normally be. UObject/Object.h  

virtual bool NeedsLoadForServer ()

 Called during saving to determine the load flags to save with the object. UObject/Object.h  

virtual bool NeedsLoadForTargetPlatform ( const ITargetPlatform* TargetPlatform
) const

 Called during saving to determine the load flags to save with the object. UObject/Object.h  

virtual void OnCookEvent ( UE::Cook::ECookEvent CookEvent,
UE::Cook::FCookEventContext& Context
)

 Called during cooking for various events that happen on each UObject in a package during load/transform/save. UObject/Object.h  

void OutputReferencers ( FOutputDevice& Ar,
FReferencerInformationList* Referencers
)

 Outputs a string to an arbitrary output device, describing the list of objects which are holding references to this one. UObject/Object.h  

virtual void OverrideConfigSection ( FString& SectionName
)

 Allows Non-PerObjectConfig classes, to override the ini section name used for loading config settings UObject/Object.h  

virtual void OverridePerObjectConfigSection ( FString& SectionName
)

 Allows PerObjectConfig classes, to override the ini section name used for the PerObjectConfig object. UObject/Object.h  

void ParseParms ( const TCHAR* Parms
)

 Import an object from a file. UObject/Object.h  

virtual void PostCDOCompiled ( const FPostCDOCompiledContext& Context
)

 Called after the Blueprint compiler has finished generating the Class Default Object (CDO) for a class. UObject/Object.h  

virtual void PostCDOCompiled ()

 Called after the Blueprint compiler has finished generating the Class Default Object (CDO) for a class. UObject/Object.h  

virtual void PostCDOContruct ()

 Called after the C++ constructor has run on the Class Default Object (CDO) for a class. UObject/Object.h  

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   UObject/Object.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad. UObject/Object.h  

void PostEditChange()

 Intentionally non-virtual as it calls the FPropertyChangedEvent version UObject/Object.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

 This alternate version of PostEditChange is called when properties inside structs are modified. UObject/Object.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally UObject/Object.h  

virtual void PostEditImport()

 Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization UObject/Object.h  

virtual void PostEditUndo ( TSharedPtr< ITransactionObjectAnnotation > TransactionAnnotation
)

 Called after applying a transaction to the object in cases where transaction annotation was provided. UObject/Object.h  

virtual void PostEditUndo ()

 Called after applying a transaction to the object. UObject/Object.h  

virtual void PostInitProperties ()

 Called after the C++ constructor and after the properties have been initialized, including those loaded from config. UObject/Object.h  

virtual void PostInterpChange ( FProperty* PropertyThatChanged
)

   UObject/Object.h  

virtual void PostLinkerChange()

 Called in response to the linker changing, this can only happen in the editor UObject/Object.h  

virtual void PostLoad ()

 Do any object-specific cleanup required immediately after loading an object. UObject/Object.h  

bool PostLoadCouldComplete()

   UObject/Object.h  

virtual void PostLoadSubobjects ( FObjectInstancingGraph* OuterInstanceGraph
)

 Instances components for objects being loaded from disk, if necessary. UObject/Object.h  

virtual void PostNetReceive()

 Called right after receiving a bunch UObject/Object.h  

virtual void PostReinitProperties ()

 Called after properties are overwritten, including after subobjects initialization from a CDO. UObject/Object.h  

virtual void PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

 Called from ReloadConfig after the object has reloaded its configuration data. UObject/Object.h  

virtual void PostRename ( UObject* OldOuter,
const FName OldName
)

 Called at the end of Rename(), but only if the rename was actually carried out UObject/Object.h  

virtual void PostRepNotifies()

 Called right after calling all OnRep notifies (called even when there are no notifies) UObject/Object.h  

virtual void PostSaveRoot ( FObjectPostSaveRootContext ObjectSaveContext
)

 Called from within SavePackage on the passed in base/root object. UObject/Object.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

 Called after the object has been transacted in some way. UObject/Object.h  

virtual void PreDestroyFromReplication()

 Called right before being marked for destruction due to network replication UObject/Object.h  

virtual void PreDuplicate ( FObjectDuplicationParameters& DupParams
)

 Called before duplication. UObject/Object.h  

virtual void PreEditChange ( FEditPropertyChain& PropertyAboutToChange
)

 This alternate version of PreEditChange is called when properties inside structs are modified. UObject/Object.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally UObject/Object.h  

virtual void PreEditUndo ()

 Called before applying a transaction to the object. UObject/Object.h  

virtual void PreNetReceive()

 Called right before receiving a bunch UObject/Object.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function. UObject/Object.h  

virtual void PreSaveRoot ( FObjectPreSaveRootContext ObjectSaveContext
)

 Called from within SavePackage on the passed in base/root object. UObject/Object.h  

virtual bool ProcessConsoleExec ( const TCHAR* Cmd,
FOutputDevice& Ar,
UObject* Executor
)

 This function handles a console exec sent to the object; it is virtual so 'nexus' objects like a player controller can reroute the command to several different objects. UObject/Object.h  

virtual void ProcessEvent ( UFunction* Function,
void* Parms
)

 Called by VM to execute a UFunction with a filled in UStruct of parameters UObject/Object.h  

void ProcessInternal ( FFrame& Stack,
void* Result
)

 Internal function call processing. UObject/Object.h  

void PropagatePostEditChange ( TArray< UObject* >& AffectedObjects,
FPropertyChangedChainEvent& PropertyChangedEvent
)

 Calls PostEditChange on all instances based on an archetype in AffectedObjects. UObject/Object.h  

void PropagatePreEditChange ( TArray< UObject* >& AffectedObjects,
FEditPropertyChain& PropertyAboutToChange
)

 Calls PreEditChange on all instances based on an archetype in AffectedObjects. UObject/Object.h  

virtual UClass * RegenerateClass ( UClass* ClassToRegenerate,
UObject* PreviousCDO
)

 Called on the target when a class is loaded with ClassGeneratedBy is loaded. UObject/Object.h  

virtual void RegisterReplicationFragments ( UE::Net::FFragmentRegistrationContext& Context,
UE::Net::EFragmentRegistrationFlags RegistrationFlags
)

 RegisterReplicationFragments is called when we an object is added to the ReplicationSystem, it allows an object to register new or existing ReplicationFragments describing data to be replicated and how it should be accessed For more information about ReplicationFragments see ReplicationFragment.h UObject/Object.h  

void ReinitializeProperties ( UObject* SourceObject,
FObjectInstancingGraph* InstanceGraph
)

 Wrapper function for InitProperties() which handles safely tearing down this object before re-initializing it from the specified source object. UObject/Object.h  

void ReloadConfig ( UClass* ConfigClass,
const TCHAR* Filename,
uint32 PropagationFlags,
FProperty* PropertyToLoad
)

 Wrapper method for LoadConfig that is used when reloading the config data for objects at runtime which have already loaded their config data at least once. UObject/Object.h  

virtual bool Rename ( const TCHAR* NewName,
UObject* NewOuter,
ERenameFlags Flags
)

 Rename this object to a unique name, or change its outer. UObject/Object.h  

virtual bool ResolveSubobject ( const TCHAR* SubObjectPath,
UObject*& OutObject,
bool bLoadIfExists
)

 Called to defer loading a subobject to its top-level container object. UObject/Object.h  

void RetrieveReferencers ( TArray< FReferencerInformation >* OutInternalReferencers,
TArray< FReferencerInformation >* OutExternalReferencers
)

 Called by OutputReferencers() to get the internal list of referencers to write UObject/Object.h  

void SaveConfig ( uint64 RequiredPropertyFlags,
const TCHAR* Filename,
FConfigCacheIni* Config,
bool bAllowCopyToDefaultObject
)

 Save configuration out to ini files Must be safe to call on class-default object UObject/Object.h  

void SaveConfig ( const FSaveConfigContext& Context
)

   UObject/Object.h  

virtual void Serialize ( FStructuredArchive::FRecord Record
)

   UObject/Object.h  

virtual void Serialize ( FArchive& Ar
)

 Handles reading, writing, and reference collecting using FArchive. UObject/Object.h  

void SerializeScriptProperties ( FStructuredArchive::FSlot Slot
) const

 Serializes the script property data located at Data. UObject/Object.h  

void SerializeScriptProperties ( FArchive& Ar
) const

 Serializes the script property data located at Data. UObject/Object.h  

void SetEditChangePropagationFlags ( EEditChangePropagationFlags InFlags
)

 Called to set the flags that control how editor change events get propagated to archetype instances. UObject/Object.h  

void SetLinker ( FLinkerLoad* LinkerLoad,
int32 LinkerIndex,
bool bShouldDetachExisting,
bool bSilenceLogs
)

 Changes the linker and linker index to the passed in one. UObject/Object.h  

void SetPostLoadCouldComplete ( bool bValue
)

   UObject/Object.h  

virtual void ShutdownAfterError()

 After a critical error, perform any mission-critical cleanup, such as restoring the video mode orreleasing hardware resources. UObject/Object.h  

void SkipFunction ( FFrame& Stack,
void*const Z_Param__Result,
UFunction* Function
)

 Advances Stack's code past the parameters to the given Function and if the function has a return value, copies the zero value for that property to the memory for the return value UObject/Object.h  

virtual void TagSubobjects ( EObjectFlags NewFlags
)

 Tags objects that are part of the same asset with the specified object flag, used for GC checking UObject/Object.h  

void ThreadedPostLoadAssetRegistryTags ( FPostLoadAssetRegistryTagsContext& Context
) const

 Internal use function for the AssetRegistry. UObject/Object.h  

bool TryUpdateDefaultConfigFile ( const FString& SpecificFileLocation,
bool bWarnIfFail
)

 Try to Saves just the section(s) for this class into the default ini file for the class (with just the changes from base) UObject/Object.h  

void UpdateDefaultConfigFile ( const FString& SpecificFileLocation
)

 Saves just the section(s) for this class into the default ini file for the class (with just the changes from base) UObject/Object.h  

void UpdateGlobalUserConfigFile()

 Saves just the section(s) for this class into the global user ini file for the class (with just the changes from base) UObject/Object.h  

void UpdateProjectUserConfigFile()

 Saves just the section(s) for this class into the project user ini file for the class (with just the changes from base) UObject/Object.h  

void UpdateSinglePropertyInConfigFile ( const FProperty* InProperty,
const FString& InConfigIniName
)

 Saves just the property into the global user ini file for the class (with just the changes from base) UObject/Object.h  

virtual void ValidateGeneratedRepEnums ( const TArray< struct FRepRecord >& ClassReps
) const

   UObject/Object.h  

virtual void WillNeverCacheCookedPlatformDataAgain()

 All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms) UObject/Object.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool CanCheckDefaultSubObjects ( bool bForceCheck,
bool& bResult
) const

 Checks it's ok to perform subobjects check at this time. UObject/Object.h  

virtual bool CheckDefaultSubobjectsInternal()

 Checks default sub-object assumptions. UObject/Object.h  

virtual TSharedPtr< ITransactionObjectAnnotation > FactoryTransactionAnnotation ( const ETransactionAnnotationCreationMode InCreationMode
) const

   UObject/Object.h  
This function actually does the work for the GetDetailedInfo() and is virtual. UObject/Object.h  

virtual bool IsSelectedInEditor()

 Test the selection state of a UObject UObject/Object.h  

virtual void ThreadedPostLoadAssetRegistryTagsOverride ( FPostLoadAssetRegistryTagsContext& Context
) const

 Performs fixup on loaded asset registry data. UObject/Object.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

 Callback used to allow object register its direct object references that are not already covered by the token stream. UObject/Object.h  
Append config values or settings that can change how instances of the class are cooked, including especially values that determine how version upgraded are conducted. UObject/Object.h  

static bool CanCreateInCurrentContext ( UObject* Template
)

 Determines if you can create an object from the supplied template in the current context (editor, client only, dedicated server, game/listen) This calls NeedsLoadForClient & NeedsLoadForServer UObject/Object.h  

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

 Declare classes that can be constructed by this class during loading. UObject/Object.h  

static void DeclareCustomVersions ( FArchive& Ar,
const UClass* SpecificSubclass
)

 Call Ar.UsingCustomVersion for every CustomVersion that might be serialized by this class when saving. UObject/Object.h  

static UObject * GetArchetypeFromRequiredInfo ( const UClass* Class,
const UObject* Outer,
FName Name,
EObjectFlags ObjectFlags
)

 Return the template that an object with this class, outer and name would be UObject/Object.h  

static TSet< FName > & GetMetaDataTagsForAssetRegistry()

 The metadata tags to be transferred from the FMetaData to the Asset Registry UObject/Object.h  

static const FName & SourceFileTagName()

 Get the common tag name used for all asset source file import paths UObject/Object.h  

static void UpdateClassesExcludedFromDedicatedClient ( const TArray< FString >& InClassNames,
const TArray< FString >& InModulesNames
)

 Update the list of classes that we should exclude from dedicated client builds UObject/Object.h  

static void UpdateClassesExcludedFromDedicatedServer ( const TArray< FString >& InClassNames,
const TArray< FString >& InModulesNames
)

 Update the list of classes that we should exclude from dedicated server builds UObject/Object.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page