isaacscript-common 6.12.0 → 6.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "6.12.0",
+  "version": "6.15.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/index",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.34"
+    "isaac-typescript-definitions": "^3.0.35"
   }
 }

package/src/callbacks/postPickupInitFirst.ts

@@ -29,6 +29,8 @@ function postPickupInit(pickup: EntityPickup) {
     return;
   }
 
+  // The room visited count is not reset when re-entering a Treasure Room or Boss room in the
+  // Ascent.
   const roomVisitedCount = getRoomVisitedCount();
   if (roomVisitedCount > 0) {
     return;

package/src/enums/private/SerializationBrand.ts

@@ -2,7 +2,7 @@
  * During serialization, we write an arbitrary string key to the object with a value of an empty
  * string. This is used during deserialization to instantiate the correct type of object.
  *
- * Note that we do not bother branding TSTL classes because we have no way to invoke the proper
+ * Note that we do not bother branding TSTL classes because we have no way to run the proper
  * constructor during deserialization.
  */
 export enum SerializationBrand {

package/src/features/collectibleItemPoolType.ts

@@ -1,5 +1,5 @@
 // The item pool type of a collectible is not stored on the collectible. Thus, we scan for incoming
-// item pool types in the PreGetCollectible callback, and then assume that the next spawned
+// item pool types in the `PRE_GET_COLLECTIBLE` callback, and then assume that the next spawned
 // collectible has this item pool type.
 
 import {
@@ -45,8 +45,8 @@ function postPickupInitCollectible(pickup: EntityPickup) {
 
 /**
  * Helper function to get the item pool type that a given collectible came from. Since there is no
- * native method in the API to get this, we listen in the PreGetCollectible callback for item pool
- * types, and then assume that the next spawned collectible will match.
+ * native method in the API to get this, we listen in the `PRE_GET_COLLECTIBLE` callback for item
+ * pool types, and then assume that the next spawned collectible will match.
  */
 export function getCollectibleItemPoolType(
   collectible: EntityPickup,

package/src/features/customGridEntity.ts

@@ -228,8 +228,8 @@ export function spawnCustomGridEntity(
  *                   Default is true. This is generally a good idea because if the room is not
  *                   updated, you will be unable to spawn another grid entity on the same tile until
  *                   a frame has passed. However, doing this is expensive, since it involves a call
- *                   to `Isaac.GetRoomEntities`, so set it to false if you need to invoke this
- *                   function multiple times.
+ *                   to `Isaac.GetRoomEntities`, so set it to false if you need to run this function
+ *                   multiple times.
  * @returns The grid entity that was removed. Returns undefined if no grid entity was found at the
  *          given location or if the given grid entity was not a custom grid entity.
  */

package/src/features/customTrapdoor/blackSprite.ts

@@ -1,16 +1,22 @@
 import { VectorZero } from "../../constants";
 import { StageTravelState } from "../../enums/private/StageTravelState";
-import { ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH } from "../customStage/customStageConstants";
 import v from "./v";
 
-const sprite = Sprite();
-sprite.Load(`${ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH}/black.anm2`, true);
-sprite.SetFrame("Default", 0);
+// In order to represent a black sprite, we just use the first frame of the boss versus screen
+// animation. However, we must lazy load the sprite in order to prevent issues with mods that
+// replace the vanilla files. (For some reason, loading the sprites will cause the overwrite to no
+// longer apply on the second and subsequent runs.)
+const blackSprite = Sprite();
 
 export function drawBlackSprite(): void {
   if (v.run.state !== StageTravelState.PAUSING_ON_BLACK) {
     return;
   }
 
-  sprite.RenderLayer(0, VectorZero);
+  if (!blackSprite.IsLoaded()) {
+    blackSprite.Load("gfx/ui/boss/versusscreen.anm2", true);
+    blackSprite.SetFrame("Scene", 0);
+  }
+
+  blackSprite.RenderLayer(0, VectorZero);
 }

package/src/features/extraConsoleCommands/exports.ts

@@ -24,9 +24,10 @@ export function enableExtraConsoleCommands(mod: ModUpgraded): void {
  *
  * The standard library comes with many existing console commands that are useful for debugging, but
  * you can also add your own commands that are useful for your particular mod. It's easier to add
- * commands to the existing command system than to add logic manually to the ExecuteCmd callback.
+ * commands to the existing command system than to add your own logic manually to the `EXECUTE_CMD`
+ * callback.
  *
- * Before using this function, you must first invoke `enableExtraConsoleCommands`.
+ * Before using this function, you must first run the `enableExtraConsoleCommands` function.
  */
 export function addConsoleCommand(
   commandName: string,
@@ -59,7 +60,7 @@ export function addConsoleCommand(
  * The standard library comes with many existing console commands that are useful for debugging. If
  * you want to disable one of them, use this function.
  *
- * Before using this function, you must first invoke `enableExtraConsoleCommands`.
+ * Before using this function, you must first run the `enableExtraConsoleCommands` function.
  */
 export function removeConsoleCommand(commandName: string): void {
   if (!isExtraConsoleCommandsInitialized()) {

package/src/features/extraConsoleCommands/init.ts

@@ -27,7 +27,7 @@ export function extraConsoleCommandsInit(mod: ModUpgraded): void {
 function initMap() {
   extraConsoleCommandsFunctionMap.set("1hp", commands.oneHP);
   extraConsoleCommandsFunctionMap.set("addCharges", commands.addCharges);
-  extraConsoleCommandsFunctionMap.set("angel", commands.angel);
+  extraConsoleCommandsFunctionMap.set("angelRoom", commands.angelRoom);
   extraConsoleCommandsFunctionMap.set("ascent", commands.ascent);
   extraConsoleCommandsFunctionMap.set("bedroom", commands.bedroom);
   extraConsoleCommandsFunctionMap.set("bh", commands.bh);
@@ -46,7 +46,7 @@ function initMap() {
   );
   extraConsoleCommandsFunctionMap.set("bombs", commands.bombs);
   extraConsoleCommandsFunctionMap.set("boneHearts", commands.boneHearts);
-  extraConsoleCommandsFunctionMap.set("boss", commands.boss);
+  extraConsoleCommandsFunctionMap.set("bossRoom", commands.bossRoom);
   extraConsoleCommandsFunctionMap.set("bossRush", commands.bossRush);
   extraConsoleCommandsFunctionMap.set("brokenHearts", commands.brokenHearts);
   extraConsoleCommandsFunctionMap.set("card", commands.card);
@@ -66,7 +66,7 @@ function initMap() {
   extraConsoleCommandsFunctionMap.set("d6", commands.d6);
   extraConsoleCommandsFunctionMap.set("damage", commands.damage);
   extraConsoleCommandsFunctionMap.set("dd", commands.dd);
-  extraConsoleCommandsFunctionMap.set("devil", commands.devil);
+  extraConsoleCommandsFunctionMap.set("devilRoom", commands.devilRoom);
   extraConsoleCommandsFunctionMap.set("dirtyBedroom", commands.dirtyBedroom);
   extraConsoleCommandsFunctionMap.set("disableCurses", commands.disableCurses);
   extraConsoleCommandsFunctionMap.set(
@@ -89,7 +89,7 @@ function initMap() {
     commandsDisplay.effectsDisplay,
   );
   extraConsoleCommandsFunctionMap.set("eh", commands.eh);
-  extraConsoleCommandsFunctionMap.set("error", commands.error);
+  extraConsoleCommandsFunctionMap.set("errorRoom", commands.errorRoom);
   extraConsoleCommandsFunctionMap.set("eternalHearts", commands.eternalHearts);
   extraConsoleCommandsFunctionMap.set(
     "familiarDisplay",
@@ -113,10 +113,9 @@ function initMap() {
   extraConsoleCommandsFunctionMap.set("grid2", commands.grid2);
   extraConsoleCommandsFunctionMap.set("gridCosts", commands.gridCosts);
   extraConsoleCommandsFunctionMap.set("gridEntities", commands.gridEntities);
-  extraConsoleCommandsFunctionMap.set("h", commands.h);
   extraConsoleCommandsFunctionMap.set("hearts", commands.hearts);
   extraConsoleCommandsFunctionMap.set("hitboxes", commands.hitboxes);
-  extraConsoleCommandsFunctionMap.set("iAmError", commands.iAmError);
+  extraConsoleCommandsFunctionMap.set("iAmErrorRoom", commands.iAmErrorRoom);
   extraConsoleCommandsFunctionMap.set("key", commands.key);
   extraConsoleCommandsFunctionMap.set("keys", commands.keys);
   extraConsoleCommandsFunctionMap.set(
@@ -146,7 +145,6 @@ function initMap() {
   extraConsoleCommandsFunctionMap.set("mana", commands.mana);
   extraConsoleCommandsFunctionMap.set("map", commands.map);
   extraConsoleCommandsFunctionMap.set("maxHearts", commands.maxHearts);
-  extraConsoleCommandsFunctionMap.set("mh", commands.mh);
   extraConsoleCommandsFunctionMap.set("miniboss", commands.miniboss);
   extraConsoleCommandsFunctionMap.set("noCurses", commands.noCurses);
   extraConsoleCommandsFunctionMap.set("npcDisplay", commandsDisplay.npcDisplay);
@@ -207,7 +205,6 @@ function initMap() {
     commandsDisplay.projectilesDisplay,
   );
   extraConsoleCommandsFunctionMap.set("redHearts", commands.redHearts);
-  extraConsoleCommandsFunctionMap.set("rh", commands.rh);
   extraConsoleCommandsFunctionMap.set("right", commands.right);
   extraConsoleCommandsFunctionMap.set(
     "rockDisplay",
@@ -221,13 +218,12 @@ function initMap() {
   extraConsoleCommandsFunctionMap.set("rottenHearts", commands.rottenHearts);
   extraConsoleCommandsFunctionMap.set("runTests", commands.runTests);
   extraConsoleCommandsFunctionMap.set("s", commands.s);
-  extraConsoleCommandsFunctionMap.set("sacrifice", commands.sacrifice);
-  extraConsoleCommandsFunctionMap.set("secret", commands.secret);
+  extraConsoleCommandsFunctionMap.set("sacrificeRoom", commands.sacrificeRoom);
+  extraConsoleCommandsFunctionMap.set("secretRoom", commands.secretRoom);
   extraConsoleCommandsFunctionMap.set("seedStick", commands.seedStick);
   extraConsoleCommandsFunctionMap.set("seeds", commands.seedsCommand);
   extraConsoleCommandsFunctionMap.set("setCharges", commands.setCharges);
   extraConsoleCommandsFunctionMap.set("setPosition", commands.setPosition);
-  extraConsoleCommandsFunctionMap.set("sh", commands.sh);
   extraConsoleCommandsFunctionMap.set("shop", commands.shop);
   extraConsoleCommandsFunctionMap.set(
     "slotDisplay",
@@ -256,8 +252,12 @@ function initMap() {
     "spikesDisplay",
     commandsDisplay.spikesDisplay,
   );
-  extraConsoleCommandsFunctionMap.set("supersecret", commands.superSecret);
+  extraConsoleCommandsFunctionMap.set(
+    "superSecretRoom",
+    commands.superSecretRoom,
+  );
   extraConsoleCommandsFunctionMap.set("startingRoom", commands.startingRoom);
+  extraConsoleCommandsFunctionMap.set("startRoom", commands.startRoom);
   extraConsoleCommandsFunctionMap.set(
     "tearDisplay",
     commandsDisplay.tearDisplay,
@@ -267,14 +267,18 @@ function initMap() {
     "tearsDisplay",
     commandsDisplay.tearsDisplay,
   );
+  extraConsoleCommandsFunctionMap.set("tests", commands.tests);
   extraConsoleCommandsFunctionMap.set("tntDisplay", commandsDisplay.tntDisplay);
   extraConsoleCommandsFunctionMap.set(
     "tntsDisplay",
     commandsDisplay.tntsDisplay,
   );
   extraConsoleCommandsFunctionMap.set("trapdoor", commands.trapdoorCommand);
-  extraConsoleCommandsFunctionMap.set("treasure", commands.treasure);
-  extraConsoleCommandsFunctionMap.set("ultraSecret", commands.ultraSecret);
+  extraConsoleCommandsFunctionMap.set("treasureRoom", commands.treasureRoom);
+  extraConsoleCommandsFunctionMap.set(
+    "ultraSecretRoom",
+    commands.ultraSecretRoom,
+  );
   extraConsoleCommandsFunctionMap.set("unseed", commands.unseed);
   extraConsoleCommandsFunctionMap.set("up", commands.up);
   extraConsoleCommandsFunctionMap.set("warp", commands.warp);

package/src/features/extraConsoleCommands/listCommands.ts

@@ -1,16 +1,23 @@
 // This file is arbitrarily named "listCommands.ts" instead of "commands.ts" so that it will appear
-// below the "init" page.
+// below "exports.ts".
 
 // cspell:ignore addcharges
 /**
  * This is a list of custom console commands that are included with the standard library.
  *
- * Note that as a quality of life feature, you do not have to match the casing of the command. For
- * example, you can type the "addCharges" command as "addcharges", and it will still work the same.
+ * As a quality of life feature, you do not have to match the casing of the command. For example,
+ * you can type the "addCharges" command as "addcharges", and it will still work the same.
+ *
+ * Additionally, you can also abbreviate any command by omitting letters that do not overlap with
+ * any other command. For example, the command of "c" will be interpreted as the "card" command.
  *
  * In order for the custom console commands to work, you first have to call
  * `enableExtraConsoleCommands`. (See the "Extra Console Commands (Init)" page for more details.)
  *
+ * Each command has a corresponding function of the same name, but these functions are not actually
+ * exported for end-user consumption. (This is to cut down on namespace conflicts and because the
+ * names of the functions are not very descriptive.)
+ *
  * @module
  */
 
@@ -151,7 +158,7 @@ export function addCharges(params: string): void {
  * Warps to the Angel Room for the floor. If the Devil Room has already been visited or initialized,
  * this will uninitialize it and make an Angel Room instead.
  */
-export function angel(): void {
+export function angelRoom(): void {
   devilAngel(false);
 }
 
@@ -276,7 +283,7 @@ export function boneHearts(params: string): void {
 }
 
 /** Warps to the first Boss Room on the floor. */
-export function boss(): void {
+export function bossRoom(): void {
   warpToRoomType(RoomType.BOSS);
 }
 
@@ -473,14 +480,14 @@ export function damage(): void {
 
 /** Alias for the "devil" command. */
 export function dd(): void {
-  devil();
+  devilRoom();
 }
 
 /**
  * Warps to the Devil Room for the floor. If the Angel Room has already been visited or initialized,
  * this will uninitialize it and make an Devil Room instead.
  */
-export function devil(): void {
+export function devilRoom(): void {
   devilAngel(true);
 }
 
@@ -500,7 +507,7 @@ export function down(params: string): void {
   movePlayer(params, Direction.DOWN);
 }
 
-/** Warps to the Dungeon (i.e. crawl space) for the floor. */
+/** Warps to the Dungeon (i.e. the crawl space room) for the floor. */
 export function dungeon(): void {
   changeRoom(GridRoom.DUNGEON);
 }
@@ -518,8 +525,8 @@ export function eh(params: string): void {
 }
 
 /** Alias for the "iAmError" command. */
-export function error(): void {
-  iAmError();
+export function errorRoom(): void {
+  iAmErrorRoom();
 }
 
 /**
@@ -663,11 +670,6 @@ export function gridEntities(): void {
   }
 }
 
-/** Alias for the "hearts" command. */
-export function h(params: string): void {
-  hearts(params);
-}
-
 /**
  * Gives a half red heart. Provide a number to give a custom amount of hearts. (You can use negative
  * numbers to remove hearts.)
@@ -682,7 +684,7 @@ export function hitboxes(): void {
 }
 
 /** Warps to the I AM ERROR room for the floor. */
-export function iAmError(): void {
+export function iAmErrorRoom(): void {
   changeRoom(GridRoom.ERROR);
 }
 
@@ -816,11 +818,6 @@ export function maxHearts(params: string): void {
   addHeart(params, HealthType.MAX_HEARTS);
 }
 
-/** Alias for the "maxHearts" command. */
-export function mh(params: string): void {
-  maxHearts(params);
-}
-
 /** Warps to the first Miniboss Room on the floor. */
 export function miniboss(): void {
   warpToRoomType(RoomType.MINI_BOSS);
@@ -964,11 +961,6 @@ export function redHearts(params: string): void {
   hearts(params);
 }
 
-/** Alias for the "redHearts" command. */
-export function rh(params: string): void {
-  redHearts(params);
-}
-
 /** Moves the player 0.5 units right. Provide a number to move a custom amount of units. */
 export function right(params: string): void {
   movePlayer(params, Direction.RIGHT);
@@ -1048,12 +1040,12 @@ export function s(params: string): void {
 }
 
 /** Warps to the first Sacrifice Room on the floor. */
-export function sacrifice(): void {
+export function sacrificeRoom(): void {
   warpToRoomType(RoomType.SACRIFICE);
 }
 
 /** Warps to the first Secret Room on the floor. */
-export function secret(): void {
+export function secretRoom(): void {
   warpToRoomType(RoomType.SECRET);
 }
 
@@ -1160,11 +1152,6 @@ export function setPosition(params: string): void {
   player.Position = position;
 }
 
-/** Alias for the "soulHearts" command. */
-export function sh(params: string): void {
-  soulHearts(params);
-}
-
 /** Warps to the first shop on the floor. */
 export function shop(): void {
   warpToRoomType(RoomType.SHOP);
@@ -1280,8 +1267,13 @@ export function startingRoom(): void {
   changeRoom(startingRoomIndex);
 }
 
+/** Alias for the "startingRoom" command. */
+export function startRoom(): void {
+  startingRoom();
+}
+
 /** Warps to the first Super Secret Room on the floor. */
-export function superSecret(): void {
+export function superSecretRoom(): void {
   warpToRoomType(RoomType.SUPER_SECRET);
 }
 
@@ -1299,18 +1291,23 @@ export function tears(): void {
   printEnabled(v.run.maxDamage, "debug tear-rate");
 }
 
+/** Alias for the "runTests" command. */
+export function tests(): void {
+  runTests();
+}
+
 /** Creates a trapdoor next to the player. */
 export function trapdoorCommand(): void {
   spawnTrapdoorOrCrawlSpace(true);
 }
 
 /** Warps to the first Treasure Room on the floor. */
-export function treasure(): void {
+export function treasureRoom(): void {
   warpToRoomType(RoomType.TREASURE);
 }
 
 /** Warps to the first Ultra Secret Room on the floor. */
-export function ultraSecret(): void {
+export function ultraSecretRoom(): void {
   warpToRoomType(RoomType.ULTRA_SECRET);
 }
 

package/src/functions/collectibles.ts

@@ -323,6 +323,10 @@ export function getCollectibleName(collectibleType: CollectibleType): string {
   return DEFAULT_COLLECTIBLE_NAME;
 }
 
+/**
+ * Helper function to get the "pedestal type" of a collectible. For example, it might be sitting on
+ * top of a broken Blood Donation Machine, or it might be sitting on top of an opened Spiked Chest.
+ */
 export function getCollectiblePedestalType(
   collectible: EntityPickup,
 ): CollectiblePedestalType {
@@ -338,8 +342,8 @@ export function getCollectiblePedestalType(
 }
 
 /**
- * Helper function to get the path to a collectible's quality. Returns 0 if the provided collectible
- * type was not valid.
+ * Helper function to get a collectible's quality. For example, Mom's Knife has a quality of 4.
+ * Returns 0 if the provided collectible type was not valid.
  */
 export function getCollectibleQuality(collectibleType: CollectibleType): int {
   const itemConfigItem = itemConfig.GetCollectible(collectibleType);

package/src/functions/color.ts

@@ -1,6 +1,8 @@
 import { SerializationBrand } from "../enums/private/SerializationBrand";
 import { SerializationType } from "../enums/SerializationType";
 import { isaacAPIClassEquals, isIsaacAPIClassOfType } from "./isaacAPIClass";
+import { getRandom } from "./random";
+import { getRandomSeed, isRNG, newRNG } from "./rng";
 import { copyValuesToTable, getNumbersFromTable, tableHasKeys } from "./table";
 import { isTable } from "./types";
 
@@ -105,6 +107,26 @@ export function copyColor(
   }
 }
 
+/**
+ * Helper function to get a random color.
+ *
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param alpha Optional. The alpha value to use. Default is 1.
+ */
+export function getRandomColor(
+  seedOrRNG: Seed | RNG = getRandomSeed(),
+  alpha = 1,
+): Color {
+  const rng = isRNG(seedOrRNG) ? seedOrRNG : newRNG(seedOrRNG);
+
+  const r = getRandom(rng);
+  const g = getRandom(rng);
+  const b = getRandom(rng);
+
+  return Color(r, g, b, alpha);
+}
+
 /** Helper function to check if something is an instantiated Color object. */
 export function isColor(object: unknown): object is Color {
   return isIsaacAPIClassOfType(object, OBJECT_NAME);

package/src/functions/gridEntities.ts

@@ -19,7 +19,6 @@ import {
 import { BACKDROP_TYPE_TO_ROCK_ALT_TYPE } from "../objects/backdropTypeToRockAltType";
 import { AnyGridEntity } from "../types/AnyGridEntity";
 import { isCircleIntersectingRectangle } from "./math";
-import { getRandomSeed } from "./rng";
 import { roomUpdateSafe } from "./rooms";
 import { clearSprite } from "./sprites";
 import { isNumber } from "./types";
@@ -488,7 +487,7 @@ export function removeAllMatchingGridEntities(
  *                   generally a good idea because if the room is not updated, you will be unable to
  *                   spawn another grid entity on the same tile until a frame has passed. However,
  *                   doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
- *                   so set this to false if you need to invoke this function multiple times.
+ *                   so set this to false if you need to run this function multiple times.
  * @param cap Optional. If specified, will only remove the given amount of entities.
  * @returns An array of the entities that were removed.
  */
@@ -527,7 +526,7 @@ export function removeGridEntities<T extends AnyGridEntity>(
  *                   generally a good idea because if the room is not updated, you will be unable to
  *                   spawn another grid entity on the same tile until a frame has passed. However,
  *                   doing this is expensive, since it involves a call to `Isaac.GetRoomEntities`,
- *                   so set this to false if you need to invoke this function multiple times.
+ *                   so set this to false if you need to run this function multiple times.
  */
 export function removeGridEntity(
   gridEntityOrGridIndex: GridEntity | int,
@@ -654,57 +653,6 @@ export function spawnGridEntityWithVariant(
   return gridEntity;
 }
 
-/**
- * Helper function for emulating what happens when a vanilla `GridEntityType.ROCK_ALT` grid entity
- * breaks.
- *
- * Note that most of the time, this function will do nothing, similar to how most of the time, when
- * an individual urn is destroyed, nothing will spawn.
- *
- * The logic in this function is based on the rewards listed on the wiki:
- * https://bindingofisaacrebirth.fandom.com/wiki/Rocks
- *
- * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
- *                    at spawning coins and spiders.
- * @param _seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
- *                   the `RNG.Next` method will be called. Default is `getRandomSeed()`. Normally,
- *                   you should pass the `InitSeed` of the grid entity that was broken.
- * @returns Whether or not this function spawned something.
- */
-export function spawnRockAltReward(
-  rockAltType: RockAltType,
-  _seedOrRNG: Seed | RNG = getRandomSeed(),
-): boolean {
-  /// const chance = getRandom(seedOrRNG);
-
-  switch (rockAltType) {
-    case RockAltType.URN: {
-      // TODO
-      return false;
-    }
-
-    case RockAltType.MUSHROOM: {
-      // TODO
-      return false;
-    }
-
-    case RockAltType.SKULL: {
-      // TODO
-      return false;
-    }
-
-    case RockAltType.POLYP: {
-      // TODO
-      return false;
-    }
-
-    case RockAltType.BUCKET: {
-      // TODO
-      return false;
-    }
-  }
-}
-
 /**
  * Helper function to spawn a Void Portal. This is more complicated than simply spawning a trapdoor
  * with the appropriate variant, as the game does not give it the correct sprite automatically.