USourceControlPreferences | Unreal Engine 5.6 Documentation

API > API/Developer > API/Developer/SourceControl

Settings for the Source Control Integration


Name	USourceControlPreferences
Type	class
Header File	/Engine/Source/Developer/SourceControl/Public/SourceControlPreferences.h
Include Path	#include "SourceControlPreferences.h"

Syntax

UCLASS (MinimalAPI, Config=Editor, defaultconfig,  
       Meta=(DisplayName="Revision Control", Keywords="Source Control"))  
class USourceControlPreferences : public UDeveloperSettings

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UDeveloperSettings → USourceControlPreferences

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bEnableUncontrolledChangelists	bool	Enables Uncontrolled Changelists features.	SourceControlPreferences.h	Config EditAnywhere Category=SourceControl Meta=(ToolTip="Enables Uncontrolled Changelists features. The editor must be restarted for the change to be fully taken into account.", ConfigRestartRequired=true)
bEnableValidationTag	bool	If enabled, adds a tag in changelist descriptions when they are validated	SourceControlPreferences.h	Config EditAnywhere Category=SourceControl Meta=(ToolTip="Adds validation tag to changelist description on submit.")
bRequiresRevisionControlToRenameLocalizableAssets	bool	Revision Control is a requirement to move/rename/delete localizable assets	SourceControlPreferences.h	Config EditAnywhere DisplayName="Requires Revision Control To Manage Localizable Assets" Category=Internationalization Meta=(ToolTip="If the project uses Localization and its localized content might not be on disk (but still in your Revision Control), then enabling this feature will require a Revision Control Provider to be configured to move/rename/delete files to be sure no localized variants become orphaned. (Works only with Perforce for now)")
bShouldDeleteNewFilesOnRevert	bool	If enabled, deletes new files when reverted.	SourceControlPreferences.h	Config EditAnywhere Category=SourceControl Meta=(ToolTip="Deletes new files when reverted.")
CollectionChangelistTags	TArray< FString >	List of lines to add to any collection on checkin	SourceControlPreferences.h	Config EditAnywhere Category=SourceControl
SpecificCollectionChangelistTags	TMap< FName, FString >	Map of collection names and additional text to apply to changelist descriptions when checking them in	SourceControlPreferences.h	Config EditAnywhere Category=SourceControl Meta=(MultiLine=true)

Functions

Static

Name	Remarks	Include Path
static bool AreUncontrolledChangelistsEnabled()	Helper to access easily Enable Uncontrolled Changelists setting	SourceControlPreferences.h
static bool IsValidationTagEnabled()	Helper to access easily Enable Validation Tag setting	SourceControlPreferences.h
static bool RequiresRevisionControlToRenameLocalizableAssets()	Helper to access easily Requires Revision Control To Rename Localizable Assets setting	SourceControlPreferences.h
static bool ShouldDeleteNewFilesOnRevert()	Helper to access easily Should Delete New Files On Revert setting	SourceControlPreferences.h

Navigation

Syntax

Inheritance Hierarchy

Variables

Public

Functions

Static