Skip to content

Api > NavMesh > GetAreaFromName()


NavMesh.GetAreaFromName(string areaName)⚓︎

Returns the area index for a named NavMesh area type.

Parameters:⚓︎

Name Type Description
areaName string Name of the area to look up.

Returns:⚓︎

type Description
number Index if the specified are, or -1 if no area found.

Usage⚓︎

---@type string
local areaName;


local val0 = NavMesh:GetAreaFromName(areaName)