1. Epic GamesDeveloper
  3. UStruct

UStruct

Base class for all [UObject](API\Runtime\CoreUObject\UObject\UObject) types that contain fields.

API > API/Runtime > API/Runtime/CoreUObject > API/Runtime/CoreUObject/UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h
Include #include "UObject/Class.h"

Syntax

class UStruct :  
    public UField,  
    private FStructBaseChain

Remarks

Base class for all UObject types that contain fields.

Variables

  Type Name Description
Protected variable bool bHasAssetRegistrySearchableProperties True if this struct has Asset Registry searchable properties
Public variable FField * ChildProperties Pointer to start of linked list of child fields
Public variable TObjectPtr< UField > Children Pointer to start of linked list of child fields
Public variable FProperty * DestructorLink In memory only: Linked list of properties requiring destruction.
Public variable int32 FieldPathSerialNumber Unique id incremented each time this class properties get destroyed
Public variable int32 MinAlignment Alignment of structure in memory, structure will be at least this large
Public variable FProperty * PostConstructLink In memory only: Linked list of properties requiring post constructor initialization
Public variable int32 PropertiesSize Total size of all UProperties, the allocated structure may be larger due to alignment
Public variable FProperty * PropertyLink In memory only: Linked list of properties from most-derived to base
Public variable TArray< TObjectPtr< UPropertyWrapper > > PropertyWrappers List of wrapper UObjects for FProperties
Public variable FProperty * RefLink In memory only: Linked list of object reference properties from most-derived to base
Public variable TArray< uint8 > Script Script bytecode associated with this object
Public variable TArray< TObjectPtr< UObject > > ScriptAndPropertyObjectReferences Array of object references embedded in script code and referenced by FProperties.
Public variable FUnresolvedScriptPropertiesArray * UnresolvedScriptProperties Contains a list of script properties that couldn't be resolved at load time
Public variable const FUnversionedStructSchema * UnversionedEditorSchema Cached schema for optimized unversioned property serialization, with editor data, owned by this.
Public variable const FUnversionedStructSchema * UnversionedGameSchema Cached schema for optimized unversioned and filtereditoronly property serialization, owned by this.

Constructors

  Type Name Description
Public function  

UStruct ( const FObjectInitializer& ObjectInitializer
)

  
Public function COREUOBJECT_API

UStruct ( FVTableHelper& Helper
)

 DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
Public function  

UStruct ( UStruct* InSuperStruct,
SIZE_T ParamsSize,
SIZE_T Alignment
)

  
Public function  

UStruct ( EStaticConstructor,
int32 InSize,
int32 InAlignment,
EObjectFlags InFlags
)

 Constructors.
Public function  

UStruct ( const FObjectInitializer& ObjectInitializer,
UStruct* InSuperStruct,
SIZE_T ParamsSize,
SIZE_T Alignment
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void  
Public function Static UObject *  
Public function Static void  
Protected function Virtual Const bool Returns if we have access to property guids
Public function void Collects UObjects referenced by bytecode and properties for faster GC access
Public function void Collects UObjects referenced by bytecode and properties for this class and its child fields and their children...
Public function void

CollectBytecodeReferencedObjects ( TArray< UObject* >& OutReferencedObjects
)

 Collects UObjects referenced by bytecode
Public function void

CollectPropertyReferencedObjects ( TArray< UObject* >& OutReferencedObjects
)

 Collects UObjects referenced by properties
Protected function void  
Public function Virtual Const FProperty *

CustomFindProperty ( const FName InName
)

 Look up a property by an alternate name if it was not found in the first search, this is overridden for user structs
Public function void Deletes the UnresolvedScriptProperties array
Public function void Destroys all properties owned by this struct
Public function Virtual Const void

DestroyStruct ( void* Dest,
int32 ArrayDim
)

 Destroy a struct in memory.
Public function Const FProperty * Searches property link chain for a property with the specified name
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 Const FString

GetAuthoredNameForField ( const UField* Field
)

 Returns a human readable string for a given field, overridden for user defined structs
Public function Virtual Const FString

GetAuthoredNameForField ( const FField* Field
)

 Returns a human readable string for a given field, overridden for user defined structs
Public function Const bool Try and find boolean metadata with the given key.
Public function Virtual Const UStruct * Returns the structure used for inheritance, may be changed by child types
Public function Const int32 Alignment of structure in memory, structure will be at least this large
Public function Virtual Const const TCHAR * Returns the struct/ class prefix used for the C++ declaration of this struct/ class.
Public function Const int32 Total size of all UProperties, the allocated structure may be larger due to alignment
Public function Const const FBlake3Hash &

GetSchemaHash ( bool bSkipEditorOnly
)

 Get the Schema Hash for this struct - the hash of its property names and types.
Public function Const bool

GetStringMetaDataHierarchical ( const FName& Key,
FString* OutValue
)

 Try and find string metadata with the given key.
Public function Const FTopLevelAssetPath Returns struct path name as a package + struct FName pair
Public function Const int32 Returns actual allocated size of structure in memory
Public function Const UStruct * Struct this inherits from, may be null
Public function Const bool Returns true if this struct has Asset Registry searchable properties
Public function Const const UStruct * Determines if the struct or any of its super structs has any metadata associated with the provided key
Public function Virtual Const void

InitializeStruct ( void* Dest,
int32 ArrayDim
)

 Initialize a struct over uninitialized memory.
Public function void

InstanceSubobjectTemplates ( void* Data,
void const* DefaultData,
UStruct* DefaultStruct,
UObject* Owner,
FObjectInstancingGraph* InstanceGraph
)

 Creates new copies of components
Public function Const bool

IsChildOf ( const UStruct* SomeBase
)

 Returns true if this struct either is SomeBase, or is a child of SomeBase.
Public function Const bool Returns true if this struct either is class T, or is a child of class T.
Public function Virtual Const bool If true, this class has been cleaned and sanitized (trashed) and should not be used
Public function Virtual void

Link ( FArchive& Ar,
bool bRelinkExistingProperties
)

 Creates the field/property links and gets structure ready for use at runtime
Protected function Const void

LoadTaggedPropertiesFromText ( FStructuredArchive::FSlot Slot,
uint8* Data,
UStruct* DefaultsStruct,
uint8* Defaults,
const UObject* BreakRecursionIfFullyLoad
)

 Serializes list of properties to a te, using property tags to handle mismatches
Public function Virtual void Preloads all fields that belong to this struct
Public function Virtual Const void Serializes struct properties, does not handle defaults.
Public function Virtual Const void

SerializeBin ( FArchive& Ar,
void* Data
)

 Serializes struct properties, does not handle defaults.
Public function Const void

SerializeBinEx ( FStructuredArchive::FSlot Slot,
void* Data,
void const* DefaultData,
UStruct* DefaultStruct
)

 Serializes the class properties that reside in Data if they differ from the corresponding values in DefaultData
Public function Virtual EExprToken

SerializeExpr ( int32& iCode,
FArchive& Ar
)

 Serialize an expression to an archive. Returns expression token
Protected function void Serializes properties of this struct
Public function Virtual Const void

SerializeTaggedProperties ( FStructuredArchive::FSlot Slot,
uint8* Data,
UStruct* DefaultsStruct,
uint8* Defaults,
const UObject* BreakRecursionIfFullyLoad
)

 Serializes list of properties, using property tags to handle mismatches
Public function Virtual Const void

SerializeTaggedProperties ( FArchive& Ar,
uint8* Data,
UStruct* DefaultsStruct,
uint8* Defaults,
const UObject* BreakRecursionIfFullyLoad
)

 Serializes list of properties, using property tags to handle mismatches
Public function void

SetPropertiesSize ( int32 NewSize
)

 Modifies the property size after it's been recomputed
Public function Virtual void

SetSuperStruct ( UStruct* NewSuperStruct
)

 Sets the super struct pointer and updates hash information as necessary.
Public function void Sets the UnresolvedScriptProperties array
Public function Static UClass * Returns a UClass object representing this class at runtime
Public function Static EClassCastFlags Returns the static cast flags for this class
Public function void

StaticLink ( bool bRelinkExistingProperties
)

 Static wrapper for Link, using a dummy archive
Public function Static const TCHAR * Returns the package this class belongs in
Public function Static void  

Overridden from UField

  Type Name Description
Public function Virtual void

AddCppProperty ( FProperty* Property
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called to finish destroying the object.
Public function Virtual void Called during cooking.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.
Public function Virtual void

TagSubobjects ( EObjectFlags NewFlags
)

 Tags objects that are part of the same asset with the specified object flag, used for GC checking

Overridden from UObjectBase

  Type Name Description
Public function Virtual void Force any base classes to be registered first, then call BaseRegister

Operators

  Type Name Description
Public function void

operator delete ( void* InMem
)

 Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy.
Public function void *

operator new ( const size_t InSize,
EInternal InInternalOnly,
UObject* InOuter,
FName InName,
EObjectFlags InSetFlags
)

 For internal use only; use StaticConstructObject() to create new objects.
Public function void *

operator new ( const size_t InSize,
EInternal* InMem
)

 For internal use only; use StaticConstructObject() to create new objects.

Typedefs

Name Description
FUnresolvedScriptPropertiesArray  
Super Typedef for the base class (UField)
ThisClass Typedef for UStruct.

Constants

Name Description
StaticClassFlags Bitwise union of EClassFlags pertaining to this class.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page