From 2b79582e99654282a03ee10424db380942b04b10 Mon Sep 17 00:00:00 2001 From: Alexander Gavrilov Date: Wed, 22 Aug 2012 12:28:01 +0400 Subject: Implement a policy of marking DFHack-owned screens with a signature. --- Lua API.html | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'Lua API.html') 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 true, was_only_planned if removed; or false if none fo
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.
+Basic painting functions:
dfhack.screen.getWindowSize()
Returns width, height of the screen.
@@ -1455,7 +1456,10 @@ functions in this section, this may be used at any time.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:
+the game. +NOTE: As a matter of policy, in order to avoid user confusion, all +interface screens added by dfhack should bear the "DFHack" signature.
+Screens are managed with the following functions:
dfhack.screen.show(screen[,below])
Displays the given screen, possibly placing it below a different one. -- cgit v1.2.1