summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/techspecs/luaengine.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2020-12-13 09:54:03 +1100
committer Vas Crabb <vas@vastheman.com>2020-12-13 09:54:03 +1100
commit4d7ef2749083e5e3aaf41e5b2c6b03a93c237c47 (patch)
tree47076411b64212db0145e73f953325affa9d49dc /docs/source/techspecs/luaengine.rst
parentbc951bcfa9c9b4a54e40dc3ab5559531f820fafc (diff)
-luaengine.cpp: Clean up render classes and expose screen image adjustments.
* Started moving Lua class reference to docs. Expecting people to find the class reference material in the source isn’t going to help make it approachable. The docs allow longer explanations, better formatting, and cross reference links. * Added another layout scripting example to the docs. -goldnpkr.cpp: Minor clean-up. * Improved the short names for Witch Card and Witch Game clone sets. * Made Witch Up & Down artwork clickable. * Added working Video Klein sets where the parent is a working Video Klein set to the tiny subtarget. * Removed history from the header comment - we have version control for a readon.
Diffstat (limited to 'docs/source/techspecs/luaengine.rst')
-rw-r--r--docs/source/techspecs/luaengine.rst20
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/source/techspecs/luaengine.rst b/docs/source/techspecs/luaengine.rst
index 4b9c3f0e555..22981fe79e6 100644
--- a/docs/source/techspecs/luaengine.rst
+++ b/docs/source/techspecs/luaengine.rst
@@ -1,6 +1,13 @@
-Scripting MAME via LUA
+.. _luaengine:
+
+Scripting MAME via Lua
======================
+.. contents:: :local:
+
+
+.. _luaengine-intro:
+
Introduction
------------
@@ -19,6 +26,9 @@ change without prior notice. However, we expose methods to let you know at
runtime which API version you are running against, and most of the objects
support runtime you can introspection.
+
+.. _luaengine-features:
+
Features
--------
@@ -34,6 +44,9 @@ currently available to Lua scripts:
- memory read/write (8/16/32/64 bits, signed and unsigned)
- register and state control (state enumeration, get and set)
+
+.. _luaengine-usage:
+
Usage
-----
@@ -52,10 +65,13 @@ approach. The former is not encouraged as it is resource-intensive and makes
control flow unnecessarily complex. Instead, we suggest to register custom
hooks to be invoked on specific events (e.g. at each frame rendering).
+
+.. _luaengine-walkthrough:
+
Walkthrough
-----------
-Let's first run MAME in a terminal to reach the LUA console:
+Let's first run MAME in a terminal to reach the Lua console:
::