Skip to content
LogoOpenMW
Modding Lua API Post-Processing
⌘ K
LogoOpenMW
Modding Lua API Post-Processing

Reference

  • Modding
    • Foreword
    • Modding OpenMW vs Morrowind
    • How To Install and Use Mods
    • OpenMW Game Template
    • Advanced Settings Configuration
      • Camera
      • Cells
      • Fog
      • Game
      • General
      • Groundcover
      • GUI
      • HUD
      • Input
      • Lua
      • Map
      • Models
      • Navigator
      • Physics
      • Post-Processing
      • Shaders
      • Shadows
      • Saves
      • Sound
      • Stereo
      • Stereo View
      • Terrain
      • Video
      • Water
      • Windows
    • Texture Modding
      • Texture Modding Basics
      • Normal maps from Morrowind to OpenMW
    • Custom Models
      • Static Model via COLLADA
      • Animated Creature via COLLADA
      • Blender to OpenMW with OSG native
      • Blender to OpenMW with NIF
    • Fonts
    • Sound Effects
    • Music
    • Sky System and Structure
    • Doors and Connecting Cells
    • Custom Shader Effects
    • Extended modding feature overview
    • Animation blending
    • Paths
    • Localisation
  • Post-Processing
    • OMWFX Language
    • Lua Integration

Lua

  • Overview
  • API Reference
    • Packages
      • ambient
      • animation
      • async
      • camera
      • core
      • debug
      • input
      • markup
      • menu
      • nearby
      • postprocessing
      • self
      • storage
      • types
      • ui
      • util
      • vfs
      • world
    • Auxiliary Packages
      • calendar
      • time
      • ui
      • util
    • AI packages
      • Combat
      • Escort
      • Follow
      • Pursue
      • Travel
      • Wander
    • Interfaces
      • Activation
      • AI
      • AnimationController
      • Camera
      • Combat
      • Controls
      • Crimes
      • GamepadControls
      • ItemUsage
      • MWUI
      • Settings
      • SkillProgression
      • UI
    • UI
      • Widget
      • Container
      • Flex
      • Image
      • Text
      • TextEdit
    • Setting Renderers
    • Engine Handlers
    • Events
    • Iterables
  • Teal

Help

  • Installation Guide
    • Install OpenMW
    • Install Game Files
    • Common Problems
  • OpenMW-CS User Manual
    • Foreword
    • A Tour through OpenMW CS: making a magic ring
    • Files and Directories
    • OpenMW CS Starting Dialog
    • Tables
    • File Tables
    • World Tables
    • Mechanics Tables
    • Characters Tables
    • Assets Tables
    • Object Record Types
    • Record Filters
    • Cell View
    • Drag and Drop
  • Help with docs?

Navigator Settings

enable

Type

Range

Default

Location

boolean true, false true user settings.cfg

Enables the navigator system, building a navmesh for pathfinding. Disabling uses only path grid, which affects NPC AI and pathfinding. May impact performance, especially on single-core CPUs.

max tiles number

Type

Range

Default

Location

int ≥ 0 512 user settings.cfg

Sets the number of tiles in the navmesh area around the player. Increasing can decrease performance. Must satisfy: max tiles number * max polygons per tile ≤ 4194304.

wait until min distance to player

Type

Range

Default

Location

int ≥ 0 5 user settings.cfg

Distance in tiles around player to delay loading screen until navmesh is generated. Zero disables waiting.

enable nav mesh disk cache

Type

Range

Default

Location

boolean true, false true user settings.cfg

Enables using disk cache for navmesh tiles in addition to memory cache.

write to navmeshdb

Type

Range

Default

Location

boolean true, false true user settings.cfg

Enables writing generated navmesh tiles to disk cache during runtime.

max navmeshdb file size

Type

Range

Default

Location

uint > 0 2147483648 user settings.cfg

Maximum size in bytes of navmesh disk cache file.

async nav mesh updater threads

Type

Range

Default

Location

uint ≥ 1 1 user settings.cfg

Number of background threads updating navmesh. Increasing threads may affect latency and performance.

max nav mesh tiles cache size

Type

Range

Default

Location

uint ≥ 0 268435456 user settings.cfg

Maximum memory size for cached navmesh tiles. Larger cache reduces update latency but uses more memory.

min update interval ms

Type

Range

Default

Location

int ≥ 0 250 user settings.cfg

Minimum milliseconds between navmesh updates per tile when objects move. Smaller values increase CPU usage.

enable write recast mesh to file

Type

Range

Default

Location

boolean true, false false user settings.cfg

Write recast mesh to .obj file on each update for debugging.

enable write nav mesh to file

Type

Range

Default

Location

boolean true, false false user settings.cfg

Write navmesh to file readable by RecastDemo app.

enable recast mesh file name revision

Type

Range

Default

Location

boolean true, false false user settings.cfg

Append revision number to recast mesh file names to keep history.

enable nav mesh file name revision

Type

Range

Default

Location

boolean true, false false user settings.cfg

Append revision number to navmesh file names to keep history.

recast mesh path prefix

Type

Range

Default

Location

string "" user settings.cfg

File path prefix for recast mesh files.

nav mesh path prefix

Type

Range

Default

Location

string "" user settings.cfg

File path prefix for navmesh files.

enable nav mesh render

Type

Range

Default

Location

boolean true, false false user settings.cfg

Render the navmesh in-game for debugging.

nav mesh render mode

Type

Range

Default

Location

string "area type", "update frequency" "area type" user settings.cfg

Mode to render navmesh: color by area type or show update frequency heatmap.

enable agents paths render

Type

Range

Default

Location

boolean true, false false user settings.cfg

Render NPC/creature planned paths, even if navigator disabled.

enable recast mesh render

Type

Range

Default

Location

boolean true, false false user settings.cfg

Render recast mesh (culled tiles from physical mesh) for debugging.

wait for all jobs on exit

Type

Range

Default

Location

boolean true, false false user settings.cfg

Wait for all async navmesh jobs to complete before engine exit.

recast scale factor

Type

Range

Default

Location

float32 > 0.0 0.029411764705882353 user settings.cfg

Scale factor between navigation mesh voxels and world units. Changing affects mesh generation and navigation accuracy.

max polygon path size

Type

Range

Default

Location

uint > 0 1024 user settings.cfg

Maximum path length over polygons.

max smooth path size

Type

Range

Default

Location

uint > 0 1024 user settings.cfg

Maximum length of smoothed path.

cell height

Type

Range

Default

Location

float32 > 0.0 0.2 user settings.cfg

Height (Z axis) size of each voxel cell in navigation mesh.

cell size

Type

Range

Default

Location

float32 > 0.0 0.2 user settings.cfg

XY plane size of each voxel cell in navigation mesh.

detail sample dist

Type

Range

Default

Location

float32 0.0 or ≥ 0.9 6.0 user settings.cfg

Sampling distance when generating detail mesh.

detail sample max error

Type

Range

Default

Location

float32 ≥ 0.0 1.0 user settings.cfg

Maximum deviation distance of detail mesh surface from heightfield.

max simplification error

Type

Range

Default

Location

float32 ≥ 0.0 1.3 user settings.cfg

Max deviation for simplified contours from raw contour.

tile size

Type

Range

Default

Location

int > 0 128 user settings.cfg

Width and height of each navmesh tile in voxels.

border size

Type

Range

Default

Location

int ≥ 0 16 user settings.cfg

Size of non-navigable border around heightfield.

max edge len

Type

Range

Default

Location

int ≥ 0 12 user settings.cfg

Max length for contour edges on mesh border.

max nav mesh query nodes

Type

Range

Default

Location

int [1, 65535] 2048 user settings.cfg

Maximum number of search nodes for pathfinding queries.

max polygons per tile

Type

Range

Default

Location

int powers of two [0, 22] 4096 user settings.cfg

Max polygons per navmesh tile. Must satisfy: max tiles number * max polygons per tile ≤ 4194304.

max verts per poly

Type

Range

Default

Location

int ≥ 3 6 user settings.cfg

Max vertices per polygon in mesh.

region merge area

Type

Range

Default

Location

int ≥ 0 400 user settings.cfg

Regions smaller than this may be merged with larger ones.

region min area

Type

Range

Default

Location

int ≥ 0 64 user settings.cfg

Minimum cell count to form isolated regions.

Models Settings
Physics Settings

On this page

  • enable
  • max tiles number
  • wait until min distance to player
  • enable nav mesh disk cache
  • write to navmeshdb
  • max navmeshdb file size
  • async nav mesh updater threads
  • max nav mesh tiles cache size
  • min update interval ms
  • enable write recast mesh to file
  • enable write nav mesh to file
  • enable recast mesh file name revision
  • enable nav mesh file name revision
  • recast mesh path prefix
  • nav mesh path prefix
  • enable nav mesh render
  • nav mesh render mode
  • enable agents paths render
  • enable recast mesh render
  • wait for all jobs on exit
  • recast scale factor
  • max polygon path size
  • max smooth path size
  • cell height
  • cell size
  • detail sample dist
  • detail sample max error
  • max simplification error
  • tile size
  • border size
  • max edge len
  • max nav mesh query nodes
  • max polygons per tile
  • max verts per poly
  • region merge area
  • region min area

© 2024, OpenMW Team Built with Sphinx 7.1.2