Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

NavMesh.GetSettingsByIndex

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

public static method GetSettingsByIndex(index: int): AI.NavMeshBuildSettings;
public static AI.NavMeshBuildSettings GetSettingsByIndex(int index);

Parameters

indexThe index to retrieve from.

Returns

NavMeshBuildSettings The found settings.

Description

Returns an existing entry of NavMesh build settings by its ordered index.

If the index is outside the valid range (0, GetSettingsCount-1), the returned NavMeshBuildSettings struct will have the agentTypeID set to -1.

See Also: NavMeshBuildSettings and GetSettingsCount.