Version: 2020.1
LanguageEnglish
  • C#

NavMesh.SetAreaCost

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 void SetAreaCost(int areaIndex, float cost);

Parameters

areaIndexIndex of the area to set.
costNew cost.

Description

Sets the cost for finding path over geometry of the area type on all agents.

This will replace any custom area costs on all agents, and set the default cost for new agents that are created after calling the function. The cost must be larger than 1.0.

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

// ToggleWaterCost
using UnityEngine;
using UnityEngine.AI;

public class ToggleWaterCost : MonoBehaviour { void Update() { if (Input.anyKeyDown) { // Make water area 10x more costly to traverse. NavMesh.SetAreaCost(NavMesh.GetAreaFromName("water"), 10.0f); } } }

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

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