History

Guldoman dd75e676bc Fix running `core.step` when receiving an event while not waiting When `time_to_wake` was <= 0, so when a coroutine needed to be executed as soon as possible, we didn't check for events, so we only performed a `core.step` with the blink timer. This resulted in jerky reactions to input.		2023-11-29 09:11:39 +08:00
..
api	Fix running `core.step` when receiving an event while not waiting	2023-11-29 09:11:39 +08:00
README.md	Added README to docs directory.	2021-06-25 03:03:07 -04:00

README.md

Interface Files

This directory holds the documentation for the Lua C API that is hidden in the C source files of Lite. The idea of these files is to serve you as a quick reference about the functionality that is not written in Lua it self. Please note that they don't have any real code, just metadata or annotations.

Also, these interfaces are using EmmyLua annotation syntax which is supported by LSP servers like the Sumneko Lua LSP. This means that you can get nice code autocompletion and descriptions of Lite core libraries and symbols when developing plugins or adding any options to your User Module File (init.lua).

The Base Core

Most of the code that is written in Lua for Lite is powered by the exposed C API in the four namespaces that follow:

Finally, all global variables are documented in the file named globals.lua.