Module |
|
Header |
/Engine/Source/Runtime/CoreUObject/Public/UObject/Object.h |
Include |
#include "UObject/Object.h" |
class UObject : public UObjectBaseUtility
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 | Description | |
---|---|---|
|
UObject() |
Default constructor |
|
UObject ( |
Constructor that takes an ObjectInitializer. |
|
UObject ( |
DO NOT USE. This constructor is for internal usage only for hot-reload purposes. |
|
UObject ( |
DO NOT USE. This constructor is for internal usage only for statically-created objects. |
Name | Description | ||
---|---|---|---|
|
void |
__DefaultConstructor ( |
|
|
UObject *... |
__VTableCtorCaller ( |
|
|
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. |
|
void |
AddReferencedObjects ( |
Callback used to allow object register its direct object references that are not already covered by the token stream. |
|
void |
AppendToClassSchema ( |
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. |
|
bool |
AreNativePropertiesIdenticalTo ( |
Returns whether native properties are identical to the one of the passed in component. |
|
void |
BeginCacheForCookedPlatformData ( |
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 |
|
void |
BeginDestroy() |
Called before destroying the object. |
|
void |
BuildSubobjectMapping |
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. |
|
void |
CallAddReferencedObjects ( |
Helper function to call AddReferencedObjects for this object's class. |
|
void |
CallFunction |
Internal VM method for executing a function |
|
bool |
CallFunctionByNameWithArguments ( |
Handle calling a function by name when executed from the console or a command line |
|
bool |
CallRemoteFunction ( |
Call the actor's function remotely |
|
bool |
CanCheckDefaultSubObjects ( |
Checks it's ok to perform subobjects check at this time. |
|
bool |
CanCreateInCurrentContext ( |
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 |
|
bool |
CanEditChange ( |
Alternate version of CanEditChange that includes the full property chain leading to the property in question. |
|
bool |
CanEditChange ( |
Called by the editor to query whether a property of this object is allowed to be modified. |
|
bool |
CanModify() |
Utility to allow overrides of Modify to avoid doing work if this object cannot be safely modified |
|
bool |
CheckDefaultSubobjects ( |
Checks default sub-object assumptions. |
|
bool |
CheckDefaultSubobjectsInternal() |
Checks default sub-object assumptions. |
|
void |
ClearAllCachedCookedPlatformData() |
Clear all cached cooked platform data |
|
void |
ClearCachedCookedPlatformData ( |
Clears cached cooked platform data for specific platform |
|
void |
CollectDefaultSubobjects |
Uses the TArchiveObjectReferenceCollector to build a list of all components referenced by this object which have this object as the outer |
|
bool |
ConditionalBeginDestroy() |
Called before destroying the object. |
|
bool |
ConditionalFinishDestroy() |
Called when an object is actually destroyed, memory should never be accessed again |
|
void |
ConditionalPostLoad() |
PostLoad if needed. |
|
void |
ConditionalPostLoadSubobjects ( |
Instances subobjects and components for objects being loaded from disk, if necessary. |
|
void |
CookAdditionalFiles ( |
Called during cook to allow objects to generate additional cooked files alongside their cooked package. |
|
TSharedPtr< ... |
CreateAndRestoreTransactionAnnotation ( |
Create and restore a previously serialized annotation object with any external data required for applying a transaction |
|
TReturnType ... |
CreateDefaultSubobject ( |
Create a component or subobject, allows creating a child class and returning the parent class. |
|
TReturnType ... |
CreateDefaultSubobject ( |
Create a component or subobject. |
|
UObject *... |
CreateDefaultSubobject |
Utility function for templates below |
|
TReturnType ... |
CreateEditorOnlyDefaultSubobject ( |
Create a component or subobject only to be used with the editor. |
|
TReturnType ... |
CreateOptionalDefaultSubobject ( |
Create an optional component or subobject. |
|
TReturnType ... |
CreateOptionalDefaultSubobject ( |
Create an optional component or subobject. |
|
void |
DeclareConstructClasses ( |
Declare classes that can be constructed by this class during loading. |
|
void |
DeclareCustomVersions |
Call Ar.UsingCustomVersion for every CustomVersion that might be serialized by this class when saving. |
|
void |
DestroyNonNativeProperties() |
Destroy properties that won't be destroyed by the native destructor |
|
void |
ExecuteUbergraph ( |
Execute the ubergraph from a specific entry point |
|
void |
ExportCustomProperties ( |
Exports the property values for the specified object as text to the output device. |
|
TSharedPtr< ... |
FactoryTransactionAnnotation ( |
|
|
UFunction &#... |
FindFunction ( |
Returns a UFunction with the specified name, wrapper for UClass::FindFunctionByName() |
|
UFunction &#... |
FindFunctionChecked ( |
Version of FindFunction() that will assert if the function was not found |
|
TSharedPtr< ... |
FindOrCreateTransactionAnnotation() |
Find or create and populate an annotation object with any external data required for applying a transaction |
|
void |
FinishDestroy() |
Called to finish destroying the object. |
|
UObject *... |
GetArchetype() |
Return the template this object is based on. |
|
UObject *... |
GetArchetypeFromRequiredInfo |
Return the template that an object with this class, outer and name would be |
|
void |
GetArchetypeInstances |
Builds a list of objects which have this object in their archetype chain. |
|
void |
GetAssetRegistryTagMetadata ( |
Gathers a collection of asset registry tag metadata |
|
void |
GetAssetRegistryTags ( |
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 |
|
void |
GetAssetRegistryTags ( |
Gathers a list of asset registry tags for an FAssetData |
|
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) |
|
GetDefaultConfigFilename() |
Get the default config filename for the specified UObject |
|
|
UObject *... |
GetDefaultSubobjectByName ( |
Finds a subobject associated with this object instance by its name |
|
void |
GetDefaultSubobjects |
Gets all default subobjects associated with this object instance. |
|
GetDesc() |
Return a one line description of an object for viewing in the thumbnail view of the generic browser |
|
|
GetDetailedInfo() |
This will return detail info about this specific object. |
|
|
GetDetailedInfoInternal() |
This function actually does the work for the GetDetailedInfo() and is virtual. |
|
|
GetExporterName() |
Returns the name of the exporter factory used to export this object Used when multiple factories have the same extension |
|
|
void |
GetExtendedAssetRegistryTagsForSave ( |
Temporary interim solution to gather asset registry data at save time only. |
|
int32 |
GetFunctionCallspace |
Return the space this function should be called. |
|
GetGlobalUserConfigFilename() |
Get the global user override config filename for the specified UObject |
|
|
void |
GetLifetimeReplicatedProps ( |
Returns properties that are replicated for the lifetime of the actor channel |
|
GetMetaDataTagsForAssetRegistry() |
The metadata tags to be transferred from the UMetaData to the Asset Registry |
|
|
bool |
GetNativePropertyValues |
Callback for retrieving a textual representation of natively serialized properties. |
|
uint64 |
GetNetPushIdDynamic() |
Should only ever be used by internal systems. |
|
void |
GetPreloadDependencies |
Called during cooking. |
|
void |
GetPrestreamPackages |
Called during cooking. |
|
FPrimaryAsse... |
GetPrimaryAssetId() |
Returns an Type:Name pair representing the PrimaryAssetId for this object. |
|
GetProjectUserConfigFilename() |
Get the project user override config filename for the specified UObject |
|
|
void |
GetReplicatedCustomConditionState ( |
Called when this object begins replicating to initialize the state of custom property conditions |
|
SIZE_T |
GetResourceSizeBytes ( |
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. |
|
void |
GetResourceSizeEx ( |
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). |
|
FRestoreForU... |
GetRestoreForUObjectOverwrite() |
Save information for StaticAllocateObject in the case of overwriting an existing object. |
|
UScriptStruc... |
GetSparseClassDataStruct() |
Return the UStruct corresponding to the sidecar data structure that stores data that is constant for all instances of this class. |
|
void |
GetSubobjectsWithStableNamesForNetworking |
Returns a list of sub-objects that have stable names for networking |
|
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) |
|
bool |
Implements() |
Returns true if this object implements the interface T, false otherwise. |
|
void |
ImportCustomProperties ( |
Exports the property values for the specified object as text to the output device. |
|
void |
InstanceSubobjectTemplates ( |
Wrapper for calling UClass::InstanceSubobjectTemplates() for this object. |
|
bool |
IsAsset() |
Returns true if this object is considered an asset. |
|
bool |
IsBasedOnArchetype ( |
Determine if this object has SomeObject in its archetype chain. |
|
bool |
IsCachedCookedPlatformDataLoaded ( |
Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData |
|
EDataValidat... |
IsDataValid |
Generic function to validate objects during changelist validations, etc. |
|
EDataValidat... |
IsDataValid ( |
Generic function to validate objects during changelist validations, etc. |
|
bool |
IsDestructionThreadSafe() |
Called during garbage collection to determine if an object can have its destructor called on a worker thread. |
|
bool |
IsEditorOnly() |
Called during saving to determine if the object is forced to be editor only or not |
|
bool |
IsFullNameStableForNetworking() |
IsFullNameStableForNetworking means an object can be referred to its full path name over the network |
|
bool |
IsInBlueprint() |
Returns whether this object is contained in or part of a blueprint object |
|
bool |
IsLocalizedResource() |
Returns true if this object is considered a localized resource. |
|
bool |
IsNameStableForNetworking() |
IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network |
|
bool |
IsPostLoadThreadSafe() |
Called during async load to determine if PostLoad can be called on the loading thread. |
|
bool |
IsReadyForAsyncPostLoad() |
Called before calling PostLoad() in FAsyncPackage::PostLoadObjects(). |
|
bool |
IsReadyForFinishDestroy() |
Called to check if the object is ready for FinishDestroy. |
|
bool |
IsSafeForRootSet() |
Returns true if this object is safe to add to the root set. |
|
bool |
IsSelected() |
Test the selection state of a UObject |
|
bool |
IsSelectedInEditor() |
Test the selection state of a UObject |
|
bool |
IsSupportedForNetworking() |
IsSupportedForNetworking means an object can be referenced over the network |
|
void |
LoadConfig |
Imports property values from an .ini file. |
|
void |
LoadedFromAnotherClass ( |
Called when the object was loaded from another class via active class redirects. |
|
void |
MarkAsEditorOnlySubobject() |
Called during subobject creation to mark this component as editor only, which causes it to get stripped in packaged builds |
|
bool |
Modify ( |
Note that the object will be modified. |
|
void |
MoveDataToSparseClassDataStruct() |
|
|
bool |
NeedsLoadForClient() |
Called during saving to determine the load flags to save with the object. |
|
bool |
NeedsLoadForEditorGame() |
Called during saving to include this object in client/servers running in editor builds, even if they wouldn't normally be. |
|
bool |
NeedsLoadForServer() |
Called during saving to determine the load flags to save with the object. |
|
bool |
NeedsLoadForTargetPlatform ( |
Called during saving to determine the load flags to save with the object. |
|
void |
OutputReferencers ( |
Outputs a string to an arbitrary output device, describing the list of objects which are holding references to this one. |
|
void |
OverrideConfigSection ( |
Allows Non-PerObjectConfig classes, to override the ini section name used for loading config settings |
|
void |
OverridePerObjectConfigSection ( |
Allows PerObjectConfig classes, to override the ini section name used for the PerObjectConfig object. |
|
void |
ParseParms ( |
Import an object from a file. |
|
void |
PostCDOCompiled ( |
Called after the Blueprint compiler has finished generating the Class Default Object (CDO) for a class. |
|
void |
PostCDOContruct() |
Called after the C++ constructor has run on the Class Default Object (CDO) for a class. |
|
void |
PostDuplicate ( |
|
|
void |
PostDuplicate ( |
Called after duplication & serialization and before PostLoad. |
|
void |
PostEditChange() |
Intentionally non-virtual as it calls the FPropertyChangedEvent version |
|
void |
PostEditChangeChainProperty ( |
This alternate version of PostEditChange is called when properties inside structs are modified. |
|
void |
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
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 |
|
void |
PostEditUndo |
Called after applying a transaction to the object in cases where transaction annotation was provided. |
|
void |
PostEditUndo() |
Called after applying a transaction to the object. |
|
void |
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
void |
PostInterpChange ( |
This is called when property is modified by InterpPropertyTracks |
|
void |
PostLinkerChange() |
Called in response to the linker changing, this can only happen in the editor |
|
void |
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
void |
PostLoadAssetRegistryTags ( |
Performs fixup on loaded asset registry data. |
|
void |
PostLoadSubobjects ( |
Instances components for objects being loaded from disk, if necessary. |
|
void |
PostNetReceive() |
Called right after receiving a bunch |
|
void |
PostReinitProperties() |
Called after properties are overwritten, including after subobjects initialization from a CDO. |
|
void |
PostReloadConfig ( |
Called from ReloadConfig after the object has reloaded its configuration data. |
|
void |
PostRename |
Called at the end of Rename(), but only if the rename was actually carried out |
|
void |
PostRepNotifies() |
Called right after calling all OnRep notifies (called even when there are no notifies) |
|
void |
PostSaveRoot ( |
Called from within SavePackage on the passed in base/root object. |
|
void |
PostTransacted ( |
Called after the object has been transacted in some way. |
|
void |
PreDestroyFromReplication() |
Called right before being marked for destruction due to network replication |
|
void |
PreDuplicate ( |
Called before duplication. |
|
void |
PreEditChange ( |
This alternate version of PreEditChange is called when properties inside structs are modified. |
|
void |
PreEditChange ( |
This is called when a property is about to be modified externally |
|
void |
PreEditUndo() |
Called before applying a transaction to the object. |
|
void |
PreNetReceive() |
Called right before receiving a bunch |
|
void |
PreSave ( |
Presave function. |
|
void |
PreSaveRoot ( |
Called from within SavePackage on the passed in base/root object. |
|
bool |
ProcessConsoleExec ( |
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. |
|
void |
ProcessEvent ( |
Called by VM to execute a UFunction with a filled in UStruct of parameters |
|
void |
ProcessInternal ( |
Internal function call processing. |
|
void |
PropagatePostEditChange ( |
Calls PostEditChange on all instances based on an archetype in AffectedObjects. |
|
void |
PropagatePreEditChange ( |
Calls PreEditChange on all instances based on an archetype in AffectedObjects. |
|
UClass * |
RegenerateClass |
Called on the target when a class is loaded with ClassGeneratedBy is loaded. |
|
void |
ReinitializeProperties ( |
Wrapper function for InitProperties() which handles safely tearing down this object before re-initializing it from the specified source object. |
|
void |
ReloadConfig |
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. |
|
bool |
Rename ( |
Rename this object to a unique name, or change its outer. |
|
bool |
ResolveSubobject ( |
Called to defer loading a subobject to its top-level container object. |
|
void |
RetrieveReferencers ( |
Called by OutputReferencers() to get the internal list of referencers to write |
|
void |
SaveConfig ( |
Save configuration out to ini files Must be safe to call on class-default object |
|
void |
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
|
void |
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
|
void |
SerializeScriptProperties ( |
Serializes the script property data located at Data. |
|
void |
SerializeScriptProperties ( |
Serializes the script property data located at Data. |
|
void |
SetLinker ( |
Changes the linker and linker index to the passed in one. |
|
void |
ShutdownAfterError() |
After a critical error, perform any mission-critical cleanup, such as restoring the video mode orreleasing hardware resources. |
|
void |
SkipFunction |
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 |
|
const FName ... |
SourceFileTagName() |
Get the common tag name used for all asset source file import paths |
|
UClass * |
StaticClass() |
Returns a UClass object representing this class at runtime |
|
EClassCastFl... |
StaticClassCastFlags() |
Returns the static cast flags for this class |
|
const TCHAR ... |
StaticConfigName() |
|
|
const TCHAR ... |
StaticPackage() |
Returns the package this class belongs in |
|
void |
StaticRegisterNativesUObject() |
|
|
void |
TagSubobjects ( |
Tags objects that are part of the same asset with the specified object flag, used for GC checking |
|
bool |
TryUpdateDefaultConfigFile ( |
Try to Saves just the section(s) for this class into the default ini file for the class (with just the changes from base) |
|
void |
UpdateClassesExcludedFromDedicatedClient |
Update the list of classes that we should exclude from dedicated client builds |
|
void |
UpdateClassesExcludedFromDedicatedServer |
Update the list of classes that we should exclude from dedicated server builds |
|
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) |
|
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) |
|
void |
UpdateSinglePropertyInConfigFile |
Saves just the property into the global user ini file for the class (with just the changes from base) |
|
void |
ValidateGeneratedRepEnums ( |
|
|
void |
WillNeverCacheCookedPlatformDataAgain() |
All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms) |
Name | Description | ||
---|---|---|---|
|
void |
operator delete ( |
Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy. |
|
void * |
operator new ( |
For internal use only; use StaticConstructObject() to create new objects. |
|
void * |
operator new |
For internal use only; use StaticConstructObject() to create new objects. |
Name |
Description |
|
---|---|---|
|
FAssetRegistryTag |
Struct used by GetAssetRegistryTags() to return tag info |
|
FAssetRegistryTagMetadata |
Additional data pertaining to asset registry tags used by the editor |
|
Object_eventExecuteUbergraph_Parms |
Wrapper struct to hold the entrypoint in the right memory address |
Name |
Description |
|
---|---|---|
|
ENetFields_Private |
|
|
ETransactionAnnotationCreationMode |
Factory a new annotation object and optionally populate it with data |
Name |
Description |
---|---|
FPostCDOCompiledContext |
|
Super |
Typedef for the base class (UObject) |
ThisClass |
Typedef for UObject. |
WithinClass |
Name |
Description |
---|---|
StaticClassFlags |
Bitwise union of EClassFlags pertaining to this class. |
Name | Description | ||
---|---|---|---|
|
void |
CookAdditionalFiles ( |
Use the new CookAdditionalFilesOverride that provides a function to write the files |
|
TReturnType ... |
CreateAbstractDefaultSubobject ( |
CreateAbstract did not work as intended and has been deprecated in favor of CreateDefaultObject |
|
UObject *... |
CreateDefaultSubobject |
CreateDefaultSubobject no longer takes bAbstract as a parameter. |
|
void |
GetExternalActorExtendedAssetRegistryTags ( |
Use the new GetExtendedAssetRegistryTagsForSave that takes a TargetPlatform |
|
void |
PostCDOCompiled() |
Use version that takes FPostCDOCompiledContext instead. |
|
void |
PostSaveRoot ( |
Use version that takes FObjectPostSaveContext instead. |
|
void |
PreSave ( |
Use version that takes FObjectPreSaveContext instead. |
|
bool |
PreSaveRoot ( |
Use version that takes FObjectPreSaveContext instead. |
|
void |
UpdateDefaultConfigFile ( |
TryUpdateDefaultConfigFile replaces UpdateDefaultConfigFile |