1. Epic GamesDeveloper
  3. UCookerSettings

UCookerSettings

Various cooker settings.

API > API/Developer > API/Developer/DeveloperToolSettings

Various cooker settings.

   
Name UCookerSettings
Type class
Header File /Engine/Source/Developer/DeveloperToolSettings/Classes/CookerSettings.h
Include Path #include "CookerSettings.h"

Syntax

UCLASS (MinimalAPI, Config=Engine, defaultconfig, Meta=(DisplayName="Cooker"))  
class UCookerSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCookerSettings ( const FObjectInitializer& ObjectInitializer
)

   CookerSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCompileBlueprintsInDevelopmentMode bool Whether or not to compile Blueprints in development mode when cooking. CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
bCookOnTheFlyForLaunchOn bool Enable -cookonthefly for launch on CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • Meta=(DisplayName="Cooking on the fly when launching from the editor (launch on)")
bEnableBuildDDCInBackground bool   CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • Meta=(DisplayName="Generate DDC data in background for desired launch on platform (speeds up launch on)")
bEnableCookOnTheSide bool   CookerSettings.h
  • 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)
bIgnoreIniSettingsOutOfDateForIteration bool Ignore ini changes when doing iterative cooking, either in editor or out of editor CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
bIgnoreScriptPackagesOutOfDateForIteration bool Ignore native header file changes when doing iterative cooking, either in editor or out of editor CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
bIterativeCookingForFileCookContent bool Enable -iterate when triggering from Platforms dropdown menu CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • Meta=(DisplayName="LegacyIterative cooking for the Platforms->Cook Content menu item")
bIterativeCookingForLaunchOn bool Enable -iterate for launch on CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • Meta=(DisplayName="LegacyIterative cooking for builds launched from the editor (launch on)")
BlueprintComponentDataCookingMethod EBlueprintComponentDataCookingMethod Generate optimized component data to speed up Blueprint construction at runtime. CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
  • Meta=(DisplayName="Generate optimized Blueprint component data")
BlueprintPropertyGuidsCookingMethod EBlueprintPropertyGuidsCookingMethod Should we include the property GUIDs for a Blueprint class in a cooked build, so that SaveGame archives can redirect property names via the GUIDs? CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
  • Meta=(DisplayName="Cook Blueprint property GUIDs?")
ClassesExcludedOnDedicatedClient TArray< FString > List of class names to exclude when cooking for dedicated client CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
  • Meta=(DisplayName="Classes excluded when cooking for dedicated client")
ClassesExcludedOnDedicatedServer TArray< FString > List of class names to exclude when cooking for dedicated server CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
  • Meta=(DisplayName="Classes excluded when cooking for dedicated server")
ConfigRestartRequired     CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Textures
  • Meta=(ConsoleVariable="cook.ASTCTextureCompressor", DisplayName="ASTC Texture Compressor", ToolTip="which compressor to use for ASTC textures", ConfigRestartRequired=true)
ConsoleVariable   Allows opening cooked assets in the editor CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • Meta=(ConsoleVariable="cook.displaymode", DisplayName="Cooker Progress Display Mode", ToolTip="Controls log output of the cooker")
DefaultASTCQualityBySize int32 Quality of 0 means smallest (12x12 block size), 4 means best (4x4 block size) CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Textures
  • Meta=(DisplayName="ASTC Compression Block Size (0-4, 0 is smallest)")
DefaultASTCQualityBySizeHQ int32 Quality of 0 means smallest (12x12 block size), 4 means best (4x4 block size) CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Textures
  • Meta=(DisplayName="ASTC Compression Block Size for High Quality (BC7) (0-4, 0 is smallest)")
DefaultASTCQualityBySpeed int32 Quality of 0 means fastest, 3 means best quality CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Textures
  • Meta=(DisplayName="ASTC Compression Speed (0-3, 0 is fastest)")
DisplayName     CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • Meta=(ConsoleVariable="cook.displaymode", DisplayName="Cooker Progress Display Mode", ToolTip="Controls log output of the cooker")
EditCondition     CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Textures
  • Meta=(ConsoleVariable="cook.AllowASTCHDRProfile", DisplayName="ASTC HDR Profile", ToolTip="whether to allow ASTC HDR profile using Arm encoder, the hdr format is only supported on some devices, e.g. Apple A13, Mali-G72, Adreno (TM) 660", ConfigRestartRequired=true, EditCondition="DefaultASTCCompressor == ETextureFormatASTCCompressor::Arm")
ModulesExcludedOnDedicatedClient TArray< FString > List of module names to exclude when cooking for dedicated client CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
  • Meta=(DisplayName="Modules excluded when cooking for dedicated client")
ModulesExcludedOnDedicatedServer TArray< FString > List of module names to exclude when cooking for dedicated server CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
  • Meta=(DisplayName="Modules excluded when cooking for dedicated server")
ToolTip     CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • Meta=(ConsoleVariable="cook.displaymode", DisplayName="Cooker Progress Display Mode", ToolTip="Controls log output of the cooker")
VersionedIntRValues TArray< FString > List of r values that need to be versioned CookerSettings.h
  • GlobalConfig
  • EditAnywhere
  • Category=Cooker
  • AdvancedDisplay
  • Meta=(DisplayName="r values that need to be versioned")

Protected

Name Type Remarks Include Path Unreal Specifiers
bCookBlueprintComponentTemplateData bool Deprecated. Use BlueprintComponentDataCookingMethod instead. CookerSettings.h
  • GlobalConfig

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void OverrideConfigSection ( FString& InOutSectionName
)

 This class was moved from UnrealEd module, but to allow it to be used by developer tools, like UFE, it has moved to this module. CookerSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CookerSettings.h  

virtual void PostInitProperties()

   CookerSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page