// Copyright Epic Games, Inc. All Rights Reserved.

/*=============================================================================
        CookerSettings.h: Declares the UCookerSettings class.
=============================================================================*/

#pragma once

#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Engine/DeveloperSettings.h"
#include "CookerSettings.generated.h"

struct FPropertyChangedEvent;

UENUM()
enum class ECookProgressDisplayMode : int32
{
    /** Don't display any progress messages */
    Nothing = 0,

    /** Display the number of remaining packages */
    RemainingPackages = 1,

    /** Display names of cooked packages */
    PackageNames = 2,

    /** Display the number of remaining packages and package names */
    NamesAndRemainingPackages = 3,

    /** MAX - invalid */
    Max UMETA(Hidden),
};

UENUM()
enum class EBlueprintComponentDataCookingMethod
{
    /** Do not generate optimized component data. No additional memory will be used. */
    Disabled,

    /** Generate optimized component data for all Blueprint types. This option will require the most additional memory. */
    AllBlueprints,

    /** Generate optimized component data only for Blueprint types that have explicitly enabled this feature in the class settings. */
    EnabledBlueprintsOnly,
};

UENUM()
enum class EASTCCookLevel
{
    ASTCCL_Lowest  = 0 UMETA(DisplayName = "Lowest"),
    ASTCCL_Low     = 1 UMETA(DisplayName = "Low"),
    ASTCCL_Medium  = 2 UMETA(DisplayName = "Medium"),
    ASTCCL_High    = 3 UMETA(DisplayName = "High"),
    ASTCCL_Highest = 4 UMETA(DisplayName = "Highest"),
    ASTCCL_MAX,
};

/**
 * Various cooker settings.
 */
UCLASS(config = Engine, defaultconfig, meta = (DisplayName = "Cooker"))
class UNREALED_API UCookerSettings: public UDeveloperSettings
{
    GENERATED_UCLASS_BODY()

    virtual void PostInitProperties() override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;

public:
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, meta = (DisplayName = "Enable cooking via network in the background of the editor, launch on uses this setting, requires device to have network access to editor", ConfigRestartRequired = true))
    bool bEnableCookOnTheSide;

    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, meta = (DisplayName = "Generate DDC data in background for desired launch on platform (speeds up launch on)"))
    bool bEnableBuildDDCInBackground;

    /** Enable -iterate for launch on */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, meta = (DisplayName = "Iterative cooking for builds launched from the editor (launch on)"))
    bool bIterativeCookingForLaunchOn;

    /** Enable -iterate when triggering from File dropdown menu */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, meta = (DisplayName = "Iterative cooking for the File->Cook Content menu item"))
    bool bIterativeCookingForFileCookContent;

    /** Enable -cookonthefly for launch on */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, meta = (DisplayName = "Cooking on the fly when launching from the editor (launch on)"))
    bool bCookOnTheFlyForLaunchOn;

    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, meta = (ConsoleVariable = "cook.displaymode", DisplayName = "Cooker Progress Display Mode", ToolTip = "Controls log output of the cooker"))
    ECookProgressDisplayMode CookProgressDisplayMode;

    /** Ignore ini changes when doing iterative cooking, either in editor or out of editor */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay)
    bool bIgnoreIniSettingsOutOfDateForIteration;

    /** Ignore native header file changes when doing iterative cooking, either in editor or out of editor */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay)
    bool bIgnoreScriptPackagesOutOfDateForIteration;

    /** Whether or not to compile Blueprints in development mode when cooking. */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay)
    bool bCompileBlueprintsInDevelopmentMode;

    /** Generate optimized component data to speed up Blueprint construction at runtime. This option can increase the overall Blueprint memory usage in a cooked build. Requires Event-Driven Loading (EDL), which is enabled by default. */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay, meta = (DisplayName = "Generate optimized Blueprint component data"))
    EBlueprintComponentDataCookingMethod BlueprintComponentDataCookingMethod;

    /** List of class names to exclude when cooking for dedicated server */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay, meta = (DisplayName = "Classes excluded when cooking for dedicated server"))
    TArray<FString> ClassesExcludedOnDedicatedServer;

    /** List of module names to exclude when cooking for dedicated server */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay, meta = (DisplayName = "Modules excluded when cooking for dedicated server"))
    TArray<FString> ModulesExcludedOnDedicatedServer;

    /** List of class names to exclude when cooking for dedicated client */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay, meta = (DisplayName = "Classes excluded when cooking for dedicated client"))
    TArray<FString> ClassesExcludedOnDedicatedClient;

    /** List of module names to exclude when cooking for dedicated client */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay, meta = (DisplayName = "Modules excluded when cooking for dedicated client"))
    TArray<FString> ModulesExcludedOnDedicatedClient;

    /** List of r values that need to be versioned */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Cooker, AdvancedDisplay, meta = (DisplayName = "r values that need to be versioned"))
    TArray<FString> VersionedIntRValues;

    UPROPERTY(GlobalConfig, EditAnywhere, Category = Textures, meta = (DisplayName = "ASTC Cooking Level"))
    EASTCCookLevel ASTCCookLevel;

    /** Quality of 0 means fastest, 4 means best quality */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Textures, meta = (DisplayName = "PVRTC Compression Quality (0-4, 0 is fastest)"))
    int32 DefaultPVRTCQuality;

    /** Quality of 0 means fastest, 3 means best quality */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Textures, meta = (DisplayName = "ASTC Compression Quality vs Speed (0-3, 0 is fastest)"))
    int32 DefaultASTCQualityBySpeed;

    /** Quality of 0 means smallest (12x12 block size), 4 means best (4x4 block size) */
    UPROPERTY(GlobalConfig, EditAnywhere, Category = Textures, meta = (DisplayName = "ASTC Compression Quality vs Size (0-4, 0 is smallest)"))
    int32 DefaultASTCQualityBySize;

    /** Allows opening cooked assets in the editor */
    UPROPERTY(EditAnywhere, config, Category = Editor, meta = (ConsoleVariable = "cook.AllowCookedDataInEditorBuilds", DisplayName = "Allow Cooked Content In The Editor", ToolTip = "If true, the editor will be able to open cooked assets (limited to a subset of supported asset types).", ConfigRestartRequired = true))
    uint32 bAllowCookedDataInEditorBuilds : 1;

private:
    /** Deprecated. Use BlueprintComponentDataCookingMethod instead. */
    UPROPERTY(GlobalConfig)
    bool bCookBlueprintComponentTemplateData;
};