Teleport region - Revision history

Cathartes: document exclusion areas: this is the part that actually restricts within-level teleport; destination areas still control level arrival

2024-08-13T03:36:37Z

document exclusion areas: this is the part that actually restricts within-level teleport; destination areas still control level arrival

Cathartes: castle region description

2024-06-22T04:47:26Z

castle region description

Cathartes: fix grammar

2024-06-22T04:40:18Z

fix grammar

Cathartes: also branchport

2024-06-22T04:37:04Z

also branchport

ScienceBall: Small cleanup of wording

2024-06-22T04:29:48Z

Small cleanup of wording

Cathartes: add levels that have teleport regions

2024-06-22T03:06:11Z

add levels that have teleport regions

Cathartes: create article

2024-06-22T02:40:57Z

create article

New page

A '''teleport region''' is a region on a level that controls the possible locations of [[teleport]]s, and placement when arriving to a level via [[hole]], [[trap door]], and [[levelport]]. Teleport regions are defined as rectangular areas in level definition files using the [[Des-file_format#TELEPORT_REGION|TELEPORT_REGION]] directive.

It is not possible to teleport from inside to outside, or from outside to inside, a teleport region.{{refsrc|src/teleport.c|222|nethack=3.6.7|comment=<code>tele_jump_ok()</code> prevents teleporting across a <code>dndest</code> or <code>updest</code> region boundary}}{{refsrc|util/lev_comp.y|1820-L1833|nethack=3.6.7|comment=The DES file parser converts the TELEPORT_REGION directive into a LR_TELE, LR_UPTELE, or LR_DOWNTELE value}}{{refsrc|src/mkmaze.c|505-L530|nethack=3.6.7|comment=<code>fixup_special()</code> converts the <code>LR_*TELE</code> into <code>updest</code> and <code>dndest</code> regions}}

Teleport regions may specify whether they are possible arrival destinations for a particular direction of arrival (upwards, downwards, or both). When arriving at a level via hole, trap door, or levelport, the hero is randomly placed, and will be subject to the teleport region of their arrival direction.{{refsrc|src/dungeon.c|1214|comment=<code>u_on_rndspot()</code> is called when hero is randomly placed while enter a level}}{{refsrc|src/do.c|1540|nethack=3.6.7|comment=<code>u_on_rndspot()</code> call from <code>goto_level</code>}} Monsters and objects are also subject to the teleport region when arriving.{{refsrc|src/teleport.c|1132|nethack=3.6.7|comment=monster arrival}}{{refsrc|src/teleport.c|1446|nethack=3.6.7|comment=object arrival}}

The following special levels contain teleport regions:
{{todo|add levels}}

==References==
<references/>

{{nethack-367}}

@@ Line 1: / Line 1: @@
 A '''teleport region''' is a region on a level that controls the possible locations of [[teleport]]s, and random placement when arriving to a level via [[hole]], [[trap door]], [[levelport]], and [[branchport]].  Teleport regions are defined in level definition files using the [[Des-file_format#TELEPORT_REGION|TELEPORT_REGION]] directive.
-It is not possible to teleport from inside to outside, or from outside to inside, a teleport region.{{refsrc|src/teleport.c|222|nethack=3.6.7|comment=<code>tele_jump_ok()</code> prevents teleporting across a <code>dndest</code> or <code>updest</code> region boundary}}{{refsrc|util/lev_comp.y|1820-L1833|nethack=3.6.7|comment=The DES file parser converts the <code>TELEPORT_REGION</code> directive into a <code>LR_TELE</code>, <code>LR_UPTELE</code>, or <code>LR_DOWNTELE</code> value}}{{refsrc|src/mkmaze.c|505-L530|nethack=3.6.7|comment=<code>fixup_special()</code> converts the <code>LR_*TELE</code> into <code>updest</code> and <code>dndest</code> regions}}
+Each teleport region may define two rectangular areas:{{refsrc|include/dungeon.h|49|nethack=3.6.7}}
 Teleport regions may specify whether they are possible arrival destinations for a particular direction of arrival (upwards, downwards, or both).  When arriving at a level via hole, trap door, levelport, or branchport, the hero is randomly placed, and will be subject to the teleport region of their arrival direction.{{refsrc|src/dungeon.c|1214|nethack=3.6.7|comment=<code>u_on_rndspot()</code> is called when hero is randomly placed while entering a level}}{{refsrc|src/do.c|1540|nethack=3.6.7|comment=<code>u_on_rndspot()</code> call from <code>goto_level()</code>}}  Monsters and objects are also subject to the teleport region when arriving.{{refsrc|src/teleport.c|1132|nethack=3.6.7|comment=monster arrival}}{{refsrc|src/teleport.c|1446|nethack=3.6.7|comment=object arrival}}
@@ Line 22: / Line 26: @@
 * [[Orctown]], to prevent arriving inside the town when being randomly placed on the level.
-{{upcoming|NetHack 3.7.0|As of {{commit|c4c31ae6a8cdab60b319cc8b355445968e8ec286}}, [[Mines' End#The Gnome King's Wine Cellar|the wine cellar]] version of Mines' End has a teleport region to exclude the treasure chamber as an arrival location.}}
+{{upcoming|NetHack 3.7.0|As of {{commit|c4c31ae6a8cdab60b319cc8b355445968e8ec286}}, [[Mines' End#The Gnome King's Wine Cellar|the wine cellar]] version of Mines' End has a teleport region to force arrival in the room containing the stairs.}}
 ==References==

@@ Line 7: / Line 7: @@
 The following special levels contain teleport regions:
 {{todo|Add the missing boundary descriptions}}
-* The [[Castle]] has 2 teleport regions, one each for upward and downward arrival.
+* The [[Castle]] has two teleport regions, one each for upward and downward arrival. The maze containing the upstair is for downward arrival, while the opposite-side maze is for upward arrival.
-* [[Medusa's Island]], all four versions, in order to place arrival locations near the appropriate stairs.  The third version only has a teleport region for downwards arrival, while the others have both upward and downward regions.
+* [[Medusa's Island]], all four versions, in order to place arrival locations near the appropriate stairs.  The third version only has a teleport region for downward arrival, while the others have both upward and downward regions.
 * [[Big Room#Big_Room_.2310|Big Room #10]], preventing downwards arrival into the fog maze.
 * [[Endgame]] levels, controlling arrival location.

@@ Line 3: / Line 3: @@
 It is not possible to teleport from inside to outside, or from outside to inside, a teleport region.{{refsrc|src/teleport.c|222|nethack=3.6.7|comment=<code>tele_jump_ok()</code> prevents teleporting across a <code>dndest</code> or <code>updest</code> region boundary}}{{refsrc|util/lev_comp.y|1820-L1833|nethack=3.6.7|comment=The DES file parser converts the <code>TELEPORT_REGION</code> directive into a <code>LR_TELE</code>, <code>LR_UPTELE</code>, or <code>LR_DOWNTELE</code> value}}{{refsrc|src/mkmaze.c|505-L530|nethack=3.6.7|comment=<code>fixup_special()</code> converts the <code>LR_*TELE</code> into <code>updest</code> and <code>dndest</code> regions}}
-Teleport regions may specify whether they are possible arrival destinations for a particular direction of arrival (upwards, downwards, or both).  When arriving at a level via hole, trap door, levelport, or branchport, the hero is randomly placed, and will be subject to the teleport region of their arrival direction.{{refsrc|src/dungeon.c|1214|nethack=3.6.7|comment=<code>u_on_rndspot()</code> is called when hero is randomly placed while enter a level}}{{refsrc|src/do.c|1540|nethack=3.6.7|comment=<code>u_on_rndspot()</code> call from <code>goto_level()</code>}}  Monsters and objects are also subject to the teleport region when arriving.{{refsrc|src/teleport.c|1132|nethack=3.6.7|comment=monster arrival}}{{refsrc|src/teleport.c|1446|nethack=3.6.7|comment=object arrival}}
+Teleport regions may specify whether they are possible arrival destinations for a particular direction of arrival (upwards, downwards, or both).  When arriving at a level via hole, trap door, levelport, or branchport, the hero is randomly placed, and will be subject to the teleport region of their arrival direction.{{refsrc|src/dungeon.c|1214|nethack=3.6.7|comment=<code>u_on_rndspot()</code> is called when hero is randomly placed while entering a level}}{{refsrc|src/do.c|1540|nethack=3.6.7|comment=<code>u_on_rndspot()</code> call from <code>goto_level()</code>}}  Monsters and objects are also subject to the teleport region when arriving.{{refsrc|src/teleport.c|1132|nethack=3.6.7|comment=monster arrival}}{{refsrc|src/teleport.c|1446|nethack=3.6.7|comment=object arrival}}
 The following special levels contain teleport regions:

@@ Line 1: / Line 1: @@
-A '''teleport region''' is a region on a level that controls the possible locations of [[teleport]]s, and placement when arriving to a level via [[hole]], [[trap door]], and [[levelport]].  Teleport regions are defined in level definition files using the [[Des-file_format#TELEPORT_REGION|TELEPORT_REGION]] directive.
+A '''teleport region''' is a region on a level that controls the possible locations of [[teleport]]s, and random placement when arriving to a level via [[hole]], [[trap door]], [[levelport]], and [[branchport]].  Teleport regions are defined in level definition files using the [[Des-file_format#TELEPORT_REGION|TELEPORT_REGION]] directive.
-It is not possible to teleport from inside to outside, or from outside to inside, a teleport region.{{refsrc|src/teleport.c|222|nethack=3.6.7|comment=<code>tele_jump_ok()</code> prevents teleporting across a <code>dndest</code> or <code>updest</code> region boundary}}{{refsrc|util/lev_comp.y|1820-L1833|nethack=3.6.7|comment=The DES file parser converts the TELEPORT_REGION directive into a LR_TELE, LR_UPTELE, or LR_DOWNTELE value}}{{refsrc|src/mkmaze.c|505-L530|nethack=3.6.7|comment=<code>fixup_special()</code> converts the <code>LR_*TELE</code> into <code>updest</code> and <code>dndest</code> regions}}
+It is not possible to teleport from inside to outside, or from outside to inside, a teleport region.{{refsrc|src/teleport.c|222|nethack=3.6.7|comment=<code>tele_jump_ok()</code> prevents teleporting across a <code>dndest</code> or <code>updest</code> region boundary}}{{refsrc|util/lev_comp.y|1820-L1833|nethack=3.6.7|comment=The DES file parser converts the <code>TELEPORT_REGION</code> directive into a <code>LR_TELE</code>, <code>LR_UPTELE</code>, or <code>LR_DOWNTELE</code> value}}{{refsrc|src/mkmaze.c|505-L530|nethack=3.6.7|comment=<code>fixup_special()</code> converts the <code>LR_*TELE</code> into <code>updest</code> and <code>dndest</code> regions}}
-Teleport regions may specify whether they are possible arrival destinations for a particular direction of arrival (upwards, downwards, or both).  When arriving at a level via hole, trap door, or levelport, the hero is randomly placed, and will be subject to the teleport region of their arrival direction.{{refsrc|src/dungeon.c|1214|nethack=3.6.7|comment=<code>u_on_rndspot()</code> is called when hero is randomly placed while enter a level}}{{refsrc|src/do.c|1540|nethack=3.6.7|comment=<code>u_on_rndspot()</code> call from <code>goto_level()</code>}}  Monsters and objects are also subject to the teleport region when arriving.{{refsrc|src/teleport.c|1132|nethack=3.6.7|comment=monster arrival}}{{refsrc|src/teleport.c|1446|nethack=3.6.7|comment=object arrival}}
+Teleport regions may specify whether they are possible arrival destinations for a particular direction of arrival (upwards, downwards, or both).  When arriving at a level via hole, trap door, levelport, or branchport, the hero is randomly placed, and will be subject to the teleport region of their arrival direction.{{refsrc|src/dungeon.c|1214|nethack=3.6.7|comment=<code>u_on_rndspot()</code> is called when hero is randomly placed while enter a level}}{{refsrc|src/do.c|1540|nethack=3.6.7|comment=<code>u_on_rndspot()</code> call from <code>goto_level()</code>}}  Monsters and objects are also subject to the teleport region when arriving.{{refsrc|src/teleport.c|1132|nethack=3.6.7|comment=monster arrival}}{{refsrc|src/teleport.c|1446|nethack=3.6.7|comment=object arrival}}
 The following special levels contain teleport regions:
@@ Line 19: / Line 19: @@
 * [[Baalzebub's Lair]]
 * [[Moloch's Sanctum]]
-* [[Fort Ludios]]
+* [[Fort Ludios]]: although it is not possible to arrive here by falling or levelport, it is possible to arrive by branchport, and the teleport region will ensure placement in the small room containing the portal.
 * [[Orctown]], to prevent arriving inside the town when being randomly placed on the level.

@@ Line 20: / Line 20: @@
 * [[Moloch's Sanctum]]
 * [[Fort Ludios]]
-* [[Orctown]], to exclude the arriving inside the town when being randomly placed on the level.
+* [[Orctown]], to prevent arriving inside the town when being randomly placed on the level.
 {{upcoming|NetHack 3.7.0|As of {{commit|c4c31ae6a8cdab60b319cc8b355445968e8ec286}}, [[Mines' End#The Gnome King's Wine Cellar|the wine cellar]] version of Mines' End has a teleport region to exclude the treasure chamber as an arrival location.}}