1. Epic GamesDeveloper
  3. UScriptStruct

UScriptStruct

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

Unreal Engine C++ API Reference > Runtime > CoreUObject > UObject

Inheritance Hierarchy

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

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

Constructors

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

UScriptStruct ( const FObjectInitializer& ObjectInitializer
)

  
Public function  

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

  
Public function  

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

  

Functions

  Type Name Description
Public function Static void  
Public function Static UObject *  
Public function void Resets currently assigned CppStructOps, called when loading a struct
Public function Const void

ClearScriptStruct ( void* Dest,
int32 ArrayDim
)

 Reinitialize a struct in memory.
Public function Const bool

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

 Compare two script structs
Public function Const void

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

 Copy a struct over an existing struct
Public function Static void

DeferCppStructOps ( FTopLevelAssetPath Target,
ICppStructOps* InCppStructOps
)

 Stash a CppStructOps for future use
Public function Static void  
Public function Const 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
Public function Virtual Const bool

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

 Provide an FProperty and data pointer when given an FName of a property that this object owns indirectly (ie FInstancedStruct)
Public function Const ICppStructOps * Returns the CppStructOps that can be used to do custom operations
Public function Virtual Const FGuid Returns the custom Guid assigned to this struct for User Defined Structs, or an invalid Guid
Protected function Const FTopLevelAssetPath 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.
Public function Virtual Const FString

GetStructCPPName ( uint32 CPPExportFlags
)

 Returns the (native, c++) name of the struct
Public function Virtual Const uint32

GetStructTypeHash ( const void* Src
)

 Calls GetTypeHash for native structs, otherwise computes a hash of all struct members
Public function Const bool If it is native, it is assumed to have defaults because it has a constructor
Public function Const const TCHAR *

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

 Sets value of script struct based on imported string
Public function Const 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
Public function Virtual Const void

InitializeDefaultValue ( uint8* InStructData
)

 Initializes this structure to its default values
Public function Virtual void Look for the CppStructOps and hook it up
Public function Virtual void Used by User Defined Structs to preload this struct and any child objects
Public function void

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

 Serializes a specific instance of a struct
Public function void

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

  
Public function void

SetStructTrashed ( bool bIsTrash
)

 Sets or unsets the trashed flag on this struct
Public function Const bool Returns whether this struct should be serialized atomically.
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 Static const TCHAR * Returns the package this class belongs in
Public function Static void  
Public function Const bool Returns true if this struct should be binary serialized for the given archive
Public function Const bool Returns true if this struct has a native serialize function

Overridden from UStruct

  Type Name Description
Public function Virtual Const void

DestroyStruct ( void* Dest,
int32 ArrayDim
)

 Destroy a struct in memory.
Public function Virtual Const void

InitializeStruct ( void* Dest,
int32 ArrayDim
)

 Initialize a struct over uninitialized memory.
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

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.
Public function Virtual void  

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.

Classes

  Type Name Description
Public struct ICppStructOps Interface to template to manage dynamic access to C++ struct construction and destruction  
Public struct TAutoCppStructOps Template for noexport classes to autoregister before main starts  
Public struct 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page