2022-02-03 01:05:43 +00:00
|
|
|
---
|
|
|
|
-- `openmw.debug` is an interface to the engine debug utils.
|
|
|
|
-- Can be used only by local scripts, that are attached to a player.
|
2023-01-30 10:13:26 +00:00
|
|
|
-- @module Debug
|
2022-02-03 01:05:43 +00:00
|
|
|
-- @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
|
2023-01-30 10:13:26 +00:00
|
|
|
-- @field [parent=#Debug] #RENDER_MODE RENDER_MODE
|
2022-02-03 01:05:43 +00:00
|
|
|
|
|
|
|
---
|
|
|
|
-- Toggles rendering mode
|
2023-01-30 10:13:26 +00:00
|
|
|
-- @function [parent=#Debug] toggleRenderMode
|
2022-02-03 01:05:43 +00:00
|
|
|
-- @param #RENDER_MODE value
|
|
|
|
|
2023-06-07 20:47:05 +00:00
|
|
|
---
|
|
|
|
-- Toggles god mode
|
|
|
|
-- @function [parent=#Debug] toggleGodMode
|
|
|
|
|
|
|
|
---
|
|
|
|
-- Is god mode enabled
|
|
|
|
-- @function [parent=#Debug] isGodMode
|
|
|
|
-- @return #boolean
|
|
|
|
|
2023-09-15 14:49:46 +00:00
|
|
|
---
|
|
|
|
-- Toggles AI
|
|
|
|
-- @function [parent=#Debug] toggleAI
|
|
|
|
|
|
|
|
---
|
|
|
|
-- Is AI enabled
|
|
|
|
-- @function [parent=#Debug] isAIEnabled
|
|
|
|
-- @return #boolean
|
|
|
|
|
2023-06-07 20:47:05 +00:00
|
|
|
---
|
|
|
|
-- Toggles collisions
|
|
|
|
-- @function [parent=#Debug] toggleCollision
|
|
|
|
|
|
|
|
---
|
|
|
|
-- Is player collision enabled
|
|
|
|
-- @function [parent=#Debug] isCollisionEnabled
|
|
|
|
-- @return #boolean
|
|
|
|
|
2023-09-09 09:42:55 +00:00
|
|
|
---
|
|
|
|
-- Toggles MWScripts
|
|
|
|
-- @function [parent=#Debug] toggleMWScript
|
|
|
|
|
|
|
|
---
|
|
|
|
-- Is MWScripts enabled
|
|
|
|
-- @function [parent=#Debug] isMWScriptEnabled
|
|
|
|
-- @return #boolean
|
|
|
|
|
|
|
|
---
|
|
|
|
-- Reloads all Lua scripts
|
|
|
|
-- @function [parent=#Debug] reloadLua
|
|
|
|
|
2022-02-03 01:05:43 +00:00
|
|
|
---
|
|
|
|
-- 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
|
2023-01-30 10:13:26 +00:00
|
|
|
-- @field [parent=#Debug] #NAV_MESH_RENDER_MODE NAV_MESH_RENDER_MODE
|
2022-02-03 01:05:43 +00:00
|
|
|
|
|
|
|
---
|
|
|
|
-- Sets navigation mesh rendering mode
|
2023-01-30 10:13:26 +00:00
|
|
|
-- @function [parent=#Debug] setNavMeshRenderMode
|
2022-02-03 01:05:43 +00:00
|
|
|
-- @param #NAV_MESH_RENDER_MODE value
|
|
|
|
|
2022-08-04 11:36:24 +00:00
|
|
|
---
|
|
|
|
-- Enable/disable automatic reload of modified shaders
|
2023-01-30 10:13:26 +00:00
|
|
|
-- @function [parent=#Debug] setShaderHotReloadEnabled
|
2022-08-04 11:36:24 +00:00
|
|
|
-- @param #bool value
|
|
|
|
|
|
|
|
---
|
|
|
|
-- To reload modified shaders
|
2023-01-30 10:13:26 +00:00
|
|
|
-- @function [parent=#Debug] triggerShaderReload
|
2022-02-03 01:05:43 +00:00
|
|
|
return nil
|