isaacscript-common 87.6.2 → 87.8.0

package/dist/classes/ModUpgraded.lua

@@ -199,7 +199,7 @@ function ModUpgraded.prototype.initFeature(self, feature)
     end
     if feature.callbacksUsed ~= nil then
         for ____, callbackTuple in ipairs(feature.callbacksUsed) do
-            local modCallback, callbackFunc, optionalArgs = table.unpack(callbackTuple)
+            local modCallback, callbackFunc, optionalArgs = table.unpack(callbackTuple, 1, 3)
             self:AddPriorityCallback(
                 modCallback,
                 CallbackPriority.IMPORTANT,
@@ -210,7 +210,7 @@ function ModUpgraded.prototype.initFeature(self, feature)
     end
     if feature.customCallbacksUsed ~= nil then
         for ____, callbackTuple in ipairs(feature.customCallbacksUsed) do
-            local modCallback, callbackFunc, optionalArgs = table.unpack(callbackTuple)
+            local modCallback, callbackFunc, optionalArgs = table.unpack(callbackTuple, 1, 3)
             self:AddPriorityCallbackCustom(
                 modCallback,
                 CallbackPriority.IMPORTANT,
@@ -248,13 +248,13 @@ function ModUpgraded.prototype.uninitFeature(self, feature)
     end
     if feature.callbacksUsed ~= nil then
         for ____, callbackTuple in ipairs(feature.callbacksUsed) do
-            local modCallback, callbackFunc = table.unpack(callbackTuple)
+            local modCallback, callbackFunc = table.unpack(callbackTuple, 1, 2)
             self:RemoveCallback(modCallback, callbackFunc)
         end
     end
     if feature.customCallbacksUsed ~= nil then
         for ____, callbackTuple in ipairs(feature.customCallbacksUsed) do
-            local modCallback, callbackFunc = table.unpack(callbackTuple)
+            local modCallback, callbackFunc = table.unpack(callbackTuple, 1, 2)
             self:RemoveCallbackCustom(modCallback, callbackFunc)
         end
     end

package/dist/classes/callbacks/InputActionFilter.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(InputActionFilter, CustomCallback)
 function InputActionFilter.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _entity, inputHook, buttonAction = table.unpack(fireArgs)
-        local callbackInputHook, callbackButtonAction = table.unpack(optionalArgs)
+        local _entity, inputHook, buttonAction = table.unpack(fireArgs, 1, 3)
+        local callbackInputHook, callbackButtonAction = table.unpack(optionalArgs, 1, 2)
         return (callbackInputHook == nil or callbackInputHook == inputHook) and (callbackButtonAction == nil or callbackButtonAction == buttonAction)
     end
     self.inputAction = function(____, entity, inputHook, buttonAction) return self:fire(entity, inputHook, buttonAction) end

package/dist/classes/callbacks/InputActionPlayer.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(InputActionPlayer, CustomCallback)
 function InputActionPlayer.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local player, inputHook, buttonAction = table.unpack(fireArgs)
-        local callbackPlayerVariant, callbackCharacter, callbackInputHook, callbackButtonAction = table.unpack(optionalArgs)
+        local player, inputHook, buttonAction = table.unpack(fireArgs, 1, 3)
+        local callbackPlayerVariant, callbackCharacter, callbackInputHook, callbackButtonAction = table.unpack(optionalArgs, 1, 4)
         local character = player:GetPlayerType()
         return (callbackPlayerVariant == nil or callbackPlayerVariant == player.Variant) and (callbackCharacter == nil or callbackCharacter == character) and (callbackInputHook == nil or callbackInputHook == inputHook) and (callbackButtonAction == nil or callbackButtonAction == buttonAction)
     end

package/dist/classes/callbacks/PostCollectibleEmpty.lua

@@ -19,8 +19,8 @@ function PostCollectibleEmpty.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.v = v
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _collectible, oldCollectibleType = table.unpack(fireArgs)
-        local callbackCollectibleType = table.unpack(optionalArgs)
+        local _collectible, oldCollectibleType = table.unpack(fireArgs, 1, 2)
+        local callbackCollectibleType = table.unpack(optionalArgs, 1, 1)
         return callbackCollectibleType == nil or callbackCollectibleType == oldCollectibleType
     end
     self.postPickupUpdateCollectible = function(____, pickup)

package/dist/classes/callbacks/PostCursedTeleport.lua

@@ -49,7 +49,7 @@ function PostCursedTeleport.prototype.____constructor(self)
         if trackingArray == nil then
             return
         end
-        local lastDamageFrame, callbackActivatedOnThisFrame = table.unpack(trackingArray)
+        local lastDamageFrame, callbackActivatedOnThisFrame = table.unpack(trackingArray, 1, 2)
         if not self:playerIsTeleportingFromCursedTeleport(player, lastDamageFrame) then
             return
         end
@@ -76,7 +76,7 @@ function PostCursedTeleport.prototype.setDamageFrame(self, player, damageFlags)
     local gameFrameCount = game:GetFrameCount()
     local trackingArray = mapGetPlayer(nil, v.run.playersDamageFrameMap, player)
     if trackingArray ~= nil then
-        local lastDamageFrame, callbackFiredOnThisFrame = table.unpack(trackingArray)
+        local lastDamageFrame, callbackFiredOnThisFrame = table.unpack(trackingArray, 1, 2)
         if lastDamageFrame == gameFrameCount and callbackFiredOnThisFrame then
             return
         end

package/dist/classes/callbacks/PostCustomRevive.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PostCustomRevive, CustomCallback)
 function PostCustomRevive.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _player, revivalType = table.unpack(fireArgs)
-        local callbackRevivalType = table.unpack(optionalArgs)
+        local _player, revivalType = table.unpack(fireArgs, 1, 2)
+        local callbackRevivalType = table.unpack(optionalArgs, 1, 1)
         return callbackRevivalType == nil or revivalType == callbackRevivalType
     end
     self.featuresUsed = {ISCFeature.CUSTOM_REVIVE}

package/dist/classes/callbacks/PostDiceRoomActivated.lua

@@ -20,8 +20,8 @@ function PostDiceRoomActivated.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.v = v
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _player, diceFloorSubType = table.unpack(fireArgs)
-        local callbackDiceFloorSubType = table.unpack(optionalArgs)
+        local _player, diceFloorSubType = table.unpack(fireArgs, 1, 2)
+        local callbackDiceFloorSubType = table.unpack(optionalArgs, 1, 1)
         return callbackDiceFloorSubType == nil or diceFloorSubType == callbackDiceFloorSubType
     end
     self.postEffectUpdateDiceFloor = function(____, effect)

package/dist/classes/callbacks/PostGridEntityCollision.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PostGridEntityCollision, CustomCallback)
 function PostGridEntityCollision.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local gridEntity, entity = table.unpack(fireArgs)
-        local callbackGridEntityType, callbackGridEntityVariant, callbackEntityType, callbackEntityVariant, callbackEntitySubType = table.unpack(optionalArgs)
+        local gridEntity, entity = table.unpack(fireArgs, 1, 2)
+        local callbackGridEntityType, callbackGridEntityVariant, callbackEntityType, callbackEntityVariant, callbackEntitySubType = table.unpack(optionalArgs, 1, 5)
         local gridEntityType = gridEntity:GetType()
         local gridEntityVariant = gridEntity:GetVariant()
         return (callbackGridEntityType == nil or callbackGridEntityType == gridEntityType) and (callbackGridEntityVariant == nil or callbackGridEntityVariant == gridEntityVariant) and (callbackEntityType == nil or callbackEntityType == entity.Type) and (callbackEntityVariant == nil or callbackEntityVariant == entity.Variant) and (callbackEntitySubType == nil or callbackEntitySubType == entity.SubType)

package/dist/classes/callbacks/PostGridEntityCustomCollision.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PostGridEntityCustomCollision, CustomCallback)
 function PostGridEntityCustomCollision.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _gridEntity, gridEntityTypeCustom, entity = table.unpack(fireArgs)
-        local callbackGridEntityTypeCustom, callbackEntityType, callbackEntityVariant, callbackEntitySubType = table.unpack(optionalArgs)
+        local _gridEntity, gridEntityTypeCustom, entity = table.unpack(fireArgs, 1, 3)
+        local callbackGridEntityTypeCustom, callbackEntityType, callbackEntityVariant, callbackEntitySubType = table.unpack(optionalArgs, 1, 4)
         return (callbackGridEntityTypeCustom == nil or callbackGridEntityTypeCustom == gridEntityTypeCustom) and (callbackEntityType == nil or callbackEntityType == entity.Type) and (callbackEntityVariant == nil or callbackEntityVariant == entity.Variant) and (callbackEntitySubType == nil or callbackEntitySubType == entity.SubType)
     end
     self.featuresUsed = {ISCFeature.GRID_ENTITY_COLLISION_DETECTION}

package/dist/classes/callbacks/PostGridEntityCustomRemove.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PostGridEntityCustomRemove, CustomCallback)
 function PostGridEntityCustomRemove.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _gridIndex, gridEntityTypeCustom = table.unpack(fireArgs)
-        local callbackGridEntityTypeCustom = table.unpack(optionalArgs)
+        local _gridIndex, gridEntityTypeCustom = table.unpack(fireArgs, 1, 2)
+        local callbackGridEntityTypeCustom = table.unpack(optionalArgs, 1, 1)
         return callbackGridEntityTypeCustom == nil or callbackGridEntityTypeCustom == gridEntityTypeCustom
     end
     self.featuresUsed = {ISCFeature.GRID_ENTITY_UPDATE_DETECTION}

package/dist/classes/callbacks/PostGridEntityRemove.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PostGridEntityRemove, CustomCallback)
 function PostGridEntityRemove.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _gridIndex, gridEntityType, variant = table.unpack(fireArgs)
-        local callbackGridEntityType, callbackVariant = table.unpack(optionalArgs)
+        local _gridIndex, gridEntityType, variant = table.unpack(fireArgs, 1, 3)
+        local callbackGridEntityType, callbackVariant = table.unpack(optionalArgs, 1, 2)
         return (callbackGridEntityType == nil or callbackGridEntityType == gridEntityType) and (callbackVariant == nil or callbackVariant == variant)
     end
     self.featuresUsed = {ISCFeature.GRID_ENTITY_UPDATE_DETECTION}

package/dist/classes/callbacks/PostItemDischarge.lua

@@ -45,8 +45,8 @@ function PostItemDischarge.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.v = v
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _player, collectibleType = table.unpack(fireArgs)
-        local callbackCollectibleType = table.unpack(optionalArgs)
+        local _player, collectibleType = table.unpack(fireArgs, 1, 2)
+        local callbackCollectibleType = table.unpack(optionalArgs, 1, 1)
         return callbackCollectibleType == nil or callbackCollectibleType == collectibleType
     end
     self.preNPCCollisionSucker = function(____, npc, collider)

package/dist/classes/callbacks/PostKeyboardChanged.lua

@@ -22,8 +22,8 @@ function PostKeyboardChanged.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.v = v
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local keyboard, pressed = table.unpack(fireArgs)
-        local callbackKeyboard, callbackPressed = table.unpack(optionalArgs)
+        local keyboard, pressed = table.unpack(fireArgs, 1, 2)
+        local callbackKeyboard, callbackPressed = table.unpack(optionalArgs, 1, 2)
         return (callbackKeyboard == nil or callbackKeyboard == keyboard) and (callbackPressed == nil or callbackPressed == pressed)
     end
     self.postRender = function()

package/dist/classes/callbacks/PostPickupSelectionFilter.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PostPickupSelectionFilter, CustomCallback)
 function PostPickupSelectionFilter.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _pickup, pickupVariant, subType = table.unpack(fireArgs)
-        local callbackPickupVariant, callbackPickupSubType = table.unpack(optionalArgs)
+        local _pickup, pickupVariant, subType = table.unpack(fireArgs, 1, 3)
+        local callbackPickupVariant, callbackPickupSubType = table.unpack(optionalArgs, 1, 2)
         return (callbackPickupVariant == nil or callbackPickupVariant == pickupVariant) and (callbackPickupSubType == nil or callbackPickupSubType == subType)
     end
     self.postPickupSelection = function(____, pickup, variant, subType) return self:fire(pickup, variant, subType) end

package/dist/classes/callbacks/PostPurchase.lua

@@ -36,8 +36,8 @@ function PostPurchase.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.v = v
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _player, pickup = table.unpack(fireArgs)
-        local callbackPickupVariant, callbackPickupSubType = table.unpack(optionalArgs)
+        local _player, pickup = table.unpack(fireArgs, 1, 2)
+        local callbackPickupVariant, callbackPickupSubType = table.unpack(optionalArgs, 1, 2)
         return (callbackPickupVariant == nil or callbackPickupVariant == pickup.Variant) and (callbackPickupSubType == nil or callbackPickupSubType == pickup.SubType)
     end
     self.postUseItem = function(____, _collectibleType, _rng, player)

package/dist/classes/callbacks/PostRoomClearChanged.lua

@@ -19,8 +19,8 @@ function PostRoomClearChanged.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.v = v
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local roomClear = table.unpack(fireArgs)
-        local callbackRoomClear = table.unpack(optionalArgs)
+        local roomClear = table.unpack(fireArgs, 1, 1)
+        local callbackRoomClear = table.unpack(optionalArgs, 1, 1)
         return callbackRoomClear == nil or callbackRoomClear == roomClear
     end
     self.postUpdate = function()

package/dist/classes/callbacks/PostTransformation.lua

@@ -26,8 +26,8 @@ function PostTransformation.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.v = v
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local _player, playerForm = table.unpack(fireArgs)
-        local callbackPlayerForm = table.unpack(optionalArgs)
+        local _player, playerForm = table.unpack(fireArgs, 1, 2)
+        local callbackPlayerForm = table.unpack(optionalArgs, 1, 1)
         return callbackPlayerForm == nil or callbackPlayerForm == playerForm
     end
     self.postPEffectUpdateReordered = function(____, player)

package/dist/classes/callbacks/PreEntitySpawnFilter.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PreEntitySpawnFilter, CustomCallback)
 function PreEntitySpawnFilter.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local entityType, variant, subType = table.unpack(fireArgs)
-        local callbackEntityType, callbackVariant, callbackSubType = table.unpack(optionalArgs)
+        local entityType, variant, subType = table.unpack(fireArgs, 1, 3)
+        local callbackEntityType, callbackVariant, callbackSubType = table.unpack(optionalArgs, 1, 3)
         return (callbackEntityType == nil or callbackEntityType == entityType) and (callbackVariant == nil or callbackVariant == variant) and (callbackSubType == nil or callbackSubType == subType)
     end
     self.preEntitySpawn = function(____, entityType, variant, subType, position, velocity, spawner, initSeed) return self:fire(

package/dist/classes/callbacks/PreRoomEntitySpawnFilter.lua

@@ -13,8 +13,8 @@ __TS__ClassExtends(PreRoomEntitySpawnFilter, CustomCallback)
 function PreRoomEntitySpawnFilter.prototype.____constructor(self)
     CustomCallback.prototype.____constructor(self)
     self.shouldFire = function(____, fireArgs, optionalArgs)
-        local entityTypeOrGridEntityXMLType, variant, subType = table.unpack(fireArgs)
-        local callbackEntityTypeOrGridEntityXMLType, callbackVariant, callbackSubType = table.unpack(optionalArgs)
+        local entityTypeOrGridEntityXMLType, variant, subType = table.unpack(fireArgs, 1, 3)
+        local callbackEntityTypeOrGridEntityXMLType, callbackVariant, callbackSubType = table.unpack(optionalArgs, 1, 3)
         return (callbackEntityTypeOrGridEntityXMLType == nil or callbackEntityTypeOrGridEntityXMLType == entityTypeOrGridEntityXMLType) and (callbackVariant == nil or callbackVariant == variant) and (callbackSubType == nil or callbackSubType == subType)
     end
     self.preRoomEntitySpawn = function(____, entityTypeOrGridEntityXMLType, variant, subType, gridIndex, initSeed) return self:fire(

package/dist/classes/features/callbackLogic/GridEntityUpdateDetection.lua

@@ -67,7 +67,7 @@ function GridEntityUpdateDetection.prototype.checkGridEntitiesRemoved(self, grid
     for ____, ____value in __TS__Iterator(v.room.initializedGridEntities) do
         local gridIndex = ____value[1]
         local gridEntityTuple = ____value[2]
-        local storedGridEntityType, storedGridEntityVariant = table.unpack(gridEntityTuple)
+        local storedGridEntityType, storedGridEntityVariant = table.unpack(gridEntityTuple, 1, 2)
         local gridEntity = gridEntitiesMap:get(gridIndex)
         if gridEntity == nil or gridEntity:GetType() ~= storedGridEntityType then
             v.room.initializedGridEntities:delete(gridIndex)
@@ -85,7 +85,7 @@ function GridEntityUpdateDetection.prototype.checkGridEntityStateChanged(self, g
     if gridEntityTuple == nil then
         return
     end
-    local _gridEntityType, _gridEntityVariant, oldState = table.unpack(gridEntityTuple)
+    local _gridEntityType, _gridEntityVariant, oldState = table.unpack(gridEntityTuple, 1, 3)
     local newState = gridEntity.State
     if oldState ~= newState then
         self:updateTupleInMap(gridEntity)

package/dist/classes/features/other/DeployJSONRoom.lua

@@ -61,7 +61,7 @@ function spawnGridEntityForJSONRoom(self, gridEntityXMLType, gridEntityXMLVarian
     if gridEntityTuple == nil then
         return nil
     end
-    local gridEntityType, variant = table.unpack(gridEntityTuple)
+    local gridEntityType, variant = table.unpack(gridEntityTuple, 1, 2)
     local position = gridCoordinatesToWorldPosition(nil, x, y)
     local gridIndex = room:GetGridIndex(position)
     local gridEntity = spawnGridEntityWithVariant(nil, gridEntityType, variant, gridIndex)

package/dist/classes/features/other/ExtraConsoleCommands.lua

@@ -118,7 +118,7 @@ function ExtraConsoleCommands.prototype.____constructor(self)
         if resultTuple == nil then
             return
         end
-        local commandName, commandFunction = table.unpack(resultTuple)
+        local commandName, commandFunction = table.unpack(resultTuple, 1, 2)
         print("Command: " .. commandName)
         commandFunction(nil, params)
     end

package/dist/classes/features/other/NoSirenSteal.lua

@@ -38,7 +38,7 @@ function NoSirenSteal.prototype.checkReturnFamiliarToPlayer(self, npc)
 end
 function NoSirenSteal.prototype.blacklistEntryExists(self, incomingFamiliarVariant, incomingFamiliarSubType)
     for ____, familiarTuple in ipairs(v.run.familiarBlacklist) do
-        local familiarVariant, familiarSubType = table.unpack(familiarTuple)
+        local familiarVariant, familiarSubType = table.unpack(familiarTuple, 1, 2)
         if familiarVariant == incomingFamiliarVariant and familiarSubType == incomingFamiliarSubType then
             return true
         end

package/dist/classes/features/other/PersistentEntities.lua

@@ -125,7 +125,7 @@ function PersistentEntities.prototype.removePersistentEntity(self, persistentEnt
         local ptrHash = ____value[1]
         local tuple = ____value[2]
         do
-            local index, entityPtr = table.unpack(tuple)
+            local index, entityPtr = table.unpack(tuple, 1, 2)
             if index ~= persistentEntityIndex then
                 goto __continue16
             end

package/dist/classes/features/other/extraConsoleCommands/commands.lua

@@ -382,7 +382,7 @@ function ____exports.spawnTrinketAt(self, params, golden)
         print("You must specify the number corresponding to the trinket type and the number corresponding to the grid tile location.")
         return
     end
-    local trinketTypeString, gridIndexString = table.unpack(args)
+    local trinketTypeString, gridIndexString = table.unpack(args, 1, 2)
     if trinketTypeString == nil or gridIndexString == nil then
         return
     end
@@ -419,7 +419,7 @@ function ____exports.addCharges(self, params)
         print("Invalid amount of arguments: " .. tostring(#args))
         return
     end
-    local activeSlotString, numChargeString = table.unpack(args)
+    local activeSlotString, numChargeString = table.unpack(args, 1, 2)
     if activeSlotString == nil then
         return
     end
@@ -1210,7 +1210,7 @@ function ____exports.setCharges(self, params)
         print("Invalid amount of arguments: " .. tostring(#args))
         return
     end
-    local activeSlotString, chargeString = table.unpack(args)
+    local activeSlotString, chargeString = table.unpack(args, 1, 2)
     if activeSlotString == nil or chargeString == nil then
         return
     end
@@ -1245,7 +1245,7 @@ function ____exports.setPosition(self, params)
         print("You must specify a position. (e.g. \"setPosition 100 50\")")
         return
     end
-    local xString, yString = table.unpack(args)
+    local xString, yString = table.unpack(args, 1, 2)
     if xString == nil or yString == nil then
         return
     end
@@ -1324,7 +1324,7 @@ function ____exports.spawnCollectibleAt(self, params)
         print("You must specify the number corresponding to the collectible type and the number corresponding to the grid tile location.")
         return
     end
-    local collectibleTypeString, gridIndexString = table.unpack(args)
+    local collectibleTypeString, gridIndexString = table.unpack(args, 1, 2)
     if collectibleTypeString == nil or gridIndexString == nil then
         return
     end

package/dist/functions/array.d.ts

@@ -9,25 +9,11 @@ export declare function arrayEquals<T>(array1: readonly T[], array2: readonly T[
  * array. If the specified element(s) are not found in the array, it will simply return a shallow
  * copy of the array.
  *
- * This function is variadic, meaning that you can specify N arguments to remove N elements.
- *
- * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAll` function
- * instead.
- */
-export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
-/**
- * Shallow copies and removes the specified element(s) from the array. Returns the copied array. If
- * the specified element(s) are not found in the array, it will simply return a shallow copy of the
- * array.
+ * If there is more than one matching element in the array, this function will remove all of them.
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
- *
- * If there is more than one matching element in the array, this function will remove every matching
- * element. If you want to only remove the first matching element, use the `arrayRemove` function
- * instead.
  */
-export declare function arrayRemoveAll<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
+export declare function arrayRemove<T>(originalArray: readonly T[], ...elementsToRemove: readonly T[]): T[];
 /**
  * Removes all of the specified element(s) from the array. If the specified element(s) are not found
  * in the array, this function will do nothing.
@@ -101,7 +87,7 @@ export declare function emptyArray(array: unknown[]): void;
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): NewT[];
+export declare function filterMap<OldT, NewT>(array: readonly OldT[], func: (element: OldT) => NewT | undefined): readonly NewT[];
 /**
  * Helper function to get all possible combinations of the given array. This includes the
  * combination of an empty array.

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

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/functions/array.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAO1D;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,MAAM,EAAE,SAAS,CAAC,EAAE,EACpB,MAAM,EAAE,SAAS,CAAC,EAAE,GACnB,OAAO,CAST;AAED;;;;;;;;;;GAUG;AAEH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,CAAC,EAAE,CAWL;AAED;;;;;;;;;;GAUG;AAEH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,CAAC,EAAE,CAIL;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAErC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,OAAO,CAeT;AAED;;;;;;;;;;;GAWG;AAEH,wBAAgB,kBAAkB,CAAC,CAAC,EAElC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,CAAC,EAAE,CAYL;AAED;;;;;;GAMG;AAEH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,GAAG,eAAe,EAAE,SAAS,GAAG,EAAE,GACjC,CAAC,EAAE,CAWL;AAED;;;;;;;GAOG;AAEH,wBAAgB,uBAAuB,CAAC,CAAC,EAEvC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,eAAe,EAAE,SAAS,GAAG,EAAE,GACjC,CAAC,EAAE,CAoBL;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,CAQ/D;AAED;;;;;;GAMG;AAEH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAS5E;AAED;;;;;;GAMG;AAEH,wBAAgB,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,CAc3E;AAED,0EAA0E;AAE1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAEjD;AAED;;;;;;;;;;GAUG;AAEH,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAClC,KAAK,EAAE,SAAS,IAAI,EAAE,EACtB,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,GAAG,SAAS,GACxC,IAAI,EAAE,CAWR;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,iBAAiB,EAAE,OAAO,EAC1B,GAAG,CAAC,EAAE,GAAG,EACT,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CAsB7B;AAuBD;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EACjE,KAAK,EAAE,SAAS,CAAC,EAAE,GAClB,SAAS,CAAC,EAAE,CAad;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,SAAS,GAAG,EAAE,CAEzE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,GAAG,SAAS,CAcpB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,GAAG,SAAS,CAcpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,SAAS,CAAC,EAAO,GAC5B,CAAC,CAiBH;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAE9C,KAAK,EAAE,CAAC,EAAE,EACV,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,SAAS,CAAC,EAAO,GAC5B,CAAC,CAQH;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,SAAS,OAAO,EAAE,EACzB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,SAAS,GAAG,EAAO,GAC9B,GAAG,CAQL;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,YAAY,SAAS,YAAY,CAAC,CAAC,CAAC,EAC9D,KAAK,EAAE,SAAS,YAAY,EAAE,EAC9B,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,GAC7B,aAAa,IAAI,YAAY,CAG/B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,OAAO,EACf,sBAAsB,UAAO,GAC5B,MAAM,IAAI,OAAO,EAAE,CAmCrB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,GAAG,EAAE,GAAG,OAAO,CAWhE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,OAAO,CAGxE;AAED,iEAAiE;AACjE,wBAAgB,cAAc,CAAC,CAAC,EAC9B,YAAY,EAAE,SAAS,CAAC,EAAE,EAC1B,WAAW,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GACvC,OAAO,CAET;AAED,4EAA4E;AAE5E,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAIjE;AAED;;;;;;;;;;;;GAYG;AAEH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,GAChC,CAAC,EAAE,CAKL;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAEjC,KAAK,EAAE,OAAO,EAAE,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,GAChC,IAAI,CAWN;AAED,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAEzD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAE/B,KAAK,EAAE,OAAO,EAAE,EAChB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,GACR,IAAI,CAMN"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/functions/array.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAO1D;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,MAAM,EAAE,SAAS,CAAC,EAAE,EACpB,MAAM,EAAE,SAAS,CAAC,EAAE,GACnB,OAAO,CAST;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAEhC,CAAC,EAAE,CAWL;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAErC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAChC,OAAO,CAeT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAElC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,gBAAgB,EAAE,SAAS,CAAC,EAAE,GAEhC,CAAC,EAAE,CAYL;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,GAAG,eAAe,EAAE,SAAS,GAAG,EAAE,GAEjC,CAAC,EAAE,CAWL;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,CAAC,EAEvC,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,eAAe,EAAE,SAAS,GAAG,EAAE,GAEjC,CAAC,EAAE,CAoBL;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,CAQ/D;AAED;;;;;;GAMG;AAEH,wBAAgB,aAAa,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAS5E;AAED;;;;;;GAMG;AAEH,wBAAgB,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,CAc3E;AAED,0EAA0E;AAE1E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAEjD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,EAClC,KAAK,EAAE,SAAS,IAAI,EAAE,EACtB,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,IAAI,GAAG,SAAS,GACxC,SAAS,IAAI,EAAE,CAWjB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,iBAAiB,EAAE,OAAO,EAC1B,GAAG,CAAC,EAAE,GAAG,EACT,GAAG,CAAC,EAAE,GAAG,GACR,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CAsB7B;AAuBD;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EACjE,KAAK,EAAE,SAAS,CAAC,EAAE,GAClB,SAAS,CAAC,EAAE,CAad;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,SAAS,GAAG,EAAE,CAEzE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,GAAG,SAAS,CAcpB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,SAAS,MAAM,EAAE,GACvB,MAAM,GAAG,SAAS,CAcpB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,KAAK,EAAE,SAAS,CAAC,EAAE,EACnB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,SAAS,CAAC,EAAO,GAC5B,CAAC,CAiBH;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAE9C,KAAK,EAAE,CAAC,EAAE,EACV,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,SAAS,CAAC,EAAO,GAC5B,CAAC,CAQH;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,SAAS,OAAO,EAAE,EACzB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,EACjC,UAAU,GAAE,SAAS,GAAG,EAAO,GAC9B,GAAG,CAQL;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,YAAY,SAAS,YAAY,CAAC,CAAC,CAAC,EAC9D,KAAK,EAAE,SAAS,YAAY,EAAE,EAC9B,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC,GAC7B,aAAa,IAAI,YAAY,CAG/B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,OAAO,EACf,sBAAsB,UAAO,GAC5B,MAAM,IAAI,OAAO,EAAE,CAmCrB;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,SAAS,GAAG,EAAE,GAAG,OAAO,CAWhE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,SAAS,OAAO,EAAE,GAAG,OAAO,CAGxE;AAED,iEAAiE;AACjE,wBAAgB,cAAc,CAAC,CAAC,EAC9B,YAAY,EAAE,SAAS,CAAC,EAAE,EAC1B,WAAW,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,GACvC,OAAO,CAET;AAED,4EAA4E;AAE5E,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAIjE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,aAAa,EAAE,SAAS,CAAC,EAAE,EAC3B,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,GAEhC,CAAC,EAAE,CAKL;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAEjC,KAAK,EAAE,OAAO,EAAE,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,GAChC,IAAI,CAWN;AAED,+DAA+D;AAC/D,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAEzD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAE/B,KAAK,EAAE,OAAO,EAAE,EAChB,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,GACR,IAAI,CAMN"}

package/dist/functions/array.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.arrayEquals = arrayEquals;
 exports.arrayRemove = arrayRemove;
-exports.arrayRemoveAll = arrayRemoveAll;
 exports.arrayRemoveAllInPlace = arrayRemoveAllInPlace;
 exports.arrayRemoveInPlace = arrayRemoveInPlace;
 exports.arrayRemoveIndex = arrayRemoveIndex;
@@ -54,14 +53,13 @@ function arrayEquals(array1, array2) {
  * array. If the specified element(s) are not found in the array, it will simply return a shallow
  * copy of the array.
  *
- * This function is variadic, meaning that you can specify N arguments to remove N elements.
+ * If there is more than one matching element in the array, this function will remove all of them.
  *
- * If there is more than one matching element in the array, this function will only remove the first
- * matching element. If you want to remove all of the elements, use the `arrayRemoveAll` function
- * instead.
+ * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
+function arrayRemove(originalArray, ...elementsToRemove
 // eslint-disable-next-line complete/no-mutable-return
-function arrayRemove(originalArray, ...elementsToRemove) {
+) {
     const elementsToRemoveSet = new ReadonlySet_1.ReadonlySet(elementsToRemove);
     const array = [];
     for (const element of originalArray) {
@@ -71,23 +69,6 @@ function arrayRemove(originalArray, ...elementsToRemove) {
     }
     return array;
 }
-/**
- * Shallow copies and removes the specified element(s) from the array. Returns the copied array. If
- * the specified element(s) are not found in the array, it will simply return a shallow copy of the
- * array.
- *
- * This function is variadic, meaning that you can specify N arguments to remove N elements.
- *
- * If there is more than one matching element in the array, this function will remove every matching
- * element. If you want to only remove the first matching element, use the `arrayRemove` function
- * instead.
- */
-// eslint-disable-next-line complete/no-mutable-return
-function arrayRemoveAll(originalArray, ...elementsToRemove) {
-    const array = copyArray(originalArray);
-    arrayRemoveAllInPlace(array, ...elementsToRemove);
-    return array;
-}
 /**
  * Removes all of the specified element(s) from the array. If the specified element(s) are not found
  * in the array, this function will do nothing.
@@ -128,10 +109,11 @@ array, ...elementsToRemove) {
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-// eslint-disable-next-line complete/no-mutable-return
 function arrayRemoveInPlace(
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
-array, ...elementsToRemove) {
+array, ...elementsToRemove
+// eslint-disable-next-line complete/no-mutable-return
+) {
     const removedElements = [];
     for (const element of elementsToRemove) {
         const index = array.indexOf(element);
@@ -149,8 +131,9 @@ array, ...elementsToRemove) {
  *
  * This function is variadic, meaning that you can specify N arguments to remove N elements.
  */
+function arrayRemoveIndex(originalArray, ...indexesToRemove
 // eslint-disable-next-line complete/no-mutable-return
-function arrayRemoveIndex(originalArray, ...indexesToRemove) {
+) {
     const indexesToRemoveSet = new ReadonlySet_1.ReadonlySet(indexesToRemove);
     const array = [];
     for (const [i, element] of originalArray.entries()) {
@@ -168,10 +151,11 @@ function arrayRemoveIndex(originalArray, ...indexesToRemove) {
  *
  * @returns The removed elements. This will be an empty array if no elements were removed.
  */
-// eslint-disable-next-line complete/no-mutable-return
 function arrayRemoveIndexInPlace(
 // eslint-disable-next-line complete/prefer-readonly-parameter-types
-array, ...indexesToRemove) {
+array, ...indexesToRemove
+// eslint-disable-next-line complete/no-mutable-return
+) {
     const legalIndexes = indexesToRemove.filter((i) => i >= 0 && i < array.length);
     if (legalIndexes.length === 0) {
         return [];
@@ -248,7 +232,6 @@ function emptyArray(array) {
  * This is named `filterMap` after the Rust function:
  * https://doc.rust-lang.org/std/iter/struct.FilterMap.html
  */
-// eslint-disable-next-line complete/no-mutable-return
 function filterMap(array, func) {
     const filteredArray = [];
     for (const element of array) {
@@ -331,7 +314,7 @@ function getArrayDuplicateElements(array) {
         set.add(element);
     }
     const values = [...duplicateElements];
-    return values.sort(sort_1.sortNormal);
+    return values.toSorted(sort_1.sortNormal);
 }
 /**
  * Helper function to get an array containing the indexes of an array.
@@ -538,7 +521,6 @@ function setAllArrayElements(array, value) {
  *                  `RNG.Next` method will be called. If `undefined` is provided, it will default to
  *                  a random seed.
  */
-// eslint-disable-next-line complete/no-mutable-return
 function shuffleArray(originalArray, seedOrRNG) {
     const array = copyArray(originalArray);
     shuffleArrayInPlace(array, seedOrRNG);