isaacscript-common 4.5.0 → 4.6.0

package/types/PickingUpItem.lua

@@ -20,15 +20,15 @@ function ____exports.resetPickingUpItem(self, pickingUpItem)
 end
 local COLLECTIBLE_ITEM_TYPES = __TS__New(Set, {ItemType.PASSIVE, ItemType.ACTIVE, ItemType.FAMILIAR})
 --- Helper function to narrow the type of `PickingUpItem`.
-function ____exports.pickingUpItemIsNull(self, pickingUpItem)
+function ____exports.isPickingUpItemNull(self, pickingUpItem)
     return pickingUpItem.itemType == ItemType.NULL
 end
 --- Helper function to narrow the type of `PickingUpItem`.
-function ____exports.pickingUpItemIsCollectible(self, pickingUpItem)
+function ____exports.isPickingUpItemCollectible(self, pickingUpItem)
     return COLLECTIBLE_ITEM_TYPES:has(pickingUpItem.itemType)
 end
 --- Helper function to narrow the type of `PickingUpItem`.
-function ____exports.pickingUpItemIsTrinket(self, pickingUpItem)
+function ____exports.isPickingUpItemTrinket(self, pickingUpItem)
     return pickingUpItem.itemType == ItemType.TRINKET
 end
 return ____exports

package/enums/StageTravelEntityState.d.ts

@@ -1,4 +0,0 @@
-export declare enum StageTravelEntityState {
-    OPEN = 0,
-    CLOSED = 1
-}

package/enums/StageTravelEntityState.lua

@@ -1,7 +0,0 @@
-local ____exports = {}
-____exports.StageTravelEntityState = {}
-____exports.StageTravelEntityState.OPEN = 0
-____exports.StageTravelEntityState[____exports.StageTravelEntityState.OPEN] = "OPEN"
-____exports.StageTravelEntityState.CLOSED = 1
-____exports.StageTravelEntityState[____exports.StageTravelEntityState.CLOSED] = "CLOSED"
-return ____exports

package/enums/StageTravelState.d.ts

@@ -1,6 +0,0 @@
-export declare enum StageTravelState {
-    DISABLED = 0,
-    FADING_TO_BLACK = 1,
-    GOING_TO_NEW_FLOOR = 2,
-    FADING_IN = 3
-}

package/enums/StageTravelState.lua

@@ -1,11 +0,0 @@
-local ____exports = {}
-____exports.StageTravelState = {}
-____exports.StageTravelState.DISABLED = 0
-____exports.StageTravelState[____exports.StageTravelState.DISABLED] = "DISABLED"
-____exports.StageTravelState.FADING_TO_BLACK = 1
-____exports.StageTravelState[____exports.StageTravelState.FADING_TO_BLACK] = "FADING_TO_BLACK"
-____exports.StageTravelState.GOING_TO_NEW_FLOOR = 2
-____exports.StageTravelState[____exports.StageTravelState.GOING_TO_NEW_FLOOR] = "GOING_TO_NEW_FLOOR"
-____exports.StageTravelState.FADING_IN = 3
-____exports.StageTravelState[____exports.StageTravelState.FADING_IN] = "FADING_IN"
-return ____exports

package/features/customTrapdoor/constants.d.ts

@@ -1,5 +0,0 @@
-export declare const STAGE_TRAVEL_FEATURE_NAME = "stageTravel";
-/** This also applies to crawl spaces. The value was determined through trial and error. */
-export declare const TRAPDOOR_OPEN_DISTANCE = 60;
-export declare const TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS: number;
-export declare const TRAPDOOR_BOSS_REACTION_FRAMES = 30;

package/features/customTrapdoor/constants.lua

@@ -1,7 +0,0 @@
-local ____exports = {}
-____exports.STAGE_TRAVEL_FEATURE_NAME = "stageTravel"
---- This also applies to crawl spaces. The value was determined through trial and error.
-____exports.TRAPDOOR_OPEN_DISTANCE = 60
-____exports.TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS = ____exports.TRAPDOOR_OPEN_DISTANCE * 2.5
-____exports.TRAPDOOR_BOSS_REACTION_FRAMES = 30
-return ____exports

package/features/customTrapdoor/exports.d.ts

@@ -1,37 +0,0 @@
-import { LevelStage, StageType } from "isaac-typescript-definitions";
-/**
- * Helper function to spawn a trapdoor grid entity that will have one or more of the following
- * attributes:
- *
- * - custom destination (or custom logic for after the player enters)
- * - custom graphics
- * - custom logic for opening/closing
- * - TODO: animation
- *
- * You can use this function to take the player to your custom stage. (See the `registerCustomStage`
- * helper function.)
- *
- * Under the hood, the custom trapdoor is represented by a decoration grid entity and is manually
- * respawned every time the player re-enters the room.
- *
- * @param gridIndexOrPosition The location in the room to spawn the trapdoor.
- * @param _destination Used to specify where the player will go after jumping into the trapdoor. Can
- *                     either be a tuple containing the stage and stage type, a string containing
- *                     the name of a custom stage, or a function that returns one of these things.
- *                     You can also specify a function that returns undefined in order to perform
- *                     some custom behavior and/or handle the traveling part yourself. By default,
- *                     the destination will be set to the next floor like that of a vanilla
- *                     trapdoor.
- * @param _anm2 Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2 of
- *              "gfx/grid/door_11_trapdoor.anm2" will be used.
- * @param _shouldOpenFunc Optional. If the trapdoor is currently closed, this function will run on
- *                        every frame to determine if it should open. By default, a function that
- *                        emulates a vanilla trapdoor will be used.
- * @param _shouldCloseFunc Optional. If the trapdoor is currently open, this function will run on
- *                         every frame to determine if it should close. By default, a function that
- *                         emulates a vanilla trapdoor will be used.
- * @param _spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. Can either be
- *                   a boolean or a function returning a boolean. By default, a function that
- *                   emulates a vanilla trapdoor will be used.
- */
-export declare function spawnCustomTrapdoor(gridIndexOrPosition: int | Vector, _destination?: [stage: LevelStage, stageType: StageType] | string | ((gridEntity: GridEntity) => [stage: LevelStage, stageType: StageType] | string | undefined), _anm2?: string, _shouldOpenFunc?: (gridEntity: GridEntity) => boolean, _shouldCloseFunc?: (gridEntity: GridEntity) => boolean, _spawnOpen?: boolean | ((gridEntity: GridEntity) => boolean)): GridEntity;

package/features/customTrapdoor/exports.lua

@@ -1,120 +0,0 @@
-local ____exports = {}
-local defaultDestinationFunc, defaultShouldOpenFunc, isPlayerCloseAfterBoss, shouldBeClosedFromStartingInRoomWithEnemies, defaultShouldCloseFunc, defaultShouldSpawnOpenFunc
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local GridEntityType = ____isaac_2Dtypescript_2Ddefinitions.GridEntityType
-local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____gridEntity = require("functions.gridEntity")
-local spawnGrid = ____gridEntity.spawnGrid
-local ____nextStage = require("functions.nextStage")
-local getNextStage = ____nextStage.getNextStage
-local getNextStageType = ____nextStage.getNextStageType
-local ____positionVelocity = require("functions.positionVelocity")
-local anyPlayerCloserThan = ____positionVelocity.anyPlayerCloserThan
-local ____roomClearFrame = require("features.roomClearFrame")
-local getRoomClearGameFrame = ____roomClearFrame.getRoomClearGameFrame
-local ____constants = require("features.customTrapdoor.constants")
-local TRAPDOOR_BOSS_REACTION_FRAMES = ____constants.TRAPDOOR_BOSS_REACTION_FRAMES
-local TRAPDOOR_OPEN_DISTANCE = ____constants.TRAPDOOR_OPEN_DISTANCE
-local TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS = ____constants.TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS
-local ____v = require("features.customTrapdoor.v")
-local getCustomTrapdoorDescription = ____v.getCustomTrapdoorDescription
-function defaultDestinationFunc(self)
-    local nextStage = getNextStage(nil)
-    local nextStageType = getNextStageType(nil)
-    return {nextStage, nextStageType}
-end
-function defaultShouldOpenFunc(self, gridEntity)
-    local entityDescription = getCustomTrapdoorDescription(nil, gridEntity)
-    if entityDescription == nil then
-        return false
-    end
-    local room = game:GetRoom()
-    local roomClear = room:IsClear()
-    return not anyPlayerCloserThan(nil, gridEntity.Position, TRAPDOOR_OPEN_DISTANCE) and not isPlayerCloseAfterBoss(nil, gridEntity.Position) and not shouldBeClosedFromStartingInRoomWithEnemies(nil, entityDescription.initial, roomClear)
-end
-function isPlayerCloseAfterBoss(self, position)
-    local gameFrameCount = game:GetFrameCount()
-    local room = game:GetRoom()
-    local roomType = room:GetType()
-    local roomClearGameFrame = getRoomClearGameFrame(nil)
-    if roomType ~= RoomType.BOSS or roomClearGameFrame == nil or gameFrameCount >= roomClearGameFrame + TRAPDOOR_BOSS_REACTION_FRAMES then
-        return false
-    end
-    return anyPlayerCloserThan(nil, position, TRAPDOOR_OPEN_DISTANCE_AFTER_BOSS)
-end
-function shouldBeClosedFromStartingInRoomWithEnemies(self, initial, roomClear)
-    return initial and not roomClear
-end
-function defaultShouldCloseFunc(self)
-    return false
-end
-function defaultShouldSpawnOpenFunc(self, gridEntity)
-    local room = game:GetRoom()
-    local roomFrameCount = room:GetFrameCount()
-    local roomClear = room:IsClear()
-    if roomFrameCount > 0 then
-        return false
-    end
-    if not roomClear then
-        return false
-    end
-    return defaultShouldOpenFunc(nil, gridEntity)
-end
---- Helper function to spawn a trapdoor grid entity that will have one or more of the following
--- attributes:
--- 
--- - custom destination (or custom logic for after the player enters)
--- - custom graphics
--- - custom logic for opening/closing
--- - TODO: animation
--- 
--- You can use this function to take the player to your custom stage. (See the `registerCustomStage`
--- helper function.)
--- 
--- Under the hood, the custom trapdoor is represented by a decoration grid entity and is manually
--- respawned every time the player re-enters the room.
--- 
--- @param gridIndexOrPosition The location in the room to spawn the trapdoor.
--- @param _destination Used to specify where the player will go after jumping into the trapdoor. Can
--- either be a tuple containing the stage and stage type, a string containing
--- the name of a custom stage, or a function that returns one of these things.
--- You can also specify a function that returns undefined in order to perform
--- some custom behavior and/or handle the traveling part yourself. By default,
--- the destination will be set to the next floor like that of a vanilla
--- trapdoor.
--- @param _anm2 Optional. The path to the anm2 file to use. By default, the vanilla trapdoor anm2 of
--- "gfx/grid/door_11_trapdoor.anm2" will be used.
--- @param _shouldOpenFunc Optional. If the trapdoor is currently closed, this function will run on
--- every frame to determine if it should open. By default, a function that
--- emulates a vanilla trapdoor will be used.
--- @param _shouldCloseFunc Optional. If the trapdoor is currently open, this function will run on
--- every frame to determine if it should close. By default, a function that
--- emulates a vanilla trapdoor will be used.
--- @param _spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. Can either be
--- a boolean or a function returning a boolean. By default, a function that
--- emulates a vanilla trapdoor will be used.
-function ____exports.spawnCustomTrapdoor(self, gridIndexOrPosition, _destination, _anm2, _shouldOpenFunc, _shouldCloseFunc, _spawnOpen)
-    if _destination == nil then
-        _destination = defaultDestinationFunc
-    end
-    if _anm2 == nil then
-        _anm2 = "gfx/grid/door_11_trapdoor.anm2"
-    end
-    if _shouldOpenFunc == nil then
-        _shouldOpenFunc = defaultShouldOpenFunc
-    end
-    if _shouldCloseFunc == nil then
-        _shouldCloseFunc = defaultShouldCloseFunc
-    end
-    if _spawnOpen == nil then
-        _spawnOpen = defaultShouldSpawnOpenFunc
-    end
-    local decoration = spawnGrid(nil, GridEntityType.DECORATION, gridIndexOrPosition)
-    if decoration == nil then
-        error("Failed to spawn a custom trapdoor.")
-    end
-    return decoration
-end
-return ____exports

package/features/customTrapdoor/init.d.ts

@@ -1 +0,0 @@
-export declare function stageTravelInit(): void;

package/features/customTrapdoor/init.lua

@@ -1,11 +0,0 @@
-local ____exports = {}
-local ____exports = require("features.saveDataManager.exports")
-local saveDataManager = ____exports.saveDataManager
-local ____constants = require("features.customTrapdoor.constants")
-local STAGE_TRAVEL_FEATURE_NAME = ____constants.STAGE_TRAVEL_FEATURE_NAME
-local ____v = require("features.customTrapdoor.v")
-local v = ____v.default
-function ____exports.stageTravelInit(self)
-    saveDataManager(nil, STAGE_TRAVEL_FEATURE_NAME, v)
-end
-return ____exports

package/features/customTrapdoor/v.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="isaac-typescript-definitions" />
-import { StageTravelState } from "../../enums/StageTravelState";
-import { StageTravelEntityDescription } from "../../interfaces/StageTravelEntityDescription";
-declare const v: {
-    run: {
-        state: StageTravelState;
-    };
-    room: {
-        /** Indexed by grid index. */
-        trapdoors: Map<number, StageTravelEntityDescription>;
-    };
-};
-export default v;
-export declare function getCustomTrapdoorDescription(gridEntity: GridEntity): StageTravelEntityDescription | undefined;

package/features/customTrapdoor/v.lua

@@ -1,16 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____StageTravelState = require("enums.StageTravelState")
-local StageTravelState = ____StageTravelState.StageTravelState
-local v = {
-    run = {state = StageTravelState.DISABLED},
-    room = {trapdoors = __TS__New(Map)}
-}
-____exports.default = v
-function ____exports.getCustomTrapdoorDescription(self, gridEntity)
-    local gridIndex = gridEntity:GetGridIndex()
-    return v.room.trapdoors:get(gridIndex)
-end
-return ____exports

package/interfaces/StageTravelEntityDescription.d.ts

@@ -1,5 +0,0 @@
-import { StageTravelEntityState } from "../enums/StageTravelEntityState";
-export interface StageTravelEntityDescription {
-    initial: boolean;
-    state: StageTravelEntityState;
-}

package/interfaces/StageTravelEntityDescription.lua

@@ -1,2 +0,0 @@
-local ____exports = {}
-return ____exports