1. Epic GamesDeveloper
  3. FSourceCodeNavigation

FSourceCodeNavigation

Source code navigation functionality

API > API/Editor > API/Editor/UnrealEd

Source code navigation functionality

   
Name FSourceCodeNavigation
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/SourceCodeNavigation.h
Include Path #include "SourceCodeNavigation.h"

Syntax

class FSourceCodeNavigation

Structs

Name Remarks
EGatherMode Gather modes for GatherFunctionsForActors()
FEditCodeMenuClass Allows function symbols to be organized by class
FFunctionSymbolInfo Holds useful information about a function's symbols

Typedefs

Name Type Remarks Include Path
FOnCompilerNotFound TMulticastDelegate_NoParams< void > Delegate that's triggered when any symbol query has completed SourceCodeNavigation.h
FOnNewModuleAdded TMulticastDelegate_OneParam< void, FName > Delegate that's triggered when a new module (.Build.cs file) has been added SourceCodeNavigation.h
FOnSymbolQueryFinished TMulticastDelegate_NoParams< void > Delegate that's triggered when any symbol query has completed SourceCodeNavigation.h

Constants

Name Type Remarks Include Path
bCachedIsCompilerAvailable bool Cached result of check for compiler availability. SourceCodeNavigation.h
CriticalSection FCriticalSection Critical section for locking access to the source file database. SourceCodeNavigation.h
Instance FSourceFileDatabase Source file database instance. SourceCodeNavigation.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FOnCompilerNotFound & AccessOnCompilerNotFound()

 Call this to access the multi-cast delegate that you can register a callback with SourceCodeNavigation.h  

static FOnNewModuleAdded & AccessOnNewModuleAdded()

 Call this to access the multi-cast delegate that you can register a callback with SourceCodeNavigation.h  

static FOnSymbolQueryFinished & AccessOnSymbolQueryFinished()

 Call this to access the multi-cast delegate that you can register a callback with SourceCodeNavigation.h  

static void AddNavigationHandler ( ISourceCodeNavigationHandler* Handler
)

 Add a navigation handler SourceCodeNavigation.h  

static bool AddSourceFiles ( const TArray< FString >& AbsoluteSourcePaths
)

 Add multiple source files to the current solution/project/workspace SourceCodeNavigation.h  

static bool CanNavigateToClass ( const UClass* InClass
)

 Determines whether it is possible to navigate to the UClass in the IDE SourceCodeNavigation.h  

static bool CanNavigateToFunction ( const UFunction* InFunction
)

 Determines whether it is possible to navigate to the UFunction in the IDE SourceCodeNavigation.h  

static bool CanNavigateToProperty ( const FProperty* InProperty
)

 Determines whether it is possible to navigate to the FProperty in the IDE SourceCodeNavigation.h  

static bool CanNavigateToStruct ( const UStruct* InStruct
)

 Determines whether it is possible to navigate to the UStruct in the IDE SourceCodeNavigation.h  

static bool CanNavigateToStruct ( const UScriptStruct* InStruct
)

 Determines whether it is possible to navigate to the UScriptStruct in the IDE SourceCodeNavigation.h  

static bool DoesModuleSolutionExist()

 Query if the current source code solution exists SourceCodeNavigation.h  

static void DownloadAndInstallSuggestedIDE ( FOnIDEInstallerDownloadComplete OnDownloadComplete
)

 Downloads and installs the suggested IDE (currently only works for Windows) SourceCodeNavigation.h  

static bool FindClassHeaderPath ( const UField* InField,
FString& OutClassHeaderPath
)

 Finds the path to a given class header. Does not rely on symbols; finds matching .build.cs files. SourceCodeNavigation.h  

static bool FindClassModuleName ( UClass* InClass,
FString& ModuleName
)

 Attempt to locate fully qualified class module name SourceCodeNavigation.h  

static bool FindClassSourcePath ( const UField* InField,
FString& OutClassSourcePath
)

 Finds the path to a given class source. Does not rely on symbols; finds matching .build.cs files. SourceCodeNavigation.h  

static bool FindModulePath ( const UPackage* InModulePackage,
FString& OutModulePath
)

 Finds the base directory for a given module. SourceCodeNavigation.h  

static bool FindModulePath ( const FString& InModuleName,
FString& OutModulePath
)

 Finds the base directory for a given module name. SourceCodeNavigation.h  

static void GatherFunctionsForActors ( TArray< AActor* >& Actors,
const EGatherMode::Type GatherMode,
TArray< FEditCodeMenuClass >& Classes
)

 Finds all of the functions in classes for the specified list of actors SourceCodeNavigation.h  

static bool GetCanDirectlyInstallSourceCodeIDE()

 Returns whether the suggested source code IDE for the current platform can be installed directly (vs. requiring that the user download it manually) SourceCodeNavigation.h  

static FSlateIcon GetOpenSourceCodeIDEIcon()

 Returns the IDE specific representative icon to open source code SourceCodeNavigation.h  

static FSlateIcon GetRefreshSourceCodeIDEIcon()

 Returns the IDE specific representative icon to refresh source code SourceCodeNavigation.h  

static FText GetSelectedSourceCodeIDE()

 Returns the name of the selected IDE SourceCodeNavigation.h  

static const FSourceFileDatabase & GetSourceFileDatabase()

 Retrieves the SourceFileDatabase instance SourceCodeNavigation.h  

static FText GetSuggestedSourceCodeIDE ( bool bShortIDEName
)

 Returns the name of the suggested IDE, based on platform SourceCodeNavigation.h  

static FString GetSuggestedSourceCodeIDEDownloadURL()

 Returns the url to the location where the suggested IDE can be downloaded SourceCodeNavigation.h  

static void Initialize()

 Initializes FSourceCodeNavigation static class SourceCodeNavigation.h  

static bool IsCompilerAvailable()

 Returns true if the compiler for the current platform is available for use SourceCodeNavigation.h  

static bool NavigateToClass ( const UClass* InClass
)

 Navigates asynchronously to the UClass in the IDE SourceCodeNavigation.h  

static bool NavigateToFunction ( const UFunction* InFunction
)

 Navigates asynchronously to the UFunction in IDE SourceCodeNavigation.h  

static bool NavigateToFunctionAsync ( UFunction* InFunction
)

 Deprecated, use NavigateToFunction SourceCodeNavigation.h  

static void NavigateToFunctionSourceAsync ( const FString& FunctionSymbolName,
const FString& FunctionModuleName,
const bool bIgnoreLineNumber
)

 Asynchronously locates the source file and line for a specific function in a specific module and navigates an external editing to that source line SourceCodeNavigation.h  

static bool NavigateToProperty ( const FProperty* InProperty
)

 Navigates asynchronously to the FProperty in the IDE SourceCodeNavigation.h  

static bool NavigateToStruct ( const UScriptStruct* InStruct
)

 Navigates asynchronously to the UScriptStruct in the IDE SourceCodeNavigation.h  

static bool NavigateToStruct ( const UStruct* InStruct
)

 Navigates asynchronously to the UStruct in the IDE SourceCodeNavigation.h  

static bool OpenModuleSolution()

 Open the current source code solution SourceCodeNavigation.h  

static bool OpenProjectSolution ( const FString& InProjectPath
)

 Open the source code solution for the project at the given location SourceCodeNavigation.h  

static bool OpenSourceFile ( const FString& AbsoluteSourcePath,
int32 LineNumber,
int32 ColumnNumber
)

 Opens a single source file SourceCodeNavigation.h  

static bool OpenSourceFiles ( const TArray< FString >& AbsoluteSourcePaths
)

 Opens a multiple source files SourceCodeNavigation.h  
Refresh the state of compiler availability. SourceCodeNavigation.h  

static void RemoveNavigationHandler ( ISourceCodeNavigationHandler* Handler
)

 Remove a navigation handler SourceCodeNavigation.h  

static void SetPreferredAccessor ( const TCHAR* Name
)

 Set a new preferred accessor and refresh compiler status SourceCodeNavigation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page