mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-01-31 20:45:34 +00:00
Code Issues Releases Wiki Activity
openmw/files/lua_api
History
psi29a 7a52b9d1d8 Merge branch 'kantoniak/lua-docs-fixes' into 'master' 
Apply minor fixes to Lua documentation

See merge request OpenMW/openmw!2785

(cherry picked from commit 56c8c25a0e)

ccdd381f Minor fixes to Lua documentation
2023-03-01 21:08:03 +00:00
..
openmw Merge branch 'kantoniak/lua-docs-fixes' into 'master' 2023-03-01 21:08:03 +00:00
CMakeLists.txt make sure lua works with macos packages (!2687 for 0.48) 2023-02-27 22:20:10 +01:00
coroutine.doclua Update OpenMW Lua documentation 2021-07-09 20:48:54 +02:00
global.doclua Remove accidental copy-paste in global.doclua 2023-01-27 18:31:04 +01:00
math.doclua Update OpenMW Lua documentation 2021-07-09 20:48:54 +02:00
os.doclua Change terminology of gameSecond/gameHour to simulationTime/gameTime 2022-01-10 21:03:35 +01:00
README.md Update OpenMW Lua documentation 2021-07-09 20:48:54 +02:00
string.doclua Update OpenMW Lua documentation 2021-07-09 20:48:54 +02:00
table.doclua Update OpenMW Lua documentation 2021-07-09 20:48:54 +02:00

README.md

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.