You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openmw/files/lua_api
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
1 year ago
..
openmw Merge branch 'kantoniak/lua-docs-fixes' into 'master' 1 year ago
CMakeLists.txt make sure lua works with macos packages (!2687 for 0.48) 1 year ago
README.md Update OpenMW Lua documentation 3 years ago
coroutine.doclua Update OpenMW Lua documentation 3 years ago
global.doclua Remove accidental copy-paste in global.doclua 1 year ago
math.doclua Update OpenMW Lua documentation 3 years ago
os.doclua Change terminology of gameSecond/gameHour to simulationTime/gameTime 2 years ago
string.doclua Update OpenMW Lua documentation 3 years ago
table.doclua Update OpenMW Lua documentation 3 years ago

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.