isaacscript-common 4.7.3 → 4.8.2

package/enums/ModCallbackCustom.d.ts

@@ -706,7 +706,7 @@ export declare enum ModCallbackCustom {
      * what it was on the previous frame.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the player matches the `CollectibleType` provided.
+     * only fire if the collectible matches the `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleAdded(
@@ -721,7 +721,7 @@ export declare enum ModCallbackCustom {
      * what it was on the previous frame.
      *
      * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the player matches the `CollectibleType` provided.
+     * only fire if the collectible matches the `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleRemoved(

package/functions/playerHealth.d.ts

@@ -16,6 +16,13 @@ export declare function getPlayerHealthType(player: EntityPlayer, healthType: He
 export declare function newPlayerHealth(): PlayerHealth;
 export declare function playerConvertBlackHeartsToSoulHearts(player: EntityPlayer): void;
 export declare function playerConvertSoulHeartsToBlackHearts(player: EntityPlayer): void;
+/**
+ * Helper function to see if the player is out of health.
+ *
+ * Specifically, this function will return false if the player has 0 red hearts, 0 soul/black
+ * hearts, and 0 bone hearts.
+ */
+export declare function playerHasHealthLeft(player: EntityPlayer): boolean;
 export declare function removeAllPlayerHealth(player: EntityPlayer): void;
 /**
  * Helper function to set a player's health to a specific state. You can use this in combination

package/functions/playerHealth.lua

@@ -340,4 +340,14 @@ function ____exports.playerConvertSoulHeartsToBlackHearts(self, player)
     )
     ____exports.setPlayerHealth(nil, player, playerHealth)
 end
+--- Helper function to see if the player is out of health.
+-- 
+-- Specifically, this function will return false if the player has 0 red hearts, 0 soul/black
+-- hearts, and 0 bone hearts.
+function ____exports.playerHasHealthLeft(self, player)
+    local hearts = player:GetHearts()
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    return hearts > 0 or soulHearts > 0 or boneHearts > 0
+end
 return ____exports

package/functions/random.d.ts

@@ -40,5 +40,8 @@ export declare function getRandomFloat(min: int, max: int, seedOrRNG?: Seed | RN
  * @param max The upper bound for the random number (inclusive).
  * @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 exceptions Optional. An array of elements that will be skipped over when getting the
+ *                   random integer. For example, a min of 1, a max of 4, and an exceptions array of
+ *                   `[2]` would cause the function to return either 1, 3, or 4.
  */
-export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG): int;
+export declare function getRandomInt(min: int, max: int, seedOrRNG?: Seed | RNG, exceptions?: int[] | readonly int[]): int;

package/functions/random.lua

@@ -1,3 +1,6 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____rng = require("functions.rng")
 local getRandomSeed = ____rng.getRandomSeed
@@ -54,10 +57,16 @@ end
 -- @param max The upper bound for the random number (inclusive).
 -- @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()`.
-function ____exports.getRandomInt(self, min, max, seedOrRNG)
+-- @param exceptions Optional. An array of elements that will be skipped over when getting the
+-- random integer. For example, a min of 1, a max of 4, and an exceptions array of
+-- `[2]` would cause the function to return either 1, 3, or 4.
+function ____exports.getRandomInt(self, min, max, seedOrRNG, exceptions)
     if seedOrRNG == nil then
         seedOrRNG = getRandomSeed(nil)
     end
+    if exceptions == nil then
+        exceptions = {}
+    end
     local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
     if min > max then
         local oldMin = min
@@ -65,6 +74,13 @@ function ____exports.getRandomInt(self, min, max, seedOrRNG)
         min = oldMax
         max = oldMin
     end
-    return rng:RandomInt(max - min + 1) + min
+    local exceptionsSet = __TS__New(Set, exceptions)
+    local randomInt
+    repeat
+        do
+            randomInt = rng:RandomInt(max - min + 1) + min
+        end
+    until exceptionsSet:has(randomInt)
+    return randomInt
 end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "4.7.3",
+  "version": "4.8.2",
   "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.15"
+    "isaac-typescript-definitions": "^3.0.17"
   }
 }