From 9d1baac6a0d07c7de5ec71ea970795b39b4a5858 Mon Sep 17 00:00:00 2001 From: PeridexisErrant Date: Wed, 23 Sep 2015 10:38:46 +1000 Subject: [PATCH] Note issue with multidimensional arrays in lua Closes #597. Also remove old TODO in readme. --- README.rst | 2 -- docs/Lua API.rst | 4 ++++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index cb46d46a0..7d8830f45 100644 --- a/README.rst +++ b/README.rst @@ -27,8 +27,6 @@ Documentation DFHack documentation is generated by Sphinx. Check out the table of contents below, or the sources in the docs folder! -TODO: make this work on Github! - Contents for users: diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 345901ca6..0cee9a9dc 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -194,6 +194,10 @@ A container field can associate an enum to the container reference, which allows accessing elements using string keys instead of numerical indices. +Note that two-dimensional arrays in C++ (ie pointers to pointers) +are exposed to lua as one-dimensional. The best way to handle this +is probably ``array[x].value:_displace(y)``. + Implemented features: * ``ref._enum``