Scripting API

Scripting API

NavMeshFile

Class in Abyss.Navigation, from Abyss.Navigation.

A baked navmesh as its file keeps it, .abynav: what a NavMeshSurface3D's NavMeshSurface3D.Baked names, which a game reads as the surface appears.

public static class NavMeshFile

Remarks

Little-endian: ABYNAV, the file's version (16 bits), Recast's version as its length (16 bits) and text, the agent it was baked for — radius, height, step and slope (4 floats) — and the bake for the rest, as Bake made it: its tiles' layers of floor, which Detour's tile cache builds into a navmesh and obstacles cut into as the game plays.

Detour's layers are Detour's, its own version in each: a navmesh baked by another version that cannot read them is said as one to bake again, as is one of version 1, a navmesh of one tile.

Methods

Write

public static byte[] Write(in NavAgentType3D agent, ReadOnlySpan<byte> data)

A navmesh's file, of data baked for agent.

Parameters

  • agent
  • data

Read

public static NavMesh3D Read(ReadOnlySpan<byte> file)

The navmesh a file holds, loaded.

Parameters

  • file

Exceptions

  • InvalidDataException: It is no navmesh's file, one of a newer version, or one Detour cannot read.

Constants

Extension

public const string Extension = ".abynav"

The ending of a navmesh's file.

CurrentVersion

public const int CurrentVersion = 2

The version of the file this build writes, and the newest it reads.