Skip to content

tes3pathGrid⚓︎

A navigation graph used for pathfinding through cells. Composed of nodes (waypoints) connected by navigable edges. Pathgrid data is only available when the isLoaded property is true.

This type inherits the following: tes3baseObject

Properties⚓︎

blocked⚓︎

The blocked state of the object.

Returns:

  • result (boolean)

deleted⚓︎

Read-only. The deleted state of the object.

Returns:

  • result (boolean)

disabled⚓︎

Read-only. The disabled state of the object.

Returns:

  • result (boolean)

granularity⚓︎

Read-only. Unknown purpose.

Returns:

  • result (number)

id⚓︎

Read-only. The unique identifier for the object.

Returns:

  • result (string)

isLoaded⚓︎

Read-only. If the game has loaded the path grid data.

Returns:

  • result (boolean)

modified⚓︎

The modification state of the object since the last save.

Returns:

  • result (boolean)

nodeCount⚓︎

Read-only. The total number of nodes.

Returns:

  • result (number)

nodes⚓︎

Read-only. A list of all path nodes in the grid. Note that for some cells, not all nodes are placed on the ground.

Returns:

objectFlags⚓︎

Read-only. The raw flags of the object.

Returns:

  • result (number)

objectType⚓︎

Read-only. The type of object. Maps to values in tes3.objectType.

Returns:

parentCell⚓︎

Read-only. The cell that the pathgrid belongs to.

Returns:

persistent⚓︎

The persistent flag of the object.

Returns:

  • result (boolean)

sourceless⚓︎

The soruceless flag of the object.

Returns:

  • result (boolean)

sourceMod⚓︎

Read-only. The filename (including the extension) of the mod that owns this object. It has nil value if the object was anything other than loaded from an ESP or ESM file.

Returns:

  • result (string)

supportsLuaData⚓︎

If true, references of this object can store temporary or persistent lua data.

Returns:

  • result (boolean)

Methods⚓︎

__tojson⚓︎

Serializes the object to json.

local string = myObject:__tojson()

Returns:

  • string (string)