Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

NavMesh.GetAreaCost

Other Versions
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

public static function GetAreaCost(areaIndex: int): float;
public static float GetAreaCost(int areaIndex);

Parameters

areaIndex Index of the area to get.

Description

Gets the cost for path finding over geometry of the area type.

The value applies to all agents unless you the value has been customized per agent by calling NavMeshAgent.SetAreaCost.

You can use NavMesh.GetAreaFromName to find the area index based on the name of the NavMesh area type.

See Also: Areas and Costs to learn how to use different Area types.

Did you find this page useful? Please give it a rating:

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 © 2017 Unity Technologies. Publication: 2017.1-001R. Built: 2017-10-06.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information