description: LOD has changed, it will have to notify all SMC that uses this SM and ask them to refresh LOD

code: static void RefreshLODChange ( const [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh )


description: If BoneInfluenceLimit is 0, the DefaultBoneInfluenceLimit from the project settings will be used.

module: SkeletalMeshUtilitiesCommon

code: static void RegenerateAllImportSkinWeightProfileData ( [FSkeletalMeshLODModel](API\Runtime\Engine\Rendering\FSkeletalMeshLODModel) & LODModelDest, int32 BoneInfluenceLimit, const [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Regenerate LOD that are dependent of LODIndex

code: static void RegenerateDependentLODs ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, int32 LODIndex, const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform )


description: Removes a particular LOD from the SkeletalMesh.

code: static void RemoveLOD ( [FSkeletalMeshUpdateContext](API\Developer\SkeletalMeshUtilitiesCommon\FSkeletalMeshUpdateContext) & UpdateContext, int32 DesiredLOD )


description:
Regenerate LODs of the mesh
true if succeed. If mesh reduction is not available this will return false.

code: static bool RegenerateLOD ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, int32 NewLODCount, bool bRegenerateEvenIfImported, bool bGenerateBaseLOD )


description: Removes the specified LODs from the SkeletalMesh.

code: static void RemoveLODs ( [FSkeletalMeshUpdateContext](API\Developer\SkeletalMeshUtilitiesCommon\FSkeletalMeshUpdateContext) & UpdateContext, const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & DesiredLODs )


description: Reorder the material slot array to follow the base LOD section order. It will readjust all LOD section material index and LODMaterialMap.

code: static void ReorderMaterialSlotToBaseLod ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh )


code: static void RestoreClothingFromBackup ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, [TArray](API\Runtime\Core\Containers\TArray)< [ClothingAssetUtils::FClothingAssetMeshBinding](API\Runtime\ClothingSystemRuntimeCommon\FClothingAssetMeshBinding) > & ClothingBindings, const int32 LODIndex )


code: static void RestoreClothingFromBackup ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, [TArray](API\Runtime\Core\Containers\TArray)< [ClothingAssetUtils::FClothingAssetMeshBinding](API\Runtime\ClothingSystemRuntimeCommon\FClothingAssetMeshBinding) > & ClothingBindings )


description: Restore the LOD imported model to the last imported data. Call this function if you want to remove the reduce on the base LOD

code: static bool RestoreSkeletalMeshLODImportedData_DEPRECATED ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, int32 LodIndex )


description: DestinationSkeletalMesh - Skeletal mesh receiving the LOD data.  SourceSkeletalMesh - Skeletal mesh providing the LOD data we want to use to add or modify the specified destination LOD at LodIndex. The LOD we want to import is always the base LOD of the source mesh.  LodIndex - The destination lod index we want to add or modify.  SourceDataFilename - The file name we use to import the source skeletal mesh.

code: static bool SetCustomLOD ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * DestinationSkeletalMesh, [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SourceSkeletalMesh, const int32 LodIndex, const [FString](API\Runtime\Core\Containers\FString) & SourceDataFilename )


description: Simplifies the static mesh based upon various user settings for DesiredLOD.

code: static void SimplifySkeletalMeshLOD ( [FSkeletalMeshUpdateContext](API\Developer\SkeletalMeshUtilitiesCommon\FSkeletalMeshUpdateContext) & UpdateContext, int32 DesiredLOD, const class [ITargetPlatform](API\Developer\TargetPlatform\Interfaces\ITargetPlatform) * TargetPlatform, bool bRestoreClothing, class [FThreadSafeBool](API\Runtime\Core\HAL\FThreadSafeBool) * OutNeedsPackageDirtied )


description: Simplifies the static mesh based upon various user settings for DesiredLOD This is private function that gets called by SimplifySkeletalMesh

code: static void SimplifySkeletalMeshLOD &40; USkeletalMesh &42; SkeletalMesh, int32 DesiredLOD, const class ITargetPlatform &42; TargetPlatform, bool bRestoreClothing, class FThreadSafeBool &42; OutNeedsPackageDirtied &41;


code: static void UnbindClothingAndBackup ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, [TArray](API\Runtime\Core\Containers\TArray)< [ClothingAssetUtils::FClothingAssetMeshBinding](API\Runtime\ClothingSystemRuntimeCommon\FClothingAssetMeshBinding) > & ClothingBindings )


description: SkeletalMesh: The skeletalmesh we want to optimize  LODIndex: The LOD we want to optimize  TextureMask: The texture containing the stripping mask. non black pixel strip triangle, black pixel keep them.  Threshold: The threshold we want when comparing the texture value with zero.

code: static bool StripLODGeometry ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, const int32 LODIndex, [UTexture2D](API\Runtime\Engine\Engine\UTexture2D) * TextureMask, const float Threshold )


code: static void UnbindClothingAndBackup ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMesh, [TArray](API\Runtime\Core\Containers\TArray)< [ClothingAssetUtils::FClothingAssetMeshBinding](API\Runtime\ClothingSystemRuntimeCommon\FClothingAssetMeshBinding) > & ClothingBindings, const int32 LODIndex )


description: This function apply the skinning weights from the saved imported skinning weight data to the destination skeletal mesh. The Destination will receive the weights has the alternate weights.

code: static bool UpdateAlternateSkinWeights ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshDest, const [FName](API\Runtime\Core\UObject\FName) & ProfileNameDest, int32 LODIndexDest, const [IMeshUtilities::MeshBuildOptions](API\Developer\MeshUtilities\IMeshUtilities\MeshBuildOptions) & Options )


description: This function apply the skinning weights from asource skeletal mesh to the destination skeletal mesh. The Destination will receive the weights has the alternate weights. We extract the imported skinning weight data from the SkeletalMeshSrc and we save the imported raw data into the destination mesh. Then we call UpdateAlternateSkinWeights without the SkeletalMeshSrc

code: static bool UpdateAlternateSkinWeights ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshDest, const [FName](API\Runtime\Core\UObject\FName) & ProfileNameDest, [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshSrc, int32 LODIndexDest, int32 LODIndexSrc, const [IMeshUtilities::MeshBuildOptions](API\Developer\MeshUtilities\IMeshUtilities\MeshBuildOptions) & Options )


code: static bool UpdateAlternateSkinWeights ( [FSkeletalMeshLODModel](API\Runtime\Engine\Rendering\FSkeletalMeshLODModel) & LODModelDest, [FSkeletalMeshImportData](API\Runtime\Engine\Rendering\FSkeletalMeshImportData) & ImportDataDest, [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshDest, const [FReferenceSkeleton](API\Runtime\Engine\FReferenceSkeleton) & RefSkeleton, const [FName](API\Runtime\Core\UObject\FName) & ProfileNameDest, int32 LODIndexDest, const [IMeshUtilities::MeshBuildOptions](API\Developer\MeshUtilities\IMeshUtilities\MeshBuildOptions) & Options )


description: Deprecated* Please use the new overloads of UpdateAlternateSkinWeights that take anIMeshUtilities::MeshBuildOptions. Note thatIMeshUtilities::MeshBuildOptions::bComputeNormals/Tangents has the opposite meaning of ShouldImportNormals/Tangents.

code: static bool UpdateAlternateSkinWeights ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshDest, const [FName](API\Runtime\Core\UObject\FName) & ProfileNameDest, int32 LODIndexDest, [FOverlappingThresholds](API\Runtime\Engine\FOverlappingThresholds) OverlappingThresholds, bool ShouldImportNormals, bool ShouldImportTangents, bool bUseMikkTSpace, bool bComputeWeightedNormals )


code: static bool UpdateAlternateSkinWeights ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshDest, const [FName](API\Runtime\Core\UObject\FName) & ProfileNameDest, [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshSrc, int32 LODIndexDest, int32 LODIndexSrc, [FOverlappingThresholds](API\Runtime\Engine\FOverlappingThresholds) OverlappingThresholds, bool ShouldImportNormals, bool ShouldImportTangents, bool bUseMikkTSpace, bool bComputeWeightedNormals )


code: static bool UpdateAlternateSkinWeights ( [FSkeletalMeshLODModel](API\Runtime\Engine\Rendering\FSkeletalMeshLODModel) & LODModelDest, [FSkeletalMeshImportData](API\Runtime\Engine\Rendering\FSkeletalMeshImportData) & ImportDataDest, [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * SkeletalMeshDest, const [FReferenceSkeleton](API\Runtime\Engine\FReferenceSkeleton) & RefSkeleton, const [FName](API\Runtime\Core\UObject\FName) & ProfileNameDest, int32 LODIndexDest, [FOverlappingThresholds](API\Runtime\Engine\FOverlappingThresholds) OverlappingThresholds, bool ShouldImportNormals, bool ShouldImportTangents, bool bUseMikkTSpace, bool bComputeWeightedNormals )


className: FLODUtilities

description: No constructors are accessible with public or protected access.

code: class FLODUtilities


description: Build the vertex attributes

code: static bool UpdateLODInfoVertexAttributes ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * InSkeletalMesh, int32 InSourceLODIndex, int32 InTargetLODIndex, bool bInCopyAttributeValues )


className: FSkeletalMeshNotifyDelegate

description: A delegate for monitoring to skeletal mesh global notifications.

code: typedef TMulticastDelegate_TwoParams< void, const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > &, const [ESkeletalMeshNotifyType](API\Developer\SkeletalMeshUtilitiesCommon\ESkeletalMeshNotifyType) > FSkeletalMeshNotifyDelegate


className: FSkeletalMeshUpdateContext

code: struct FSkeletalMeshUpdateContext

AssociatedComponents

type: TArray<UActorC...

OnLODChanged

type: FExecuteAction

SkeletalMesh

type: USkeletalMesh&...


description:
Creates a skeleton from a static mesh with a single root bone.
`true_ if the operation succeeded.

code: static bool InitializeSkeletonFromStaticMesh ( [USkeleton](API\Runtime\Engine\Animation\USkeleton) * InSkeleton, const [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * InStaticMesh, const FVector & InRelativeRootPosition )


description:
Creates a skeleton from a static mesh with a bone chain going from root to end effector, where the intermediary bones are distributed evenly along a line between the two.
`true_ if the operation succeeded.

code: static bool InitializeSkeletonFromStaticMesh ( [USkeleton](API\Runtime\Engine\Animation\USkeleton) * InSkeleton, const [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * InStaticMesh, const FVector & InRelativeRootPosition, const FVector & InRelativeEndEffectorPosition, const int32 InIntermediaryJointCount )


description: Initialize a skeletal mesh from the given static mesh and a skeleton. The mesh will initially be created with a rigid binding on the root bone.

code: static bool InitializeSkeletalMeshFromStaticMesh ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * InSkeletalMesh, const [UStaticMesh](API\Runtime\Engine\Engine\UStaticMesh) * InStaticMesh, const [FReferenceSkeleton](API\Runtime\Engine\FReferenceSkeleton) & InReferenceSkeleton, const [FName](API\Runtime\Core\UObject\FName) InBindBone )


description: Create a skeletal mesh from a list of mesh description objects and a reference skeleton. If any mesh description either doesn't contain a skin weight, or any of the skin weights reference a bone that doesn't exist on the reference skeleton, this operation fails.

code: static bool InitializeSkeletalMeshFromMeshDescriptions ( [USkeletalMesh](API\Runtime\Engine\Engine\USkeletalMesh) * InSkeletalMesh, [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * > InMeshDescriptions, TConstArrayView< [FSkeletalMaterial](API\Runtime\Engine\Engine\FSkeletalMaterial) > InMaterials, const [FReferenceSkeleton](API\Runtime\Engine\FReferenceSkeleton) & InReferenceSkeleton, const bool bInRecomputeNormals, const bool bInRecomputeTangents )


className: FStaticToSkeletalMeshConverter

code: struct FStaticToSkeletalMeshConverter


code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetSelectedBones() const


className: NameFunction

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< [TOptional](API\Runtime\Core\IO\TOptional)< [FName](API\Runtime\Core\UObject\FName) >([HHitProxy](API\Runtime\Engine\HHitProxy) *) > NameFunction


code: ISkeletalMeshEditorBinding()


code: virtual ~ISkeletalMeshEditorBinding()


className: ISkeletalMeshEditorBinding

code: class ISkeletalMeshEditorBinding


description: Override this function to react to notifications locally.

code: void HandleNotification ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & BoneNames, const [ESkeletalMeshNotifyType](API\Developer\SkeletalMeshUtilitiesCommon\ESkeletalMeshNotifyType) InNotifyType )


code: void Notify ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & BoneNames, const [ESkeletalMeshNotifyType](API\Developer\SkeletalMeshUtilitiesCommon\ESkeletalMeshNotifyType) InNotifyType ) const


code: bool Notifying() const


code: virtual ~ISkeletalMeshNotifier()


code: ISkeletalMeshNotifier()


className: ISkeletalMeshNotifier

code: class ISkeletalMeshNotifier


className: FNavigationEventSimulationViewArgs

module: SlateReflector

OnNavigateToWidget

type: FSimpleWidgetDe...


className: FSimpleWidgetDelegate

code: typedef TBaseDelegate_OneParam< void, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< const [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > > FSimpleWidgetDelegate


className: ENavigationStyle

code: enum ENavigationStyle { FourCardinalDirections, ConceptualNextAndPrevious, }


className: ERoutedReason

code: enum ERoutedReason { BoundaryRule, Window, LastWidget, }


className: FHandleNavigation

code: typedef TBaseDelegate_TwoParams< [TOptional](API\Runtime\Core\IO\TOptional)< [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) >, uint32, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & > FHandleNavigation


code: FSimulatedReply &40; const FNavigationReply & &41;


className: FSimulatedReply

code: struct FSimulatedReply

BoundaryRule

type: EUINavigationRu...

EventHandler

type: TSharedPtr<SWi...


code: bool IsHandled&40;&41; const


code: bool IsValid&40;&41; const


className: FSimulationResult

code: struct FSimulationResult

bAlwaysHandleNavigationAttempt

type: bool

description: The event is handle, even if the destination widget is nullptr or the Viewport->HandleNavigation return false.

bCanFindWidgetForSetFocus

description: Was able to find the widget to focus.

bHandledByViewport

description: Handled by the viewport. See OnViewportHandleNavigation.

bIsDynamic

description: Can not return a result since it would involve calling a dynamic callback.

bRoutedHandlerHasNavigationMeta

description: Does the routed widget has navigation meta data.

FocusedWidgetPath

description: The widget that will received the focus.

NavigationDestination

type: FWidgetPath

description: The result of the navigation simulation.

NavigationReply

type: FSimulatedReply

description: The reply of received from the routed widget.

NavigationSource

description: From where the navigation started.

NavigationType

type: EUINavigation

description: The navigation type.

RoutedReason

type: ERoutedReason

description: The reason we choose that boundary widget.

WidgetThatShouldReceivedFocus

description: Base on the boundary rule, the widget that should receive the focus.


description: Simulate a navigation event for a widget

code: [TArray](API\Runtime\Core\Containers\TArray)< [FSimulationResult](API\Developer\SlateReflector\FSlateNavigationEventSimulator\FSimulationResult) > Simulate ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & WidgetPath, int32 UserIndex, ENavigationGenesis Genesis, [ENavigationStyle](API\Developer\SlateReflector\FSlateNavigationEventSimulator\ENavigationStyle) Navigation )


code: [FSimulationResult](API\Developer\SlateReflector\FSlateNavigationEventSimulator\FSimulationResult) Simulate ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & WidgetPath, int32 UserIndex, ENavigationGenesis Genesis, EUINavigation Navigation )


description: Simulate for each widgets that are enabled and support keyboard focus

code: [TArray](API\Runtime\Core\Containers\TArray)< [FSimulationResult](API\Developer\SlateReflector\FSlateNavigationEventSimulator\FSimulationResult) > SimulateForEachWidgets ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & WidgetPath, int32 UserIndex, ENavigationGenesis Genesis, [ENavigationStyle](API\Developer\SlateReflector\FSlateNavigationEventSimulator\ENavigationStyle) Navigation )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FSimulationResult](API\Developer\SlateReflector\FSlateNavigationEventSimulator\FSimulationResult) > SimulateForEachWidgets ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > & Window, int32 UserIndex, ENavigationGenesis Genesis, [ENavigationStyle](API\Developer\SlateReflector\FSlateNavigationEventSimulator\ENavigationStyle) Navigation )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FSimulationResult](API\Developer\SlateReflector\FSlateNavigationEventSimulator\FSimulationResult) > SimulateForEachWidgets ( const [FWidgetPath](API\Runtime\SlateCore\Layout\FWidgetPath) & WidgetPath, int32 UserIndex, ENavigationGenesis Genesis, EUINavigation Navigation )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FSimulationResult](API\Developer\SlateReflector\FSlateNavigationEventSimulator\FSimulationResult) > SimulateForEachWidgets ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > & Window, int32 UserIndex, ENavigationGenesis Genesis, EUINavigation Navigation )


code: static [FText](API\Runtime\Core\Internationalization\FText) ToText ( [ENavigationStyle](API\Developer\SlateReflector\FSlateNavigationEventSimulator\ENavigationStyle) NavigationStyle )


code: static [FText](API\Runtime\Core\Internationalization\FText) ToText ( [ERoutedReason](API\Developer\SlateReflector\FSlateNavigationEventSimulator\ERoutedReason) RoutedReason )


className: FSlateNavigationEventSimulator

description: The application or a widget can consume the "set focus" event. Resulting in different behavior.

code: class FSlateNavigationEventSimulator

OnViewportHandleNavigation

type: FHandleNavigati...

description: Once the destination widget has been decided, the viewport may handled the event.


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< INavigationEventSimulationView >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: void SelectWidget ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > & Widget )


code: int32 PaintSimuationResult ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId )


code: void SetSimulationResult ( [TArray](API\Runtime\Core\Containers\TArray)< [FSlateNavigationEventSimulator::FSimulationResult](API\Developer\SlateReflector\FSlateNavigationEventSimulator\FSimulationResult) > SimulationResult )


description: Create a widget to visualize the result of a Navigation Event Simulation.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [INavigationEventSimulationView](API\Developer\SlateReflector\INavigationEventSimulationView) > CreateNavigationEventSimulationView ( const [FNavigationEventSimulationViewArgs](API\Developer\SlateReflector\FNavigationEventSimulationViewAr-) & DetailsViewArgs )


className: INavigationEventSimulationView

code: class INavigationEventSimulationView : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: Display the texture atlas visualizer, either spawned from a tab manager, or in a new window if the tab manager can't be used

code: void DisplayFontAtlasVisualizer()


code: void DisplayTextureAtlasVisualizer()


description: Display the widget reflector, either spawned from a tab manager, or in a new window if the tab manager can't be used

code: void DisplayWidgetReflector()


description: Get the Navigation Event Simulator used by the widget reflector.


description: Registers a tab spawner for the widget reflector.

code: void RegisterTabSpawner ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > & WorkspaceGroup )


description: Unregisters the tab spawner for the widget reflector.

code: void UnregisterTabSpawner()


description: Virtual destructor.

code: virtual ~ISlateReflectorModule()


className: ISlateReflectorModule

description: Interface for messaging modules.

code: class ISlateReflectorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FDoneLaunchingCodeAccessor

description: Event fired when done launching code accessor

module: SourceCodeAccess

code: typedef TMulticastDelegate_OneParam< void, const bool > FDoneLaunchingCodeAccessor


className: FLaunchingCodeAccessor

description: Event fired when launching code accessor

code: typedef TMulticastDelegate_NoParams< void > FLaunchingCodeAccessor


className: FOpenFileFailed

description: Event fired when opening a file has failed

code: typedef TMulticastDelegate_OneParam< void, const [FString](API\Runtime\Core\Containers\FString) & > FOpenFileFailed


description:
Check to see if source code can be accessed.
true if source code can be accessed.

code: bool CanAccessSourceCode() const


description:
Checks if a compiler is available
true if source code can be compiled.

code: bool CanCompileSourceCode() const


description:
Get the accessor to allow us to view source code
the accessor.

code: [ISourceCodeAccessor](API\Developer\SourceCodeAccess\ISourceCodeAccessor) & GetAccessor() const


description: Gets the Event that is broadcasted when an attempted launch of this code accessor was successful or failed


description: Gets the Event that is broad casted when attempting to launch visual studio


description: Gets the Event that is broadcast when an attempt to load a file through Visual Studio failed


description: Set the accessor we want to use to view source code

code: void SetAccessor ( const [FName](API\Runtime\Core\UObject\FName) & InName )


className: ISourceCodeAccessModule

description: Module used to access source code

code: class ISourceCodeAccessModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
Add a group of source files to the current solution/project/workspace
true if the files could be added, false otherwise

code: bool AddSourceFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AbsoluteSourcePaths, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AvailableModules )


description:
Check if we can currently access source code
true if source code can be accessed


description:
Determine if the source code solution for the given accessor already exists
true if solution files exist

code: bool DoesSolutionExist() const


description:
Get the name of this source code accessor - used as a unique identifier
the name of this accessor


description:
Get the description text for this source code accessor
the description text of this accessor


description:
Get the name text for this source code accessor
the name text of this accessor


description:
Get the icon that represents opening this source code editor
the default source code editor icon

code: virtual [FName](API\Runtime\Core\UObject\FName) GetOpenIconName() const


description:
Get the icon that represents refreshing this source code editor
the default source code editor icon

code: virtual [FName](API\Runtime\Core\UObject\FName) GetRefreshIconName() const


description:
Open the current code solution for editing
true if successful

code: bool OpenSolution()


description:
Opens a file in the correct running instance of this code accessor at a line and optionally to a column.
true if successful

code: bool OpenFileAtLine ( const [FString](API\Runtime\Core\Containers\FString) & FullPath, int32 LineNumber, int32 ColumnNumber )


description:
Open the code solution at a specific path for editing
true if successful

code: bool OpenSolutionAtPath ( const [FString](API\Runtime\Core\Containers\FString) & InSolutionPath )


description: Opens a group of source files.

code: bool OpenSourceFiles ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AbsoluteSourcePaths )


description: Not necessary to call unless you know you're changing the state of any installed compilers. If that's the case, you should call this before checking the state the installed state of the compilers.

code: void RefreshAvailability()


description:
Saves all open code documents if they need to be saved. Will block if there is any read-only files open that need to be saved.
true if successful

code: bool SaveAllOpenDocuments() const


description: Tick this source code accessor

code: void Tick ( const float DeltaTime )


code: virtual ~ISourceCodeAccessor()


className: ISourceCodeAccessor

description: Interface for viewing/editing source code

code: class ISourceCodeAccessor : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Results of a command execution

module: SourceControl

code: namespace ECommandResult { enum Type { Failed, Succeeded, Cancelled, } }


description: Hint for how to execute the operation. Note that asynchronous operations requireTick()to be called to manage completed operations.

code: namespace EConcurrency { enum Type { Synchronous, Asynchronous, } }


description: The modality of the login window.

code: namespace ELoginWindowMode { enum Type { Modal, Modeless, } }


description: Login window startup behavior

code: namespace EOnLoginWindowStartup { enum Type { ResetProviderToNone, PreserveProvider, } }


description: Hint to provider when updating state

code: namespace EStateCacheUsage { enum Type { ForceUpdate, Use, } }


code: FAnnotationLine ( int32 InChangeNumber, const [FString](API\Runtime\Core\Containers\FString) & InUserName, const [FString](API\Runtime\Core\Containers\FString) & InLine )


className: FAnnotationLine

description: A single line of an annotated file

code: class FAnnotationLine

Line

type: FString


className: FAssetDataArrayPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [TArray](API\Runtime\Core\Containers\TArray)< [FAssetData](API\Runtime\CoreUObject\AssetRegistry\FAssetData) > > FAssetDataArrayPtr


className: FAssetDataToLoad

code: struct FAssetDataToLoad


code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDescription() const


description: Get the string to display when this operation is in progress

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


code: const [FText](API\Runtime\Core\Internationalization\FText) & GetSuccessMessage() const


description: Get the name of this operation, used as a unique identifier

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: void SetDescription ( const [FText](API\Runtime\Core\Internationalization\FText) & InDescription )


code: void SetKeepCheckedOut ( const bool bInKeepCheckedOut )


code: void SetSuccessMessage ( const [FText](API\Runtime\Core\Internationalization\FText) & InSuccessMessage )


className: FCheckIn

description: Operation used to check files into source control

code: class FCheckIn : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

bKeepCheckedOut

description: Keep files checked-out after checking in

Description

type: FText

description: Description of the checkin

SuccessMessage

description: A short message listing changelist/revision we submitted, if successful


code: const [FText](API\Runtime\Core\Internationalization\FText) & GetErrorText() const


className: FCheckOut

description: Operation used to check files out of source control

code: class FCheckOut : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


code: const [FString](API\Runtime\Core\Containers\FString) & GetPassword() const


code: void SetErrorText ( const [FText](API\Runtime\Core\Internationalization\FText) & InErrorText )


code: void SetPassword ( const [FString](API\Runtime\Core\Containers\FString) & InPassword )


className: FConnect

description: Operation used to connect (or test a connection) to source control

code: class FConnect : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

OutErrorText

description: Error text for easy diagnosis

Password

description: Password we use for this operation


className: ECopyMethod

code: enum ECopyMethod { Branch, Add, }


code: const [FString](API\Runtime\Core\Containers\FString) & GetDestination() const


code: void SetDestination ( const [FString](API\Runtime\Core\Containers\FString) & InDestination )


code: void SetDestination ( [FString](API\Runtime\Core\Containers\FString) && InDestination )


className: FCopy

description: Operation used to copy a file or directory from one location to another

code: class FCopy : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

CopyMethod

type: ECopyMethod

description: Whether a relationship to the original file should be maintained

Destination

description: Destination path of the copy operation


description: Add a new mapping for the client spec in the native format of the current source control provider. These will be written to the client spec in the order that they are added.

code: void AddNativeClientViewMapping ( FStringView DepotPath, FStringView ClientPath )


description: Remove all currently set client-view mappings

code: void ClearClientViewMappings()


className: EType

code: enum EType { Writeable = 0, ReadOnly, Partitioned, }


className: FClientViewMapping

code: typedef TPair< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > FClientViewMapping


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FClientViewMapping](API\Developer\SourceControl\FCreateWorkspace\FClientViewMapping) > GetClientView() const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetWorkspaceDescription() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetWorkspaceName() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetWorkspaceRoot() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetWorkspaceStream() const


description: Set the description to be used by the workspace, if left unset then the default description will be used

code: void SetDescription ( FStringView Desciption )


description: Set the stream to be used by the workspace, if left unset then a classic depot with ClientView will be used

code: void SetStream ( FStringView Stream )


description: FCreateWorkspace::EType

code: void SetType ( [EType](API\Developer\SourceControl\FCreateWorkspace\EType) InType )


description: Constructor

code: FCreateWorkspace ( FStringView WorkspaceName, FStringView WorkspaceRoot )


className: FCreateWorkspace

description: Operation used to create a new workspace if the source control system supports this functionality.

code: class FCreateWorkspace : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

ClientView

type: TArray<FClient...

Type

type: EType


className: FDelete

description: Operation used to mark files for delete in source control

code: class FDelete : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


className: FDeleteChangelist

description: Operation used to delete an empty changelist

code: class FDeleteChangelist : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


className: FDeleteShelved

description: Operation used to delete shelved files from a changelist

code: class FDeleteShelved : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


description: Constructor

code: FDeleteWorkspace ( FStringView InWorkspaceName )


className: FDeleteWorkspace

description: Operation used to delete a workspace

code: class FDeleteWorkspace : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


description: Deprecated* Replaced by __Internal_AddFileData but you shouldn't be calling this anyway

code: void AddFileData ( const [FString](API\Runtime\Core\Containers\FString) & Filename, [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) FileData )


description: This will return true if the operation can be safely called from a background thread. Currently it is assumed to only the operation 'FDownloadFile' will return true at least until the API is made thread safe.

code: virtual bool CanBeCalledFromBackgroundThreads() const


className: EVerbosity

code: enum EVerbosity { None, Full, }


description: If no target directory was given to download the files too then the command will keep the files in memory which can be accessed via this method. If the file failed to download then a nullFSharedBufferwill be returned.

code: [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) GetFileData ( const FStringView & Filename )


description: Get the string to display when this operation is in progress

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


description: Returns the directory that the files will (or have) been downloaded to. This path will be empty if no target directory was given, in which case the files can be accessed via the ::GetFileData method.


description: Get the name of this operation, used as a unique identifier

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


description: Return true if the command should log its operations, otherwise false

code: bool ShouldLogToStdOutput() const


description: This version ofFDownloadFilewill download the files and keep them in memory, which can then be accessed by calling ::GetFileData. Full logging verbosity will be used.

code: FDownloadFile()


description: This version ofFDownloadFilewill download the files and keep them in memory, which can then be accessed by calling ::GetFileData.

code: FDownloadFile ( [EVerbosity](API\Developer\SourceControl\FDownloadFile\EVerbosity) InVerbosity )


description: This version ofFDownloadFilewill download the files to the given target directory

code: FDownloadFile ( FStringView InTargetDirectory, [EVerbosity](API\Developer\SourceControl\FDownloadFile\EVerbosity) InVerbosity )


description: Do not call outside of source control implementations. Used to add the file in memory once downloaded so that the caller can get access to it.

code: void __Internal_AddFileData ( const [FString](API\Runtime\Core\Containers\FString) & Filename, [FSharedBuffer](API\Runtime\Core\Memory\FSharedBuffer) FileData )


className: FDownloadFile

description: Operation used to download a file from the source control server directly rather than sync it. This should not change the state of anything locally on the client.

code: class FDownloadFile : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDescription() const


code: void SetDescription ( const [FText](API\Runtime\Core\Internationalization\FText) & InDescription )


className: FEditChangelist

description: Operation to change the description of a changelist

code: class FEditChangelist : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

Description

description: Description of the changelist


code: const [TArray](API\Runtime\Core\Containers\TArray)< [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > > & GetChangelistDetails()


code: const [FString](API\Runtime\Core\Containers\FString) & GetChangelistNumber()


code: void SetChangelistNumber ( const [FString](API\Runtime\Core\Containers\FString) & InChangelistNumber )


code: void SetChangelistDetails ( [TArray](API\Runtime\Core\Containers\TArray)< [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) >> && InChangelistDetails )


code: FGetChangelistDetails ( [FString](API\Runtime\Core\Containers\FString) && InChangelistNumber )


code: FGetChangelistDetails ( FStringView InChangelistNumber )


code: virtual ~FGetChangelistDetails()


className: FGetChangelistDetails

description: This operations query the source control to extract all the details available for a given changelist. The operations returns a collection of key/value corresponding to the details available. The list of key/value is specific to the source control implementation.

code: class FGetChangelistDetails : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


code: const [FString](API\Runtime\Core\Containers\FString) & GetChangelistNumber() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetDepotFilePath() const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetOutPackageFilename() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetRevisionNumber() const


code: FGetFile ( const [FString](API\Runtime\Core\Containers\FString) & InChangelistNumber, const [FString](API\Runtime\Core\Containers\FString) & InRevisionNumber, const [FString](API\Runtime\Core\Containers\FString) & InDepotFilePath, bool bInIsShelve )


className: FGetFile

description: This operation uses p4v print command to get file from specified depot by shelved changelist or file revision returns a package filename

code: class FGetFile : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetFilesList() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetSearchPattern() const


code: void SetFilesList ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > && InFilesList )


code: void SetIncludeDeleted ( const bool bInIncludeDeleted )


code: void SetSearchPattern ( const [FString](API\Runtime\Core\Containers\FString) & InSearchPattern )


className: FGetFileList

description: Operation used to get the file list of a folder out of source control

code: class FGetFileList : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

bIncludeDeleted

description: Include deleted files in the list.

FilesList

type: TArray<FString...

description: Stored result of the operation

SearchPattern

description: The search pattern for the file list


code: void SetOutPackageFilename ( const [FString](API\Runtime\Core\Containers\FString) & InOutPackageFilename )


className: FGetPendingChangelists

description: Operation used to retrieve pending changelist(s).

code: class FGetPendingChangelists : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


className: FGetSourceControlOperation

description: Delegate used by providers to create source control operations

code: typedef TBaseDelegate_NoParams< [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) > FGetSourceControlOperation


className: FGetSubmittedChangelists

description: Operation used to retrieve submitted changelist(s).

code: class FGetSubmittedChangelists : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


className: FMarkForAdd

description: Operation used to mark files for add in source control

code: class FMarkForAdd : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


description: Get the string to display when this operation is in progress

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


className: FMoveToChangelist

description: Operation used to move files between changelists

code: class FMoveToChangelist : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDescription() const


code: const [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr) & GetNewChangelist() const


code: void SetDescription ( const [FText](API\Runtime\Core\Internationalization\FText) & InDescription )


code: void SetNewChangelist ( [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr) InNewChangelist )


className: FNewChangelist

description: Operation used to create a new changelist

code: class FNewChangelist : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

Description

description: Description of the changelist

NewChangelist

type: FSourceControlC...


className: FOnPostCheckOut

description: Delegate used for performing operation on files that may need a checkout, but before they are added to source control

code: typedef TBaseDelegate_ThreeParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FText](API\Runtime\Core\Internationalization\FText) &, [FText](API\Runtime\Core\Internationalization\FText) & > FOnPostCheckOut


className: FResolve

description: Operation used to resolve a file that is in a conflicted state.

code: class FResolve : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


code: void AddDeletedFile ( const [FString](API\Runtime\Core\Containers\FString) & InDeletedFile )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetDeletedFiles() const


code: void SetRevertAll ( const bool bInRevertAll )


code: void SetSoftRevert ( const bool bInSoftRevert )


code: bool ShouldDeleteNewFiles() const


className: FRevert

description: Operation used to revert changes made back to the state they are in source control

code: class FRevert : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


className: FRevertUnchanged

description: Operation to revert unchanged file(s) or all unchanged files in a changelist

code: class FRevertUnchanged : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


description: Get the provider we are using


description: Destructor; Closes Source Control Provider

code: ~FScopedSourceControl()


description: Constructor; Initializes Source Control Provider

code: FScopedSourceControl()


className: FScopedSourceControl

description: Helper class that ensures FSourceControl is properly initialized and shutdown by calling Init/Close in its constructor/destructor respectively.

code: class FScopedSourceControl


description: Makes sure the dialog is ticked

code: void Tick()


className: FScopedSourceControlProgress

code: class FScopedSourceControlProgress


code: const [FText](API\Runtime\Core\Internationalization\FText) & GetDescription() const


description: Destructor - closes the dialog

code: ~FScopedSourceControlProgress()


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


description: Get the name of this operation, used as a unique identifier

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: void SetDescription ( const [FText](API\Runtime\Core\Internationalization\FText) & InDescription )


className: FShelve

description: Operation used to shelve files in a changelist

code: class FShelve : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


description:
Attempt to get AssetData for the provided SourceControlled file.
True if processing is complete for the requested asset. False if the process is incomplete and AssetData could still be updated in the future.

code: bool GetAssetDataArray ( [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) InFileState, [FAssetDataArrayPtr](API\Developer\SourceControl\FAssetDataArrayPtr) & OutAssetDataArrayPtr )


description: Called when Source Control Dialog is shown. Prevents tasks to run while the dialog is opened.

code: void OnSourceControlDialogShown()


description: Called when SourceControl module is shutting down.

code: void Shutdown()


description: Called when Source Control Dialog is closed. Allow work to be resumed.

code: void OnSourceControlDialogClosed()


description: Constructor. Progress dialog is shown immediately (if possible) and is closed when this object goes out of scope.

code: FScopedSourceControlProgress ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, const FSimpleDelegate & InOnCancelled )


description: Called when SourceControl module is starting up.

code: void Startup()


description: Called every update.


className: FSourceControlAssetDataCache

code: class FSourceControlAssetDataCache


className: FSourceControlAssetDataEntry

code: struct FSourceControlAssetDataEntry

AssetDataArrayPtr

type: FAssetDataArray...

FetchAssetDataTask

type: TFuture< void >


className: FSourceControlChangelistPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlChangelist](API\Developer\SourceControl\ISourceControlChangelist), ESPMode::ThreadSafe > FSourceControlChangelistPtr


className: FSourceControlChangelistRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlChangelist](API\Developer\SourceControl\ISourceControlChangelist), ESPMode::ThreadSafe > FSourceControlChangelistRef


className: FSourceControlChangelistStatePtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlChangelistState](API\Developer\SourceControl\ISourceControlChangelistState), ESPMode::ThreadSafe > FSourceControlChangelistStatePtr


className: FSourceControlChangelistStateRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlChangelistState](API\Developer\SourceControl\ISourceControlChangelistState), ESPMode::ThreadSafe > FSourceControlChangelistStateRef


className: FSourceControlFilesDeletedDelegate

description: Delegate called after source control operations deleted files.

code: typedef TMulticastDelegate_OneParam< void, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & > FSourceControlFilesDeletedDelegate


className: FOnSourceControlFileStatus

description: Invoked when the status of a source controlled files is updated. The state can be null when the source control provider is changed.

code: typedef TBaseDelegate_TwoParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [ISourceControlState](API\Developer\SourceControl\ISourceControlState) * > FOnSourceControlFileStatus


description: Returns the set of files being monitored by the specifed owner.

code: [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > GetMonitoredFiles ( uintptr_t OwnerId )


description: Returns the file status age, i.e. (now - last_status_update) if the file is monitored. If the initial status request hasn't been received yet, returns zero.

code: [TOptional](API\Runtime\Core\IO\TOptional)< [FTimespan](API\Runtime\Core\Misc\FTimespan) > GetStatusAge ( const [FString](API\Runtime\Core\Containers\FString) & AbsPathname ) const


description: Sets the maximum number of files to batch into a single request.Bydefault, a maximum of 100 files status is requested.

code: void SetMaxFilePerRequestPolicy ( int32 MaxNum )


description: Starts monitoring files that weren't monitored yet by the specified owner, stops monitoring those that were monitored by the owner but are not in the updated list and keep monitoring files that were monitored before and still in the updated list.

code: void SetMonitoringFiles ( uintptr_t OwnerId, [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > && AbsPathnames, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus )


description: Set the times waited before a newly added file status request is sent to the source control provider. This is used batch several status for file added closed in time into a single server request, for example ifStartMonitoringFile()is called in a loop or when the user scroll a long list of files for which the status needs to be updated. Setting a value of 0 remove the probation period.Bydefault, the propbation period is 1 second.

code: void SetNewRequestProbationPeriodPolicy ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InPropbationPeriod )


description: Sets a function invoked to detect if the monitor should suspend its activities, for example, if no user is currently interacting with the application, it may not worth checking the file status periodically.Bydefault, the monitor will suspends if there are not Slate interaction within 5 minutes and resume at the next user interaction.

code: void SetSuspendMonitoringPolicy ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool()> IsMonitoringSuspended )


description: SetSuspendMonitoringPolicy

code: void SetUpdateStatusPeriodPolicy ( const [FTimespan](API\Runtime\Core\Misc\FTimespan) & InRefreshPeriod )


description: GetStatusAge()

code: void StartMonitoringFile ( uintptr_t OwnerId, const [FString](API\Runtime\Core\Containers\FString) & AbsPathname, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus )


code: void StartMonitoringFiles ( uintptr_t OwnerId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus )


code: void StartMonitoringFiles ( uintptr_t OwnerId, const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames, [FOnSourceControlFileStatus](API\Developer\SourceControl\FSourceControlFileStatusMonitor\FOnSourceControl-) OnSourceControlledFileStatus )


description: This can be called fron the FOnSourceControlFileStatus callback passed toStartMonitoringFile().

code: void StopMonitoringFile ( uintptr_t OwnerId, const [FString](API\Runtime\Core\Containers\FString) & AbsPathname )


description: Stops monitoring all the files that were registered by the specified owner Id.

code: void StopMonitoringFiles ( uintptr_t OwnerId )


code: void StopMonitoringFiles ( uintptr_t OwnerId, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames )


code: void StopMonitoringFiles ( uintptr_t OwnerId, const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & AbsPathnames )


code: FSourceControlFileStatusMonitor()


className: FSourceControlFileStatusMonitor

description: Periodically monitors the source controlled status of a collection of files and notifies the latest status, including potential warnings such as 'out of date', 'locked by other', etc. This service is meant to throttle and batch non-time sensitiveFUpdateStatusrequests to the source control provider because those requests are expensive and can add an undesired load on the provider server.

code: class FSourceControlFileStatusMonitor : public [TSharedFromThis< FSourceControlFileStatusMonitor >](API\Runtime\Core\Templates\TSharedFromThis)


code: bool CanReadFromConfigFile() const


code: void AddSetting ( FStringView SettingName, FStringView SettingValue )


code: bool CanWriteToConfigFile() const


className: EConfigBehavior

code: enum EConfigBehavior { ReadWrite, ReadOnly, None, }


className: EBehavior

code: enum EBehavior { OverrideAll, OverrideExisting, }


code: bool IsOverridden ( FStringView SettingName ) const


code: void OverrideSetting ( FStringView SettingName, [FString](API\Runtime\Core\Containers\FString) & InOutSettingValue )


code: void SetConfigBehavior ( [EConfigBehavior](API\Developer\SourceControl\FSourceControlInitSettings\EConfigBehavior) Behavior )


code: FSourceControlInitSettings ( [EBehavior](API\Developer\SourceControl\FSourceControlInitSettings\EBehavior) Behavior )


code: ~FSourceControlInitSettings()


className: FSourceControlInitSettings

code: class FSourceControlInitSettings


className: FSourceControlLoginClosed

description: Delegate called when the source control login window is closed. Parameter determines if source control is enabled or not

code: typedef TBaseDelegate_OneParam< void, bool > FSourceControlLoginClosed


description: Add error message.

code: virtual void AddErrorMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InError )


description: Add info/warning message.

code: virtual void AddInfoMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InInfo )


description: Append any info or error messages that may have accumulated during the operation prior to returning a result, ensuring to keep any already accumulated info.

code: virtual void AppendResultInfo ( const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & InResultInfo )


description: Add tag.

code: virtual void AddTag ( const [FString](API\Runtime\Core\Containers\FString) & InTag )


description: Retrieve any info or error messages that may have accumulated during the operation.

code: virtual const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & GetResultInfo() const


className: FSourceControlOperationBase

description: Adds some common functionality to source control operations.

code: class FSourceControlOperationBase : public [ISourceControlOperation](API\Developer\SourceControl\ISourceControlOperation)

ResultInfo

type: FSourceControlR...


className: FSourceControlOperationComplete

description: Delegate used by providers for when operations finish

code: typedef TBaseDelegate_TwoParams< void, const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) &, [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) > FSourceControlOperationComplete


className: FSourceControlOperationRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlOperation](API\Developer\SourceControl\ISourceControlOperation), ESPMode::ThreadSafe > FSourceControlOperationRef


description: Delegate called on pre-submit for data validation

code: typedef TBaseDelegate_FourParams< void, [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr), EDataValidationResult &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & > FSourceControlPreSubmitDataValidationDelegate


className: FSourceControlPreSubmitFinalizeDelegate

description: Delegate called once the user has confirmed that they want to submit files to source control BUT before the files are actually submitted. It is intended for last minute checks that can only run once there is no chance of the user canceling the actual submit. At this point the only way to prevent the files from being submitted is for this delegate to return errors.

code: typedef TMulticastDelegate_ThreeParams< void, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > &, [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > & > FSourceControlPreSubmitFinalizeDelegate


className: FSourceControlProviderChanged

description: Delegate called when the active source control provider is changed

code: typedef TMulticastDelegate_TwoParams< void, [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) &, [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & > FSourceControlProviderChanged


className: FSourceControlProjectDirDelegate

description: Delegate used to specify the project base directory to be used by the source control

code: typedef TBaseDelegate_NoParams< [FString](API\Runtime\Core\Containers\FString) > FSourceControlProjectDirDelegate


description: Append any messages from anotherFSourceControlResultInfo, ensuring to keep any already accumulated info.

code: void Append ( const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & InResultInfo )


code: bool DidConnectionFail() const


className: EAdditionalErrorContext

code: enum EAdditionalErrorContext { None = 0, ConnectionFailed = 1 << 0, ConnectionDropped = 1 << 1, }


className: FSourceControlResultInfo

description: Accumulated error and info messages for a source control operation.

code: struct FSourceControlResultInfo

ErrorMessages

type: TArray<FText>

description: Potential error message storage

InfoMessages

description: Info and/or warning message storage

Tags

description: Additional arbitrary information attached to the command


className: FSourceControlState

description: USourceControlHelpers::QueryFileState()

code: struct FSourceControlState

bCanAdd

type: bool

description: Determine if this file can be added to source control (i.e. is part of the directory structure currently under source control)

bCanCheckIn

description: Determine if this file can be checked in.

bCanCheckOut

description: Determine if this file can be checked out

bCanDelete

description: Determine if source control allows this file to be deleted.

bCanEdit

description: Determine if source control allows this file to be edited

bCanRevert

description: Determine if this file can be reverted, i.e. discard changes and the file will no longer be checked-out.

bIsAdded

description: Determine if this file is marked for add


className: FSourceControlStateChanged

description: Delegate called when the state of an item (or group of items) has changed.

code: typedef TMulticastDelegate_NoParams< void > FSourceControlStateChanged


className: FSourceControlStatePtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlState](API\Developer\SourceControl\ISourceControlState), ESPMode::ThreadSafe > FSourceControlStatePtr


className: FSourceControlStateRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlState](API\Developer\SourceControl\ISourceControlState), ESPMode::ThreadSafe > FSourceControlStateRef


description: Get the string to display when this operation is in progress

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


description: Get the name of this operation, used as a unique identifier

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetRevision() const


code: bool IsHeadRevisionFlagSet() const


code: void SetForce ( const bool bInForce )


code: bool IsLastSyncedFlagSet() const


code: void SetHeadRevisionFlag ( const bool bInHeadRevision )


code: void SetLastSyncedFlag ( const bool bInLastSynced )


code: void SetRevision ( const [FString](API\Runtime\Core\Containers\FString) & InRevision )


description: Deprecated*FSync::SetRevisionNumber(int32)has been deprecated. Please update to Fsync::SetRevision(const FString&).

code: void SetRevisionNumber ( int32 InRevisionNumber )


className: FSync

description: Operation used to sync files to the state they are in source control

code: class FSync : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

bForce

description: Forces operation, even if the file is already at the wanted revision.

bHeadRevision

description: Flag abstracting if the operation aims to sync to head

bLastSynced

description: Flag abstracting if the operation aims to force sync to last synced revision

Revision

description: Revision to sync to


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & GetAffectedFiles() const


code: int64 GetTransferSize() const


code: void SetAffectedFiles ( [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > && InAffectedFiles )


code: void SetTransferSize ( const int64 InTransferSize )


className: FSyncPreview

description: Operation used to determine the files that would be affected by a sync operation

code: class FSyncPreview : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

AffectedFiles

description: Array of files that would be affected by the sync operation

bHeadRevision

description: Flag abstracting if the operation aims to preview a sync to head

description: Target Revision to which the sync preview refers to

TransferSize

description: Number of bytes that need to be transferred for the sync operation


className: FUnshelve

description: Operation used to unshelve files from a changelist

code: class FUnshelve : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) > & GetChangelistsToUpdate() const


code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


code: void SetChangelistsToUpdate ( const [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) > & InChangelistsToUpdate )


code: void SetChangelistsToUpdate ( const [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) > & InChangelistsToUpdate )


code: void SetUpdateAllChangelists ( bool bInUpdateAllChangelists )


code: void SetUpdateFilesStates ( bool bInUpdateFilesStates )


code: void SetUpdateShelvedFilesStates ( bool bInUpdateShelvedFilesStates )


code: bool ShouldUpdateAllChangelists() const


code: bool ShouldUpdateFilesStates() const


className: FUpdatePendingChangelistsStatus

description: Operation used to update the source control status of changelist(s)

code: class FUpdatePendingChangelistsStatus : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)


description: Returns if the given path should be considered a directory or not. If bSetRequireDirPathEndWithSeparator is not set (the default) then we will poll the file system. However in some cases this can be very slow, in which case bSetRequireDirPathEndWithSeparator can be set to true and we require that any directory path must be terminated by a path separator (/ or ) so that we can tell by simply looking at the path itself. This is opt in behavior to avoid breaking existing 3rd party code that relies on the default behavior.

code: bool IsDirectoryPath ( const [FString](API\Runtime\Core\Containers\FString) & Path ) const


code: void SetCheckingAllFiles ( bool bInCheckingAllFiles )


code: void SetGetOpenedOnly ( bool bInGetOpenedOnly )


code: void SetQuiet ( bool bInQuiet )


description: IsDirectoryPath()

code: void SetRequireDirPathEndWithSeparator ( bool bFlag )


code: void SetUpdateHistory ( bool bInUpdateHistory )


code: void SetUpdateModifiedState ( bool bInUpdateModifiedState )


code: void SetUpdateModifiedStateToLocalRevision ( bool bInUpdateModifiedStateToLocalRevision )


code: bool ShouldCheckAllFiles() const


code: void SetForceUpdate ( const bool bInForceUpdate )


code: bool ShouldForceUpdate() const


code: bool ShouldGetOpenedOnly() const


code: bool ShouldUpdateHistory() const


code: bool ShouldUpdateModifiedState() const


className: FUpdateStatus

description: Operation used to update the source control status of files

code: class FUpdateStatus : public [FSourceControlOperationBase](API\Developer\SourceControl\FSourceControlOperationBase)

bCheckingAllFiles

description: Hint that we are intending on checking all files in the project - some providers can optimize for this

bForceQuiet

description: Controls whether the operation will trigger an update or not

bForceUpdate

description: Forces the verification for provided files - providers can ignore files not opened/edited without it

bGetOpenedOnly

description: Whether to just get files that are opened/edited

bSetRequireDirPathEndWithSeparator

description: If we should assume paths ending in a separator are directory paths or do we need to check with the file system?

bUpdateHistory

description: Whether to update history

bUpdateModifiedState

description: Whether to update the modified state - expensive

bUpdateModifiedStateToLocalRevision

description: Whether to update the modified state against local revision - only used when bUpdateModifiedState is true


description: Returns true if the changelist is deletable. Some special changelist might not be deletable like the default Perforce changelist.

code: virtual bool CanDelete() const


description: Get source control specific identifier for this changelist, for example CL number in Perforce.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetIdentifier() const


description: Returns true if this changelist is a default changelist.

code: virtual bool IsDefault() const


description: Virtual destructor

code: virtual ~ISourceControlChangelist()


className: ISourceControlChangelist

description: An abstraction of a changelist under source control

code: class ISourceControlChangelist : public [TSharedFromThis< ISourceControlChangelist, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description:
Returns the object on which this state was constructed
the changelist associated to this state


description:
Get a text representation of the state
the text to display for this state


description:
Get a tooltip to describe this state
the text to display for this states tooltip


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > & GetFilesStates() const


description:
Get the name of the icon graphic we should use to display the state in a UI.
the name of the icon to display


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > & GetShelvedFilesStates() const


description:
Get the name of the small icon graphic we should use to display the state in a UI.
the name of the icon to display


description:
Get the timestamp of the last update that was made to this state.
the timestamp of the last update

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetTimeStamp() const


description: Returns whether the change list description can be saved and persisted. Some changelists are special and the description cannot be persisted with the changelist. For example the P4 default changelist description cannot be persisted and the user must create a new changelist.

code: virtual bool SupportsPersistentDescription() const


description: Virtual destructor


className: ISourceControlChangelistState

description: An abstraction of the state of a pending changelist under source control

code: class ISourceControlChangelistState : public [TSharedFromThis< ISourceControlChangelistState, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description: Get a list of file revisions at this label.

code: virtual bool GetFileRevisions ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > > & OutRevisions ) const


code: bool GetFileRevisions ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > > & OutRevisions ) const


description: Get the name of this label

code: const [FString](API\Runtime\Core\Containers\FString) & GetName() const


description: Sync a path/filename to this label

code: virtual bool Sync ( const [FString](API\Runtime\Core\Containers\FString) & InFilename ) const


description: Sync a list of paths/filenames to this label

code: bool Sync ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFilenames ) const


className: ISourceControlLabel

description: Abstraction of a source control label/tag.

code: class ISourceControlLabel : public [TSharedFromThis< ISourceControlLabel >](API\Runtime\Core\Templates\TSharedFromThis)


description: Virtual destructor

code: virtual ~ISourceControlLabel()


description:
Creates and returns a unique source control provider that will be owned by the caller. This allows subsystems to own their own source control connection in addition to the general connection used by the rest of the process. This could be to avoid the user changing settings that the subsystem needs, or so that it can open a connection with an entirely different source control type if required.
A pointer to the newly created provider, this can be null if creating the name is invalid or if the provider type does not support unique connection creation.

code: [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) > CreateProvider ( const [FName](API\Runtime\Core\UObject\FName) & Name, const FStringView & OwningSystem, const [FSourceControlInitSettings](API\Developer\SourceControl\FSourceControlInitSettings) & InitialSettings ) const


description:
Gets a reference to the source control module instance.
A reference to the source control module.

code: static [ISourceControlModule](API\Developer\SourceControl\ISourceControlModule) & Get()


description: Get the source control AssetData information cache.


description: FSourceControlFilesDeletedDelegate

code: const [FSourceControlFilesDeletedDelegate](API\Developer\SourceControl\FSourceControlFilesDeletedDelega-) & GetOnFilesDeleted() const


description: FSourceControlPreSubmitFinalizeDelegate

code: const [FSourceControlPreSubmitFinalizeDelegate](API\Developer\SourceControl\FSourceControlPreSubmitFinalizeD-) & GetOnPreSubmitFinalize() const


description: Get the source control provider that is currently in use.

code: [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) & GetProvider() const


description: Returns a list of the registered source control providers

code: void GetProviderNames ( [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & OutProviderNames )


description: Gets currently registered delegates for pre-submit data validation


description: Returns the object used to monitor the source control status of a collection of files.


description: Returns the project base directory to be used by the source control


description:
Get whether we should use global or per-project settings
true if we should use global settings

code: bool GetUseGlobalSettings() const


description: Check whether source control is enabled. Specifically, it returns true if a source control provider is set (regardless of whether the provider is available) and false if no provider is set.

code: bool IsEnabled() const


description: Queues a file to have its source control status updated in the background.

code: void QueueStatusUpdate ( const [TArray](API\Runtime\Core\Containers\TArray)< [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > & InPackages )


code: void QueueStatusUpdate ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFilenames )


code: void QueueStatusUpdate ( [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage )


code: void QueueStatusUpdate ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )


description: FSourceControlFilesDeletedDelegate

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterFilesDeleted ( const FSourceControlFilesDeletedDelegate::FDelegate & InDelegate )


description: FSourceControlPreSubmitFinalizeDelegate

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterPreSubmitFinalize ( const FSourceControlPreSubmitFinalizeDelegate::FDelegate & Delegate )


description: Register a delegate to be called to validate asset changes before submitting changes

code: void RegisterPreSubmitDataValidation ( const [FSourceControlPreSubmitDataValidationDelegate](API\Developer\SourceControl\FSourceControlPreSubmitDataValid-) & PreSubmitDataValidationDelegate )


description: Register a delegate to be called when the source control provider changes

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterProviderChanged ( const FSourceControlProviderChanged::FDelegate & SourceControlProviderChanged )


description: Register a delegate used to specify the project base directory to be used by the source control

code: void RegisterSourceControlProjectDirDelegate ( const [FSourceControlProjectDirDelegate](API\Developer\SourceControl\FSourceControlProjectDirDelegate) & SourceControlProjectDirDelegate )


description: Set the current source control provider to the one specified here by name. This will assert if the provider does not exist.

code: void SetProvider ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Set whether we should use global or per-project settings

code: void SetUseGlobalSettings ( bool bIsUseGlobalSettings )


description: Show the source control login dialog

code: void ShowLoginDialog ( const [FSourceControlLoginClosed](API\Developer\SourceControl\FSourceControlLoginClosed) & InOnSourceControlLoginClosed, [ELoginWindowMode::Type](API\Developer\SourceControl\ELoginWindowMode__Type) InLoginWindowMode, [EOnLoginWindowStartup::Type](API\Developer\SourceControl\EOnLoginWindowStartup__Type) InOnLoginWindowStartup )


description: Tick the source control module. This is responsible for dispatching batched/queued status requests & for callingISourceControlProvider::Tick()

code: void Tick()


description: FSourceControlFilesDeletedDelegate

code: void UnregisterFilesDeleted ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) InHandle )


description: Unregister a delegate called before submitting changes


description: FSourceControlPreSubmitFinalizeDelegate

code: void UnregisterPreSubmitFinalize ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


description: Unregister the FSourceControlProjectDirDelegate delegate


description: Returns whether a delegate has been registered to specify the project base directory to be used by the source control

code: bool UsesCustomProjectDir() const


className: ISourceControlModule

description: Interface for talking to source control providers

code: class ISourceControlModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Add error message.

code: virtual void AddErrorMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InError )


description: Add info/warning message.

code: virtual void AddInfoMessge ( const [FText](API\Runtime\Core\Internationalization\FText) & InInfo )


description: Add tag.

code: virtual void AddTag ( const [FString](API\Runtime\Core\Containers\FString) & InTag )


description: Append any info or error messages that may have accumulated during the operation prior to returning a result, ensuring to keep any already accumulated info.

code: virtual void AppendResultInfo ( const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & InResultInfo )


description: This will return true if the operation can be safely called from a background thread. Currently it is assumed to only the operation 'FDownloadFile' will return true at least until the API is made thread safe.

code: virtual bool CanBeCalledFromBackgroundThreads() const


description: Factory method for easier operation creation

code: template<typename Type, typename... TArgs> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< Type, ESPMode::ThreadSafe > Create ( TArgs &&... Args )


description: Get the string to display when this operation is in progress

code: virtual [FText](API\Runtime\Core\Internationalization\FText) GetInProgressString() const


description: Unregister a delegate to be called when the source control provider changes

code: void UnregisterProviderChanged ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


description: Get the name of this operation, used as a unique identifier


description: Retrieve any info or error messages that may have accumulated during the operation.

code: virtual const [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & GetResultInfo() const


description: Virtual destructor

code: virtual ~ISourceControlOperation()


className: ISourceControlOperation

code: class ISourceControlOperation : public [TSharedFromThis< ISourceControlOperation, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description: Whether the provider allow a diff between a changed file and the depot

code: bool AllowsDiffAgainstDepot() const


description:
Check to see if we can cancel an operation.
true if the operation was cancelled.

code: bool CanCancelOperation ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation ) const


description: Attempt to cancel an operation in progress.

code: void CancelOperation ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation )


description:
Check to see if we can execute an operation.
true if the operation can be executed.

code: bool CanExecuteOperation ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation ) const


description: Shut down source control provider.

code: void Close()


description: ISourceControlModule::CreateProvider

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISourceControlProvider](API\Developer\SourceControl\ISourceControlProvider) > Create ( const FStringView & OwnerName, const [FSourceControlInitSettings](API\Developer\SourceControl\FSourceControlInitSettings) & InitialSettings ) const


className: EStatus

code: enum EStatus { Enabled, Connected, Port, User, Client, Repository, Remote, Branch, Email, ScmVersion, PluginVersion, Workspace, WorkspacePath, Changeset, }


description: Helper overload for operation execution, seeExecute().

code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [FString](API\Runtime\Core\Containers\FString) & InFile, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr) InChangelist, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, const [TArray](API\Runtime\Core\Containers\TArray)< [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > & InPackages, const [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


description:
Attempt to execute an operation on the passed-in files (if any are required).
the result of the operation.

code: [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Execute ( const [FSourceControlOperationRef](API\Developer\SourceControl\FSourceControlOperationRef) & InOperation, [FSourceControlChangelistPtr](API\Developer\SourceControl\FSourceControlChangelistPtr) InChangelist, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


description: Get all cached source control state objects for which the supplied predicate returns true

code: [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > GetCachedStateByPredicate ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< bool(const [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) &)> Predicate ) const


description: Returns the list of available changelists if the underlying source control supports the 'changelist' concept.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) > GetChangelists ( [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage )


description:
Get a label matching the passed-in name.
the label, if any

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlLabel](API\Developer\SourceControl\ISourceControlLabel) > GetLabel ( const [FString](API\Runtime\Core\Containers\FString) & InLabelName ) const


description:
Get an array of labels matching the passed-in spec.
an array of labels matching the spec.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [ISourceControlLabel](API\Developer\SourceControl\ISourceControlLabel) > > GetLabels ( const [FString](API\Runtime\Core\Containers\FString) & InMatchingSpec ) const


description: Get the source control provider name

code: const [FName](API\Runtime\Core\UObject\FName) & GetName() const


description:
Returns the number of changes in the local workspace NOTE: This concept is currently only implemented for the Skein source control provider.
The result of the operation if supported by the provider

code: [TOptional](API\Runtime\Core\IO\TOptional)< int > GetNumLocalChanges() const


description: Helper overload for state retrieval, seeGetState().

code: virtual [FSourceControlStatePtr](API\Developer\SourceControl\FSourceControlStatePtr) GetState ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage )


code: virtual [FSourceControlStatePtr](API\Developer\SourceControl\FSourceControlStatePtr) GetState ( const [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * InPackage, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage )


code: virtual [FSourceControlChangelistStatePtr](API\Developer\SourceControl\FSourceControlChangelistStatePtr) GetState ( const [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) & InChangelist, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage )


description:
Get the state of each of the passed-in files. State may be cached for faster queries. Note states can be NULL!
the result of the operation.

code: [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) GetState ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles, [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > & OutState, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage )


code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) GetState ( const [TArray](API\Runtime\Core\Containers\TArray)< [UPackage](API\Runtime\CoreUObject\UObject\UPackage) * > & InPackages, [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlStateRef](API\Developer\SourceControl\FSourceControlStateRef) > & OutState, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage )


description:
Get the state of each of the passed-in changelists. State may be cached for faster queries. Note states can be NULL!
the result of the operation.

code: [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) GetState ( const [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistRef](API\Developer\SourceControl\FSourceControlChangelistRef) > & InChangelists, [TArray](API\Runtime\Core\Containers\TArray)< [FSourceControlChangelistStateRef](API\Developer\SourceControl\FSourceControlChangelistStateRef) > & OutState, [EStateCacheUsage::Type](API\Developer\SourceControl\EStateCacheUsage__Type) InStateCacheUsage )


description:
Gets the state index of the specified branch, higher index branches are generally closer to releases
the index of the specified branch

code: int32 GetStateBranchIndex ( const [FString](API\Runtime\Core\Containers\FString) & BranchName ) const


description: Get the source control status as a series of key value pairs

code: [TMap](API\Runtime\Core\Containers\TMap)< [EStatus](API\Developer\SourceControl\ISourceControlProvider\EStatus), [FString](API\Runtime\Core\Containers\FString) > GetStatus() const


description: Get the source control status as plain, human-readable text


description: Initialize source control provider.

code: void Init ( bool bForceConnection )


description:
This concept is currently only implemented for the Skein source control provider.
The result of the operation if supported by the provider

code: [TOptional](API\Runtime\Core\IO\TOptional)< bool > IsAtLatestRevision() const


description:
Quick check if source control is available for use (server-based providers can use this to return whether the server is available or not)
true if source control is available, false if it is not

code: bool IsAvailable() const


description: Quick check if source control is enabled. Specifically, it returns true if a source control provider is set (regardless of whether the provider is available) and false if no provider is set. So all providers except the stub DefalutSourceProvider will return true.

code: bool IsEnabled() const


description:
Login to the source control server (if any). This is just a wrapper aroundExecute().
the result of the operation.

code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) Login ( const [FString](API\Runtime\Core\Containers\FString) & InPassword, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency, const [FSourceControlOperationComplete](API\Developer\SourceControl\FSourceControlOperationComplete) & InOperationCompleteDelegate )


description:
Create a settings widget for display in the login window.
a widget used to edit the providers settings required prior to connection.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MakeSettingsWidget() const


description: Queries branch configuration from source control

code: bool QueryStateBranchConfig ( const [FString](API\Runtime\Core\Containers\FString) & ConfigSrc, const [FString](API\Runtime\Core\Containers\FString) & ConfigDest )


description: Register a delegate to be called when source control state(s) change

code: [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) RegisterSourceControlStateChanged_Handle ( const FSourceControlStateChanged::FDelegate & SourceControlStateChanged )


description: Register branches to query for state in addition to the current branch

code: void RegisterStateBranches ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & BranchNames, const [FString](API\Runtime\Core\Containers\FString) & ContentRoot )


description:
Used to switch the provider from one workspace to another. NOTE: This concept is currently only implemented for the perforce source control provider.
The result of the operation.

code: virtual [ECommandResult::Type](API\Developer\SourceControl\ECommandResult__Type) SwitchWorkspace ( FStringView NewWorkspaceName, [FSourceControlResultInfo](API\Developer\SourceControl\FSourceControlResultInfo) & OutResultInfo, [FString](API\Runtime\Core\Containers\FString) * OutOldWorkspaceName )


description: Called every update.

code: void Tick()


description:
Executes theFDownloadFileoperation, but unlike theExecutemethod this can be called from a background thread, this works becauseFDownloadFileis thread safe and it does not change the state of source control. NOTE: This is only intended for use by the virtualization module and will be deprecated at some point in the future when thread safety is built into the system. NOTE: This is only implemented for the perforce source control provider with no plans to extend this to other providers.
True if the operation was a success, otherwise false.

code: bool TryToDownloadFileFromBackgroundThread ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FDownloadFile](API\Developer\SourceControl\FDownloadFile) > & InOperation, const [FString](API\Runtime\Core\Containers\FString) & InFile )


code: virtual bool TryToDownloadFileFromBackgroundThread ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FDownloadFile](API\Developer\SourceControl\FDownloadFile) > & InOperation, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InFiles )


description: Unregister a delegate to be called when source control state(s) change

code: void UnregisterSourceControlStateChanged_Handle ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


description: Whether the provider uses changelists to identify commits/revisions

code: bool UsesChangelists() const


description: Whether the provider uses the checkout workflow

code: bool UsesCheckout() const


description: Whether the provider uses individual file revisions

code: bool UsesFileRevisions() const


description: Whether the provider uses local read-only state to signal whether a file is editable.

code: bool UsesLocalReadOnlyState() const


description: Whether the provider uses snapshots

code: bool UsesSnapshots() const


description: Whether the provider supports uncontrolled changelists to allow work offline


description: Virtual destructor

code: virtual ~ISourceControlProvider()


className: ISourceControlProvider

description: Interface to talking with source control providers.

code: class ISourceControlProvider : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description:
Get this revision of the file & store it in a temp file.
true if the operation succeeded.

code: bool Get ( [FString](API\Runtime\Core\Containers\FString) & InOutFilename, [EConcurrency::Type](API\Developer\SourceControl\EConcurrency__Type) InConcurrency ) const


description: Action taken to the file this revision (branch/integrate/edit/etc.)

code: const [FString](API\Runtime\Core\Containers\FString) & GetAction() const


description:
Get an annotated revision of the file & store it in a temp file.
true if the operation succeeded.

code: bool GetAnnotated ( [TArray](API\Runtime\Core\Containers\TArray)< [FAnnotationLine](API\Developer\SourceControl\FAnnotationLine) > & OutLines ) const


code: bool GetAnnotated ( [FString](API\Runtime\Core\Containers\FString) & InOutFilename ) const


description: Source of branch, if any

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > GetBranchSource() const


description: Changelist number/revision number of the revision - an identifier for the check-in

code: int32 GetCheckInIdentifier() const


description: Workspace/Clientspec of the submitter (if any)

code: const [FString](API\Runtime\Core\Containers\FString) & GetClientSpec() const


description: Date of the revision

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) & GetDate() const


description: Changelist/Commit description

code: const [FString](API\Runtime\Core\Containers\FString) & GetDescription() const


description: Get the local filename of this file.

code: const [FString](API\Runtime\Core\Containers\FString) & GetFilename() const


description: String representation of the revision

code: const [FString](API\Runtime\Core\Containers\FString) & GetRevision() const


description: File size of the revision (0 if the file was deleted)

code: int32 GetFileSize() const


description: Number of the revision

code: int32 GetRevisionNumber() const


description: User name of the submitter

code: const [FString](API\Runtime\Core\Containers\FString) & GetUserName() const


description: Virtual destructor

code: virtual ~ISourceControlRevision()


className: ISourceControlRevision

description: Abstraction of a source control revision.

code: class ISourceControlRevision : public [TSharedFromThis< ISourceControlRevision, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description: Get whether this file can be added to source control (i.e. is part of the directory structure currently under source control)

code: bool CanAdd() const


description: Get whether this file can be checked in.

code: bool CanCheckIn() const


description: Get whether this file can be checked out

code: bool CanCheckout() const


description: Get whether source control allows this file to be deleted.

code: bool CanDelete() const


description: Get whether source control allows this file to be edited

code: bool CanEdit() const


description: Get whether this file can be reverted, i.e. its changes are discarded and the file will no longer be checked-out.

code: bool CanRevert() const


description:
Find an item from the history with the specified revision number.
a history item or NULL if the item could not be found

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [ISourceControlRevision](API\Developer\SourceControl\ISourceControlRevision), ESPMode::ThreadSafe > FindHistoryRevision ( int32 RevisionNumber ) const