UserDefinedStruct.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#endif // UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
#include "Misc/Guid.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
#include "UObject/StructOnScope.h"
#include "UObject/WeakObjectPtr.h"
#include "Templates/SubclassOf.h"
 
#include "UserDefinedStruct.generated.h"
 
class UUserDefinedStruct;
class UUserDefinedStructEditorData;
class UStructCookedMetaData;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnStructChanged, UUserDefinedStruct*);
 
UENUM()
enum EUserDefinedStructureStatus : int
{
    UDSS_UpToDate,
    UDSS_Dirty,
    UDSS_Error,
    UDSS_Duplicate,
 
    UDSS_MAX,
};
 
class FUserStructOnScopeIgnoreDefaults : public FStructOnScope
{
public:
    FUserStructOnScopeIgnoreDefaults() : FStructOnScope() {}
 
    COREUOBJECT_API FUserStructOnScopeIgnoreDefaults(const UUserDefinedStruct* InUserStruct);
 
    COREUOBJECT_API FUserStructOnScopeIgnoreDefaults(const UUserDefinedStruct* InUserStruct, uint8* InData);
 
    COREUOBJECT_API void Recreate(const UUserDefinedStruct* InUserStruct);
 
    COREUOBJECT_API virtual void Initialize() override;
};
 
UCLASS(MinimalAPI)
class UUserDefinedStruct : public UScriptStruct
{
    GENERATED_UCLASS_BODY()
 
public:
#if WITH_EDITORONLY_DATA
    UPROPERTY(Transient)
    TWeakObjectPtr<UUserDefinedStruct> PrimaryStruct;
 
    UPROPERTY()
    FString ErrorMessage;
 
    UPROPERTY()
    TObjectPtr<UObject> EditorData;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY()
    TEnumAsByte<enum EUserDefinedStructureStatus> Status;
 
    UPROPERTY(AssetRegistrySearchable)
    FGuid Guid;
 
protected:
    FUserStructOnScopeIgnoreDefaults DefaultStructInstance;
 
    bool bIgnoreStructDefaults;
 
public:
#if WITH_EDITOR
    // UObject interface.
    COREUOBJECT_API virtual void PostDuplicate(bool bDuplicateForPIE) override;
    COREUOBJECT_API virtual void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const override;
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    COREUOBJECT_API virtual void GetAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) const override;
    COREUOBJECT_API virtual void PostLoad() override;
    COREUOBJECT_API virtual void PreSaveRoot(FObjectPreSaveRootContext ObjectSaveContext) override;
    COREUOBJECT_API virtual void PostSaveRoot(FObjectPostSaveRootContext ObjectSaveContext) override;
    // End of UObject interface.
 
    COREUOBJECT_API void ValidateGuid();
 
    COREUOBJECT_API virtual void OnChanged();
 
    friend UUserDefinedStructEditorData;
#endif  // WITH_EDITOR
 
    // UObject interface.
    COREUOBJECT_API virtual void Serialize(FStructuredArchive::FRecord Record) override;
    COREUOBJECT_API virtual void SerializeTaggedProperties(FStructuredArchive::FSlot Slot, uint8* Data, const UStruct* DefaultsStruct, const uint8* Defaults, const UObject* BreakRecursionIfFullyLoad = nullptr) const override;
    COREUOBJECT_API virtual FString GetAuthoredNameForField(const FField* Field) const override;
    // End of UObject interface.
 
    // UScriptStruct interface.
    COREUOBJECT_API virtual void InitializeStruct(void* Dest, int32 ArrayDim = 1) const override;
    COREUOBJECT_API virtual uint32 GetStructTypeHash(const void* Src) const override;
    COREUOBJECT_API virtual void RecursivelyPreload() override;
    COREUOBJECT_API virtual FGuid GetCustomGuid() const override;
    COREUOBJECT_API virtual FString GetStructCPPName(uint32 CPPExportFlags) const override;
    COREUOBJECT_API virtual FProperty* CustomFindProperty(const FName Name) const override;
    COREUOBJECT_API virtual void PrepareCppStructOps() override;
    // End of  UScriptStruct interface.
 
    COREUOBJECT_API const uint8* GetDefaultInstance() const;
 
    COREUOBJECT_API void InitializeStructIgnoreDefaults(void* Dest, int32 ArrayDim = 1) const;
 
    static COREUOBJECT_API uint32 GetUserDefinedStructTypeHash(const void* Src, const UScriptStruct* Type);
 
    static COREUOBJECT_API void AddReferencedObjects(UObject* InThis, FReferenceCollector& Collector);
 
    COREUOBJECT_API void UpdateStructFlags();
 
#if WITH_EDITORONLY_DATA
    UE_FORCEINLINE_HINT FOnStructChanged& OnStructChanged() { return ChangedEvent; }
public:
    FOnStructChanged ChangedEvent;
 
protected:
    COREUOBJECT_API virtual TSubclassOf<UStructCookedMetaData> GetCookedMetaDataClass() const;
 
private:
    COREUOBJECT_API UStructCookedMetaData* NewCookedMetaData();
    COREUOBJECT_API const UStructCookedMetaData* FindCookedMetaData();
    COREUOBJECT_API void PurgeCookedMetaData();
 
    UPROPERTY()
    TObjectPtr<UStructCookedMetaData> CachedCookedMetaDataPtr;
#endif // WITH_EDITORONLY_DATA
};