Lua API

This page is about how to use Lua API functions. If you want general information on Lua such as how to run a script and script usage please read Lua scripts.

The goal of the Lua API is to provide extensive support and to provide both low level and high level access to all internal data stored in Retro Graphics Toolkit, and to allow for both platform (the game console you have currently selected) depended and independent functions.

Another note about the API these functions are designed to not cause a crash even when called with invalid/incorrect parameters. If this happen it is a bug and it should be reported.

Currently the best documentation on these functions is the source code runlua.cpp. I have also wrote many examples of calling these API functions here luaExamples however these do not necessarily cover all functions.