Language:
Discover
By Skill Level
By Category

FSourceCodeNavigation

Choose your OS:

Syntax

class FSourceCodeNavigation

Remarks

Source code navigation functionality

Functions

Name Description

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

AccessOnCompilerNotFound()

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

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

AccessOnNewModuleAdded()

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

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

AccessOnSymbolQueryFinished()

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

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

AddNavigationHandler

Add a navigation handler

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

AddSourceFiles

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

Add multiple source files to the current solution/project/workspace

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

CanNavigateToClass

(
    const UClass * InClass
)

Determines whether it is possible to navigate to the UClass in the IDE

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

CanNavigateToFunction

(
    const UFunction * InFunction
)

Determines whether it is possible to navigate to the UFunction in the IDE

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

CanNavigateToProperty

(
    const UProperty * InProperty
)

Determines whether it is possible to navigate to the UProperty in the IDE

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

DoesModuleSolutionExist()

Query if the current source code solution exists

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

DownloadAndInstallSuggestedIDE

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

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

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

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

FindClassModuleName

(
    UClass * InClass,
    FString & ModuleName
)

Attempt to locate fully qualified class module name

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

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

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

FindModulePath

(
    const FString & InModuleName,
    FString & OutModulePath
)

Finds the base directory for a given module name.

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

FindModulePath

(
    const UPackage * InModulePackag...,
    FString & OutModulePath
)

Finds the base directory for a given module.

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

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

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

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

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

GetSelectedSourceCodeIDE()

Returns the name of the selected IDE

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

GetSourceFileDatabase()

Retrieves the SourceFileDatabase instance

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

GetSuggestedSourceCodeIDE

(
    bool bShortIDEName
)

Returns the name of the suggested IDE, based on platform

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

GetSuggestedSourceCodeIDEDownloadURL()

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

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

Initialize()

Initializes FSourceCodeNavigation static class

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

IsCompilerAvailable()

Returns true if the compiler for the current platform is available for use

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

NavigateToClass

(
    const UClass * InClass
)

Navigates asynchronously to the UClass in the IDE

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

NavigateToFunction

(
    const UFunction * InFunction
)

Navigates asynchronously to the UFunction in IDE

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

NavigateToFunctionAsync

(
    UFunction * InFunction
)

Deprecated, use NavigateToFunction

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

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

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

NavigateToProperty

(
    const UProperty * InProperty
)

Navigates asynchronously to the UProperty in the IDE

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

OpenModuleSolution()

Open the current source code solution

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

OpenProjectSolution

(
    const FString & InProjectPath
)

Open the source code solution for the project at the given location

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

OpenSourceFile

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

Opens a single source file

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

OpenSourceFiles

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

Opens a multiple source files

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

RefreshCompilerAvailability()

Refresh the state of compiler availability.

Public function Static

[UNREALED_API](API\Editor\UnrealEd\Commandlets\UNREALED_API_2)...

 

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.

References

Module

UnrealEd

Header

Editor/UnrealEd/Public/SourceCodeNavigation.h