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

Light Theme

Dark Theme

FStreamSearch

Async task for searching Blueprints

Windows

MacOS

Linux

Inheritance Hierarchy

FRunnable

FStreamSearch

References

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

Syntax

class FStreamSearch : public FRunnable

Remarks

Async task for searching Blueprints

Variables

	Name	Description
int32	BlueprintCountBelowVersion	A going count of all Blueprints below the MinimiumVersionRequirement
bool	bThreadCompleted	Whether the thread has finished running.
TArray< FImagin...	FilteredImaginaryResults	Filtered (ImaginaryDataFilter) list of imaginary data results that met the search requirements.
TArray< TShared...	ItemsFound	A list of items found, cleared whenever the main thread pulls them to display to screen
FCriticalSectio...	SearchCriticalSection	Prevents searching while other threads are pulling search results
FStreamSearchOp...	SearchOptions	Options for setting up the search
FString	SearchValue	The search value to filter results by
FThreadSafeCoun...	StopTaskCounter	0 if we've been asked to abort work in progress at the next opportunity
TUniquePtr< FRu...	Thread	Thread to run the cleanup FRunnable on

Constructors

	Name	Description
	FStreamSearch ( const FString& InSearchValue, const FStreamSearchOptions& InSear... )	Constructor

Functions

	Name	Description
void	EnsureCompletion()	End FRunnable Interface Brings the thread to a safe stop before continuing.
void	GetFilteredImaginaryResults ( TArray< FImaginaryFiBDataSharedPtr ... )	Returns the FilteredImaginaryResults from the search query, these results have been filtered by the ImaginaryDataFilter.
void	GetFilteredItems ( TArray< TSharedPtr< class FFindInBl... )	Appends the items filtered through the search filter to the passed array
int32	GetOutOfDateCount()	Returns the Out-of-Date Blueprint count
float	GetPercentComplete()	Helper function to query the percent complete this search is
bool	IsComplete()	Returns TRUE if the thread is done with it's work.

Overridden from FRunnable

	Name	Description
void	Exit()	Exits the runnable object.
bool	Init()	Begin FRunnable Interface
uint32	Run()	Runs the runnable object.
void	Stop()	Stops the runnable object. This is called if a thread is requested to terminate early.

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

Take our survey

Dismiss