Note issue with multidimensional arrays in lua

Closes #597.  Also remove old TODO in readme.
develop
PeridexisErrant 2015-09-23 10:38:46 +10:00
parent bc5f7f329a
commit 9d1baac6a0
2 changed files with 4 additions and 2 deletions

@ -27,8 +27,6 @@ Documentation
DFHack documentation is generated by Sphinx. Check out the table of contents DFHack documentation is generated by Sphinx. Check out the table of contents
below, or the sources in the docs folder! below, or the sources in the docs folder!
TODO: make this work on Github!
Contents for users: Contents for users:

@ -194,6 +194,10 @@ A container field can associate an enum to the container
reference, which allows accessing elements using string keys reference, which allows accessing elements using string keys
instead of numerical indices. 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: Implemented features:
* ``ref._enum`` * ``ref._enum``