Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > CoreUObject > UObject > UScriptStruct

Light Theme

Dark Theme

UScriptStruct

Reflection data for a standalone structure declared in a header or as a user defined struct

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UField

UStruct

UScriptStruct

UAnimBlueprintGeneratedStruct

UMovieSceneKeyStructType

UPropertyBag

UUserDefinedStruct

UAISenseBlueprintListener

References

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

Syntax

class UScriptStruct : public UStruct

Remarks

Reflection data for a standalone structure declared in a header or as a user defined struct

Variables

	Name	Description
bool	bPrepareCppStructOpsCompleted	True if we have performed PrepareCppStructOps
ICppStructOps &...	CppStructOps	Holds the Cpp ctors and dtors, sizeof, etc. Is not owned by this and is not released.
EStructFlags	StructFlags

Constructors

	Name	Description
	UScriptStruct ( FVTableHelper& Helper )	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
	UScriptStruct ( const FObjectInitializer& ObjectIn... )	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
	UScriptStruct ( EStaticConstructor, int32 InSize, int32 InAlignment, EObjectFlags InFlags )
	UScriptStruct ( const FObjectInitializer& ObjectIn..., UScriptStruct* InSuperStruct, ICppStructOps* InCppStructOps, EStructFlags InStructFlags, SIZE_T ExplicitSize, SIZE_T ExplicitAlignment )

Functions

	Name	Description
void	__DefaultConstructor ( const FObjectInitializer& X )
UObject *...	__VTableCtorCaller ( FVTableHelper& Helper )
void	ClearCppStructOps()	Resets currently assigned CppStructOps, called when loading a struct
void	ClearScriptStruct ( void* Dest, int32 ArrayDim )	Reinitialize a struct in memory.
bool	CompareScriptStruct ( const void* A, const void* B, uint32 PortFlags )	Compare two script structs
void	CopyScriptStruct ( void* Dest, void const* Src, int32 ArrayDim )	Copy a struct over an existing struct
TEnableIf<&#...	DeferCppStructOps ( FTopLevelAssetPath Target )
TEnableIf< (...	DeferCppStructOps ( FTopLevelAssetPath Target )
void	DeferCppStructOps ( FTopLevelAssetPath Target, ICppStructOps* InCppStructOps )	Stash a CppStructOps for future use
void	ExportText ( FString& ValueStr, const void* Value, const void* Defaults, UObject* OwnerObject, int32 PortFlags, UObject* ExportRootScope, bool bAllowNativeOverride )	Export script struct to a string that can later be imported
ICppStructOp...	GetCppStructOps()	Returns the CppStructOps that can be used to do custom operations
FGuid	GetCustomGuid()	Returns the custom Guid assigned to this struct for User Defined Structs, or an invalid Guid
FTopLevelAss...	GetFlattenedStructPathName()	Similar to GetStructPathName() but works with nested structs by using just the package name and struct name so a struct path name /Package/Name.Object:Struct will be flattened to /Package/Name.Struct.
FString	GetStructCPPName ( uint32 CPPExportFlags )	Returns the (native, c++) name of the struct
uint32	GetStructTypeHash ( const void* Src )	Calls GetTypeHash for native structs, otherwise computes a hash of all struct members
bool	HasDefaults()	If it is native, it is assumed to have defaults because it has a constructor
const TCHAR ...	ImportText ( const TCHAR* Buffer, void* Value, UObject* OwnerObject, int32 PortFlags, FOutputDevice* ErrorText, const FString& StructName, bool bAllowNativeOverride )	Sets value of script struct based on imported string
const TCHAR ...	ImportText ( const TCHAR* Buffer, void* Value, UObject* OwnerObject, int32 PortFlags, FOutputDevice* ErrorText, const TFunctionRef< FString()>& St..., bool bAllowNativeOverride )	Sets value of script struct based on imported string
void	InitializeDefaultValue ( uint8* InStructData )	Initializes this structure to its default values
void	PrepareCppStructOps()	Look for the CppStructOps and hook it up
void	RecursivelyPreload()	Used by User Defined Structs to preload this struct and any child objects
void	SerializeItem ( FStructuredArchive::FSlot Slot, void* Value, void const* Defaults )	Serializes a specific instance of a struct
void	SerializeItem ( FArchive& Ar, void* Value, void const* Defaults )	Serializes a specific instance of a struct
void	SetStructTrashed ( bool bIsTrash )	Sets or unsets the trashed flag on this struct
bool	ShouldSerializeAtomically ( FArchive& Ar )	Returns whether this struct should be serialized atomically.
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
void	StaticRegisterNativesUScriptStruct()
bool	UseBinarySerialization ( const FArchive& Ar )	Returns true if this struct should be binary serialized for the given archive
bool	UseNativeSerialization()	Returns true if this struct has a native serialize function

Overridden from UStruct

	Name	Description
void	DestroyStruct ( void* Dest, int32 ArrayDim )	Destroy a struct in memory.
void	InitializeStruct ( void* Dest, int32 ArrayDim )	Initialize a struct over uninitialized memory.
bool	IsStructTrashed()	If true, this class has been cleaned and sanitized (trashed) and should not be used
void	Link ( FArchive& Ar, bool bRelinkExistingProperties )	Creates the field/property links and gets structure ready for use at runtime

Overridden from UObject

		Name	Description
	void	Serialize ( FStructuredArchive::FRecord Record )	Handles reading, writing, and reference collecting using FArchive.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Operators

	Name	Description
void	operator delete ( void* InMem )	Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy.
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.
void *	operator new ( const size_t InSize, EInternal* InMem )	For internal use only; use StaticConstructObject() to create new objects.

Classes

	Name	Description
	ICppStructOps	Interface to template to manage dynamic access to C++ struct construction and destruction
	TAutoCppStructOps	Template for noexport classes to autoregister before main starts
	TCppStructOps	Template to manage dynamic access to C++ struct construction and destruction

Typedefs

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

Constants

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel