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

Standardize all core and obj functions with relative coords

Browse Source 
This is a large iteration on a previous implementation of making
nh.getmap() parse its coordinates as relative to the last defined map or
room rather than absolute to the entire level. Now, everything in the
nh.* and obj.* functions interprets coords as relative rather than
absolute. (By default; if no map or room has been defined, or if the lua
code is executing after level creation is done, they will interpret the
coordinates as absolute).

The general motivation is basically the same - routines that use
absolute coordinates are difficult to use in level creation routines,
because then the designer has to remember to convert the relative
coordinate to an absolute one (and that was impossible before
nh.abscoord was added, particularly in themed rooms). And once
nh.getmap() takes relative coordinates, it would be very strange to have
all the other functions (setting timers, burying objects, etc) remain
with absolute ones.

In a couple places, code is changed to account for coordinates that are
relative to a *room* (which uses g.coder->croom->[lx,ly] as an offset,
instead of relative to a *map*, which uses [xstart,ystart].
Specifically, selection.iterate did not account for this, and without
this the ice themed room timer was not being started in the proper
place.

All tests are updated to respect the new behavior. Most of the modified
functions are not actually used anywhere in level files; the one
exception is starting a timer in a themed room, and that has been
adjusted.

Documentation updated as well to clarify when various things are tossing
around relative and absolute coordinates, both in comments and in
lua.adoc.
This commit is contained in:
copperwater
2022-08-30 18:07:07 -04:00
committed by Pasi Kallinen
parent a30a45be46
commit f71bff3285
9 changed files with 138 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
src/sp_lev.c
View File

@@ -1150,11 +1150,15 @@ rndtrap(void)
}
/*
* Coordinates in special level files are handled specially:
* Translate a given coordinate from a special level definition into an actual
* location on the map.
*
* if x or y is < 0, we generate a random coordinate.
* The "humidity" flag is used to ensure that engravings aren't
* created underwater, or eels on dry land.
* If x or y is negative, we generate a random coordinate within the area. If
* not negative, they are interpreted as relative to the last defined map or
* room, and are output as absolute g.level.locations coordinates.
*
* The "humidity" flag is used to ensure that engravings aren't created
* underwater, or eels on dry land.
*/
static void
get_location(
@@ -3085,6 +3089,12 @@ get_table_montype(lua_State *L, int *mgender)
return ret;
}
/* Get x and y values from a table (which the caller has already checked for the
* existence of), handling both a table with x= and y= specified and a table
* with coord= specified.
* Returns absolute rather than map-relative coordinates; the caller of this
* function must decide if it wants to interpret the coordinates as map-relative
* and adjust accordingly. */
static void
get_table_xy_or_coord(lua_State *L, lua_Integer *x, lua_Integer *y)
{
@@ -5237,7 +5247,56 @@ l_table_getset_feature_flag(
}
}
/* convert relative coordinate to map-absolute.
/* guts of nhl_abs_coord; convert a coordinate relative to a map or room into an
* absolute coordinate in g.level.locations.
*
* If there is no enclosing map or room, the coordinates are assumed to be
* absolute already.
*
* Part of the reason this is a function is to make it clearer in the calling
* code that this conversion is what is intended.
*
* NOTE: if the coordinates are going to get passed to one of the get_location
* family of functions, this should NOT be called; get_location already makes
* an adjustment like this. (What this function supports which get_location
* doesn't is the input coordinates being negative. get_location will treat that
* as "level designer wants a random coordinate".) */
void
cvt_to_abscoord(coordxy *x, coordxy *y)
{
/* since commit 99715e0, xstart and ystart are only relevant in mklev when
* maps are being used, and 0 otherwise. It is possible in the future that
* map positions and dimensions can be saved and retrieved outside of mklev
* which would reintroduce nonzero xstart/ystart/xsiz/ysiz, but this is not
* currently implemented, so this function can be assumed to have no effect
* outside of mklev.
*/
if (g.coder && g.coder->croom) {
*x += g.coder->croom->lx;
*y += g.coder->croom->ly;
}
else {
*x += g.xstart;
*y += g.ystart;
}
}
/* inverse of cvt_to_abscoord; turn an absolute g.level.locations coordinate
* into one relative to the current map or room. */
void
cvt_to_relcoord(coordxy *x, coordxy *y)
{
if (g.coder && g.coder->croom) {
*x -= g.coder->croom->lx;
*y -= g.coder->croom->ly;
}
else {
*x -= g.xstart;
*y -= g.ystart;
}
}
/* convert map-relative coordinate to absolute.
local ax,ay = nh.abscoord(rx, ry);
local pt = nh.abscoord({ x = 10, y = 5 });
*/
@@ -5250,16 +5309,14 @@ nhl_abs_coord(lua_State *L)
if (argc == 2) {
x = (coordxy) lua_tointeger(L, 1);
y = (coordxy) lua_tointeger(L, 2);
x += g.xstart;
y += g.ystart;
cvt_to_abscoord(&x, &y);
lua_pushinteger(L, x);
lua_pushinteger(L, y);
return 2;
} else if (argc == 1 && lua_type(L, 1) == LUA_TTABLE) {
x = (coordxy) get_table_int(L, "x");
y = (coordxy) get_table_int(L, "y");
x += g.xstart;
y += g.ystart;
cvt_to_abscoord(&x, &y);
lua_newtable(L);
nhl_add_table_entry_int(L, "x", x);
nhl_add_table_entry_int(L, "y", y);