MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix _field method documentation

develop
vallode 2023-11-14 11:19:51 +01:00
parent 3b1df48bae
commit 55d03696ae
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/dev/Lua API.rst
Unescape Escape View File

@ -197,11 +197,12 @@ They implement the following features:
are automatically exposed in their exact type, and the reverse are automatically exposed in their exact type, and the reverse
rule would make access to superclass fields unreliable. rule would make access to superclass fields unreliable.
* ``ref._field(field)`` * ``ref:_field(field)``
Returns a reference to a valid field. That is, unlike regular Returns a reference to a valid field. That is, unlike regular
subscript, it returns a reference to the field within the structure subscript, it returns a reference to the field within the structure
even for primitive typed fields and pointers. even for primitive typed fields and pointers. Fails with an error
if the field is not found.
* ``ref:vmethod(args...)`` * ``ref:vmethod(args...)``
@ -246,7 +247,7 @@ Implemented features:
may return a default value, or auto-resize instead for convenience. may return a default value, or auto-resize instead for convenience.
Currently this relaxed mode is implemented by df-flagarray aka BitArray. Currently this relaxed mode is implemented by df-flagarray aka BitArray.
* ``ref._field(index)`` * ``ref:_field(index)``
Like with structs, returns a pointer to the array element, if possible. Like with structs, returns a pointer to the array element, if possible.
Flag and bit arrays cannot return such pointer, so it fails with an error. Flag and bit arrays cannot return such pointer, so it fails with an error.