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
Zackhasacat 575fb4e637 Correct docs 2 weeks ago
..
openmw Correct docs 2 weeks ago
CMakeLists.txt Load YAML files via Lua (feature 7590) 2 months ago
README.md Update OpenMW Lua documentation 3 years ago
coroutine.doclua Renormalise line endings 2 years ago
global.doclua Documentation and API fixes (part of !2529) 1 year ago
math.doclua Renormalise line endings 2 years ago
os.doclua Change terminology of gameSecond/gameHour to simulationTime/gameTime 2 years ago
string.doclua Renormalise line endings 2 years ago
table.doclua Renormalise line endings 2 years ago
utf8.doclua add documentation 8 months 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.