1. Epic GamesDeveloper
  3. FSourceCodeNavigation

FSourceCodeNavigation

Source code navigation functionality

Unreal Engine C++ API Reference > Editor > UnrealEd

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/SourceCodeNavigation.h
Include #include "SourceCodeNavigation.h"

Syntax

class FSourceCodeNavigation

Remarks

Source code navigation functionality

Functions

  Type Name Description
Public function Static FOnCompilerNotFound & Call this to access the multi-cast delegate that you can register a callback with
Public function Static FOnNewModuleAdded & Call this to access the multi-cast delegate that you can register a callback with
Public function Static FOnSymbolQueryFinished & Call this to access the multi-cast delegate that you can register a callback with
Public function Static void Add a navigation handler
Public function Static bool

AddSourceFiles ( const TArray< FString >& AbsoluteSourcePaths
)

 Add multiple source files to the current solution/project/workspace
Public function Static bool

CanNavigateToClass ( const UClass* InClass
)

 Determines whether it is possible to navigate to the UClass in the IDE
Public function Static bool

CanNavigateToFunction ( const UFunction* InFunction
)

 Determines whether it is possible to navigate to the UFunction in the IDE
Public function Static bool

CanNavigateToProperty ( const FProperty* InProperty
)

 Determines whether it is possible to navigate to the FProperty in the IDE
Public function Static bool

CanNavigateToStruct ( const UStruct* InStruct
)

 Determines whether it is possible to navigate to the UStruct in the IDE
Public function Static bool

CanNavigateToStruct ( const UScriptStruct* InStruct
)

 Determines whether it is possible to navigate to the UScriptStruct in the IDE
Public function Static bool Query if the current source code solution exists
Public function Static void

DownloadAndInstallSuggestedIDE ( FOnIDEInstallerDownloadComplete OnDownloadComplete
)

 Downloads and installs the suggested IDE (currently only works for Windows)
Public function 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.
Public function Static bool

FindClassModuleName ( UClass* InClass,
FString& ModuleName
)

 Attempt to locate fully qualified class module name
Public function 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.
Public function Static bool

FindModulePath ( const UPackage* InModulePackage,
FString& OutModulePath
)

 Finds the base directory for a given module.
Public function Static bool

FindModulePath ( const FString& InModuleName,
FString& OutModulePath
)

 Finds the base directory for a given module name.
Public function 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
Public function Static bool Returns whether the suggested source code IDE for the current platform can be installed directly (vs. requiring that the user download it manually)
Public function Static FSlateIcon Returns the IDE specific representative icon to open source code
Public function Static FSlateIcon Returns the IDE specific representative icon to refresh source code
Public function Static FText Returns the name of the selected IDE
Public function Static const FSourceFileDatabase & Retrieves the SourceFileDatabase instance
Public function Static FText

GetSuggestedSourceCodeIDE ( bool bShortIDEName
)

 Returns the name of the suggested IDE, based on platform
Public function Static FString Returns the url to the location where the suggested IDE can be downloaded
Public function Static void Initializes FSourceCodeNavigation static class
Public function Static bool Returns true if the compiler for the current platform is available for use
Public function Static bool

NavigateToClass ( const UClass* InClass
)

 Navigates asynchronously to the UClass in the IDE
Public function Static bool

NavigateToFunction ( const UFunction* InFunction
)

 Navigates asynchronously to the UFunction in IDE
Public function Static bool Deprecated, use NavigateToFunction
Public function 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
Public function Static bool

NavigateToProperty ( const FProperty* InProperty
)

 Navigates asynchronously to the FProperty in the IDE
Public function Static bool

NavigateToStruct ( const UScriptStruct* InStruct
)

 Navigates asynchronously to the UScriptStruct in the IDE
Public function Static bool

NavigateToStruct ( const UStruct* InStruct
)

 Navigates asynchronously to the UStruct in the IDE
Public function Static bool Open the current source code solution
Public function Static bool

OpenProjectSolution ( const FString& InProjectPath
)

 Open the source code solution for the project at the given location
Public function Static bool

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

 Opens a single source file
Public function Static bool

OpenSourceFiles ( const TArray< FString >& AbsoluteSourcePaths
)

 Opens a multiple source files
Public function Static void Refresh the state of compiler availability.
Public function Static void Remove a navigation handler
Public function Static void

SetPreferredAccessor ( const TCHAR* Name
)

 Set a new preferred accessor and refresh compiler status

Classes

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

Typedefs

Name Description
FOnCompilerNotFound Delegate that's triggered when any symbol query has completed
FOnNewModuleAdded Delegate that's triggered when a new module (.Build.cs file) has been added
FOnSymbolQueryFinished Delegate that's triggered when any symbol query has completed

Constants

Name Description
bCachedIsCompilerAvailable Cached result of check for compiler availability.
CriticalSection Critical section for locking access to the source file database.
Instance Source file database instance.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page