isaacscript-common 6.14.0 → 6.16.1

package/dist/functions/projectiles.lua

@@ -0,0 +1,73 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local EntityFlag = ____isaac_2Dtypescript_2Ddefinitions.EntityFlag
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local ProjectilesMode = ____isaac_2Dtypescript_2Ddefinitions.ProjectilesMode
+local ____entities = require("functions.entities")
+local getFilteredNewEntities = ____entities.getFilteredNewEntities
+local ____entitiesSpecific = require("functions.entitiesSpecific")
+local getProjectiles = ____entitiesSpecific.getProjectiles
+local spawnNPC = ____entitiesSpecific.spawnNPC
+--- Helper function to make an NPC fire one or more projectiles. Returns the fired projectile(s).
+-- 
+-- Use this function instead of the `EntityNPC.FireProjectiles` method if you need to modify or
+-- access the `EntityProjectile` objects after they are fired, since this function returns the
+-- objects in an array.
+-- 
+-- @param npc The NPC to fire the projectile(s) from. You can also pass undefined if you do not want
+-- the projectile(s) to come from anything in particular.
+-- @param position The staring position of the projectile(s).
+-- @param velocity The starting velocity of the projectile(s).
+-- @param projectilesMode Optional. The mode of the projectile(s). Default is
+-- `ProjectilesMode.ONE_PROJECTILE`.
+-- @param projectileParams Optional. The parameters of the projectile(s). Default is
+-- `ProjectileParams()`.
+-- @returns The fired projectile(s).
+function ____exports.fireProjectiles(self, npc, position, velocity, projectilesMode, projectileParams)
+    if projectilesMode == nil then
+        projectilesMode = ProjectilesMode.ONE_PROJECTILE
+    end
+    if projectileParams == nil then
+        projectileParams = ProjectileParams()
+    end
+    local oldProjectiles = getProjectiles(nil, projectileParams.Variant)
+    local spawnedFly = false
+    if npc == nil then
+        spawnedFly = true
+        npc = spawnNPC(
+            nil,
+            EntityType.FLY,
+            0,
+            0,
+            position
+        )
+        npc.Visible = false
+        npc:ClearEntityFlags(EntityFlag.APPEAR)
+    end
+    npc:FireProjectiles(position, velocity, projectilesMode, projectileParams)
+    local newProjectiles = getProjectiles(nil, projectileParams.Variant)
+    if spawnedFly then
+        npc:Remove()
+    end
+    return getFilteredNewEntities(nil, oldProjectiles, newProjectiles)
+end
+--- Helper function to spawn projectiles in a circle around a position. Under the hood, this
+-- leverages `ProjectileMode.N_PROJECTILES_IN_CIRCLE`.
+-- 
+-- @param npc The NPC to fire the projectile(s) from. You can also pass undefined if you do not want
+-- the projectile(s) to come from anything in particular.
+-- @param position The staring position of the projectile(s).
+-- @param speed The speed of the projectile(s).
+-- @param numProjectiles The amount of projectiles to spawn.
+-- @returns The fired projectile(s).
+function ____exports.fireProjectilesInCircle(self, npc, position, speed, numProjectiles)
+    local velocity = Vector(speed, numProjectiles)
+    return ____exports.fireProjectiles(
+        nil,
+        npc,
+        position,
+        velocity,
+        ProjectilesMode.N_PROJECTILES_IN_CIRCLE
+    )
+end
+return ____exports

package/dist/functions/rng.d.ts

@@ -1,24 +1,16 @@
 /// <reference types="typescript-to-lua/language-extensions" />
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
-import { SerializationType } from "../enums/SerializationType";
-declare type SerializedRNG = LuaMap<string, unknown> & {
+export declare type SerializedRNG = LuaMap<string, unknown> & {
     readonly __serializedRNGBrand: symbol;
 };
-interface CopyRNGReturn {
-    [SerializationType.NONE]: RNG;
-    [SerializationType.SERIALIZE]: SerializedRNG;
-    [SerializationType.DESERIALIZE]: RNG;
-}
+/** Helper function to copy an `RNG` Isaac API class. */
+export declare function copyRNG(rng: RNG): RNG;
 /**
- * Helper function to copy an `RNG` object.
- *
- * @param rng The RNG object to copy. In the case of deserialization, this will actually be a Lua
- *            table instead of an instantiated RNG class.
- * @param serializationType Default is `SerializationType.NONE`.
+ * Helper function to convert a `SerializedRNG` object to a normal `RNG` object. (This is used by
+ * the save data manager when reading data from the "save#.dat" file.)
  */
-export declare function copyRNG<R extends RNG | SerializedRNG, S extends SerializationType>(rng: R, serializationType: S): CopyRNGReturn[S];
-export declare function copyRNG<R extends RNG | SerializedRNG>(rng: R): CopyRNGReturn[SerializationType.NONE];
+export declare function deserializeRNG(rng: SerializedRNG): RNG;
 /**
  * Helper function to get a random `Seed` value to be used in spawning entities and so on. Use this
  * instead of calling the `Random` function directly since that can return a value of 0 and crash
@@ -39,6 +31,11 @@ export declare function isSerializedRNG(object: unknown): object is SerializedRN
  */
 export declare function newRNG(seed?: Seed): RNG;
 export declare function rngEquals(rng1: RNG, rng2: RNG): boolean;
+/**
+ * Helper function to convert a `RNG` object to a `SerializedRNG` object. (This is used by the save
+ * data manager when writing data from the "save#.dat" file.)
+ */
+export declare function serializeRNG(rng: RNG): SerializedRNG;
 /**
  * Helper function to iterate over the provided object and set the seed for all of the values that
  * are RNG objects equal to a particular seed.
@@ -51,5 +48,4 @@ export declare function setAllRNGToSeed(object: unknown, seed: Seed): void;
 export declare function setAllRNGToStartSeed(object: unknown): void;
 /** Helper function to set a seed to an RNG object using Blade's recommended shift index. */
 export declare function setSeed(rng: RNG, seed: Seed): void;
-export {};
 //# sourceMappingURL=rng.d.ts.map

package/dist/functions/rng.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rng.d.ts","sourceRoot":"","sources":["../../src/functions/rng.ts"],"names":[],"mappings":";;;AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,aAAK,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IAC7C,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC,CAAC;AAEF,UAAU,aAAa;IACrB,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC;IAC9B,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC;IAC7C,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;CACtC;AAYD;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,CAAC,SAAS,GAAG,GAAG,aAAa,EAC7B,CAAC,SAAS,iBAAiB,EAC3B,GAAG,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAClD,wBAAgB,OAAO,CAAC,CAAC,SAAS,GAAG,GAAG,aAAa,EACnD,GAAG,EAAE,CAAC,GACL,aAAa,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAiDzC;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,2EAA2E;AAC3E,wBAAgB,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAEpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,OAAkB,GAAG,GAAG,CAIlD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAEvD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAoBjE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAK1D;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CASlD"}
+{"version":3,"file":"rng.d.ts","sourceRoot":"","sources":["../../src/functions/rng.ts"],"names":[],"mappings":";;;AAMA,oBAAY,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACpD,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC,CAAC;AAYF,wDAAwD;AACxD,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CASrC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,aAAa,GAAG,GAAG,CAatD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,IAAI,CAIpC;AAED,2EAA2E;AAC3E,wBAAgB,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAEpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,aAAa,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,IAAI,OAAkB,GAAG,GAAG,CAIlD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAEvD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,aAAa,CAYpD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CAoBjE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAK1D;AAED,4FAA4F;AAC5F,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,CASlD"}

package/dist/functions/rng.lua

@@ -6,8 +6,6 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
-local ____SerializationType = require("enums.SerializationType")
-local SerializationType = ____SerializationType.SerializationType
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
 local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
@@ -49,57 +47,27 @@ end
 RECOMMENDED_SHIFT_IDX = 35
 local KEYS = {"seed"}
 OBJECT_NAME = "RNG"
---- Helper function to copy an `RNG` object.
--- 
--- @param rng The RNG object to copy. In the case of deserialization, this will actually be a Lua
--- table instead of an instantiated RNG class.
--- @param serializationType Default is `SerializationType.NONE`.
-function ____exports.copyRNG(self, rng, serializationType)
-    if serializationType == nil then
-        serializationType = SerializationType.NONE
+--- Helper function to copy an `RNG` Isaac API class.
+function ____exports.copyRNG(self, rng)
+    if not ____exports.isRNG(nil, rng) then
+        error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
     end
-    repeat
-        local ____switch3 = serializationType
-        local ____cond3 = ____switch3 == SerializationType.NONE
-        if ____cond3 then
-            do
-                if not ____exports.isRNG(nil, rng) then
-                    error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                local seed = rng:GetSeed()
-                return ____exports.newRNG(nil, seed)
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.SERIALIZE
-        if ____cond3 then
-            do
-                if not ____exports.isRNG(nil, rng) then
-                    error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
-                end
-                local seed = rng:GetSeed()
-                local rngTable = {}
-                rngTable.seed = seed
-                rngTable[SerializationBrand.RNG] = ""
-                return rngTable
-            end
-        end
-        ____cond3 = ____cond3 or ____switch3 == SerializationType.DESERIALIZE
-        if ____cond3 then
-            do
-                if not isTable(nil, rng) then
-                    error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
-                end
-                local seedNumber = table.unpack(getNumbersFromTable(
-                    nil,
-                    rng,
-                    OBJECT_NAME,
-                    table.unpack(KEYS)
-                ))
-                local seed = seedNumber
-                return ____exports.newRNG(nil, seed)
-            end
-        end
-    until true
+    local seed = rng:GetSeed()
+    return ____exports.newRNG(nil, seed)
+end
+--- Helper function to convert a `SerializedRNG` object to a normal `RNG` object. (This is used by
+-- the save data manager when reading data from the "save#.dat" file.)
+function ____exports.deserializeRNG(self, rng)
+    if not isTable(nil, rng) then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+    end
+    local seed = table.unpack(getNumbersFromTable(
+        nil,
+        rng,
+        OBJECT_NAME,
+        table.unpack(KEYS)
+    ))
+    return ____exports.newRNG(nil, seed)
 end
 --- Used to determine is the given table is a serialized `RNG` object created by the save data
 -- manager and/or the `deepCopy` function.
@@ -116,6 +84,18 @@ end
 function ____exports.rngEquals(self, rng1, rng2)
     return isaacAPIClassEquals(nil, rng1, rng2, KEYS)
 end
+--- Helper function to convert a `RNG` object to a `SerializedRNG` object. (This is used by the save
+-- data manager when writing data from the "save#.dat" file.)
+function ____exports.serializeRNG(self, rng)
+    if not ____exports.isRNG(nil, rng) then
+        error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    local seed = rng:GetSeed()
+    local rngTable = {}
+    rngTable.seed = seed
+    rngTable[SerializationBrand.RNG] = ""
+    return rngTable
+end
 --- Helper function to iterate over the provided object and set the seed for all of the values that
 -- are RNG objects equal to a particular seed.
 function ____exports.setAllRNGToSeed(self, object, seed)

package/dist/functions/rockAlt.d.ts

@@ -2,16 +2,32 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="isaac-typescript-definitions" />
 import { RockAltType } from "../enums/RockAltType";
+/**
+ * Helper function to get the alternate rock type (i.e. urn, mushroom, etc.) that the current room
+ * will have.
+ *
+ * The rock type is based on the backdrop of the room.
+ *
+ * For example, if you change the backdrop of the starting room of the run to `BackdropType.CAVES`,
+ * and then spawn `GridEntityType.ROCK_ALT`, it will be a mushroom instead of an urn. Additionally,
+ * if it is destroyed, it will generate mushroom-appropriate rewards.
+ *
+ * On the other hand, if an urn is spawned first before the backdrop is changed to
+ * `BackdropType.CAVES`, the graphic of the urn will not switch to a mushroom. However, when
+ * destroyed, the urn will still generate mushroom-appropriate rewards.
+ */
+export declare function getRockAltType(): RockAltType;
 /**
  * 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.
+ * 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.
  *
- * For the purposes of spawning collectibles, this function assumes that the player has not seen the
- * collectible yet in the current run. In vanilla, it is only possible to get a e.g. Quarter if the
- * collectible still exists in the Treasure Room pool.
+ * Note that in vanilla, trinkets will not spawn if they have already been removed from the trinket
+ * pool. This function cannot replicate that behavior because there is no way to check to see if a
+ * trinket is still in the pool. Thus, it will always have a chance to spawn the respective trinket
+ * (e.g. Swallowed Penny from urns).
  *
  * The logic in this function is based on the rewards listed on the wiki:
  * https://bindingofisaacrebirth.fandom.com/wiki/Rocks
@@ -19,10 +35,14 @@ import { RockAltType } from "../enums/RockAltType";
  * @param position The place to spawn the reward.
  * @param rockAltType The type of reward to spawn. For example, `RockAltType.URN` will have a chance
  *                    at spawning coins and spiders.
+ * @param variant Optional. The variant of the grid entity to emulate. Default is 0, which
+ *                corresponds to a "normal" grid entity or an empty bucket. This only matters when
+ *                spawning the reward for buckets. (Empty buckets have different rewards than full
+ *                buckets.)
  * @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 declare function spawnRockAltReward(position: Vector, rockAltType: RockAltType, seedOrRNG?: Seed | RNG): boolean;
+export declare function spawnRockAltReward(position: Vector, rockAltType: RockAltType, variant?: number, seedOrRNG?: Seed | RNG): boolean;
 //# sourceMappingURL=rockAlt.d.ts.map

package/dist/functions/rockAlt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAQnD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CA4ET"}
+{"version":3,"file":"rockAlt.d.ts","sourceRoot":"","sources":["../../src/functions/rockAlt.ts"],"names":[],"mappings":";;;AAcA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AA+BnD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAK5C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,WAAW,EACxB,OAAO,SAAI,EACX,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,OAAO,CAwBT"}