FStreamSearch

Async task for searching Blueprints

Unreal Engine C++ API Reference > Editor > Kismet

Inheritance Hierarchy

References

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

Syntax

class FStreamSearch : public [FRunnable](API\Runtime\Core\HAL\FRunnable)  

Remarks

Async task for searching Blueprints

Variables

Type 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
TUniquePtr< FRu... Thread Thread to run the cleanup FRunnable on

Constructors

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

Functions

Type 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.
bool WasStopped () Returns TRUE if Stop() was called while work is still pending.

Overridden from FRunnable

Type 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library