isaacscript-common 4.2.6 → 4.2.8

package/enums/StageTravelEntityType.d.ts

@@ -0,0 +1,5 @@
+export declare enum StageTravelEntityType {
+    TRAPDOOR = 0,
+    CRAWLSPACE = 1,
+    HEAVEN_DOOR = 2
+}

package/enums/StageTravelEntityType.lua

@@ -0,0 +1,9 @@
+local ____exports = {}
+____exports.StageTravelEntityType = {}
+____exports.StageTravelEntityType.TRAPDOOR = 0
+____exports.StageTravelEntityType[____exports.StageTravelEntityType.TRAPDOOR] = "TRAPDOOR"
+____exports.StageTravelEntityType.CRAWLSPACE = 1
+____exports.StageTravelEntityType[____exports.StageTravelEntityType.CRAWLSPACE] = "CRAWLSPACE"
+____exports.StageTravelEntityType.HEAVEN_DOOR = 2
+____exports.StageTravelEntityType[____exports.StageTravelEntityType.HEAVEN_DOOR] = "HEAVEN_DOOR"
+return ____exports

package/enums/private/SaveDataKey.d.ts

@@ -4,4 +4,3 @@ export declare enum SaveDataKey {
     LEVEL = "level",
     ROOM = "room"
 }
-export declare const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey>;

package/enums/private/SaveDataKey.lua

@@ -1,11 +1,7 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 ____exports.SaveDataKey = {}
 ____exports.SaveDataKey.PERSISTENT = "persistent"
 ____exports.SaveDataKey.RUN = "run"
 ____exports.SaveDataKey.LEVEL = "level"
 ____exports.SaveDataKey.ROOM = "room"
-____exports.RESETTABLE_SAVE_DATA_KEYS = __TS__New(Set, {____exports.SaveDataKey.RUN, ____exports.SaveDataKey.LEVEL, ____exports.SaveDataKey.ROOM})
 return ____exports

package/features/saveDataManager/main.lua

@@ -1,7 +1,9 @@
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
-local postPlayerInit, preGameExit, postNewLevel, postNewRoomEarly, restoreDefaultsAll, restoreDefaults, clearAndCopyAllElements, mod, loadedDataOnThisRun
+local postPlayerInit, preGameExit, postNewLevel, postNewRoomEarly, restoreDefaultsAll, restoreDefaults, clearAndCopyAllElements, RESETTABLE_SAVE_DATA_KEYS, mod, loadedDataOnThisRun
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local ModCallback = ____isaac_2Dtypescript_2Ddefinitions.ModCallback
 local ____cachedClasses = require("cachedClasses")
@@ -9,7 +11,6 @@ local game = ____cachedClasses.game
 local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
 local ____SaveDataKey = require("enums.private.SaveDataKey")
-local RESETTABLE_SAVE_DATA_KEYS = ____SaveDataKey.RESETTABLE_SAVE_DATA_KEYS
 local SaveDataKey = ____SaveDataKey.SaveDataKey
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
@@ -102,6 +103,7 @@ function clearAndCopyAllElements(self, oldTable, newTable)
         oldTable[key] = value
     end
 end
+RESETTABLE_SAVE_DATA_KEYS = __TS__New(Set, {SaveDataKey.RUN, SaveDataKey.LEVEL, SaveDataKey.ROOM})
 mod = nil
 loadedDataOnThisRun = false
 ---

package/features/stageTravel/exports.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Spawn a trapdoor grid entity that will have one or more of the following custom attributes:
+ *
+ * - custom sprite
+ * - custom opening/closing logic
+ * - custom destination / logic for after the player enters
+ */
+export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector): GridEntity;
+/**
+ * Convert an existing trapdoor into a custom trapdoor that will have one or more of the following
+ * custom attributes:
+ *
+ * - custom sprite
+ * - custom opening/closing logic
+ * - custom destination / logic for after the player enters
+ */
+export declare function initCustomTrapdoor(_trapdoor: GridEntity, _shouldSpawnOpenFunc?: typeof defaultShouldSpawnOpenFunc): void;
+declare function defaultShouldSpawnOpenFunc(_entity: GridEntity | EntityEffect): boolean;
+export {};

package/features/stageTravel/exports.lua

@@ -0,0 +1,44 @@
+local ____exports = {}
+local defaultShouldSpawnOpenFunc
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____gridEntity = require("functions.gridEntity")
+local spawnGrid = ____gridEntity.spawnGrid
+--- Convert an existing trapdoor into a custom trapdoor that will have one or more of the following
+-- custom attributes:
+-- 
+-- - custom sprite
+-- - custom opening/closing logic
+-- - custom destination / logic for after the player enters
+function ____exports.initCustomTrapdoor(self, _trapdoor, _shouldSpawnOpenFunc)
+    if _shouldSpawnOpenFunc == nil then
+        _shouldSpawnOpenFunc = defaultShouldSpawnOpenFunc
+    end
+end
+function defaultShouldSpawnOpenFunc(self, _entity)
+    local room = game:GetRoom()
+    local roomFrameCount = room:GetFrameCount()
+    local roomClear = room:IsClear()
+    if roomFrameCount == 0 then
+        if not roomClear then
+            return false
+        end
+    end
+    return false
+end
+--- Spawn a trapdoor grid entity that will have one or more of the following custom attributes:
+-- 
+-- - custom sprite
+-- - custom opening/closing logic
+-- - custom destination / logic for after the player enters
+function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition)
+    local trapdoor = spawnGrid(nil, GridEntityType.TRAPDOOR, gridIndexOrPosition)
+    if trapdoor == nil then
+        error("Failed to spawn a custom trapdoor.")
+    end
+    ____exports.initCustomTrapdoor(nil, trapdoor)
+    return trapdoor
+end
+return ____exports

package/functions/character.d.ts

@@ -42,7 +42,7 @@ export declare function getCharacterDeathAnimationName(character: PlayerType): s
  * Mother's Kiss; use the `getPlayerMaxHeartContainers` helper function for that.
  */
 export declare function getCharacterMaxHeartContainers(character: PlayerType): int;
-/** Helper function to get the name of a character. Returns "unknown" for modded characters. */
+/** Helper function to get the name of a character. Returns "Unknown" for modded characters. */
 export declare function getCharacterName(character: PlayerType): string;
 export declare function isModdedCharacter(character: PlayerType): boolean;
 export declare function isVanillaCharacter(character: PlayerType): boolean;

package/functions/character.lua

@@ -84,10 +84,10 @@ function ____exports.getCharacterMaxHeartContainers(self, character)
     end
     return 12
 end
---- Helper function to get the name of a character. Returns "unknown" for modded characters.
+--- Helper function to get the name of a character. Returns "Unknown" for modded characters.
 function ____exports.getCharacterName(self, character)
     if ____exports.isModdedCharacter(nil, character) then
-        return "unknown"
+        return "Unknown"
     end
     return CHARACTER_NAMES[character]
 end

package/objects/characterNames.d.ts

@@ -1,5 +1,4 @@
 import { PlayerType } from "isaac-typescript-definitions";
-export declare const DEFAULT_CHARACTER_NAME = "Unknown";
 export declare const CHARACTER_NAMES: {
     readonly [key in PlayerType]: string;
 };

package/objects/characterNames.lua

@@ -1,7 +1,6 @@
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
-____exports.DEFAULT_CHARACTER_NAME = "Unknown"
 ____exports.CHARACTER_NAMES = {
     [PlayerType.POSSESSOR] = "Possessor",
     [PlayerType.ISAAC] = "Isaac",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.2.6",
+  "version": "4.2.8",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^3.0.11"
+    "isaac-typescript-definitions": "^3.0.12"
   }
 }