manual/plugins/lua.tex

   1 \subsection{Lua scripting language}
   2
   3 To quote from the Lua website (\url{http://www.lua.org}), Lua is a ``powerful,
   4 fast, lightweight, embeddable scripting language''. Select a \fname{.lua} file
   5 in the \setting{File Browser} to run it. For more information on programming
   6 in Lua, please see \url{http://www.lua.org/manual/5.1/} and
   7 \url{http://www.lua.org/pil/}.
   8
   9 There are a few exceptions/additions to the Lua support in Rockbox:
  10 \begin{description}
  11     \item[No floating point support.] The number type in Lua is usually float,
  12     however in the Rockbox implementation it is integer.
  13     \item[Non-supported libraries.] The coroutine, debug and math libraries are
  14     not supported.
  15     \item[Partially-supported libraries.]  The os and package libraries are only
  16     partially supported.
  17     \item[Additional libraries.] The bitlib library is integrated to support
  18     bitwise operators.  See \url{http://luaforge.net/projects/bitlib} and
  19     \url{http://lua-users.org/wiki/BitwiseOperators}.
  20 \end{description}
  21
  22 Documentation of the API is still a work in progress, and the API itself is
  23 not finalised. For the latest information, see \wikilink{PluginLua}.\\
  24
  25 \note{Please note that if a script does not provide a way to exit, then
  26 the only way to exit will be to reset the \dap.}