1. Epic GamesDeveloper
  3. UScriptStruct

UScriptStruct

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

API > API/Runtime > API/Runtime/CoreUObject

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

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

Syntax

class UScriptStruct : public UStruct

Inheritance Hierarchy

Derived Classes

UScriptStruct derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
DO NOT USE. This constructor is for internal usage only for hot-reload purposes. UObject/Class.h  

UScriptStruct ( const FObjectInitializer& ObjectInitializer
)

   UObject/Class.h  

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

   UObject/Class.h  

UScriptStruct ( const FObjectInitializer& ObjectInitializer,
UScriptStruct* InSuperStruct,
ICppStructOps* InCppStructOps,
EStructFlags InStructFlags,
SIZE_T ExplicitSize,
SIZE_T ExplicitAlignment
)

   UObject/Class.h  

Structs

Name Remarks
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 Type Remarks Include Path
Super UStruct Typedef for the base class (UStruct) UObject/Class.h
ThisClass UScriptStruct Typedef for UScriptStruct. UObject/Class.h

Constants

Name Type Remarks Include Path
StaticClassFlags EClassFlags Bitwise union of EClassFlags pertaining to this class. UObject/Class.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
StructFlags EStructFlags   UObject/Class.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearCppStructOps()

 Resets currently assigned CppStructOps, called when loading a struct UObject/Class.h  

void ClearScriptStruct ( void* Dest,
int32 ArrayDim
) const

 Reinitialize a struct in memory. UObject/Class.h  

bool CompareScriptStruct ( const void* A,
const void* B,
uint32 PortFlags
) const

 Compare two script structs UObject/Class.h  

void CopyScriptStruct ( void* Dest,
void const* Src,
int32 ArrayDim
) const

 Copy a struct over an existing struct UObject/Class.h  

void ExportText ( FString& ValueStr,
const void* Value,
const void* Defaults,
UObject* OwnerObject,
int32 PortFlags,
UObject* ExportRootScope,
bool bAllowNativeOverride
) const

 Export script struct to a string that can later be imported UObject/Class.h  

virtual bool FindInnerPropertyInstance ( FName PropertyName,
const void* Data,
const FProperty*& OutProp,
const void*& OutData
) const

 Provide an FProperty and data pointer when given an FName of a property that this object owns indirectly (ie FInstancedStruct) UObject/Class.h  

ICppStructOps * GetCppStructOps()

 Returns the CppStructOps that can be used to do custom operations UObject/Class.h  

virtual FGuid GetCustomGuid()

 Returns the custom Guid assigned to this struct for User Defined Structs, or an invalid Guid UObject/Class.h  

virtual FString GetStructCPPName ( uint32 CPPExportFlags
) const

 Returns the (native, c++) name of the struct UObject/Class.h  

virtual uint32 GetStructTypeHash ( const void* Src
) const

 Calls GetTypeHash for native structs, otherwise computes a hash of all struct members UObject/Class.h  

bool HasDefaults()

 If it is native, it is assumed to have defaults because it has a constructor UObject/Class.h  

const TCHAR * ImportText ( const TCHAR* Buffer,
void* Value,
UObject* OwnerObject,
int32 PortFlags,
FOutputDevice* ErrorText,
const TFunctionRef< FString()>& StructNameGetter,
bool bAllowNativeOverride
) const

 Sets value of script struct based on imported string UObject/Class.h  

const TCHAR * ImportText ( const TCHAR* Buffer,
void* Value,
UObject* OwnerObject,
int32 PortFlags,
FOutputDevice* ErrorText,
const FString& StructName,
bool bAllowNativeOverride
) const

 Sets value of script struct based on imported string UObject/Class.h  

virtual void InitializeDefaultValue ( uint8* InStructData
) const

 Initializes this structure to its default values UObject/Class.h  

virtual void PrepareCppStructOps ()

 Look for the CppStructOps and hook it up UObject/Class.h  

virtual void RecursivelyPreload()

 Used by User Defined Structs to preload this struct and any child objects UObject/Class.h  

void SerializeItem ( FStructuredArchive::FSlot Slot,
void* Value,
void const* Defaults
)

   UObject/Class.h  

void SerializeItem ( FArchive& Ar,
void* Value,
void const* Defaults
)

 Serializes a specific instance of a struct UObject/Class.h  

void SetStructTrashed ( bool bIsTrash
)

 Sets or unsets the trashed flag on this struct UObject/Class.h  

bool ShouldSerializeAtomically ( FArchive& Ar
) const

 Returns whether this struct should be serialized atomically. UObject/Class.h  

bool UseBinarySerialization ( const FArchive& Ar
) const

 Returns true if this struct should be binary serialized for the given archive UObject/Class.h  

bool UseNativeSerialization()

 Returns true if this struct has a native serialize function UObject/Class.h  
Custom visit implementation for structs UObject/Class.h  
Custom visit implementation for structs UObject/Class.h  

Overridden from UStruct

Name Remarks Include Path Unreal Specifiers

virtual void DestroyStruct ( void* Dest,
int32 ArrayDim
) const

 Destroy a struct in memory. UObject/Class.h  

virtual void InitializeStruct ( void* Dest,
int32 ArrayDim
) const

 Initialize a struct over uninitialized memory. UObject/Class.h  

virtual bool IsStructTrashed()

 If true, this class has been cleaned and sanitized (trashed) and should not be used UObject/Class.h  

virtual void Link ( FArchive& Ar,
bool bRelinkExistingProperties
)

 Creates the field/property links and gets structure ready for use at runtime UObject/Class.h  

virtual void * ResolveVisitedPathInfo ( void* Data,
const FPropertyVisitorInfo& Info
) const

 Attempt to resolve the given inner path info against this outer struct to get the inner property value. UObject/Class.h  
Visits this property and allows recursion into the inner properties This method allows callers to visit inner properties without knowing about its container type as opposed to TPropertyIterator. UObject/Class.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

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

virtual void Serialize ( FStructuredArchive::FRecord Record
)

   UObject/Class.h  

Protected

Name Remarks Include Path Unreal Specifiers
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. UObject/Class.h  

Static

Name Remarks Include Path Unreal Specifiers

static void __DefaultConstructor ( const FObjectInitializer& X
)

   UObject/Class.h  

static UObject * __VTableCtorCaller ( FVTableHelper& Helper
)

   UObject/Class.h  

static void DeferCppStructOps ( FTopLevelAssetPath Target,
ICppStructOps* InCppStructOps
)

 Stash a CppStructOps for future use UObject/Class.h  

static void DeferCppStructOps ( FTopLevelAssetPath Target
)

   UObject/Class.h  

static UClass * GetPrivateStaticClass()

   UObject/Class.h  

static void IntrinsicClassInit ( UClass* Class
)

   UObject/Class.h  

static UClass * StaticClass()

 Returns a UClass object representing this class at runtime UObject/Class.h  

static EClassCastFlags StaticClassCastFlags()

 Returns the static cast flags for this class UObject/Class.h  

static const TCHAR * StaticPackage()

 Returns the package this class belongs in UObject/Class.h  

static void StaticRegisterNativesUScriptStruct()

   UObject/Class.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator delete ( void* InMem
)

 Eliminate V1062 warning from PVS-Studio while keeping MSVC and Clang happy. UObject/Class.h  

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

void * operator new ( const size_t InSize,
EInternal* InMem
)

 For internal use only; use StaticConstructObject() to create new objects. UObject/Class.h  
  UObject/Class.h  
  UObject/Class.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page