UnityEditor.QuickSearchModule

Defines a set of changes that happens in order to update a search asset index.

Enumerate all changes.

Indicates if the changeset is empty.

Enumerate all asset that were removed.

Enumerates all assets that were updated.

Create a search asset index changeset.

Assets that were updated. Assets that were deleted. Existing assets that were moved. Predicate used to exclude any updated, removed or moved assets from the change set.

Create a search asset index changeset.

Assets that were updated. Assets that were deleted. Existing assets that were moved. Predicate used to exclude any updated, removed or moved assets from the change set.

Create a search asset index changeset.

Assets that were updated. Assets that were deleted. Existing assets that were moved. Predicate used to exclude any updated, removed or moved assets from the change set.

Allows a user to register a custom Indexing function for a specific type.

Each time an object of a specific type is indexed, the registered function is called.

Version of the custom indexer. Increment this number to have the indexer re-index the indexes.

Type of object to be indexed.

Represents a descriptor for the object that is about to be indexed. It stores a reference to the object itself as well as an already set up SerializedObject.

Document Index which owns the object to index.

Object Id. The object path for an asset or the GlobalObjectId for a scene object.

Serialized representation of the object to be indexed.

Object to index.

Object type to index.

The search dispatcher is used to synchronize events from the search provider threads and the main UI threads.

Callback to be executed later in the main thread. Number of seconds to wait until the main thread executes the user callback. Returns an off handler that can be used to unregister the callback before it gets executed in the main thread later.

This function can be used in a thread to enqueue an action that will be executed later in the main thread.

Action to be executed in the main thread later. Minimum amount of time in seconds for which the main thread will wait before executing the enqueued action.

This function can be used in a thread to enqueue an action that will be executed later in the main thread.

Action to be executed in the main thread later. Minimum amount of time in seconds for which the main thread will wait before executing the enqueued action.

This function can called in the main thread to force the execution of one enqueued action.

Returns true if an enqueued action was processed.

Options for setting the display mode to use for a search view.

Display as a compact list view.

Display as a grid of icons of various sizes.

Display as a list view.

Unspecified ISearchView display mode.

Display search results in a table.

Options for the search provider on how the preview should be fetched.

Indicates that the preview resolution should be higher than 256x256.

No options are defined.

Indicates that the preview size should be around 128x128.

Indicates that the search provider should generate a 2D preview.

Indicates that the search provider should generate a 3D preview.

Provides a method to match query text using a fuzzy search algorithm.

Performs a fuzzy search for a pattern on a string.

The pattern that the method is searching for in the string. The string the method is searching. If there is a match, this parameter contains the match score. The higher the match score, the closer the pattern matched a part of the given string. List of indices in the string where the pattern was found. Returns true if a match was found.

Performs a fuzzy search for a pattern on a string.

Interface representing a filter node.

The filter identifier.

The filter value. This can be null or empty if the value has not been written yet.

The operator identifier. This can be null or empty if the operator has not been written yet.

The parameter value. This can be null or empty if the filter is not a filter function, or there is no parameter written yet.

Indicates if the filter uses a parameter.

Use Indexing options to specify the contents of your search index.

Apply all indexing options.

Include Asset dependencies in your index.

Include extended information in your index such as sub objects in Scene and Prefab Assets.

Use this option to save the created index as an Asset file.

Do not include additional indexing options.

Include Asset serialized properties in your index.

Save the search index to a temporary folder that is not managed by Unity.

Include additional types of information in your Asset index.

Interface representing a nested query node.

If the nested query is part of a filter operation, this represents the filter identifier. Otherwise, this is null or empty.

Interface of a record that is stored in the Search.PropertyDatabase|PropertyDatabase.

The key of the record.

Boolean indicating if the record is valid.

The value of the record.

Interface of a record value.

The type of record value.

Interface of a Search.PropertyDatabase|PropertyDatabase view.

Clears the entire content of the Search.PropertyDatabase|PropertyDatabase.

Creates a document key from a document identifier.

A document identifier. The document key.

Creates a property hash from a property path.

The path or name of a property. The computed property hash.

Creates a record key from a document identifier and a property path.

A document identifier. A property path or name. The record key.

Creates a record key from a document identifier and a property hash.

A document identifier. A property hash. The record key.

Creates a record key from a document key and a property hash.

A document key. A property hash. The record key.

Creates a record key from a property path.

A property path or name. The record key.

Creates a record key from a property hash.

A property hash. The record key.

Enumerates all records stored in the Search.PropertyDatabase|PropertyDatabase

An enumeration of all the records.

Deserialize a record value into its proper type.

A serialized record value. The deserialized value.

Invalidates a single property record so it is no longer retrievable.

A record key.

Invalidates all the properties stored for an entire document.

A document identifier.

Invalidates all the properties stored for an entire document.

A document key.

Invalidate all properties stored from multiple documents that match a document key mask.

A document key mask.

Returns a boolean indicating if a type can be persisted into the backing file.

A type. True if the type can be persisted in the file, false otherwise.

Stores a document property.

A document identifier. A property path or name. The value of the property. True if the store operation succeeded, false if not.

Stores a document property with a precomputed document key and property hash.

A document key. A property hash. The value of the property. True if the store operation succeeded, false if not.

Stores a document property with a precomputed record key.

A record key. The value of the property. True if the store operation succeeded, false if not.

Stores a property with a precomputed property hash.

A property hash. The value of the property. True if the store operation succeeded, false if not.

Synchronizes the views so they have access to the same content.

Loads a single property, already deseriazed into an object.

A record key. The property value. True if the record is found and is valid, false otherwise.

Loads a single property, still contained within a record.

A record key. The property record. True if the record is found and is valid, false otherwise.

Loads all the properties of a document, already deseriazed into objects.

A document key. The document property values. True if the record is found and is valid, false otherwise.

Loads all the properties of a document, still contained within records.

A document key. The document property records. True if the record is found and is valid, false otherwise.

Interface for the Search.QueryEngine_1|QueryEngine filters.

Additional information specific to the filter.

Collection of Search.QueryFilterOperator|QueryFilterOperators specific for the filter.

Indicates if the filter overrides the global string comparison options.

The type of the constant parameter passed to the filter, if used.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example. "id" in "id>=2").

The string comparison options of the filter.

List of supported operators.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2").

The type of the data that is compared by the filter.

Indicates if the filter uses a parameter.

Indicates if the filter uses a regular expression token or not.

Indicates if the filter uses a resolver function.

Add a custom filter operator specific to the filter.

The operator identifier. The added, or existing, Search.QueryFilterOperator|QueryFilterOperator.

Add or update additional information specific to the filter.

The key of the information. The value of the information. The current filter.

Add a type parser specific to the filter.

Callback used to determine if a string can be converted into "TFilterConstant". Takes a string and returns a Search.ParseResult_1|ParseResult object. This contains the success flag, and the actual converted value if it succeeded. The current filter.

Removes all additional information specific to the filter.

The current filter.

Remove information on the filter.

The key of the information. The current filter.

Remove a custom operator specific to the filter.

The operator identifier. The current filter.

Sets the filter's nested query transformer function. This function takes the result of a nested query and extracts the necessary data to compare with the filter.

The transformer function.

Interface for query handlers.

Implement this function to evaluate the query on a single element.

A single object to be tested. True if the object passes the query, false otherwise.

Implement this function to evaluate the query on a payload.

The input data of the query. An enumerable of type TData.

Interface for query handler factories.

Implement this function to create a new query handler for a specific query graph.

A graph representing a query. A collection of errors. Use this to report errors when needed. An IQueryHandler.

Interface representing a query node.

The node's children. Can be null.

A string representing this node and its children.

True if this node is a leaf. A leaf doesn't have any children.

Parent of this node. Null if this node is the root.

True if this node is skipped during evaluation. A node can be skipped if the QueryEngine was configured to skip unsupported nodes instead of generating errors.

The token used to build this node.

The node's type.

Returns a hashcode for this node. Multiple nodes can have the same hashcode if they have the same identifier.

An integer representing the hashcode.

The source of block is usually the query builder for a given search view.

Search context of the query source.

Search view in which the query block is displayed.

Apply any changes to the block to the source.

Indicates that the query block should be repainted.

Interface used to expose the search databases information.

Exclude patterns.

Include patterns.

Indicates how the database is built.

Name of the database.

Roots folder of documents being indexed.

A search list represents a collection of search results that is filled.

Any valid search context that is used to track async search requests. It can be null.

Indicates if the search request is still running and might return more results asynchronously.

Add new items to the search list.

List of items to be added.

Yields search items until the search query is finished.

List of search items. Items can be null and must be discarded.

Return a subset of items.

Number of rows to skip at the start of a query. Number of items to get from the beginning of the range. Search items in the specified range.

Insert new search items in the current list.

Index where the items should be inserted. Items to be inserted.

Enumerate search items and transform them while they are being fetched.

Function used to select what gets returned in the new enumerable list. New enumerable list.

Interface representing a query node.

True if the word or text should match exactly, false if it is a "contains" operation.

Word or text used for the search.

This search query interface is used when handling search query objects. These can be either assets saved in the user project or saved in the user preferences.

Indicates the binary long time of when the search query was created.

Search query description.

Search query display name used in the UI.

Indicates where the search query is saved on disk.

Unique GUID of the search query.

Indicates if the search query is displayed as a search template in the search view home page.

Provides a preview of how many results this query might yield if executed.

Indicates the last time the query was executed.

Search query text.

Search query icon thumbnail set by the user if any.

Returns the formatted name of the query depending on its source.

Formatted name of the query.

Returns the list of provider ids that search query is executed with.

Provider ids.

Returns the list of aggregated type ids the search query executes with.

Search provider type ids.

Returns the query search table configuration if any.

Search table configuration.

Returns the search query view state.

Persisted search view state.

Search view interface used by the search context to execute UI operations.

Returns the current view search context.

Indicates the current group that is selected by the user.

Indicates how the data is displayed in the UI.

Callback used to filter items shown in the list.

Defines the size of items in the search view.

Allows multi-selection of items in the list/grid of items. If false, a user can only select a single item.

Returns the absolute position of the Search window.

Returns the list of all search results.

Indicates that the search view is currently running a query and it has not yet completed.

Callback used to override a default Search behavior.

Returns the selected items in the view.

Returns the view model state of the Search Window.

Callback used to override the tracking behavior.

Adds new items to the current selection.

Array of item indices to add to selection.

Closes the search view.

Executes a Search action on a given list of items.

The search action to execute. The items to search. If true, executing this action closes the Search window.

Execute the default action of the active selection.

Make sure the Search window is now selected to receive input from a user.

Focus the search text field control.

Indicates if the search view is being used as an advanced search picker.

Returns true if the current view is a search window.

Triggers a refresh of the search view and refetches all the search items from enabled search providers.

The refresh flags give some additional context and reasons why the view needs to be updated.

Requests the search view to repaint itself.

Puts focus in the SearchView text field AND selects all the text inside the text field (if any).

Sets the search view property table columns.

Columns to be set in the search view table configuration used in DisplayMode.Table.

Sets the search query text.

Text displayed in the search view. Position of the cursor after setting the search text.

Sets the search query text.

Text displayed in the search view. Position of the cursor after setting the search text.

Updates the search view with a new selection.

Array of item indices to select.

Shows a contextual menu for the specified item.

Item affected by the contextual menu. The position that a menu should be drawn on screen (generally item position).

Table view interface.

Returns the search context driving the table view.

Invoked to check if the table view is read-only.

Invoked when the table view need to add a new column at a specific location.

Mouse position when adding a new column happened. Column index at which to insert the new column.

Invoked when the user opens a contextual menu on a column.

Menu in which to add new menu items. Return true if any menu items was added.

Invoked when the user opens a contextual menu on a column.

Menu in which to add new menu items. Selected column.

Invoked when a set of columns are inserted.

Inserted columns. Column index where the columns should be inserted.

Invoked when the table needs to get the list of columns to be displayed.

Enumerate table view columns.

Invoked when the property table needs all view elements not necessarily sorted.

Enumerate all search items to be displayed in the table.

Invoked when the property table needs all search items sorted.

Enumerate in order all search items.

Invoked to get the table configuration.

Returns the view search table configuration.

Invoked when the user double click on a search item row.

Selected item.

Invoked when the user opens a contextual menu on the selected search item row.

Current UI event. Selected item. Returns true if the event was handled.

Invoked when a column gets removed.

Index of the column to be removed.

Invoked when the table view gets dirty.

Invoked when the table view selection has changed.

Item selection.

Invoked when columns are being intialized.

Sets of item for which columns are being displayed.

Invoked when two columns are being swapped.

Index of the column being swapped or dragged. Index of the column being swapped with the dragged column.

Invoked when a column is being edited.

Index of the column being edited. Column being edited.

Utility class to generate search column with item selectors.

Create a search column.

Column path. Column selector. Column provider. Column flags. Returna a search column.

Enumerate search column for a given set of search items.

Search items. Search columns.

Returns the default item GUI style used to draw the cell of a search item property in table view.

Search column drawing the item. GUI style to render the item.

Object field used with the advanced search picker.

Type of the object to be selected.

Search query context used to populate the object picker.

Search flags used to open the search picker window.

Default line height used to render the object field control.

Construct an advanced search field UITK control.

Display label if used in a property editor.

Construct an advanced search field UITK control.

Display label if used in a property editor.

Draw an IMGUI advanced object field.

Position to draw the control in the current view. Currently selected object. Type of the object to be picked. Label displayed left of the control. Search context used to open the advanced search picker. Search view flags used to open the advanced search picker. Serialized property holding the selected object. Returns the selected object.

Draw an IMGUI advanced object field.

Set the object field selected objects.

Selected object.

A specialized Search.SearchIndexer which provides methods to index a UnityEngine.Object|Unity Object from custom indexers.

Adds a key-number value pair to the index. The key won't be added with variations.

Document where the indexed value was found. Key used to retrieve the value. Number value to store in the index.

Adds a property value to the index. A property is specified with a key and a string value. The value will be stored with multiple variations.

Document where the indexed word was found. Key used to retrieve the value. Value to add to the index. Define if we store this key in the keyword registry of the index. If exact is true, only the exact match of the value will be stored in the index (not the variations).

Indexes multiple variations of a property value.

Document handle for the indexed property. Key used to retrieve the value. Value to add to the index.

Adds a new word coming from a specific document to the index. The word will be added with multiple variations allowing partial search.

Document where the indexed word was found. Word to add to the index. If true, we will also store an exact match entry for this word. Modified to apply to the base match score for a specific word.

The word will be added with a maximum of variation. This can be used to save some space for very large words.

Document where the indexed word was found. Word to add to the index. Maximum number of variations to compute. Cannot be higher than the length of the word. If true, the indexer will also store an exact match entry for this word. Modified to apply to the base match score for a specific word.

Splits a word into multiple variations.

Document where the indexed word was found. Word to add to the index.

Provides methods to define an operation that can be used to filter a data set.

Boolean. Indicates if the original payload should be returned when the query is empty.

Applies the filtering on an IEnumerable data set.

The data to filter. A filtered IEnumerable.

Tests the query on a single object. Returns true if the test passes.

A single test object. True if the object passes the query, returns false otherwise.

Provides methods to define an operation that can be used to filter a data set.

A list of QueryErrors.

Query evaluation graph used to evaluate the query.

Query graph. This graph can be used to walk all the node of the query if you need to do a special type of evaluation.

The text that generated the query.

The list of tokens found in the query.

Indicates if the query is valid or not.

Applies the filtering on a payload.

The data to filter. A filtered IEnumerable.

Get the query node located at the specified index position in the query.

The position of the query node in the text. An IQueryNode.

Optimizes the query by optimizing the underlying filtering graph.

Propagate "Not" operations to leaves, so only leaves can have "Not" operations as parents. Swaps "Not" operations to the right-hand side of combining operations (i.e. "And", "Or"). Useful if a "Not" operation is slow. Optimization options.

Optimizes the query by optimizing the underlying filtering graph.

A ParseResult represents the result of a parsing operation.

Default value when no ParsetResult is available.

The parsing result.

Flag indicating if the parsing succeeded or not.

Create a ParseResult.

Flag indicating if the parsing succeeded or not. The parsing result.

The Search.PropertyDatabase|PropertyDatabase is a system that can store, in a thread-safe manner, properties of different kinds into a single file that we call a property database.

Boolean indicating if the Search.PropertyDatabase|PropertyDatabase will update the backing file automatically or not.

The file on which this Search.PropertyDatabase|PropertyDatabase is opened.

Boolean indicating if the Search.PropertyDatabase|PropertyDatabase is valid.

Clears the entire content of the Search.PropertyDatabase|PropertyDatabase.

Creates a document key from a document identifier.

A document identifier. The document key.

Creates a property hash from a property path.

The path or name of a property. The computed property hash.

Creates a record key from a document identifier and a property path.

A document identifier. A property path or name. The record key.

Creates a record key from a document identifier and a property hash.

A document identifier. A property hash. The record key.

Creates a record key from a document key and a property hash.

A document key. A property hash. The record key.

Creates a record key from a property path.

A property path or name. The record key.

Creates a record key from a property hash.

A property hash. The record key.

Constructs a new instance of a Search.PropertyDatabase|PropertyDatabase.

Path to the backing file.

Constructs a new instance of a Search.PropertyDatabase|PropertyDatabase.

Path to the backing file. Boolean indicating if the backing file will be updated automatically or not. Time between changes for the automatic background update to trigger.

Dispose of the resources used by this Search.PropertyDatabase|PropertyDatabase.

Triggers a manual update of the backing file.

Returns a formatted string showing various information of the Search.PropertyDatabase|PropertyDatabase.

The formatted information.

Deserialize a record value into its proper type.

A serialized record value. The deserialized value.

Opens a view on the Search.PropertyDatabase|PropertyDatabase.

Boolean indicating if the sync between views should only happen when the view is disposed, or for every operation. The Search.PropertyDatabase|PropertyDatabase view.

Invalidates a single property record so it is no longer retrievable.

A record key.

Invalidates all the properties stored for an entire document.

A document identifier.

Invalidates all the properties stored for an entire document.

A document key.

Invalidate all properties stored from multiple documents that match a document key mask.

A document key mask.

Returns a boolean indicating if a type can be persisted into the backing file.

A type. True if the type can be persisted in the file, false otherwise.

Stores a document property.

A document identifier. A property path or name. The value of the property. True if the store operation succeeded, false if not.

Stores a document property with a precomputed document key and property hash.

A document key. A property hash. The value of the property. True if the store operation succeeded, false if not.

Stores a document property with a precomputed record key.

A record key. The value of the property. True if the store operation succeeded, false if not.

Stores a property with a precomputed property hash.

A property hash. The value of the property. True if the store operation succeeded, false if not.

Loads a single property, already deseriazed into an object.

A record key. The property value. True if the record is found and is valid, false otherwise.

Loads a single property, still contained within a record.

A record key. The property record. True if the record is found and is valid, false otherwise.

Loads all the properties of a document, already deseriazed into objects.

A document key. The document property values. True if the record is found and is valid, false otherwise.

Loads all the properties of a document, still contained within records.

A document key. The document property records. True if the record is found and is valid, false otherwise.

The key of a record that is stored in the Search.PropertyDatabase|PropertyDatabase.

The key of the document owning the property.

The key of the property.

The size of the key, in bytes.

Compares the record key to another record key.

A record key to compare against. An integer representing the equality result. -1 if the current key is smaller, 0 if it is equal and 1 if it is greater than the other key.

Constructs a new record key.

A document key. A property hash.

Tests equality with another record key.

A record key. A record key. True if they are equal, otherwise false.

Tests equality with another record key.

A record key. A record key. True if they are equal, otherwise false.

Gets the hashcode of the key.

The hashcode.

The equals operator.

A record key. A record key.

The greater than operator.

A record key. A record key.

The less than operator.

A record key. A record key.

The not equal operator.

A record key. A record key.

An enum representing the type of data stored in a record.

Indicates that a bool is stored in the record.

Indicates that a byte is stored in the record.

Indicates that a Color is stored in the record.

Indicates that a Color32 is stored in the record.

Indicates that a double is stored in the record.

Indicates that a fixed length string is stored in the record.

Indicates that a float is stored in the record.

Indicates that a game object property is stored in the record.

Indicates that a global object id is stored in the record.

Indicates that an instance id is stored in the record.

Indicates that an integer is stored in the record.

Indicates that a long integer is stored in the record.

Indicates that nothing is stored in the record.

Indicates that a short integer is stored in the record.

Indicates that a string is stored in the record.

Indicates that an unsigned integer is stored in the record.

Indicates that an unsigned long integer is stored in the record.

Indicates that an unsigned short integer is stored in the record.

Indicates that a Vector4 is stored in the record.

Indicates that a volatile object is stored in the record.

The PropertyTable provide an IMGUI widget to display search property results in a table view.

Creates a search property table.

Unique ID used to serialize the property table. Table view host.

Make sure to dispose the property table when not needed.

Frames a search column. The table view will scroll the view to show the framed column.

Index of the column to be framed.

Draws the search property table content.

Position in the current GUI view to render the search property table.

Custom attribute is used to customize the search engine used by the scene search provider.

Create a filter with the corresponding token and supported operators.

The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2"). List of supported operator tokens. Null for all operators. String comparison options. Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute. See Search.Providers.SceneQueryEngineParameterTransformerAttribute|SceneQueryEngineParameterTransformer for more information.

Create a filter with the corresponding token and supported operators.

Attribute class that defines a custom parameter transformer function applied for a query running in a scene provider defined by a scene custom filter using Search.Providers.SceneQueryEngineFilterAttribute.

A query block is the visual element of a query node in a query.

Search context that composed this query block.

Name of the block.

Filter operator (i.e. :, =, <, >, etc.) of the block if any.

Query builder source that compose this block.

Value of the block.

This method is invoked when a selected search proposition must be applied to the builder search query.

Selected search proposition.

Returns the text filter of the block.

Formatted text filter.

A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators. Default query engine of type object.

Construct a new QueryEngine.

Indicates if the engine must validate filters when parsing the query. The validation options to use in this engine.

Construct a new QueryEngine.

Indicates if the engine must validate filters when parsing the query. The validation options to use in this engine.

Construct a new QueryEngine.

Indicates if the engine must validate filters when parsing the query. The validation options to use in this engine.

A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators.

Global string comparison options for word matching and filter handling (if not overridden).

The callback used to get the data to match to the search words.

Indicates if word/phrase matching uses searchDataStringComparison or not.

String comparison options for word/phrase matching.

The function used to match the search data against the search words.

Boolean. Indicates if incomplete filters should be skipped. If true, filters are skipped. If false and Search.QueryEngine_1.validateFilters|validateFilters is true, incomplete filters will generate errors when parsed.

Boolean. Indicates if unknown filters should be skipped. If true, unknown filters are skipped. If false and Search.QueryEngine_1.validateFilters|validateFilters is true, unknown filters will generate errors if no default filter handler is provided.

Get or set if the engine must validate filters when parsing the query. Defaults to true.

Adds a new custom filter.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData and returns an object of type TFilter. String comparison option. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter.

Adds a new custom filter with parameters.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData and TParam, and returns an object of type TFilter. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. String comparison option. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter with parameters.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData and TParam, and returns an object of type TFilter. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. String comparison option. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter with parameters.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData and TParam, and returns an object of type TFilter. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. String comparison option. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter with parameters.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData and TParam, and returns an object of type TFilter. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. String comparison option. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter with a complete resolver.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to handle any operators for this filter. Takes an object of type TData, the operator token and the filter value, and returns a boolean indicating if the filter passed or not. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter with parameters and a complete resolver.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to handle any operators for this filter. Takes an object of type TData, an object of type TParam, the operator token and the filter value, and returns a boolean indicating if the filter passed or not. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter with parameters and a complete resolver.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to handle any operators for this filter. Takes an object of type TData, an object of type TParam, the operator token and the filter value, and returns a boolean indicating if the filter passed or not. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported.

Adds a new custom filter with a regular expression.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData, a string representing the actual filter name that was matched and returns an object of type TFilter. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. String comparison option. The new filter.

Adds a new custom filter with a regular expression.

Adds a new custom filter with a regular expression and parameters.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData, a string representing the actual filter name that was matched, an object of type TParam, and returns an object of type TFilter. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. String comparison option. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. The new filter.

Adds a new custom filter with a regular expression and parameters.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData, a string representing the actual filter name that was matched, an object of type TParam, and returns an object of type TFilter. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. String comparison option. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. The new filter.

Adds a new custom filter with a regular expression and parameters.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData, a string representing the actual filter name that was matched, an object of type TParam, and returns an object of type TFilter. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. String comparison option. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. The new filter.

Adds a new custom filter with a regular expression and parameters.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to get the object that is used in the filter. Takes an object of type TData, a string representing the actual filter name that was matched, an object of type TParam, and returns an object of type TFilter. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. String comparison option. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. The new filter.

Adds a new custom filter with a regular expression and a complete resolver.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to handle any operators for this filter. Takes an object of type TData, a string representing the actual filter name that was matched, the operator token and the filter value, and returns a boolean indicating if the filter passed or not. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. The new filter.

Adds a new custom filter with a regular expression, parameters and a complete resolver.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to handle any operators for this filter. Takes an object of type TData, a string representing the actual filter name that was matched, an object of type TParam, the operator token and the filter value, and returns a boolean indicating if the filter passed or not. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. The new filter.

Adds a new custom filter with a regular expression, parameters and a complete resolver.

The regular expression that matches the filter. Matches what precedes the operator in a filter (for example, "id" in "id>=2"). Callback used to handle any operators for this filter. Takes an object of type TData, a string representing the actual filter name that was matched, an object of type TParam, the operator token and the filter value, and returns a boolean indicating if the filter passed or not. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. Callback used to convert a string to type TParam. Used when parsing the query to convert what is passed to the function into the correct format. The new filter.

Adds all custom filters that are identified with the method attribute TFilterAttribute.

Adds a new nested query aggregator. An aggregator is an operation that can be applied on a nested query to aggregate the results of the nested query according to certain criteria.

Name of the aggregator used when typing the query. This name is converted to lowercase when parsing the query to speed up the process. Aggregator function. Takes the results of the nested query, and returns an aggregate that contains any number of items.

Adds a custom filter operator.

The operator identifier.

Adds a custom filter operator handler.

The filter operator. Callback to handle the operation. Takes a TFilterVariable (the value returned by the filter handler, it will vary for each element), a TFilterConstant (right-hand side value of the operator, which is constant), and a StringComparison option and returns a boolean indicating if the filter passes or not.

Adds a custom filter operator handler.

Adds a type parser that parses a string and returns a custom type. Used by custom operator handlers (see Search.QueryEngine_1.AddOperatorHandler|AddOperatorHandler).

Callback used to determine if a string can be converted into TFilterConstant. Takes a string and returns a ParseResult object. This contains the success flag, and the converted value if it succeeds.

Removes all filters that were added on the Search.QueryEngine_1|QueryEngine.

Constructs a new QueryEngine.

Indicates if the engine must validate filters when parsing the query. The validation options to use in this engine.

Constructs a new QueryEngine.

Indicates if the engine must validate filters when parsing the query. The validation options to use in this engine.

Constructs a new QueryEngine.

Indicates if the engine must validate filters when parsing the query. The validation options to use in this engine.

Get all filters added on this Search.QueryEngine_1|QueryEngine.

An enumerable of Search.IQueryEngineFilter|IQueryEngineFilter.

Get a custom operator added on the Search.QueryEngine_1|QueryEngine.

The operator identifier. The global Search.QueryFilterOperator|QueryFilterOperator.

Parses a query string into a ParsedQuery operation. This ParsedQuery operation can then be used to filter any data set of type TData.

The query input string. Set to true to get a query that yields null results for elements that don't pass the query, instead of only the elements that pass the query. ParsedQuery operation of type TData.

Parses a query string into a ParsedQuery operation. This ParsedQuery operation can then be used to filter any data set of type TData.

The query input string. A factory object that creates query handlers of type TQueryHandler. See Search.IQueryHandlerFactory_3|IQueryHandlerFactory. ParsedQuery operation of type TData and TPayload.

Removes a custom filter.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2").

Removes a custom filter.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2").

Removes a custom filter.

The filter object returned by Search.QueryEngine_1.AddFilter|AddFilter.

Removes a custom operator that was added on the Search.QueryEngine_1|QueryEngine.

The operator identifier.

Sets the default filter handler for filters that were not registered.

Callback used to handle the filter. Takes an object of type TData, the filter identifier, the operator, and the filter value, and returns a boolean indicating if the filter passed or not.

Sets the default filter handler for function filters that were not registered.

Callback used to handle the function filter. Takes an object of type TData, the filter identifier, the parameter, the operator, and the filter value, and returns a boolean indicating if the filter passed or not.

Sets a filter's nested query transformer function. This function takes the result of a nested query and extracts the necessary data to compare with the filter.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). The transformer function.

Sets global string comparison options. Used for word matching and filter handling (unless overridden by filter).

String comparison options.

Sets the function that will handle nested queries. Only one handler can be set.

The function that handles nested queries. It receives the nested query and the filter token on which the query is applied, and returns an IEnumerable.

Sets the callback used to fetch the data that is matched against the search words.

Callback used to get the data to be matched against the search words. Takes an object of type TData and returns an IEnumerable of strings. String comparison options.

Sets the callback used to fetch the data that is matched against the search words.

Callback used to get the data to be matched against the search words. Takes an object of type TData and returns an IEnumerable of strings. String comparison options.

Sets the callback used to fetch the data that is matched against the search words.

Callback used to get the data to be matched against the search words. Takes an object of type TData and returns an IEnumerable of strings. Callback used to transform a search word during the query parsing. Useful when doing lowercase or uppercase comparison. Can return null or an empty string to remove the word from the query. String comparison options.

Set the search word matching function to be used instead of the default one. Set to null to use the default.

The search word matching function. The first parameter is the search word. The second parameter is a boolean for exact match or not. The third parameter is the StringComparison options. The fourth parameter is an element of the array returned by the search data callback. The function returns true for a match or false for no match.

Get a filter by its token.

The token used to create the filter. The existing Search.IQueryEngineFilter|IQueryEngineFilter, or null if it does not exist. Returns true if the filter is retrieved or false if the filter does not exist.

Get a filter by its token.

Base attribute class used to define a custom filter on a QueryEngine. All filter types supported by QueryEngine.AddFilter are supported by this attribute.

String comparison options.

Flag indicating if the filter overrides the global string comparison options. Set to true when the comparisonOptions are used.

Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.

List of supported operator tokens. Null for all operators.

The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").

Flag indicating if this filter uses a parameter transformer function. Set to true when paramTransformerFunction is used.

Indicates if the filter uses a regular expression token or not.

Create a filter with the corresponding token and supported operators.

The identifier of the filter. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. String comparison options. Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.

Create a filter with the corresponding token and supported operators.

The identifier of the filter or regular expression that matches the filters. Typically what precedes the operator in a filter (for example, "id" in "id>=2"). Set this flag to true if the token is a regular expression. List of supported operator tokens. This list contains the supported operator tokens. Use null or an empty list to indicate that all operators are supported. String comparison options. Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.

Create a filter with the corresponding token and supported operators.

Base attribute class that defines a custom parameter transformer function.

A QueryError holds the definition of a query parsing error.

Index where the error happened.

Length of the block that was being parsed.

Reason why the parsing failed.

Construct a new QueryError.

Index where the error happened. Reason why the parsing failed. Length of the block that was being parsed.

Construct a new QueryError.

Index where the error happened. Reason why the parsing failed. Length of the block that was being parsed.

Construct a new QueryError.

Index where the error happened. Reason why the parsing failed. Length of the block that was being parsed.

A QueryFilterOperator defines a boolean operator between a value returned by a filter and an operand inputted in the search query.

The operator identifier.

Indicates if this filter operator is valid.

Adds a custom filter operator handler.

Callback to handle the operation. Takes a TFilterVariable (the value returned by the filter handler, it will vary for each element), a TFilterConstant (right-hand side value of the operator, which is constant), and a StringComparison option and returns a boolean indicating if the filter passes or not. The current Search.QueryFilterOperator|QueryFilterOperator.

Adds a custom filter operator handler.

Class that represents a query graph.

Returns true if the graph is empty.

Root node of the graph. Can be null.

Constructor. Creates a new query graph.

Root node of the graph.

Optimize the graph.

Optimization options.

Structure containing the different options used to optimize a query graph.

Propagate "Not" operations to leaves, so only leaves can have "Not" operations as parents.

Swaps filter functions to the right-hand side of combining operations (i.e. "And", "Or"). Useful if those filter operations are slow.

Swaps "Not" operations to the right-hand side of combining operations (i.e. "And", "Or"). Useful if a "Not" operation is slow.

A query list block represents a special query block that will list a set of value for a given filter.

Block category.

Icon displayed in the query builder block widget.

Block id.

Apply proposition to the block.

Selected proposition to be applied to the source.

Returns propositions when the list block is clicked.

Flags that can be used to know which type of proposition to yield. Propositions.

This attribute can be used on a class deriving from QueryListBlock to display in query builder mode a special block that will propose a fixed set of values when clicked.

Category.

Filter id of the block.

A set of IDs for which the list block will be displayed.

Displayed name of the block.

Default operator assigned to the filter when the value changes.

The list block type is used to get the the icon to be displayed instead of the block name.

Category of the block. Display name of the block. Filter id of the block for which to display this list block. Default operator fo the filter block. Set of IDs for which this list block will be applied too.

Options for representing the query node types.

Aggregator node.

And node.

Comment node.

Filter node.

Filter with nested query node.

Group node.

Intersection node.

Nested query node.

Negation node.

Or node.

Word search node.

Toggle node.

Union node.

Where enumerator node.

Represents a token of a query string.

The length of the token. Can be different than the length of the text.

The position of the token in the query string.

The text representing the token.

Creates a token from a string and a position.

The value of the token. The position of the token in the entire query string. The length of the token.

Creates a token from a string and a position.

The value of the token. The position of the token in the entire query string. The length of the token.

Struct containing the available query validation options.

Boolean indicating if incomplete filters should be skipped.

Boolean indicating if unknown filters should be skipped.

Boolean indicating if filters should be validated. Default is false.

Refresh flags are used to indicate why search view needs to be refreshed or updated.

Normal refresh.

The display mode or item size has changed.

The current item group has changed. In example, the user selected a new search tab.

The search item list has been updated.

No particular refresh reason were specified.

A search query has completed.

A search query is about to be executed.

The structure of the current selection data has changed (i.e. the selected scene object got a new component).

Defines an action that can be applied on a SearchItem of a specific search provider type.

Indicates if the search view should be closed after the action execution.

GUI content of the search action used when displayed with an icon.

Display name for the search action.

Callback used to check if the action is enabled based on the current context.

Executes an action on a set of items.

This handler is used for actions that do not support multi-selection.

Action unique identifier.

Default constructor to build a search action.

Unique action id used to find it back later. The search provider ID that supports this action. Displays the displayname, an icon, and a tooltip when displaying the action in the Action Menu. Handler that executes the action. Label name when displaying the action in the Action Menu. Icon for the action in the Action Menu. Tooltip associated with the action when displayed in the Action Menu.

Default constructor to build a search action.

Attribute used to declare a static method that defines new actions for specific search providers.

Search columns are used to display additional information in the Search Table view.

If defined, the binder delegate is used to apply contextual data to a visual element.

If defined, the cell creator delegate is used to customize how the search column displays its information.

If defined, the comparer delegate is used to sort search results based on the value displayed in that column.

The content is used to display the search column label and image in its header.

If defined, the drawer delegate is used to customize how the search column displays its information.

If defined, the getter delegate is used to customize how the search field data is extracted and transformed for display (see SearchColumn.drawer).

Name of the search column.

Various options used to define how a search column is presented.

The path can be used by the column delegates to interpret how the data can be manipulated.

The provider is used to indicate which search column provider (see SearchColumn) is used to define the search column format.

The selector is used by the column delegates to fetch the search field data.

If defined, the setter delegate writes back the value to the corresponding field of the search result.

The column width is used to set the Search Table view column width.

Creates a new search column.

Serialization path of the column. Content to render the column header. Column flags. Selector used to fetch the field data of a search item. See SearchSelectorAttribute. Column provider used to manage the column. See SearchColumnProviderAttribute.

Creates a new search column.

Enumerate a set of columns for a variety of search items.

Search context. Items for which to fetch a set of columns. Search columns.

Initialize the column provider functors.

Search column compare arguments are used by SearchColumn.comparer to sort search results.

Left-hand side column to compare.

Right-hand side column to compare.

Indicates if the results should be sorted in ascending order or not.

Search column event arguments are used by SearchColumn.getter, SearchColumn.drawer and SearchColumn.setter delegates.

Search column being handled by the current event.

Search context being used for the current event.

Indicates if the search column cell is currently focused.

Search item currently being used for the event.

Indicates if multiple search results are currently selected when processing the current event.

UnityEngine.Rect used to indicate the drawing boudaries of the SearchColumn.drawer event.

Indicates if the search result is currently selected.

Value obtained from SearchColumn.getter before calling SearchColumn.drawer.

Search column flags are used to set multiple states.

Indicates that the user can manually hide the search column in the Search Table view.

Indicates that the user can sort the search column in the Search Table view.

Defines a default set of options for common usages.

Indicates that the search column is currently hidden in the Search Table view.

Indicates that no column options are used.

Indicates that the search column in the Search Table view is currently sorted.

Indicates that the search column in the Search Table view is sorted in descending order. If not defined, it means the column is sorted in ascending order.

Indicates that the search column in the Search Table view is aligning text in the middle.

Indicates that the search column in the Search Table view is aligning text to the left.

Indicates that the search column in the Search Table view is aligning text to the right.

The search column provider attribute is used to define new formats for a given column.

Unique name of the search column provider.

The search context includes all the data necessary to perform a query. It allows the full customization of how a query may be performed.

This event is used to receive any asynchronous search result.

Event is used to receive any asynchronous search result.

Indicates of the search query is empty. This exclude the search filter id. In example if the search text is h: , then this property will still return true.

Explicit filter ID. Usually it is the first search token like h:, p: to do an explicit search for a given search provider. Can be null.

Editor window that initiated the search.

Search context options.

Progress handle to display the progress bar for the search currently in progress.

Which search providers are active for this particular context.

Indicates if an asynchronous search is currently in progress for this context.

Returns a phrase that contains only words separated by spaces.

Processed search query (no filterId, no textFilters).

Character offset of the processed search query in the raw search text.

Raw search text (what is in the Search text box).

The search view presenting the search results.

Search query tokenized by words. All text filters are discarded and all words are in lowercase.

Returns the search result selection if any.

Invoked when a Search has ended.

Handler of the event.

Invoked when a Search is started.

Handler of the event.

All tokens containing a colon (':').

Indicates if the search should return all the results instead of only the most relevant.

Adds a new query error on this context.

The new error.

Adds new query errors on this context.

The new errors.

Creates a new search context.

The list of search providers used to resolve the specified query. The search query to perform. A set of options that help evaluate the query.

Creates a new search context.

The list of search providers used to resolve the specified query. The search query to perform. A set of options that help evaluate the query.

Creates a new search context.

The list of search providers used to resolve the specified query. The search query to perform. A set of options that help evaluate the query.

TODO.

Dispose of the Search Context.

Checks if a search provider is available to process a query.

ID of the search provider. See SearchProvider.name.id. Returns true if the search provider is enabled for this SearchContext.

Enables or disables a single search provider. A disabled search provider won't be asked to provide items to resolve the query.

ID of the search provider. See SearchProvider.name.id. If true, enables the search provider to perform a query.

Represents a searchable document that has been indexed.

Document unique ID in the search index.

Readable name of the document.

Document base relevance score.

Original source from which the document was indexed. The source is usually the container asset, i.e. prefab, Unity scene or the imported asset itself.

If true the document is considered valid.

Compare this document against another document.

Another document to compare to. If 0, both documents are equals.

Create a new SearchDocument.

Document unique ID in the search index. Source document to copy properties from. Document score used for sorting. Document position in the search index. Document path (i.e. asset path or transform path) if any. Document name (for example, asset path or transform path) if any. Document contained source path or ID. This is usually defined for nested objects with a prefab or a scene.

Create a new SearchDocument.

Compare this document against another document.

Another document to compare to. If true both document are equals.

Compare this document against another document.

Another document to compare to. If true both document are equals.

Returns the document ID string.

Returns a string representation of the document.

Search document flags are used by the indexing system to provide additional information of an indexed document, like its source.

Indicates that the indexed document is an asset. So it should have a valid asset path.

Indicates that the indexed document was grouped in another asset provider.

Indicates that the search document is an nested object.

Indicates no particular flags.

Indicates that the search document was indexed from an object such as a prefab or a scene.

Indicates that the document was indexed from a resource bundle.

Search expressions allow you to add to the search query language to express complex queries that cross-reference multiple providers, for example, to search for all objects in a scene that use a shader that doesn’t compile. Search expressions can be chained together to transform or perform set manipulations on Search Items. The manual contains example on <a href="https:docs.unity3d.comDocumentationManualsearch-expressions.html">How to use Search Expression<a> .

Alias name of an expression. This is useful to assign a more readable results to methematic expression (lile Count).

This is the inner text of the expression. This means the text without any special delimiters. Ex: the expression [1, 2, 3] which is a set expression would have an innerText of 1,2,3.

The name of the evaluator function or hte outer text. This is mostly a debuggin field.

This is the outer text of the expression. This means the full text with any special delimiters. Ex: the expression [1, 2, 3] which is a set expression would have an outerText of [1,2,3].

The parameter list of the expression. Note that each parameter is an expression in itself.

Aggrregate types of the expression. This is mostly used to validate parameters of an expression.

Execute a SearchExpression and checks if the internal value of the first yielded SearchItem is truish. Not 0, not null, not "" and not false.

SearchExpression to test. Execute context of the expression. Returns true if the SearchExpression yields more than one item or if the sole item is true.

Generate a unique id. This is useful when creating new SearchItem.

Create a new SearchItem from a value with an optional label.

Optional label of the SearchItem. This will be displayed in the search Window. Initial value of the SearchItem. Optional description of the SearchItem. This will be displayed in the search Window. Returns a new SearchItem.

Create a new SearchItem from a value with an optional label.

Execute a SearchEXpression givent a certain SearchContext Depending on flags the expression might be valuated in a worker thread (by default) or in the main thread. It returns a an enumerable list of SearchItem.

SearchContext used to initialize the SearchExpressionContext that will encapsulate all information relative to expression evaluation. Execution flags helping define how to evaluate the expression. SearchExpressionContext that will encapsulate all information relative to expression evaluation. Returns an enumerable list of SearchItem.

Take a format string and replace all selectors in it with the selected values obtained from a SearchItem.

SearchContext that yielded the SearchItem. SearchItem to select value from. Format string that mayh contain selectors. Returns a string where selectors have been replaced by the selected values from a given SearchItem.

Try to parse the innerText and convert it to a boolean value.

Initial value if we cannot convert the innerText. Returns the boolean representation of the expression.

Extract a format string from a given expression. This function should be used to extract a format string from an input parameter of a SearchExpression. For example: the evaluator print{"this is it: @label"} takes a format string as its first parameter.

Expression to convert to a format string. Extracted format string. Returns true if the SearchExpression was succesfully converted to a format string.

Try to parse the innerText and convert it to a double value.

Initial value if we cannot convert the innerText. Returns a numerical representation of the expression.

Check if the innerText of an expression is a builtin SearchExpressionKeyword.

Builtin keyword to check the expression against. Returns if the expression is a builtin Search Expression keyword.

Check if the internal value of a SearchItem is truish. It means the value is not 0, not null, not "" and not false.

SearchItem to test. Returns true if the value of the SearchItem is truish.

Take a group of SearchItems and apply a processHandler transformer function to the item in order to sets its internal value or an outputValueField. Note that these items are processed in the main thread thus allowing you to resolve any kind of selectors.

Group of items to transform. Name of the field in the SearchItem to write the value to. If null, we write to the internal value of the item. Transformer function that need to returns a new value for the item. Yield a new list of items that have been transformed.

Convert an expression to a string representation.

Returns string representation of a SearchExpression.

Resolve a selector on an item and try to convert the selected value to a double.

SearchItem to extract the value from. Resulting value. Selector use to access an item value. If null, we will use the internal item value. Returns true if we were able to select the value and convert it to a double.

This context encapsulate all the datas needed to evaluate a SearchExpression and it allows user to interact with the evaluation runtime of an expression. A SearchExpressionContext is created automatically with a SearchExpressionRuntime anytime SearchExpression.Execute is called.

Arguments of passed to the SearchExpression being evaluated.

[[]SearchExpression] being evaluated.

SearchItems yielded by the evaluation of a searchExpression.

SearchExpressionRuntime associated with this context. The runtime stores all runtime data (stack frames, stack of contex and items) necessary for evaluation of a SearchExpression.

SearchContex containing the search query that was parsed to create the SearchExpression.

Is the current context valid or not. If invalid it means the associated SearchExpression is null or the SearchExiressionRuntime is invalid.

Break the evaluation of a SearchExpression meaning items won't be yielded anymore.

Tell SearchExpression evaluation to continue.

Has the current context being flagged to break execution?

Has the current context being flagged to continue execution?

Restart evaluation and iteration of SearchExpression.

Try to resolve an alias value using the SearchExpressionRuntime attached to this context. Each frame if asked to resolve a SearchExpression.alias.

If no exeuction frames are present this becomes the default alias to be resolved. Default expression to look to resolve the alias. If null, use the runtime to resolve the alias. Returns a resolved alias.

Try to resolve an alias value using the SearchExpressionRuntime attached to this context. Each frame if asked to resolve a SearchExpression.alias.

Stop a SearchExpression evaluation by throwing a SearchExceptionEvaluatorException. User writing an evaluator can decide to throw thse exceptions if the parameters passed to evaluation are not valid or if a problem happens during evaluation.

Get string representation of a context.

Returns string representation of a context.

Hints provided to the SearchExpression runtime to specify how a certain SearchExpressionEvaluatorAttribute should be executed.

Wehn evaluating a SearchExpression signifies that each ielded items could be another SearchExpression that needs evaluation.

Default evaluation hints. Currently Default is that thread evaluation is supported (SearchExpressionEvaluationHints.ThreadSupported).

Specifies that the evaluator signature shouldn't be validated by the SearchExpression runtime thus allowing any number of parameters with any types to be passed to the evaluator. It becomes the job of the evaluator itself to validate its parameters.

Specifies that the parameters of a SearchExpression shouldn't have their signature be validated. This is used mostly for meta programming evaluator lile apply{} where partial evaluator can be used as parameter.

Specifies that an evaluator might return SearchItem containing SearchExpression that supports expansin like groupBy{}.

Specifies that an evaluator assumes its arguments are literal and will be used as such.

Specifies that an evaluator does not support worker thread evaluation and should only be evaluated in the main thread. This could be the case if an evaluator is using non-tread safe Unity API (like AssetDatabase).

Specifies that an evaluator supports being evaluated in a worker thread (that is not the main thread). This is the default evaluation hint.

Attribute used to register new SearchExpressionEvaluator. This will allow to use new function in SearchExpression. As a side note all builtin evaluators (count{}, select{}, ...) are defined using this attribute.

Use this attribute to register a static C# function as a new evaluator. SearchExpressionEvaluator when use within a SearchExpression can have a signature that is validated against the passed parameters.

Array of types corresponding to the type of the parameters used with this evaluator. N ame of the evaluator. If no name are specified the name of the evaluator functio will be used. Hints to specify to the evaluator runtime how function should be run.

Allows user to add more function signature overload to a SearchExpressionEvaluatorAttribute.

Add an overload signature to an existing SearchExpressionEvaluator.

Array of types describing what is an accepted signature for an evaluator.

Enum contaning all keywords used as configuration parameter in builtin evaluator of SearchExpression.

All keyword.

Any keyword.

Asc (contraction of Ascending). Used in sor{} to define the sorting order.

Desc (contraction of Descending). Used in sor{} to define the sorting order.

Indicates to keep results from first set.

Unrecognized keyword.

Indicates to yield sorted results.

Encapsulate all the runtime data needed to evaluate a root expression and all its parameters. This class contains the SearchContext that created the root SearchExpression and all the stack frames needed to evaluate all the nested SearchExpression.

Current SearchExpressionContext corresponding to the stack frame being evaluated.

The stack of all SearchExpressionContext being evaluated.

The stack of SearchItems that have been yielded by each execution frame.

Initial SearchContext contaning the text that was used to parse the initial root SearchExpression.

Is the current runtime valid. This means are there any SearchExpressionContext being evaluated.

Push a new SearchExpression with its arguments to be evaluated. This is useful if a user defined evaluator needs to generate a new Context of evaluation.

Expression to evaluate. Parameters passed to the expression to evaluate. Exeution Flags used to add to the flags specified in the expression being evaluated. Push a new yielded item in the current evaluation frame. Returns a new disposable Scope. When out this scope is disposed the newly created SearchExpressionContext will be removed from the frames.

Push a new SearchExpression with its arguments to be evaluated. This is useful if a user defined evaluator needs to generate a new Context of evaluation.

Get a string representation of the current SearchExpressionRuntime.

Returns a string representation of the current runtime.

Type used to characterize an expression. An expression might have multiple types. For example a Set is also an iterable. A keyword is also considered a string value. SearchExpressionType can be used with SearchExpressionEvaluatorAttribute to describe the parameter list of an evaluator.

Denote any expression of any type (Literal, Iterable or Selector).

Denote an expression with a value type: either Literal or Iterable.

Denote a Literal expression of a boolean value.

Denotes an expression using the ... operator to tell it can be expanded.

Denotes an expression of an evaluator function. For example: count{}.

Denote an expression of a group of items. Groups are generated by the groupBy{} evaluator.

Denote an expression that can iterated to yield SearchItem. Set: [1, 2, 3], Query String: t:shader and evaluator: count{} are all example of iterables.

Denote an expression yielding a SearchExpressionKeyword.

Denote an expression built from a literal values: boolean, number, text or keyword. For example in the set expression [1,"hello",true] all set values are literals.

Denote an invalid Expression.

Denote a Literal expression of a numerical value.

Used in SearchExpressionEvaluatorAttribute to specify a aprameter to be Optional.

Denote an expression representing a query string. For example: t:shader.

Denote an expression representing a selector. All selector starts with @. For example @size in expression: select{t:material, @size}.

Denote an iterable expression of a group of generally literal values. For example [1, 2, 3] or [material, shader, texture2d].

Denote an expression representing a textual (string) value.

Used in SearchExpressionEvaluatorAttribute to specify that a parameter can be used multiples times. For example count{Iterable1, Iterable2,... IterableN} can be executed with any number of iterables are parameters.

Search item field used by the property table and selector systems.

Display label of the field if displayed in the property table.

Field property label that was selected.

Field selector name. Compared to label, this field can be decorated with tokens such as # when this field selects a dynamic serialized property.

Value of the search field.

Creates a search field.

Name of the field. Value of the field. Label used for display.

Creates a search field.

Name of the field. Value of the field. Label used for display.

Creates a search field.

Name of the field. Value of the field. Label used for display.

Search options used to fetch items. Mostly with SearchContext to specify how a search should be handled.

All SearchProviders are available in the SearchWindow dropdown menu.

Adds debugging information to SearchItem while looking for results.

Default Search Flag (SearchFlags.Sorted).

Indicates that the search view is dockable. This flag is only usable with internal API.

Indicates that the search query will be evaluated as a search expression.

Sends the first items asynchronously.

Indicates that the search view will focus on the first contextual search provider available when it opens. This flag is only usable with internal API.

This is a general purpose search window that has access to all Providers in the SearchService.

Indicates that the search view will hide its side panels when it opens. This flag is only usable with internal API.

Indicates that the search view will allow multi-selection. This flag is only usable with internal API.

Prevents the search from using indexing. Asset Provider will use its builtin Find in Files provider.

No specific search options. Result will be unsorted.

Opens a search view with default contextual options. This flag is only usable with internal API.

Opens a search view with default options. This flag is only usable with internal API.

Opens a search view for a global search. This flag is only usable with internal API.

Opens a search view as an object picker. This flag is only usable with internal API.

The Object Picker window will include any results from packages.

Evaluate the search text as a pure query string (do not evaluate the text as a search expression).

Indicates that the search view will find any existing window instances that are already opened before creating a new one. This flag is only usable with internal API.

Indicates that the search view will save its settings and search provider filters when it closes. This flag is only usable with internal API.

Always show query errors even when there are results available. This flag is only usable with internal API.

Fetched items are sorted by the search service.

Search items are fetched synchronously. This can take a long time for some SearchProvider (like asset). Use at your own risk.

Persist the SearchContext state in between sessions using the SearchViewState.sessionName as its data key.

Sets the search to search for all results. This might take longer than unusual if SearchProvider are using multiple sources of items (files on disk, AssetDatabase...)

Base class for a document Indexer which provides methods for retrieving a document given a specific pattern in roughly log(n). This allows you to search a large index more quickly.

Returns the number of documents in the index.

Returns the number keywords in the index.

Minimal length of a query. By default it is 1 character.

Minimal indexed word size. Default is 2.

Name of the index. Generally this name is set by a user from SearchDatabase.Settings.

Handler used to resolve a document ID to some other data string.

Handler used to skip entries.

Indicates when the search index was last modified.

Adds a new document to be indexed.

Unique document ID. Name of path of the document. Source of the document. In example, if the document is a nested object, the source should be the container asset path. Pass true if this document has some chance of existing already. Flags describing the nature of the document. The document index/handle used to add new index entries.

Adds a new document to be indexed.

Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.

Word to add to the index. Relevance score of the word. Document where the indexed word was found.

Adds a key-number value pair to the index. The key won't be added with variations.

Key used to retrieve the value. Number value to store in the index. Relevance score of the word. Document where the indexed value was found.

Adds a property value to the index. A property is specified with a key and a string value. The value will be stored with multiple variations.

Key used to retrieve the value. String value to store in the index. Document where the indexed value was found. Indicates if we store this key in the keyword registry of the index. See SearchIndexer.GetKeywords. If true, index stores an exact match entry for this word. Relevance score of the word. Key used to retrieve the value. Minimum number of variations to compute for the value. Cannot be higher than the length of the word. Maximum number of variations to compute for the value. Cannot be higher than the length of the word.

Adds a property value to the index. A property is specified with a key and a string value. The value will be stored with multiple variations.

Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.

Word to add to the index. Relevance score of the word. Document where the indexed word was found. Number of variations to compute. Minimum number of variations to compute. Cannot be higher than the length of the word. Maximum number of variations to compute. Cannot be higher than the length of the word.

Adds a new word coming from a document to the index. The word is added with multiple variations allowing partial search.

Creates a new default SearchIndexer.

Name of the indexer.

Creates a new default SearchIndexer.

Name of the indexer.

Dispose of the SearchIndexer.