summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-09-07 11:36:45 +0400
committerAlexander Gavrilov2012-09-07 11:36:45 +0400
commite925d8f4d999817d3ccf7f3180e7abee382e03b4 (patch)
tree5a48c08b6c8a45aa3cf85e7d4b05e79cc2d4e028 /Lua API.html
parentc971a819def1c5cc29dc926f62456c336a1dfa17 (diff)
downloaddfhack-e925d8f4d999817d3ccf7f3180e7abee382e03b4.tar.gz
dfhack-e925d8f4d999817d3ccf7f3180e7abee382e03b4.tar.bz2
dfhack-e925d8f4d999817d3ccf7f3180e7abee382e03b4.tar.xz
Add an API function for reading tiles from the screen buffers.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html4
1 files changed, 4 insertions, 0 deletions
diff --git a/Lua API.html b/Lua API.html
index 546d2740..dc9c8d73 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -1480,6 +1480,10 @@ Otherwise should be <em>true/false</em>.</p>
</dl>
<p>Returns <em>false</em> if coordinates out of bounds, or other error.</p>
</li>
+<li><p class="first"><tt class="docutils literal">dfhack.screen.readTile(x,y)</tt></p>
+<p>Retrieves the contents of the specified tile from the screen buffers.
+Returns a pen, or <em>nil</em> if invalid or TrueType.</p>
+</li>
<li><p class="first"><tt class="docutils literal">dfhack.screen.paintString(pen,x,y,text)</tt></p>
<p>Paints the string starting at <em>x,y</em>. Uses the string characters
in sequence to override the <tt class="docutils literal">ch</tt> field of pen.</p>