nethack-gwaa-kiwi/nethack
1
0
Fork 0
Code Pull Requests Activity

document map column 0

Browse Source 
Something that FIQ once pointed out:  the fact that map column 0 is
not shown wasn't explicitly described anywhere.  Add a paragraph for
NHW_MAP to doc/window.txt and describe it there.
This commit is contained in:
PatR
2022-10-21 15:16:25 -07:00
parent 2caf2423c5
commit b1f7a68636
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/window.txt
View File

@@ -1,4 +1,4 @@
NetHack 3.7 window.txt $NHDT-Date: 1643491505 2022/01/29 21:25:05 $ $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.0 $
NetHack 3.7 window.txt $NHDT-Date: 1666390558 2022/10/21 22:15:58 $ $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.70 $
Introduction
@@ -56,6 +56,18 @@ page using the DEF_PAGER, if DEF_PAGER is defined. There exists an
assumption that the font for text windows is monospaced. The help
files are all formatted accordingly.
NHW_MAP is a persistent window which uses tty-style character cell
column and row as x,y coordinates (even for tiled map). The y or row
coordinate runs from 0 through ROWNO-1 inclusive. The x or column
coordinate runs from _1_ through COLNO-1; column 0 is used by the core
for internal bookkeeping and not drawn on the screen. Most levels
leave some rows and/or columns unused but the core still passes data
(typically 'unexplored' or 'solid stone') for them and those should
be rendered to the screen. The exception is map column 0. The map
window does not need to include room for that; if it does, that column
should be drawn as <space> for text map or the tile specified for
GLYPH_NOTHING for tiled map.
"window" is always of type winid. This is currently implemented as an
integer, but doesn't necessarily have to be done that way. There are
a few fixed window names that are known throughout the code: