FSourceCodeNavigation

Source code navigation functionality

Windows
MacOS
Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/SourceCodeNavigation.h

Include

#include "SourceCodeNavigation.h"

Syntax

class FSourceCodeNavigation

Remarks

Source code navigation functionality

Functions

Name Description

Public function Static

FOnCompilerN...

 

AccessOnCompilerNotFound()

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

Public function Static

FOnNewModule...

 

AccessOnNewModuleAdded()

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

Public function Static

FOnSymbolQue...

 

AccessOnSymbolQueryFinished()

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

Public function Static

void

 

AddNavigationHandler

Add a navigation handler

Public function Static

bool

 

AddSourceFiles

(
    const TArray< FString >& AbsoluteS...
)

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 UProperty* InProperty
)

Determines whether it is possible to navigate to the UProperty 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

 

DoesModuleSolutionExist()

Query if the current source code solution exists

Public function Static

void

 

DownloadAndInstallSuggestedIDE

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* InModulePackag...,
    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 >& Clas...
)

Finds all of the functions in classes for the specified list of actors

Public function 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)

Public function Static

FText

 

GetSelectedSourceCodeIDE()

Returns the name of the selected IDE

Public function Static

const FSourc...

 

GetSourceFileDatabase()

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

 

GetSuggestedSourceCodeIDEDownloadURL()

Returns the url to the location where the suggested IDE can be downloaded

Public function Static

void

 

Initialize()

Initializes FSourceCodeNavigation static class

Public function Static

bool

 

IsCompilerAvailable()

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

 

NavigateToFunctionAsync

(
    UFunction* InFunction
)

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 UProperty* InProperty
)

Navigates asynchronously to the UProperty 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

 

OpenModuleSolution()

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 >& AbsoluteS...
)

Opens a multiple source files

Public function Static

void

 

RefreshCompilerAvailability()

Refresh the state of compiler availability.

Public function Static

void

 

RemoveNavigationHandler

Remove a navigation handler

Classes

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.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback