1. Epic GamesDeveloper
  3. UEditorSettings

UEditorSettings

API > API/Editor > API/Editor/UnrealEd

   
Name UEditorSettings
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/Settings/EditorSettings.h
Include Path #include "Settings/EditorSettings.h"

Syntax

UCLASS (Config=EditorSettings, MinimalAPI)  
class UEditorSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEditorSettings ( const FObjectInitializer& ObjectInitializer
)

   Settings/EditorSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AutoScalabilityWorkScaleAmount float   Settings/EditorSettings.h
  • Config
bEnableDDCNotifications bool Whether to enable any DDC Notifications Settings/EditorSettings.h
  • EditAnywhere
  • Config
  • Category="Derived Data Cache Notifications"
  • Meta=(DisplayName="Enable Notifications", ConfigRestartRequired=false)
bEnableS3DDC bool Whether to enable the S3 derived data cache backend Settings/EditorSettings.h
  • EditAnywhere
  • Config
  • Category="Derived Data Cache S3"
  • Meta=(DisplayName="Enable AWS S3 Cache", ConfigRestartRequired=true)
bLoadTheMostRecentlyLoadedProjectAtStartup bool   Settings/EditorSettings.h
  • Meta=(DeprecatedProperty, DeprecatedMessage="Use Load At Startup setting")
bNotifyEnableS3DD bool Whether to enable the DDC path notification Settings/EditorSettings.h
  • EditAnywhere
  • Config
  • Category="Derived Data Cache Notifications"
  • Meta=(DisplayName="Notify Enable S3 DDC", ConfigRestartRequired=false, EditCondition="bEnableDDCNotifications")
bNotifySetupDDCPath bool Whether to enable the DDC path notification Settings/EditorSettings.h
  • EditAnywhere
  • Config
  • Category="Derived Data Cache Notifications"
  • Meta=(DisplayName="Notify Setup DDC Path", ConfigRestartRequired=false, EditCondition="bEnableDDCNotifications")
bNotifyUseUnrealCloudDDC bool Whether to enable the Unreal Cloud DDC notification Settings/EditorSettings.h
  • EditAnywhere
  • Config
  • Category="Derived Data Cache Notifications"
  • Meta=(DisplayName="Notify Use Unreal Cloud DDC", ConfigRestartRequired=false, EditCondition="bEnableDDCNotifications")
CompletedSurveys TArray< FGuid > The id's of the surveys completed Settings/EditorSettings.h
  • Config
CreatedProjectPaths TArray< FString > The paths of projects created with the new project wizard. Settings/EditorSettings.h
  • Config
EngineBenchmarkResult Scalability::FQualityLevels Engine scalability benchmark results Settings/EditorSettings.h  
GlobalLocalDDCPath FDirectoryPath Derived Data Cache Settings Settings/EditorSettings.h
  • EditAnywhere
  • Category=DerivedDataCache
  • Meta=(DisplayName="Global Local DDC Path", ConfigRestartRequired=true)
GlobalS3DDCPath FDirectoryPath Adjusts the Local Cache location for AWS/S3 downloaded package bundles. Settings/EditorSettings.h
  • EditAnywhere
  • Category="Derived Data Cache S3"
  • Meta=(DisplayName="Global Local S3DDC Path", ConfigRestartRequired=true, EditCondition="bEnableS3DDC")
GlobalSharedDDCPath FDirectoryPath Adjusts the Shared cache location. Settings/EditorSettings.h
  • EditAnywhere
  • Category=DerivedDataCache
  • Meta=(DisplayName="Global Shared DDC Path", ConfigRestartRequired=true)
HordeUrl FString Horde Settings    

URL of the Horde server | Settings/EditorSettings.h |

  • EditAnywhere
  • Category="Horde"
  • Meta=(DisplayName="Horde Server URL", ConfigRestartRequired=true)
|
InProgressSurveys TArray< FGuid > The id's of the surveys currently in-progress Settings/EditorSettings.h
  • Config
LocalDerivedDataCache FDirectoryPath Project specific override for the Local Cache location. Settings/EditorSettings.h
  • EditAnywhere
  • Config
  • Category=DerivedDataCache
  • AdvancedDisplay
  • Meta=(DisplayName="Project Local DDC Path", ConfigRestartRequired=true)
RecentlyOpenedProjectFiles TArray< FRecentProjectFile > ===================================================================== The following options are NOT exposed in the preferences Editor (usually because there is a different way to set them interactively!) Game project files that were recently opened in the editor Settings/EditorSettings.h
  • Config
SharedDerivedDataCache FDirectoryPath Project specific override for the Shared Cache location. Settings/EditorSettings.h
  • EditAnywhere
  • Config
  • Category=DerivedDataCache
  • AdvancedDisplay
  • Meta=(DisplayName="Project Shared DDC Path", ConfigRestartRequired=true)

Protected

Name Type Remarks Include Path Unreal Specifiers
OnMostRecentProjectSettingChangedDelegate FOnMostRecentProjectSettingChanged   Settings/EditorSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AutoApplyScalabilityBenchmark()

 Auto detects and applies the scalability benchmark Settings/EditorSettings.h  

bool IsScalabilityBenchmarkValid()

   Settings/EditorSettings.h  

void LoadScalabilityBenchmark()

 Load the engine scalability benchmark results. Performs a benchmark if not yet valid. Settings/EditorSettings.h  

FOnMostRecentProjectSettingChanged & OnMostRecentProjectSettingChanged()

   Settings/EditorSettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Settings/EditorSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Settings/EditorSettings.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bCopyStarterContentPreference_DEPRECATED bool   Settings/EditorSettings.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="Ability to add Starter Content has been removed")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page