isaacscript-common 2.0.32 → 2.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "isaacscript-common",
-  "version": "2.0.32",
-  "description": "Helper functions for IsaacScript mods",
+  "version": "2.1.0",
+  "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
     "rebirth",
@@ -10,31 +10,18 @@
   ],
   "homepage": "https://isaacscript.github.io/",
   "bugs": {
-    "url": "https://github.com/IsaacScript/isaacscript-common/issues"
+    "url": "https://github.com/IsaacScript/isaacscript/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/IsaacScript/isaacscript-common.git"
+    "url": "git+https://github.com/IsaacScript/isaacscript.git"
   },
   "license": "GPL-3.0",
   "author": "Zamiell",
-  "main": "dist/index",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist/**/*.lua",
-    "dist/**/*.d.ts"
-  ],
+  "type": "commonjs",
+  "main": "index",
+  "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.48"
-  },
-  "devDependencies": {
-    "isaacscript-lint": "^1.0.159",
-    "isaacscript-spell": "^1.0.3",
-    "isaacscript-tsconfig": "^1.1.16",
-    "npm-check-updates": "^13.0.1",
-    "ts-node": "^10.7.0",
-    "typedoc": "^0.22.15",
-    "typescript": "^4.6.4",
-    "typescript-to-lua": "^1.4.4"
+    "isaac-typescript-definitions": "^2.0.53"
   }
-}
+}

package/types/ChargeBarSprites.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * A collection of the four sprites necessary in order to render a charge bar.
+ *
+ * Used in the `newChargeBarSprites` and related helper functions.
+ */
+export interface ChargeBarSprites {
+    back: Sprite;
+    meter: Sprite;
+    meterBattery: Sprite;
+    lines: Sprite;
+    maxCharges: int;
+}

package/{dist/types → types}/CollectibleIndex.d.ts

@@ -1,6 +1,6 @@
 /**
  * CollectibleIndex is a specific type of string; see the documentation for the
- * [[`getCollectibleIndex`]] function. Mods can signify that data structures handle collectibles by
+ * `getCollectibleIndex` function. Mods can signify that data structures handle collectibles by
  * using this type.
  *
  * For example:
@@ -12,5 +12,5 @@
  * This type is branded for extra type safety.
  */
 export declare type CollectibleIndex = string & {
-    __collectibleIndexBrand: unknown;
+    __collectibleIndexBrand: void;
 };

package/{dist/types → types}/PlayerIndex.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * PlayerIndex is a specific type of string; see the documentation for the [[`getPlayerIndex`]]
+ * PlayerIndex is a specific type of string; see the documentation for the `getPlayerIndex`
  * function. Mods can signify that data structures handle `EntityPlayer` by using this type.
  *
  * For example:
@@ -12,5 +12,5 @@
  * This type is branded for extra type safety.
  */
 export declare type PlayerIndex = int & {
-    __playerIndexBrand: unknown;
+    __playerIndexBrand: void;
 };

package/{dist/types/private → types}/SaveData.d.ts

@@ -1,14 +1,21 @@
-import { Primitive } from "../Primitive";
-/**
- * I don't know how to create a recursive type definition for only primitive values. For now, this
- * is typed as "unknown", which provides no type safety.
- */
-declare type Serializable = Primitive | unknown;
 /**
  * Each sub-object of save data has a string as a key, without arbitrary data as a value. However,
  * the data has to be serializable (i.e. no `userdata` objects).
+ *
+ * The values of the save data group can only be:
+ * - `boolean`
+ * - `number`
+ * - `string`
+ * - `Map` / `DefaultMap`
+ * - `Set`
+ * - a TSTL class
+ * - serializable Isaac API classes (such as `Color`)
+ * - a sub-object or `LuaTable` that contains the above values
+ *
+ * It is not possible to create a recursive type definition that matches these properties, so this
+ * is typed as "unknown", which provides no type safety.
  */
-declare type SaveDataGroup = Record<string, Serializable>;
+export declare type SaveDataGroup = Record<string, unknown>;
 /**
  * The object that contains all of the variables that will be managed by the save data manager.
  * Depending on which property is used, the variables will be reset at certain times.
@@ -19,4 +26,3 @@ export interface SaveData {
     level?: SaveDataGroup;
     room?: SaveDataGroup;
 }
-export {};

package/{dist/types → types}/private/IsaacAPIClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type IsaacAPIClass = LuaTable<string, unknown> & {
-    __isaacAPIClassBrand: unknown;
+    __isaacAPIClassBrand: void;
 };

package/{dist/types → types}/private/SerializedIsaacAPIClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type SerializedIsaacAPIClass = LuaTable<string, unknown> & {
-    __serializedIsaacAPIClassBrand: unknown;
+    __serializedIsaacAPIClassBrand: void;
 };

package/{dist/types → types}/private/TSTLClass.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 export declare type TSTLClass = LuaTable<AnyNotNil, unknown> & {
-    __tstlClassBrand: unknown;
+    __tstlClassBrand: void;
 };

package/dist/callbacks/postGreedWave.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/callbacks/postGreedWave.lua

@@ -1,31 +0,0 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
-local ____exports = {}
-local hasSubscriptions, postUpdate, v
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-local ____exports = require("features.saveDataManager.exports")
-local saveDataManager = ____exports.saveDataManager
-local ____postGreedWave = require("callbacks.subscriptions.postGreedWave")
-local postGreedModeWaveFire = ____postGreedWave.postGreedModeWaveFire
-local postGreedModeWaveHasSubscriptions = ____postGreedWave.postGreedModeWaveHasSubscriptions
-function hasSubscriptions(self)
-    return postGreedModeWaveHasSubscriptions(nil)
-end
-function postUpdate(self)
-    if not hasSubscriptions(nil) then
-        return
-    end
-    local level = game:GetLevel()
-    local newWave = level.GreedModeWave
-    local oldWave = v.run.currentGreedWave
-    v.run.currentGreedWave = newWave
-    if newWave > oldWave then
-        postGreedModeWaveFire(nil, oldWave, newWave)
-    end
-end
-v = {run = {currentGreedWave = 0}}
-function ____exports.postGreedModeWaveCallbackInit(self, mod)
-    saveDataManager(nil, "postModeGreedWave", v, hasSubscriptions)
-    mod:AddCallback(ModCallbacks.MC_POST_UPDATE, postUpdate)
-end
-return ____exports

package/dist/callbacks/postSlotRenderBroken.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/callbacks/postSlotRenderBroken.lua

@@ -1,48 +0,0 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local hasSubscriptions, postRender, checkSlotBroken, BROKEN_ANIMATIONS, v
-local ____exports = require("features.saveDataManager.exports")
-local saveDataManager = ____exports.saveDataManager
-local ____entitySpecific = require("functions.entitySpecific")
-local getSlots = ____entitySpecific.getSlots
-local ____postSlotDestroyed = require("callbacks.subscriptions.postSlotDestroyed")
-local postSlotDestroyedFire = ____postSlotDestroyed.postSlotDestroyedFire
-local postSlotDestroyedHasSubscriptions = ____postSlotDestroyed.postSlotDestroyedHasSubscriptions
-local ____postSlotRender = require("callbacks.subscriptions.postSlotRender")
-local postSlotRenderFire = ____postSlotRender.postSlotRenderFire
-local postSlotRenderHasSubscriptions = ____postSlotRender.postSlotRenderHasSubscriptions
-function hasSubscriptions(self)
-    return postSlotRenderHasSubscriptions(nil) or postSlotDestroyedHasSubscriptions(nil)
-end
-function postRender(self)
-    if not hasSubscriptions(nil) then
-        return
-    end
-    for ____, slot in ipairs(getSlots(nil)) do
-        postSlotRenderFire(nil, slot)
-        checkSlotBroken(nil, slot)
-    end
-end
-function checkSlotBroken(self, slot)
-    local ptrHash = GetPtrHash(slot)
-    local alreadyBroken = v.room.brokenSlots:has(ptrHash)
-    if alreadyBroken then
-        return
-    end
-    local sprite = slot:GetSprite()
-    local animation = sprite:GetAnimation()
-    if BROKEN_ANIMATIONS:has(animation) then
-        v.room.brokenSlots:add(ptrHash)
-        postSlotDestroyedFire(nil, slot)
-    end
-end
-BROKEN_ANIMATIONS = __TS__New(Set, {"Broken", "Death"})
-v = {room = {brokenSlots = __TS__New(Set)}}
-function ____exports.postSlotRenderBrokenCallbacksInit(self, mod)
-    saveDataManager(nil, "postSlotRenderBroken", v, hasSubscriptions)
-    mod:AddCallback(ModCallbacks.MC_POST_RENDER, postRender)
-end
-return ____exports

package/dist/callbacks/roomClearChange.d.ts

@@ -1 +0,0 @@
-export {};