UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UScriptStruct Class Reference

#include <Class.h>

+ Inheritance diagram for UScriptStruct:

Classes

struct  ICppStructOps
 
struct  TAutoCppStructOps
 
struct  TCppStructOps
 

Public Member Functions

COREUOBJECT_API UScriptStruct (EStaticConstructor, int32 InSize, int32 InAlignment, EObjectFlags InFlags)
 
COREUOBJECT_API UScriptStruct (const FObjectInitializer &ObjectInitializer, UScriptStruct *InSuperStruct, ICppStructOps *InCppStructOps=nullptr, EStructFlags InStructFlags=STRUCT_NoFlags, SIZE_T ExplicitSize=0, SIZE_T ExplicitAlignment=0)
 
COREUOBJECT_API UScriptStruct (const FObjectInitializer &ObjectInitializer=FObjectInitializer::Get())
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar) override
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record) override
 
virtual COREUOBJECT_API void Link (FArchive &Ar, bool bRelinkExistingProperties) override
 
virtual COREUOBJECT_API void InitializeStruct (void *Dest, int32 ArrayDim=1) const override
 
virtual COREUOBJECT_API void DestroyStruct (void *Dest, int32 ArrayDim=1) const override
 
virtual COREUOBJECT_API bool IsStructTrashed () const override
 
void COREUOBJECT_API SetStructTrashed (bool bIsTrash)
 
virtual COREUOBJECT_API void PrepareCppStructOps ()
 
ICppStructOpsGetCppStructOps () const
 
void ClearCppStructOps ()
 
UE_FORCEINLINE_HINT bool HasDefaults () const
 
bool ShouldSerializeAtomically (FArchive &Ar) const
 
bool UseNativeSerialization () const
 
COREUOBJECT_API bool UseBinarySerialization (const FArchive &Ar) const
 
COREUOBJECT_API void SerializeItem (FArchive &Ar, void *Value, void const *Defaults)
 
COREUOBJECT_API void SerializeItem (FStructuredArchive::FSlot Slot, void *Value, void const *Defaults)
 
COREUOBJECT_API void ExportText (FString &ValueStr, const void *Value, const void *Defaults, UObject *OwnerObject, int32 PortFlags, UObject *ExportRootScope, bool bAllowNativeOverride=true) const
 
COREUOBJECT_API const TCHARImportText (const TCHAR *Buffer, void *Value, UObject *OwnerObject, int32 PortFlags, FOutputDevice *ErrorText, const FString &StructName, bool bAllowNativeOverride=true) const
 
COREUOBJECT_API const TCHARImportText (const TCHAR *Buffer, void *Value, UObject *OwnerObject, int32 PortFlags, FOutputDevice *ErrorText, const TFunctionRef< FString()> &StructNameGetter, bool bAllowNativeOverride=true) const
 
COREUOBJECT_API bool CompareScriptStruct (const void *A, const void *B, uint32 PortFlags) const
 
COREUOBJECT_API void CopyScriptStruct (void *Dest, void const *Src, int32 ArrayDim=1) const
 
COREUOBJECT_API void ClearScriptStruct (void *Dest, int32 ArrayDim=1) const
 
virtual COREUOBJECT_API uint32 GetStructTypeHash (const void *Src) const
 
virtual COREUOBJECT_API void RecursivelyPreload ()
 
virtual COREUOBJECT_API FGuid GetCustomGuid () const
 
virtual COREUOBJECT_API FString GetStructCPPName (uint32 CPPExportFlags=0) const
 
virtual COREUOBJECT_API void InitializeDefaultValue (uint8 *InStructData) const
 
virtual COREUOBJECT_API bool FindInnerPropertyInstance (FName PropertyName, const void *Data, const FProperty *&OutProp, const void *&OutData) const
 
virtual COREUOBJECT_API EPropertyVisitorControlFlow Visit (FPropertyVisitorContext &Context, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorContext &)> InFunc) const override
 
virtual COREUOBJECT_API voidResolveVisitedPathInfo (void *Data, const FPropertyVisitorInfo &Info) const override
 
- Public Member Functions inherited from UStruct
 UStruct (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UStruct (EStaticConstructor, int32 InSize, int32 InAlignment, EObjectFlags InFlags)
 
COREUOBJECT_API UStruct (UStruct *InSuperStruct, SIZE_T ParamsSize=0, SIZE_T Alignment=0)
 
COREUOBJECT_API UStruct (const FObjectInitializer &ObjectInitializer, UStruct *InSuperStruct, SIZE_T ParamsSize=0, SIZE_T Alignment=0)
 
virtual COREUOBJECT_API ~UStruct ()
 
virtual COREUOBJECT_API void PostLoad () override
 
virtual COREUOBJECT_API void FinishDestroy () override
 
virtual COREUOBJECT_API void RegisterDependencies () override
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps) override
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags) override
 
virtual COREUOBJECT_API void AddCppProperty (FProperty *Property) override
 
COREUOBJECT_API FTopLevelAssetPath GetStructPathName () const
 
COREUOBJECT_API FPropertyFindPropertyByName (FName InName) const
 
UE_INTERNAL COREUOBJECT_API FPropertyFindPropertyByOffset (int32 Offset) const
 
COREUOBJECT_API void InstanceSubobjectTemplates (TNotNull< void * > Data, const void *DefaultData, const UStruct *DefaultStruct, TNotNull< UObject * > Owner, FObjectInstancingGraph *InstanceGraph)
 
virtual UStructGetInheritanceSuper () const
 
COREUOBJECT_API void StaticLink (bool bRelinkExistingProperties=false)
 
virtual void SerializeBin (FArchive &Ar, void *Data) const final
 
virtual COREUOBJECT_API void SerializeBin (FStructuredArchive::FSlot Slot, void *Data) const
 
COREUOBJECT_API void SerializeBinEx (FStructuredArchive::FSlot Slot, void *Data, void const *DefaultData, UStruct *DefaultStruct) const
 
virtual void SerializeTaggedProperties (FArchive &Ar, uint8 *Data, const UStruct *DefaultsStruct, const uint8 *Defaults, const UObject *BreakRecursionIfFullyLoad=nullptr) const final
 
virtual COREUOBJECT_API void SerializeTaggedProperties (FStructuredArchive::FSlot Slot, uint8 *Data, const UStruct *DefaultsStruct, const uint8 *Defaults, const UObject *BreakRecursionIfFullyLoad=nullptr) const
 
virtual COREUOBJECT_API void PreloadChildren (FArchive &Ar)
 
virtual FPropertyCustomFindProperty (const FName InName) const
 
virtual COREUOBJECT_API EExprToken SerializeExpr (int32 &iCode, FArchive &Ar)
 
virtual const TCHARGetPrefixCPP () const
 
UE_FORCEINLINE_HINT int32 GetPropertiesSize () const
 
UE_FORCEINLINE_HINT int32 GetMinAlignment () const
 
UE_FORCEINLINE_HINT int32 GetStructureSize () const
 
void SetPropertiesSize (int32 NewSize)
 
template<class T >
bool IsChildOf () const
 
COREUOBJECT_API bool IsChildOf (const UStruct *SomeBase) const
 
FSuperStructIterator GetSuperStructIterator ()
 
FConstSuperStructIterator GetSuperStructIterator () const
 
UStructGetSuperStruct () const
 
virtual COREUOBJECT_API void SetSuperStruct (UStruct *NewSuperStruct)
 
virtual COREUOBJECT_API FString GetAuthoredNameForField (const UField *Field) const
 
virtual COREUOBJECT_API FString GetAuthoredNameForField (const FField *Field) const
 
COREUOBJECT_API void DestroyChildPropertiesAndResetPropertyLinks ()
 
void SetUnresolvedScriptProperties (FUnresolvedScriptPropertiesArray &InUnresolvedProperties)
 
void DeleteUnresolvedScriptProperties ()
 
COREUOBJECT_API void CollectBytecodeReferencedObjects (TArray< UObject * > &OutReferencedObjects)
 
COREUOBJECT_API void CollectPropertyReferencedObjects (TArray< UObject * > &OutReferencedObjects)
 
COREUOBJECT_API void CollectBytecodeAndPropertyReferencedObjects ()
 
COREUOBJECT_API void CollectBytecodeAndPropertyReferencedObjectsRecursively ()
 
COREUOBJECT_API EPropertyVisitorControlFlow Visit (void *Data, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorPath &, const FPropertyVisitorData &)> InFunc) const
 
COREUOBJECT_API EPropertyVisitorControlFlow Visit (void *Data, const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorContext &)> InFunc, FPropertyVisitorContext::EScope InScope=FPropertyVisitorContext::EScope::All) const
 
- Public Member Functions inherited from UField
 UField (const FObjectInitializer &ObjectInitializer)
 
 UField (EStaticConstructor, EObjectFlags InFlags)
 
 ~UField ()=default
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const override
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const override
 
virtual COREUOBJECT_API void Bind ()
 
COREUOBJECT_API UClassGetOwnerClass () const
 
COREUOBJECT_API UStructGetOwnerStruct () const
 
COREUOBJECT_API FString GetAuthoredName () const
 
COREUOBJECT_API bool HasAnyCastFlags (const uint64 InCastFlags) const
 
COREUOBJECT_API bool HasAllCastFlags (const uint64 InCastFlags) const
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostInitProperties ()
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Static Public Member Functions

static COREUOBJECT_API void DeferCppStructOps (FTopLevelAssetPath Target, ICppStructOps *InCppStructOps)
 
static COREUOBJECT_API void RemoveDeferredCppStructOps (FTopLevelAssetPath Target)
 
static COREUOBJECT_API void RemoveAllDeferredCppStructOps (FName PackageName)
 
template<class CPPSTRUCT >
static void DeferCppStructOps (FTopLevelAssetPath Target)
 
- Static Public Member Functions inherited from UStruct
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Public Attributes

EStructFlags StructFlags
 
- Public Attributes inherited from UStruct
TObjectPtr< UFieldChildren
 
FFieldChildProperties
 
int32 PropertiesSize
 
int16 MinAlignment
 
union { 
 
   TArray< uint8 >   Script = {} 
 
};  
 
FPropertyPropertyLink
 
FPropertyRefLink
 
FPropertyDestructorLink
 
FPropertyPostConstructLink
 
TArray< TObjectPtr< UObject > > ScriptAndPropertyObjectReferences
 
FUnresolvedScriptPropertiesArrayUnresolvedScriptProperties
 
std::atomic< const struct FUnversionedStructSchema * > UnversionedGameSchema = nullptr
 
- Public Attributes inherited from UField
TObjectPtr< UFieldNext
 

Protected Member Functions

COREUOBJECT_API FTopLevelAssetPath GetFlattenedStructPathName () const
 
- Protected Member Functions inherited from UStruct
virtual FName FindPropertyNameFromGuid (const FGuid &PropertyGuid) const
 
virtual FGuid FindPropertyGuidFromName (const FName InName) const
 
virtual bool ArePropertyGuidsAvailable () const
 
COREUOBJECT_API void SerializeProperties (FArchive &Ar)
 
COREUOBJECT_API void LoadTaggedPropertiesFromText (FStructuredArchive::FSlot Slot, uint8 *Data, const UStruct *DefaultsStruct, const uint8 *Defaults, const UObject *BreakRecursionIfFullyLoad) const
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Protected Attributes

bool bPrepareCppStructOpsCompleted
 
ICppStructOpsCppStructOps
 

Additional Inherited Members

- Public Types inherited from UStruct
typedef TArray< TPair< TFieldPath< FField >, int32 > > FUnresolvedScriptPropertiesArray
 
using FSuperStructIterator = TObjectPtrLinkedListIterator< UStruct, &UStruct::SuperStruct, true >
 
using FConstSuperStructIterator = TObjectPtrLinkedListIteratorConst< UStruct, &UStruct::SuperStruct, true >
 
- Public Types inherited from UField
typedef UField BaseFieldClass
 
typedef UClass FieldTypeClass
 
using FLinkedListBuilder = TObjectPtrLinkedListBuilder< UField >
 
- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 

Detailed Description

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

Constructor & Destructor Documentation

◆ UScriptStruct() [1/3]

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

◆ UScriptStruct() [2/3]

UScriptStruct::UScriptStruct ( const FObjectInitializer ObjectInitializer,
UScriptStruct InSuperStruct,
ICppStructOps InCppStructOps = nullptr,
EStructFlags  InStructFlags = STRUCT_NoFlags,
SIZE_T  ExplicitSize = 0,
SIZE_T  ExplicitAlignment = 0 
)
explicit

◆ UScriptStruct() [3/3]

UScriptStruct::UScriptStruct ( const FObjectInitializer ObjectInitializer = FObjectInitializer::Get())
explicit

Member Function Documentation

◆ ClearCppStructOps()

void UScriptStruct::ClearCppStructOps ( )
inline

Resets currently assigned CppStructOps, called when loading a struct

◆ ClearScriptStruct()

void UScriptStruct::ClearScriptStruct ( void Dest,
int32  ArrayDim = 1 
) const

Reinitialize a struct in memory. This may be done by calling the native destructor and then the constructor or individually reinitializing properties

Parameters
DestPointer to memory to reinitialize
ArrayDimNumber of elements in the array
StrideStride of the array, only relevant if there more than one element. If this default (0), then we will pull the size from the struct

◆ CompareScriptStruct()

bool UScriptStruct::CompareScriptStruct ( const void A,
const void B,
uint32  PortFlags 
) const

Compare two script structs

Parameters
DestPointer to memory to a struct
SrcPointer to memory to the other struct
PortFlagsComparison flags
Returns
true if the structs are identical

◆ CopyScriptStruct()

void UScriptStruct::CopyScriptStruct ( void Dest,
void const *  Src,
int32  ArrayDim = 1 
) const

Copy a struct over an existing struct

Parameters
DestPointer to memory to initialize
SrcPointer to memory to copy from
ArrayDimNumber of elements in the array
StrideStride of the array, If this default (0), then we will pull the size from the struct

◆ DeferCppStructOps() [1/2]

template<class CPPSTRUCT >
static void UScriptStruct::DeferCppStructOps ( FTopLevelAssetPath  Target)
inlinestatic

◆ DeferCppStructOps() [2/2]

void UScriptStruct::DeferCppStructOps ( FTopLevelAssetPath  Target,
ICppStructOps InCppStructOps 
)
static

Stash a CppStructOps for future use

Parameters
TargetName of the struct
InCppStructOpsCpp ops for this struct

◆ DestroyStruct()

void UScriptStruct::DestroyStruct ( void Dest,
int32  ArrayDim = 1 
) const
overridevirtual

Destroy a struct in memory. This may be done by calling the native destructor or individually destroying properties

Parameters
DestPointer to memory to destory
ArrayDimNumber of elements in the array
StrideStride of the array. If this default (0), then we will pull the size from the struct

Reimplemented from UStruct.

Reimplemented in UPropertyBag.

◆ ExportText()

void UScriptStruct::ExportText ( FString &  ValueStr,
const void Value,
const void Defaults,
UObject OwnerObject,
int32  PortFlags,
UObject ExportRootScope,
bool  bAllowNativeOverride = true 
) const

Export script struct to a string that can later be imported

Parameters
ValueStrString to write to
ValueActual struct being exported
DefaultsDefault value for this struct, pass nullptr to not use defaults
OwnerObjectUObject that contains this struct
PortFlagsEPropertyPortFlags controlling export behavior
ExportRootScopeThe scope to create relative paths from, if the PPF_ExportsNotFullyQualified flag is passed in. If NULL, the package containing the object will be used instead.
bAllowNativeOverrideIf true, will try to run native version of export text on the struct

◆ FindInnerPropertyInstance()

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

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

Parameters
PropertyNameName of the property to retrieve
DataPointer to struct to retrieve property from
OutPropFilled with the found property
OutDataFilled with a pointer to the data containing the property. Not offset to property instance yet - Call ContainerPtrToValuePtr before use.
Returns
whether the property instance was found

◆ GetCppStructOps()

ICppStructOps * UScriptStruct::GetCppStructOps ( ) const
inline

Returns the CppStructOps that can be used to do custom operations

◆ GetCustomGuid()

FGuid UScriptStruct::GetCustomGuid ( ) const
virtual

Returns the custom Guid assigned to this struct for User Defined Structs, or an invalid Guid

Reimplemented in UUserDefinedStruct, and UVerseStruct.

◆ GetFlattenedStructPathName()

FTopLevelAssetPath UScriptStruct::GetFlattenedStructPathName ( ) const
protected

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. This function is used only for generating keys for DeferredCppStructOps

◆ GetStructCPPName()

FString UScriptStruct::GetStructCPPName ( uint32  CPPExportFlags = 0) const
virtual

Returns the (native, c++) name of the struct

Reimplemented in UUserDefinedStruct.

◆ GetStructTypeHash()

uint32 UScriptStruct::GetStructTypeHash ( const void Src) const
virtual

Calls GetTypeHash for native structs, otherwise computes a hash of all struct members

Parameters
SrcPointer to instance to hash
Returns
hashed value of Src

Reimplemented in UUserDefinedStruct.

◆ HasDefaults()

UE_FORCEINLINE_HINT bool UScriptStruct::HasDefaults ( ) const
inline

If it is native, it is assumed to have defaults because it has a constructor

Returns
true if this struct has defaults

◆ ImportText() [1/2]

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

Sets value of script struct based on imported string

Parameters
BufferString to read text data out of
ValueStruct that will be modified
OwnerObjectUObject that contains this struct
PortFlagsEPropertyPortFlags controlling import behavior
ErrorTextWhat to print import errors to
StructNameName of struct, used in error display
bAllowNativeOverrideIf true, will try to run native version of export text on the struct
Returns
Buffer after parsing has succeeded, or NULL on failure

◆ ImportText() [2/2]

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

Sets value of script struct based on imported string

Parameters
BufferString to read text data out of
ValueStruct that will be modified
OwnerObjectUObject that contains this struct
PortFlagsEPropertyPortFlags controlling import behavior
ErrorTextWhat to print import errors to
StructNameGetterFunction to return the struct name to avoid doing work if no error message is forthcoming
bAllowNativeOverrideIf true, will try to run native version of export text on the struct
Returns
Buffer after parsing has succeeded, or NULL on failure

◆ InitializeDefaultValue()

void UScriptStruct::InitializeDefaultValue ( uint8 InStructData) const
virtual

Initializes this structure to its default values

Parameters
InStructDataThe memory location to initialize

◆ InitializeStruct()

void UScriptStruct::InitializeStruct ( void Dest,
int32  ArrayDim = 1 
) const
overridevirtual

Initialize a struct over uninitialized memory. This may be done by calling the native constructor or individually initializing properties

Parameters
DestPointer to memory to initialize
ArrayDimNumber of elements in the array
StrideStride of the array, If this default (0), then we will pull the size from the struct

Reimplemented from UStruct.

Reimplemented in UPropertyBag, and UUserDefinedStruct.

◆ IsStructTrashed()

bool UScriptStruct::IsStructTrashed ( ) const
overridevirtual

If true, this class has been cleaned and sanitized (trashed) and should not be used

Reimplemented from UStruct.

◆ Link()

void UScriptStruct::Link ( FArchive Ar,
bool  bRelinkExistingProperties 
)
overridevirtual

Creates the field/property links and gets structure ready for use at runtime

Reimplemented from UStruct.

◆ PrepareCppStructOps()

void UScriptStruct::PrepareCppStructOps ( )
virtual

Look for the CppStructOps and hook it up

Look for the CppStructOps if we don't already have it and set the property size

Reimplemented in UUserDefinedStruct.

◆ RecursivelyPreload()

void UScriptStruct::RecursivelyPreload ( )
virtual

Used by User Defined Structs to preload this struct and any child objects

Reimplemented in UUserDefinedStruct.

◆ RemoveAllDeferredCppStructOps()

void UScriptStruct::RemoveAllDeferredCppStructOps ( FName  PackageName)
static

On module unload, remove all entries in a package from the stash The package name should be the full package name, such as "/Script/Engine"

Parameters
PackageNameName of the package

◆ RemoveDeferredCppStructOps()

void UScriptStruct::RemoveDeferredCppStructOps ( FTopLevelAssetPath  Target)
static

On module unload, remove the entry from the stash

Parameters
TargetName of the struct

◆ ResolveVisitedPathInfo()

void * UScriptStruct::ResolveVisitedPathInfo ( void Data,
const FPropertyVisitorInfo Info 
) const
overridevirtual

Attempt to resolve the given inner path info against this outer struct to get the inner property value.

Returns
The inner property value, or null if the path info is incompatible/missing on this struct.

Reimplemented from UStruct.

◆ Serialize() [1/2]

void UScriptStruct::Serialize ( FArchive Ar)
overridevirtual

Handles reading, writing, and reference collecting using FArchive. This implementation handles all FProperty serialization, but can be overridden for native variables.

Reimplemented from UStruct.

◆ Serialize() [2/2]

virtual COREUOBJECT_API void UScriptStruct::Serialize ( FStructuredArchive::FRecord  Record)
overridevirtual

Reimplemented from UStruct.

Reimplemented in UUserDefinedStruct.

◆ SerializeItem() [1/2]

void UScriptStruct::SerializeItem ( FArchive Ar,
void Value,
void const *  Defaults 
)

Serializes a specific instance of a struct

Parameters
SlotThe structured archive slot we are serializing to
ValuePointer to memory of struct
DefaultsDefault value for this struct, pass nullptr to not use defaults

◆ SerializeItem() [2/2]

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

◆ SetStructTrashed()

void UScriptStruct::SetStructTrashed ( bool  bIsTrash)

Sets or unsets the trashed flag on this struct

◆ ShouldSerializeAtomically()

bool UScriptStruct::ShouldSerializeAtomically ( FArchive Ar) const
inline

Returns whether this struct should be serialized atomically.

Parameters
ArArchive the struct is going to be serialized with later on

◆ UseBinarySerialization()

bool UScriptStruct::UseBinarySerialization ( const FArchive Ar) const

Returns true if this struct should be binary serialized for the given archive

◆ UseNativeSerialization()

bool UScriptStruct::UseNativeSerialization ( ) const
inline

Returns true if this struct has a native serialize function

◆ Visit()

EPropertyVisitorControlFlow UScriptStruct::Visit ( FPropertyVisitorContext Context,
const TFunctionRef< EPropertyVisitorControlFlow(const FPropertyVisitorContext &)>  InFunc 
) const
overridevirtual

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. This visit property pattern facilitates the recursion into user defined properties and allows users to add specific visit logic on UStruct via traits.

Parameters
Contextwhich contains the path that was computed until we reached this property and the data to the property to visit
InFuncto call on each visited property, the return value controls what is the next behavior once this property has been visited
Returns
the new action to take one visited this property

Reimplemented from UStruct.

Member Data Documentation

◆ bPrepareCppStructOpsCompleted

bool UScriptStruct::bPrepareCppStructOpsCompleted
protected

true if we have performed PrepareCppStructOps

◆ CppStructOps

ICppStructOps* UScriptStruct::CppStructOps
protected

Holds the Cpp ctors and dtors, sizeof, etc. Is not owned by this and is not released.

◆ StructFlags

EStructFlags UScriptStruct::StructFlags

The documentation for this class was generated from the following files: