Version: 2021.3
LanguageEnglish
  • C#

NavMesh.AddNavMeshData

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 AI.NavMeshDataInstance AddNavMeshData(AI.NavMeshData navMeshData);

Parameters

navMeshData Contains the data for the navmesh.

Returns

NavMeshDataInstance Representing the added navmesh.

Description

Adds the specified NavMeshData to the game.

This makes the NavMesh data available for agents and NavMesh queries. Returns an instance for later removing the NavMesh data from the runtime.

The instance returned will be valid unless the NavMesh data could not be added - e.g. due to running out of memory or navmesh data being loaded from a corrupted file.

Additional resources: NavMeshDataInstance, NavMesh.RemoveNavMeshData.


Declaration

public static AI.NavMeshDataInstance AddNavMeshData(AI.NavMeshData navMeshData, Vector3 position, Quaternion rotation);

Parameters

navMeshData Contains the data for the navmesh.
position Translate the navmesh to this position.
rotation Rotate the navmesh to this orientation.

Returns

NavMeshDataInstance Representing the added navmesh.

Description

Adds the specified NavMeshData to the game.

This function is similar to AddNavMeshData above, but the position and rotation specified is applied in addition to the position and rotation where the NavMesh data was baked.

using UnityEngine;
using UnityEngine.AI;

class Example : MonoBehaviour { public NavMeshData data; NavMeshDataInstance[] instances = new NavMeshDataInstance[2];

public void OnEnable() { // Add an instance of navmesh data instances[0] = NavMesh.AddNavMeshData(data);

// Add another instance of the same navmesh data - displaced and rotated instances[1] = NavMesh.AddNavMeshData(data, new Vector3(0, 5, 0), Quaternion.AngleAxis(90, Vector3.up)); }

public void OnDisable() { instances[0].Remove(); instances[1].Remove(); } }