Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h |
Include |
#include "UObject/Class.h" |
class UClass : public UStruct
An object class.
Name | Description | ||
---|---|---|---|
|
bCooked |
Used to check if the class was cooked or not |
|
|
bLayoutChanging |
Used to check if the class layout is currently changing and therefore is not ready for a CDO to be created |
|
|
ClassAddReferencedObjects |
Pointer to a static AddReferencedObjects method. |
|
|
ClassCastFlags |
Cast flags used to accelerate dynamic_cast |
|
|
ClassConfigName |
Which Name.ini file to load Config variables out of |
|
|
ClassConstructor |
||
|
UObject * |
ClassDefaultObject |
The class default object; used for delta serialization and object initialization |
|
ClassFlags |
Class flags; See EClassFlags for more information |
|
|
UObject * |
ClassGeneratedBy |
This is the blueprint that caused the generation of this class, or null if it is a native compiled-in class |
|
ClassReps |
List of replication records |
|
|
ClassUnique |
Class pseudo-unique counter; used to accelerate unique instance name generation |
|
|
ClassVTableHelperCtorCaller |
||
|
UClass * |
ClassWithin |
The required type for the outer of instances of this class |
|
FirstOwnedClassRep |
Index of the first ClassRep that belongs to this class. |
|
|
Interfaces |
The list of interfaces which this class implements, along with the pointer property that is located at the offset of the interface's vtable. |
|
|
NativeFunctionLookupTable |
This class's native functions. |
|
|
NetFields |
List of network relevant fields (functions) |
|
|
FField * |
PropertiesPendingDestruction |
Linked list of properties to be destroyed when this class is destroyed that couldn't be destroyed in PurgeClass |
|
ReferenceTokenStream |
Reference token stream used by realtime garbage collector, finalized in AssembleReferenceTokenStream |
|
|
ReferenceTokenStreamCritical |
CS for the token stream. |
|
|
void * |
SparseClassData |
This is where we store the data that is only changed per class instead of per instance |
|
UScriptStruct &... |
SparseClassDataStruct |
The struct used to store sparse class data. |
Name | Description | |
---|---|---|
|
UClass ( |
DO NOT USE. This constructor is for internal usage only for hot-reload purposes. |
|
UClass ( |
Constructors. |
|
UClass ( |
Create a new UClass given its superclass. |
|
UClass ( |
Called when statically linked. |
Name | Description | ||
---|---|---|---|
|
__DefaultConstructor ( |
||
|
UObject *... |
__VTableCtorCaller ( |
|
|
AddDefaultSubobject |
Adds a new default instance map item |
|
|
AddFunctionToFunctionMap |
Add a function to the function map |
|
|
AddNativeFunction ( |
Add a native function to the internal native function table, but with a unicode name. |
|
|
AddNativeFunction ( |
Add a native function to the internal native function table |
|
|
AddReferencedObjects ( |
Callback used to allow an object to register its direct object references that are not already covered by the token stream. |
|
|
AssembleReferenceTokenStream ( |
Assembles the token stream for realtime garbage collection by combining the per class only token stream for each class in the class hierarchy. |
|
|
AssembleReferenceTokenStreams() |
Assemble reference token streams for all classes if they haven't had it assembled already |
|
|
CallAddReferencedObjects ( |
Calls AddReferencedObjects static method on the specified object. |
|
|
CleanupSparseClassData() |
||
|
ClearFunctionMapsCaches() |
Clears the function name caches, in case things have changed |
|
|
ClearSparseClassDataStruct() |
Clears the sparse class data struct for this and all child classes that directly reference it as a super-struct |
|
|
ConditionalRecompileClass ( |
Conditionally recompiles the class after loading, in case any dependencies were also newly loaded |
|
|
UObject *... |
CreateDefaultObject() |
Get the default object from the class, creating it if missing, if requested or under a few other circumstances |
|
CreateLinkAndAddChildFunctionsToMap ( |
||
|
CreatePersistentUberGraphFrame |
Creates memory to store temporary data |
|
|
void * |
CreateSparseClassData() |
|
|
DestroyPersistentUberGraphFrame |
Clears memory to store temporary data |
|
|
DestroyPropertiesPendingDestruction() |
Destroys properties that couldn't be destroyed in PurgeClass |
|
|
EmitExternalPackageReference() |
Realtime garbage collection helper function used to emit token containing information about an external package reference. |
|
|
EmitFixedArrayBegin |
Realtime garbage collection helper function used to indicate the beginning of a fixed array. |
|
|
EmitFixedArrayEnd() |
Realtime garbage collection helper function used to indicated the end of a fixed array. |
|
|
EmitObjectArrayReference |
Realtime garbage collection helper function used to emit token containing information about a an array of UObject references at the passed in offset. |
|
|
EmitObjectReference ( |
Realtime garbage collection helper function used to emit token containing information about a direct UObject reference at the passed in offset. |
|
|
EmitStructArrayBegin |
Realtime garbage collection helper function used to indicate an array of structs at the passed in offset. |
|
|
EmitStructArrayEnd ( |
Realtime garbage collection helper function used to indicate the end of an array of structs. |
|
|
UObject *... |
FindArchetype |
Finds the object that is used as the parent object when serializing properties, overridden for blueprints |
|
UClass * |
FindCommonBase |
Finds the common base class that parents the two classes passed in. |
|
UClass * |
FindCommonBase |
Finds the common base class that parents the array of classes passed in. |
|
UFunction &#... |
FindFunctionByName ( |
Looks for a given function name |
|
FlushCompilationQueueForLevel() |
||
|
GenerateFunctionList |
||
|
UObject *... |
GetArchetypeForCDO() |
Returns archetype object for CDO |
|
const void &... |
GetArchetypeForSparseClassData() |
Returns archetype for sparse class data |
|
UClass * |
GetAuthoritativeClass() |
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 |
|
const UClass... |
GetAuthoritativeClass() |
|
|
GetAutoCollapseCategories |
||
|
GetAutoExpandCategories |
||
|
GetClassFlags() |
Gets the class flags. |
|
|
GetClassGroupNames |
||
|
const FStrin... |
GetConfigName() |
Translates the hardcoded script config names (engine, editor, input and game) to their global pendants and otherwise uses config(myini) name to look for a game specific implementation and creates one based on the default if it doesn't exist yet. |
|
const ICppCl... |
GetCppTypeInfo() |
Provides access to C++ type info. |
|
T * |
GetDefaultObject() |
Get the default object from the class and cast to a particular type |
|
UObject *... |
GetDefaultObject ( |
Get the default object from the class |
|
GetDefaultObjectName() |
Get the name of the CDO for the this class |
|
|
GetDefaultObjectPreloadDependencies |
Returns all objects that should be preloaded before the class default object is serialized at load time. |
|
|
GetDefaultObjectSubobjects |
Gets all default instanced objects (often components). |
|
|
FFeedbackCon... |
GetDefaultPropertiesFeedbackContext() |
Feedback context for default property import |
|
GetDefaultsCount() |
Returns amount of memory used by default object |
|
|
UObject *... |
GetDefaultSubobjectByName ( |
Searches for the default instanced object (often a component) by name |
|
GetDescription() |
||
|
GetHideFunctions |
Editor only properties. |
|
|
void * |
GetOrCreateSparseClassData() |
Returns a pointer to the sidecar data structure. |
|
UPackage ... |
GetOuterUPackage() |
|
|
uint8 * |
GetPersistentUberGraphFrame |
Returns memory used to store temporary data on an instance, used by blueprints |
|
GetPrioritizeCategories |
||
|
const void &... |
GetSparseClassData ( |
Returns a pointer to the sidecar data structure, based on the EGetSparseClassDataMethod. |
|
UScriptStruc... |
GetSparseClassDataArchetypeStruct() |
Returns the struct used by the sparse class data archetype |
|
UScriptStruc... |
GetSparseClassDataStruct() |
Returns a pointer to the type of the sidecar data structure if one is specified. |
|
UClass * |
GetSuperClass() |
Returns parent class, the parent of a Class is always another class |
|
HasAllCastFlags ( |
||
|
HasAllClassFlags ( |
Used to safely check whether all of the passed in flags are set. |
|
|
HasAnyCastFlag ( |
Used to safely check whether the passed in flag is set. |
|
|
HasAnyClassFlags ( |
Used to safely check whether the passed in flag is set. |
|
|
HasProperty ( |
Checks if the property exists on this class or a parent class. |
|
|
HotReloadPrivateStaticClass ( |
Called when a class is reloading from a DLL...updates various information in-place. |
|
|
ImplementsInterface ( |
This will return whether or not this class implements the passed in class / interface |
|
|
InitPropertiesFromCustomList |
Helper method to assist with initializing object properties from an explicit list. |
|
|
IsAutoCollapseCategory ( |
||
|
IsAutoExpandCategory ( |
||
|
IsClassGroupName ( |
||
|
IsFunctionHidden ( |
||
|
IsFunctionImplementedInScript ( |
Determines if the specified function has been implemented in a Blueprint |
|
|
IsPrioritizeCategory ( |
||
|
IsSafeToSerializeToStructuredArchives ( |
Helper function for determining if the given class is compatible with structured archive serialization |
|
|
OverridesSparseClassDataArchetype() |
Returns whether the sparse class data on this instance overrides that of its archetype (in type or value) |
|
|
PostInitInstance ( |
Called after PostInitProperties during object construction to allow class specific initialization of an object instance. |
|
|
PostLoadDefaultObject ( |
Wraps the PostLoad() call for the class default object. |
|
|
PurgeClass ( |
Purges out the properties of this class in preparation for it to be regenerated |
|
|
RemoveFunctionFromFunctionMap ( |
Remove a function from the function map |
|
|
ReplaceNativeFunction ( |
Replace a native function in the internal native function table |
|
|
SerializeDefaultObject |
Serializes the passed in object as this class's default object using the given archive |
|
|
SerializeDefaultObject ( |
Serializes the passed in object as this class's default object using the given archive slot |
|
|
SerializeSparseClassData ( |
Serializes the associated sparse class data for the passed in object using the given archive slot. |
|
|
SetCppTypeInfoStatic ( |
Sets C++ type information. Should not be NULL. |
|
|
SetSparseClassDataStruct ( |
||
|
SetupObjectInitializer ( |
Allows class to provide data to the object initializer that can affect how native class subobjects are created. |
|
|
SetUpRuntimeReplicationData() |
Initializes the ClassReps and NetFields arrays used by replication. |
|
|
UClass * |
StaticClass() |
Returns a UClass object representing this class at runtime |
|
EClassCastFl... |
StaticClassCastFlags() |
Returns the static cast flags for this class |
|
const TCHAR ... |
StaticPackage() |
Returns the package this class belongs in |
|
StaticRegisterNativesUClass() |
Name | Description | ||
---|---|---|---|
|
const TCHAR ... |
GetPrefixCPP() |
Returns the struct/ class prefix used for the C++ declaration of this struct/ class. |
|
IsStructTrashed() |
If true, this class has been cleaned and sanitized (trashed) and should not be used |
|
|
Link |
Creates the field/property links and gets structure ready for use at runtime |
|
|
SetSuperStruct ( |
Sets the super struct pointer and updates hash information as necessary. |
Name | Description | ||
---|---|---|---|
|
FinishDestroy() |
Called to finish destroying the object. |
|
|
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 |
|
|
GetDesc() |
Return a one line description of an object for viewing in the thumbnail view of the generic browser |
|
|
GetPreloadDependencies |
Called during cooking. |
|
|
FRestoreForU... |
GetRestoreForUObjectOverwrite() |
Save information for StaticAllocateObject in the case of overwriting an existing object. |
|
IsAsset() |
Returns true if this object is considered an asset. |
|
|
IsNameStableForNetworking() |
IsNameStableForNetworking means an object can be referred to its path name (relative to outer) over the network |
|
|
PostInitProperties() |
Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
Rename ( |
Rename this object to a unique name, or change its outer. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
|
|
TagSubobjects ( |
Tags objects that are part of the same asset with the specified object flag, used for GC checking |
Name | Description | ||
---|---|---|---|
|
DeferredRegister |
Convert a boot-strap registered class into a real one, add to uobject array, etc |
Name | Description | ||
---|---|---|---|
|
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 |
---|---|
ClassAddReferencedObjectsType |
|
ClassConstructorType |
|
ClassVTableHelperCtorCallerType |
|
StaticClassFunctionType |
|
Super |
Typedef for the base class (UStruct) |
ThisClass |
Typedef for UClass. |
WithinClass |
The required type of this object's outer (class UPackage) |
Name |
Description |
---|---|
StaticClassFlags |
Bitwise union of EClassFlags pertaining to this class. |
Name | Description | ||
---|---|---|---|
|
IsFunctionImplementedInBlueprint ( |
IsFunctionImplementedInBlueprint is deprecated, call IsFunctionImplementedInScript instead |