1. Epic GamesDeveloper
  3. FUncontrolledChangelistsModule

FUncontrolledChangelistsModule

Interface for talking to Uncontrolled Changelists

API > API/Developer > API/Developer/UncontrolledChangelists

Interface for talking to Uncontrolled Changelists

   
Name FUncontrolledChangelistsModule
Type class
Header File /Engine/Source/Developer/UncontrolledChangelists/Public/UncontrolledChangelistsModule.h
Include Path #include "UncontrolledChangelistsModule.h"

Syntax

class FUncontrolledChangelistsModule : public IModuleInterface

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FUncontrolledChangelistsModule()

   UncontrolledChangelistsModule.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FUncontrolledChangelistsModule()

   UncontrolledChangelistsModule.h  

Structs

Name Remarks
FInitialScanEvent Used to determine if the initial Asset Registry scan was completed or the module was shutdown.

Typedefs

Name Type Remarks Include Path
FOnUncontrolledChangelistModuleChanged TMulticastDelegate_NoParams< void > Callback called when the state of the Uncontrolled Changelist Module (or any Uncontrolled Changelist) changed UncontrolledChangelistsModule.h
FUncontrolledChangelistsStateCache TMap< FUncontrolledChangelist, FUncontrolledChangelistStateRef >   UncontrolledChangelistsModule.h

Constants

Name Type Remarks Include Path
CHANGELISTS_NAME const TCHAR *   UncontrolledChangelistsModule.h
VERSION_NAME const TCHAR *   UncontrolledChangelistsModule.h
VERSION_NUMBER uint32   UncontrolledChangelistsModule.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnUncontrolledChangelistModuleChanged FOnUncontrolledChangelistModuleChanged   UncontrolledChangelistsModule.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AddedAssetsCache TSet< FString >   UncontrolledChangelistsModule.h  
bIsEnabled bool   UncontrolledChangelistsModule.h  
bIsStateDirty bool   UncontrolledChangelistsModule.h  
bPendingReloadState bool   UncontrolledChangelistsModule.h  
bStopAssetDiscoveryRequested std::atomic< bool >   UncontrolledChangelistsModule.h  
bWasEnabledLastFrame bool   UncontrolledChangelistsModule.h  
DiscoverAssetsTask TPimplPtr< FAsyncTask< FUncontrolledChangelistsDiscoverAssetsTask > >   UncontrolledChangelistsModule.h  
FUncontrolledChangelistsDiscoverAssetsTask friend   UncontrolledChangelistsModule.h  
InitialScanEvent TSharedPtr< FInitialScanEvent >   UncontrolledChangelistsModule.h  
LoadedCustomProjects TArray< FSourceControlProjectInfo >   UncontrolledChangelistsModule.h  
OnAssetAddedDelegateHandle FDelegateHandle   UncontrolledChangelistsModule.h  
OnCustomProjectsChangedDelegateHandle FDelegateHandle   UncontrolledChangelistsModule.h  
OnEndFrameDelegateHandle FDelegateHandle   UncontrolledChangelistsModule.h  
OnEnginePreExitDelegateHandle FDelegateHandle   UncontrolledChangelistsModule.h  
OnObjectPreSavedDelegateHandle FDelegateHandle   UncontrolledChangelistsModule.h  
UncontrolledChangelistsStateCache FUncontrolledChangelistsStateCache   UncontrolledChangelistsModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TOptional< FUncontrolledChangelist > CreateUncontrolledChangelist ( const FText& InDescription,
const TOptional< FUncontrolledChangelist >& InUncontrolledChangelist
)

 Creates a new Uncontrolled Changelist. UncontrolledChangelistsModule.h  

void DeleteUncontrolledChangelist ( const FUncontrolledChangelist& InUncontrolledChangelist
)

 Deletes an Uncontrolled Changelist. UncontrolledChangelistsModule.h  

void EditUncontrolledChangelist ( const FUncontrolledChangelist& InUncontrolledChangelist,
const FText& InNewDescription
)

 Edits an Uncontrolled Changelist's description UncontrolledChangelistsModule.h  

FUncontrolledChangelistStatePtr GetChangelistState ( const FUncontrolledChangelist& InUncontrolledChangelist
) const

 Get the changelist state of the given Uncontrolled Changelist. UncontrolledChangelistsModule.h  

TArray< FUncontrolledChangelistStateRef > GetChangelistStates()

 Get the changelist state of each cached Uncontrolled Changelist. UncontrolledChangelistsModule.h  

FUncontrolledChangelistStatePtr GetDefaultChangelistState()

 Get the changelist state of the default Uncontrolled Changelist. UncontrolledChangelistsModule.h  

FText GetReconcileStatus()

 Gets a message indicating the status of SCC coherence. UncontrolledChangelistsModule.h  

void HandleChangelistStateModified()

 Called if the state of any Uncontrolled Changelist is modified externally, eg, via the mutable accessors above. UncontrolledChangelistsModule.h  

bool IsEnabled()

 Check whether uncontrolled changelist module is enabled. UncontrolledChangelistsModule.h  

void MoveFilesToControlledChangelist ( const TArray< FString >& InUncontrolledFiles,
const FSourceControlChangelistPtr& InChangelist,
TFunctionRef< bool(const TArray< FSourceControlStateRef >&)> InOpenConflictDialog
)

 Moves files to a Controlled Changelist. UncontrolledChangelistsModule.h  

void MoveFilesToControlledChangelist ( const TArray< FSourceControlStateRef >& InUncontrolledFileStates,
const FSourceControlChangelistPtr& InChangelist,
TFunctionRef< bool(const TArray< FSourceControlStateRef >&)> InOpenConflictDialog
)

 Moves files to a Controlled Changelist. UncontrolledChangelistsModule.h  

void MoveFilesToUncontrolledChangelist ( const TArray< FSourceControlStateRef >& InControlledFileStates,
const TArray< FSourceControlStateRef >& InUncontrolledFileStates,
const FUncontrolledChangelist& InUncontrolledChangelist
)

 Moves files to an Uncontrolled Changelist. UncontrolledChangelistsModule.h  

void MoveFilesToUncontrolledChangelist ( const TArray< FString >& InControlledFiles,
const FUncontrolledChangelist& InUncontrolledChangelist
)

 Moves files to an Uncontrolled Changelist. UncontrolledChangelistsModule.h  

void OnAssetAdded ( const FAssetData& AssetData
)

 Delegate callback called when assets are added to AssetRegistry. UncontrolledChangelistsModule.h  

bool OnDeleteWritable ( const FString& InFilename
)

 Called when file has been deleted without an available Provider. UncontrolledChangelistsModule.h  

bool OnMakeWritable ( const FString& InFilename
)

 Called when file has been made writable. UncontrolledChangelistsModule.h  

bool OnNewFilesAdded ( const TArray< FString >& InFilenames
)

 Called when files should have been marked for add without an available Provider. UncontrolledChangelistsModule.h  

void OnObjectPreSaved ( UObject* InObject,
FObjectPreSaveContext InPreSaveContext
)

 Delegate callback called before an asset has been written to disk. UncontrolledChangelistsModule.h  
Called when "Reconcile assets" button is clicked. UncontrolledChangelistsModule.h  

bool OnRevert ( const TArray< FString >& InFilenames
)

 Called when "Revert files" button is clicked. Reverts modified files and deletes new ones. UncontrolledChangelistsModule.h  

bool OnSaveWritable ( const FString& InFilename
)

 Called when file has been saved without an available Provider. UncontrolledChangelistsModule.h  

void UpdateStatus()

 Updates the status of Uncontrolled Changelists and files. UncontrolledChangelistsModule.h  

Overridden from IModuleInterface

Name Remarks Include Path Unreal Specifiers

virtual void ShutdownModule()

   UncontrolledChangelistsModule.h  

virtual void StartupModule()

 IModuleInterface implementation UncontrolledChangelistsModule.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool DoesFilePassCustomProjectFilter ( const FString& InFilename,
const FSourceControlProjectInfo& Project
)

 Run the given file through the filter for the given custom project. UncontrolledChangelistsModule.h  
Gets a reference to the UncontrolledChangelists module UncontrolledChangelistsModule.h  

static FName GetModuleName()

   UncontrolledChangelistsModule.h  

static FUncontrolledChangelistsModule * GetPtr()

 Gets a pointer to the UncontrolledChangelists module, if loaded UncontrolledChangelistsModule.h  

static bool IsAvailable ()

 Checks to see if this module is loaded and ready. UncontrolledChangelistsModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page