1. Epic GamesDeveloper
  3. FFindInBlueprintSearchManager

FFindInBlueprintSearchManager

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

API > API/Editor > API/Editor/Kismet

Inheritance Hierarchy

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

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddOrUpdateBlueprintSearchMetadata ( UBlueprint* InBlueprint,
EAddOrUpdateBlueprintSearchMetadataFlags InFlags,
EFiBVersion InVersion
)

 Gathers the Blueprint's search metadata and adds or updates it in the cache
Public function void

ApplySearchDataToDatabase ( FSearchData InSearchData,
bool bAllowNewEntry
)

 Applies the given search data to a matching entry in the database.
Public function void

BeginSearchQuery ( const FStreamSearch* InSearchOriginator
)

 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
Protected function void If searches are paused, blocks the calling thread until searching is resumed
Public function void

CacheAllAssets ( TWeakPtr< class SFindInBlueprints > InSourceWidget,
const FFindInBlueprintCachingOptions& InCachingOptions
)

 Starts a task to cache Blueprints at a rate of 1 per tick
Public function void

CancelCacheAll ( SFindInBlueprints* InFindInBlueprintWidget
)

 Stops the caching process where it currently is at, the rest can be continued later
Public function void Close any orphaned global find results tabs for a particular tab manager
Public function bool

ContinueSearchQuery ( const FStreamSearch* InSearchOriginator,
FSearchData& OutSearchData
)

 Continues a search query, returning a single piece of search data
Public function Static FString Serializes an FText to memory and converts the memory into a string of hex characters
Public function Static FText Converts a string of hex characters, previously converted by ConvertFTextToHexString, to an FText.
Public function Static TSharedPtr< class FJsonObject >

ConvertJsonStringToObject ( FSearchDataVersionInfo InVersionInfo,
FString InJsonString,
TMap< int32, FText >& OutFTextLookupTable
)

 Given a fully constructed Find-in-Blueprint FString of searchable data, will parse and construct a JsonObject
Public function void Dumps the full index cache to the given stream (for debugging purposes)
Public function void

EnableGatheringData ( bool bInEnableGatheringData
)

  
Public function void

EnableGlobalFindResults ( bool bEnable
)

 Enable or disable the global find results tab feature
Public function void

EnsureSearchQueryEnds ( const FStreamSearch* InSearchOriginator
)

 This function ensures that the passed in search query ends in a safe manner.
Protected function Const FActiveSearchQueryPtr

FindSearchQuery ( const FStreamSearch* InSearchOriginator
)

 Thread-safe access to the active search query that's mapped to the given stream search
Public function void

FinishedCachingBlueprints ( EFiBCacheOpType InCacheOpType,
EFiBCacheOpFlags InCacheOpFlags,
int32 InNumberCached,
TSet< FSoftObjectPath >& InFailedToCacheList
)

 Callback to note that Blueprint caching is complete
Public function Static FString Generates a human-readable search index for the given Blueprint (for debugging purposes)
Public function Static FFindInBlueprintSearchManager &

Get ()

  
Public function Const float Returns the progress complete on the caching
Public function Const FSoftObjectPath Returns the path of the current Blueprint being cached
Public function Const int32 Returns the current index in the caching
Public function Const int32 Returns the number of Blueprints that failed to cache
Public function Const TSet< FSoftObjectPath > Returns the list of Blueprint paths that failed to cache
Public function TSharedPtr< SFindInBlueprints > Find or create the global find results widget
Protected function FSearchData

GetNextSearchDataForQuery ( const FStreamSearch* InSearchOriginator,
FActiveSearchQueryPtr InSearchQueryPtr,
bool bCheckDeferredList
)

 Returns the next pending search data for the given query and advances the index to the next entry
Public function Const int32 Returns the number of uncached assets during an active indexing operation
Public function Const int32 Returns the number of unindexed Blueprints, either due to not having been indexed before, or AR data being out-of-date
Public function Const float

GetPercentComplete ( const FStreamSearch* InSearchOriginator
)

 Query how far along a search thread is
Public function FSearchData Given an asset path, locate and return a copy of its matching search data in the index cache.
Public function Const TWeakPtr< SFindInBlueprints > Returns a weak reference to the widget that initiated the current caching operation
Public function void  
Public function Const bool Returns TRUE if caching failed
Public function Const bool Returns TRUE if we're still inside the initial asset discovery and registration stage
Public function Const bool Returns TRUE if there are one or more active asynchronous search queries
Public function Const bool Returns TRUE if Blueprints are being cached.
Public function Const bool  
Public function Const bool Returns true if a global find results tab is currently open
Public function Const bool Returns TRUE if unindexed Blueprints are being cached (since this can block the UI)
Public function void

OnCacheAllUnindexedAssets ( bool bInSourceControlActive,
bool bInCheckoutAndSave
)

 Starts the actual caching process
Public function FSearchData

QuerySingleBlueprint ( UBlueprint* InBlueprint,
bool bInRebuildSearchData
)

 Query for a single, specific Blueprint's search data.
Public function Const bool If TRUE, the developer menu tool commands will be shown in the 'Developer' section of the Blueprint Editor's menu bar
Public function Const bool If TRUE, search result meta will be gathered once and stored in a template.
Public function void

StartedCachingBlueprints ( EFiBCacheOpType InCacheOpType,
EFiBCacheOpFlags InCacheOpFlags
)

 Callback to note that Blueprint caching is started

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Classes

  Type Name Description
Protected struct FActiveSearchQuery Contains info about an active search query  

Typedefs

Name Description
FActiveSearchQueryPtr  

Constants

Name Description
Instance  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page