Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > Kismet > FFindInBlueprintSearchManager

Light Theme

Dark Theme

FFindInBlueprintSearchManager

Singleton manager for handling all Blueprint searches, helps to manage the going progress of Blueprints, and is thread-safe.

Windows

MacOS

Linux

Inheritance Hierarchy

FTickableObjectBase

FTickableEditorObject

FFindInBlueprintSearchManager

References

Module	Kismet
Header	/Engine/Source/Editor/Kismet/Public/FindInBlueprintManager.h
Include	#include "FindInBlueprintManager.h"

Syntax

class FFindInBlueprintSearchManager : public FTickableEditorObject

Remarks

Singleton manager for handling all Blueprint searches, helps to manage the going progress of Blueprints, and is thread-safe.

Constructors

	Name	Description
	FFindInBlueprintSearchManager()

Destructors

	Name	Description
	~FFindInBlueprintSearchManager()

Functions

	Name	Description
void	AddOrUpdateBlueprintSearchMetadata ( UBlueprint* InBlueprint, EAddOrUpdateBlueprintSearchMetadata..., EFiBVersion InVersion )	Gathers the Blueprint's search metadata and adds or updates it in the cache
void	ApplySearchDataToDatabase ( FSearchData InSearchData, bool bAllowNewEntry )	Applies the given search data to a matching entry in the database.
void	BeginSearchQuery ( const FStreamSearch* InSearchO... )	Starts a search query, the FiB manager handles where the thread is at in the search query at all times so that post-save of the cache to disk it can correct the index
void	BlockSearchQueryIfPaused()	If searches are paused, blocks the calling thread until searching is resumed
void	CacheAllAssets ( TWeakPtr< class SFindInBlueprints >..., const FFindInBlueprintCachingOption... )	Starts a task to cache Blueprints at a rate of 1 per tick
void	CancelCacheAll ( SFindInBlueprints* InFindInBlu... )	Stops the caching process where it currently is at, the rest can be continued later
void	CloseOrphanedGlobalFindResultsTabs ( TSharedPtr< class FTabManager > Tab... )	Close any orphaned global find results tabs for a particular tab manager
bool	ContinueSearchQuery ( const FStreamSearch* InSearchO..., FSearchData& OutSearchData )	Continues a search query, returning a single piece of search data
FString	ConvertFTextToHexString ( FText InValue )	Serializes an FText to memory and converts the memory into a string of hex characters
FText	ConvertHexStringToFText ( FString InHexString )	Converts a string of hex characters, previously converted by ConvertFTextToHexString, to an FText.
TSharedPtr< ...	ConvertJsonStringToObject ( FSearchDataVersionInfo InVersionInf..., FString InJsonString, TMap< int32, FText >& OutFTextLook... )	Given a fully constructed Find-in-Blueprint FString of searchable data, will parse and construct a JsonObject
void	DumpCache ( FArchive& Ar )	Dumps the full index cache to the given stream (for debugging purposes)
void	EnableGatheringData ( bool bInEnableGatheringData )
void	EnableGlobalFindResults ( bool bEnable )	Enable or disable the global find results tab feature
void	EnsureSearchQueryEnds ( const FStreamSearch* InSearchO... )	This function ensures that the passed in search query ends in a safe manner.
FActiveSearc...	FindSearchQuery ( const FStreamSearch* InSearchO... )	Thread-safe access to the active search query that's mapped to the given stream search
void	FinishedCachingBlueprints ( EFiBCacheOpType InCacheOpType, EFiBCacheOpFlags InCacheOpFlags, int32 InNumberCached, TSet< FName >& InFailedToCacheList )	Callback to note that Blueprint caching is complete
FString	GenerateSearchIndexForDebugging ( UBlueprint* InBlueprint )	Generates a human-readable search index for the given Blueprint (for debugging purposes)
FFindInBluep...	Get()
float	GetCacheProgress()	Returns the progress complete on the caching
FName	GetCurrentCacheBlueprintName()	Returns the name of the current Blueprint being cached
int32	GetCurrentCacheIndex()	Returns the current index in the caching
int32	GetFailedToCacheCount()	Returns the number of Blueprints that failed to cache
TSet< FName ...	GetFailedToCachePathList()	Returns the list of Blueprint paths that failed to cache
TSharedPtr< ...	GetGlobalFindResults()	Find or create the global find results widget
FSearchData	GetNextSearchDataForQuery ( FActiveSearchQueryPtr InSearchQuery..., bool bCheckDeferredList )	Returns the next pending search data for the given query and advances the index to the next entry
int32	GetNumberUncachedAssets()	Returns the number of uncached assets during an active indexing operation
int32	GetNumberUnindexedAssets()	Returns the number of unindexed Blueprints, either due to not having been indexed before, or AR data being out-of-date
float	GetPercentComplete ( const FStreamSearch* InSearchO... )	Query how far along a search thread is
FSearchData	GetSearchDataForAssetPath ( FName InAssetPath )	Given an asset path, locate and return a copy of its matching search data in the index cache.
TWeakPtr< SF...	GetSourceCachingWidget()	Returns a weak reference to the widget that initiated the current caching operation
void	GlobalFindResultsClosed ( const TSharedRef< SFindInBlueprints... )
bool	HasCachingFailed()	Returns TRUE if caching failed
bool	IsAssetDiscoveryInProgress()	Returns TRUE if we're still inside the initial asset discovery and registration stage
bool	IsCacheInProgress()	Returns TRUE if Blueprints are being cached.
bool	IsGatheringDataEnabled()
bool	IsGlobalFindResultsOpen()	Returns true if a global find results tab is currently open
bool	IsUnindexedCacheInProgress()	Returns TRUE if unindexed Blueprints are being cached (since this can block the UI)
void	OnCacheAllUnindexedAssets ( bool bInSourceControlActive, bool bInCheckoutAndSave )	Starts the actual caching process
FSearchData	QuerySingleBlueprint ( UBlueprint* InBlueprint, bool bInRebuildSearchData )	Query for a single, specific Blueprint's search data.
bool	ShouldEnableDeveloperMenuTools()	If TRUE, the developer menu tool commands will be shown in the 'Developer' section of the Blueprint Editor's menu bar
bool	ShouldEnableSearchResultTemplates()	If TRUE, search result meta will be gathered once and stored in a template.
void	StartedCachingBlueprints ( EFiBCacheOpType InCacheOpType, EFiBCacheOpFlags InCacheOpFlags )	Callback to note that Blueprint caching is started

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Classes

	Name	Description
	FActiveSearchQuery	Contains info about an active search query

Typedefs

Name	Description
FActiveSearchQueryPtr

Constants

Name	Description
Instance

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss