Files
ashlar/files/lua_api/openmw/debug.lua
T
Bret Curtis fb8f8b8c2c Add openmw.debug.takeScreenshot() and configurable test resolution
Lua had no way to fire a screenshot. Also stops integration_tests.py merging a
caller's --config settings.cfg into the generated one, which made a same-layer
duplicate that openmw rejects, and unhardcodes the 640x480 test window.
2026-09-12 18:20:20 +02:00

100 lines
2.5 KiB
Lua

---
-- Provides an interface to the engine debug utils.
-- @context player
-- @module Debug
-- @usage local debug = require('openmw.debug')
---
-- Rendering modes
-- @type RENDER_MODE
-- @field [parent=#RENDER_MODE] #number CollisionDebug
-- @field [parent=#RENDER_MODE] #number Wireframe
-- @field [parent=#RENDER_MODE] #number Pathgrid
-- @field [parent=#RENDER_MODE] #number Water
-- @field [parent=#RENDER_MODE] #number Scene
-- @field [parent=#RENDER_MODE] #number NavMesh
-- @field [parent=#RENDER_MODE] #number ActorsPaths
-- @field [parent=#RENDER_MODE] #number RecastMesh
---
-- Rendering mode values
-- @field [parent=#Debug] #RENDER_MODE RENDER_MODE
---
-- Toggles rendering mode
-- @function [parent=#Debug] toggleRenderMode
-- @param #RENDER_MODE value
---
-- Toggles god mode
-- @function [parent=#Debug] toggleGodMode
---
-- Is god mode enabled
-- @function [parent=#Debug] isGodMode
-- @return #boolean
---
-- Toggles AI
-- @function [parent=#Debug] toggleAI
---
-- Is AI enabled
-- @function [parent=#Debug] isAIEnabled
-- @return #boolean
---
-- Toggles collisions
-- @function [parent=#Debug] toggleCollision
---
-- Is player collision enabled
-- @function [parent=#Debug] isCollisionEnabled
-- @return #boolean
---
-- Toggles MWScripts
-- @function [parent=#Debug] toggleMWScript
---
-- Is MWScripts enabled
-- @function [parent=#Debug] isMWScriptEnabled
-- @return #boolean
---
-- Reloads all Lua scripts
-- @function [parent=#Debug] reloadLua
---
-- Takes a screenshot, as if the screenshot key had been pressed. The screenshot is
-- captured on the next frame and written asynchronously to the screenshots directory
-- in the user data folder, using the configured screenshot format. Quitting the game
-- immediately afterwards discards a screenshot that has not finished writing.
-- @function [parent=#Debug] takeScreenshot
---
-- Navigation mesh rendering modes
-- @type NAV_MESH_RENDER_MODE
-- @field [parent=#NAV_MESH_RENDER_MODE] #number AreaType
-- @field [parent=#NAV_MESH_RENDER_MODE] #number UpdateFrequency
---
-- Navigation mesh rendering mode values
-- @field [parent=#Debug] #NAV_MESH_RENDER_MODE NAV_MESH_RENDER_MODE
---
-- Sets navigation mesh rendering mode
-- @function [parent=#Debug] setNavMeshRenderMode
-- @param #NAV_MESH_RENDER_MODE value
---
-- Enable/disable automatic reload of modified shaders
-- @function [parent=#Debug] setShaderHotReloadEnabled
-- @param #boolean value
---
-- To reload modified shaders
-- @function [parent=#Debug] triggerShaderReload
return nil