Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

CreateIndex(in string, in IndexingOptions, IEnumerable<string>, IEnumerable<string>, IEnumerable<string>, Action<string, string, Action>)

Create a new search index.
Read time 1 minuteLast updated 11 days ago

Definition

CreateIndex(string, IndexingOptions, IEnumerable<string>, IEnumerable<string>, IEnumerable<string>, Action<string, string, Action>)

Warning
Deprecated. This API has been marked as deprecated and may be removed in a future version.
public static void CreateIndex(in string name, in IndexingOptions options, IEnumerable<string> roots, IEnumerable<string> includes, IEnumerable<string> excludes, Action<string, string, Action> onIndexReady)

Parameters

name

string
Unique name of the search index.

options

IndexingOptions
Indexing option set.

roots

IEnumerable<string>
Search index roots, for example "Assets" to index all Assets under Assets.

includes

IEnumerable<string>
Exclusive list of assets to be indexed. If this list is empty, everything will be indexed.

excludes

IEnumerable<string>
Patterns to exclude assets to be indexed under roots.

onIndexReady

Action<string, string, Action>
Callback that gets invoked when the index is created and ready to be used.

Examples

static string EnsureDecalPropertyIndexing(){    var materialDb = SearchService.EnumerateDatabases().FirstOrDefault(IsIndexingMaterialProperties);    if (materialDb != null)        return materialDb.name;    if (!EditorUtility.DisplayDialog("Create decal material index",        "Your project does not contain an index with decal material properties." +        "\n\n" +        "Do you want to create one now?", "Yes", "No"))        return null;    var dbName = "Decals";    SearchService.CreateIndex(dbName,        IndexingOptions.Properties | IndexingOptions.Dependencies |        IndexingOptions.Types | IndexingOptions.Keep,        roots: null,        includes: new string[] { ".mat" },        excludes: null,        (name, path, finished) =>        {            Debug.Log($"Material index {name} created at {path}");            finished();        });    return dbName;}static bool IsIndexingMaterialProperties(ISearchDatabase db){    if (string.Equals(db.name, "Materials", StringComparison.OrdinalIgnoreCase))        return true;    return (db.indexingOptions & IndexingOptions.Properties) == IndexingOptions.Properties        && (db.includePatterns.Count == 0 || db.includePatterns.Contains(".mat"));}