summaryrefslogtreecommitdiff
path: root/Lua API.html
diff options
context:
space:
mode:
authorAlexander Gavrilov2012-08-22 12:28:01 +0400
committerAlexander Gavrilov2012-08-22 12:28:01 +0400
commit2b79582e99654282a03ee10424db380942b04b10 (patch)
tree7d1318c51ac1a6e64fe731b13c5a7f64f25db2cc /Lua API.html
parent8969fc9435859399441cc5bc4f4308411183ef46 (diff)
downloaddfhack-2b79582e99654282a03ee10424db380942b04b10.tar.gz
dfhack-2b79582e99654282a03ee10424db380942b04b10.tar.bz2
dfhack-2b79582e99654282a03ee10424db380942b04b10.tar.xz
Implement a policy of marking DFHack-owned screens with a signature.
Diffstat (limited to 'Lua API.html')
-rw-r--r--Lua API.html6
1 files changed, 5 insertions, 1 deletions
diff --git a/Lua API.html b/Lua API.html
index 610202ce..0f1ecc3b 100644
--- a/Lua API.html
+++ b/Lua API.html
@@ -1391,6 +1391,7 @@ Returns <em>true, was_only_planned</em> if removed; or <em>false</em> if none fo
<p>The screen module implements support for drawing to the tiled screen of the game.
Note that drawing only has any effect when done from callbacks, so it can only
be feasibly used in the core context.</p>
+<p>Basic painting functions:</p>
<ul>
<li><p class="first"><tt class="docutils literal">dfhack.screen.getWindowSize()</tt></p>
<p>Returns <em>width, height</em> of the screen.</p>
@@ -1455,7 +1456,10 @@ functions in this section, this may be used at any time.</p>
</ul>
<p>In order to actually be able to paint to the screen, it is necessary
to create and register a viewscreen (basically a modal dialog) with
-the game. Screens are managed with the following functions:</p>
+the game.</p>
+<p><strong>NOTE</strong>: As a matter of policy, in order to avoid user confusion, all
+interface screens added by dfhack should bear the &quot;DFHack&quot; signature.</p>
+<p>Screens are managed with the following functions:</p>
<ul>
<li><p class="first"><tt class="docutils literal"><span class="pre">dfhack.screen.show(screen[,below])</span></tt></p>
<p>Displays the given screen, possibly placing it below a different one.