1
0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-01-09 12:42:11 +00:00
OpenMW/files/lua_api
psi29a b4f5242b98 Merge branch 'lua-docs-minor-grammar-fixes' into 'master'
Minor grammar fixes for `ambient` `async` and `animation` packages

See merge request OpenMW/openmw!4359
2024-09-26 07:37:11 +00:00
..
openmw Merge branch 'lua-docs-minor-grammar-fixes' into 'master' 2024-09-26 07:37:11 +00:00
CMakeLists.txt Load YAML files via Lua (feature 7590) 2024-03-14 16:29:21 +04:00
coroutine.doclua
global.doclua
math.doclua
os.doclua
README.md
string.doclua
table.doclua
utf8.doclua

Files in this directory describe OpenMW API for Lua Development Tools (LDT).

*.doclua files are taken (with some modifications) from LDT distribution and are distributed under MIT license. Openmw-specific docs (openmw/*.lua) are under GPLv3 license.

To get a Lua IDE with integrated OpenMW documentation and code autocompletion do the following:

  1. Install and run LDT.
  2. Press File / New / Lua Project in menu.
  3. Specify project name (for example the title of your omwaddon)
  4. Set Targeted Execution Environment to No Execution Environment, and Target Grammar to lua-5.1.
  5. Press Next, choose the Libraries tab, and click Add External Source Folder. Then specify there the path to this directory.
  6. Press Finish.