Version: 2021.3
LanguageEnglish
  • C#

SearchService.CreateIndex

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static void CreateIndex(ref string name, ref Search.IndexingOptions options, IEnumerable<string> roots, IEnumerable<string> includes, IEnumerable<string> excludes, Action<string,string,Action> onIndexReady);

Parameters

Parameter Description
name Unique name of the search index.
options Indexing option set.
roots Search index roots, for example "Assets" to index all Assets under Assets.
includes Exclusive list of assets to be indexed. If this list is empty, everything will be indexed.
excludes Patterns to exclude assets to be indexed under roots.
onIndexReady Callback that gets invoked when the index is created and ready to be used.

Description

Create a new search index.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2025 Unity Technologies. Publication Date: 2025-10-07.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information