FStreamSearch

Async task for searching Blueprints

Choose your operating system:

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

Public variable

int32

 

BlueprintCountBelowVersion

A going count of all Blueprints below the MinimiumVersionRequirement

Public variable

bool

 

bThreadCompleted

Whether the thread has finished running.

Public variable

TArray< FImagin...

 

FilteredImaginaryResults

Filtered (ImaginaryDataFilter) list of imaginary data results that met the search requirements.

Public variable

TArray< TShared...

 

ItemsFound

A list of items found, cleared whenever the main thread pulls them to display to screen

Public variable

FCriticalSectio...

 

SearchCriticalSection

Prevents searching while other threads are pulling search results

Public variable

FStreamSearchOp...

 

SearchOptions

Options for setting up the search

Public variable

FString

 

SearchValue

The search value to filter results by

Public variable

TUniquePtr< FRu...

 

Thread

Thread to run the cleanup FRunnable on

Constructors

Name Description

Public function

FStreamSearch

(
    const FString& InSearchValue,
    const FStreamSearchOptions& InSear...
)

Constructor

Functions

Name Description

Public function

void

 

EnsureCompletion()

End FRunnable Interface Brings the thread to a safe stop before continuing.

Public function

void

 

GetFilteredImaginaryResults

Returns the FilteredImaginaryResults from the search query, these results have been filtered by the ImaginaryDataFilter.

Public function

void

 

GetFilteredItems

(
    TArray< TSharedPtr< class FFindInBl...
)

Appends the items filtered through the search filter to the passed array

Public function Const

int32

 

GetOutOfDateCount()

Returns the Out-of-Date Blueprint count

Public function Const

float

 

GetPercentComplete()

Helper function to query the percent complete this search is

Public function Const

bool

 

IsComplete()

Returns TRUE if the thread is done with it's work.

Public function Const

bool

 

WasStopped()

Returns TRUE if Stop() was called while work is still pending.

Overridden from FRunnable

Name Description

Public function Virtual

void

 

Exit()

Exits the runnable object.

Public function Virtual

bool

 

Init()

Begin FRunnable Interface

Public function Virtual

uint32

 

Run()

Runs the runnable object.

Public function Virtual

void

 

Stop()

Stops the runnable object.

This is called if a thread is requested to terminate early.