isaacscript-common 6.6.3 → 6.7.0

package/dist/functions/deepCopyTests.lua

@@ -27,7 +27,7 @@ local isString = ____types.isString
 local isTable = ____types.isTable
 function copiedObjectIsTable(self)
     local oldObject = {abc = "def"}
-    local newObject = deepCopy(nil, oldObject)
+    local newObject = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectIsTable")
     if not isTable(nil, newObject) then
         error("The copied object had a type of: " .. __TS__TypeOf(newObject))
     end
@@ -36,7 +36,7 @@ function copiedObjectHasKeyAndValueString(self)
     local keyToLookFor = "abc"
     local valueToLookFor = "def"
     local oldObject = {abc = valueToLookFor}
-    local newTable = deepCopy(nil, oldObject)
+    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasKeyAndValueString")
     local newObject = newTable
     local value = newObject[keyToLookFor]
     if value == nil then
@@ -54,7 +54,7 @@ function copiedTableHasKeyAndValueNumber(self)
     local valueToLookFor = 456
     local oldTable = {}
     oldTable[keyToLookFor] = valueToLookFor
-    local newObject = deepCopy(nil, oldTable)
+    local newObject = deepCopy(nil, oldTable, SerializationType.NONE, "copiedTableHasKeyAndValueNumber")
     local newTable = newObject
     local value = newTable[keyToLookFor]
     if value == nil then
@@ -72,7 +72,7 @@ function copiedTableDoesNotCoerceTypes(self)
     local valueToLookFor = 456
     local oldTable = {}
     oldTable[keyToLookFor] = valueToLookFor
-    local newObject = deepCopy(nil, oldTable)
+    local newObject = deepCopy(nil, oldTable, SerializationType.NONE, "copiedTableDoesNotCoerceTypes")
     local newTable = newObject
     local keyString = tostring(keyToLookFor)
     local valueString = tostring(valueToLookFor)
@@ -89,7 +89,7 @@ function copiedObjectHasNoReferencesForPrimitivesForward(self)
     local originalStringValue = "abcdef"
     local originalNumberValue = 123
     local oldObject = {abc = originalStringValue, def = originalNumberValue}
-    local newTable = deepCopy(nil, oldObject)
+    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForPrimitivesForward")
     local newObject = newTable
     oldObject.abc = "newValue"
     if oldObject.abc == newObject.abc then
@@ -104,7 +104,7 @@ function copiedObjectHasNoReferencesForPrimitivesBackward(self)
     local originalStringValue = "abcdef"
     local originalNumberValue = 123
     local oldObject = {abc = originalStringValue, def = originalNumberValue}
-    local newTable = deepCopy(nil, oldObject)
+    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForPrimitivesBackward")
     local newObject = newTable
     newObject.abc = "newValue"
     if newObject.abc == oldObject.abc then
@@ -117,7 +117,7 @@ function copiedObjectHasNoReferencesForPrimitivesBackward(self)
 end
 function copiedObjectHasNoReferencesForArray(self)
     local oldObject = {abc = {1, 2, 3}}
-    local newTable = deepCopy(nil, oldObject)
+    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasNoReferencesForArray")
     local newObject = newTable
     if oldObject.abc == newObject.abc then
         error("The copied object has the same point to the child array.")
@@ -145,7 +145,7 @@ function copiedObjectHasChildObject(self)
     local keyToLookFor = "def"
     local valueToLookFor = "ghi"
     local oldObject = {abc = {def = valueToLookFor}}
-    local newTable = deepCopy(nil, oldObject)
+    local newTable = deepCopy(nil, oldObject, SerializationType.NONE, "copiedObjectHasChildObject")
     local newObject = newTable
     local childObject = newObject[childObjectIndex]
     if childObject == nil then
@@ -170,7 +170,7 @@ function copiedMapIsMap(self)
     local valueToLookFor = "def"
     local oldMap = __TS__New(Map)
     oldMap:set(keyToLookFor, valueToLookFor)
-    local newObject = deepCopy(nil, oldMap)
+    local newObject = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapIsMap")
     local newMap = newObject
     if not isTable(nil, newMap) then
         error("The copied Map had a type of: " .. __TS__TypeOf(newMap))
@@ -184,7 +184,7 @@ function copiedMapHasValue(self)
     local valueToLookFor = "def"
     local oldMap = __TS__New(Map)
     oldMap:set(keyToLookFor, valueToLookFor)
-    local newTable = deepCopy(nil, oldMap)
+    local newTable = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapHasValue")
     local newMap = newTable
     local value = newMap:get(keyToLookFor)
     if value == nil then
@@ -198,7 +198,7 @@ function copiedSetIsSet(self)
     local valueToLookFor = "abc"
     local oldSet = __TS__New(Set)
     oldSet:add(valueToLookFor)
-    local newTable = deepCopy(nil, oldSet)
+    local newTable = deepCopy(nil, oldSet, SerializationType.NONE, "copiedSetIsSet")
     local newSet = newTable
     if not isTable(nil, newSet) then
         error("The copied Set had a type of: " .. __TS__TypeOf(newSet))
@@ -211,7 +211,7 @@ function copiedSetHasValue(self)
     local valueToLookFor = "abc"
     local oldSet = __TS__New(Set)
     oldSet:add(valueToLookFor)
-    local newTable = deepCopy(nil, oldSet)
+    local newTable = deepCopy(nil, oldSet, SerializationType.NONE, "copiedSetHasValue")
     local newSet = newTable
     local hasValue = newSet:has(valueToLookFor)
     if not hasValue then
@@ -226,7 +226,7 @@ function copiedMapHasChildMap(self)
     local keyToLookFor = "abc"
     local oldMap = __TS__New(Map)
     oldMap:set(keyToLookFor, oldChildMap)
-    local newTable = deepCopy(nil, oldMap)
+    local newTable = deepCopy(nil, oldMap, SerializationType.NONE, "copiedMapHasChildMap")
     local newMap = newTable
     local newChildMap = newMap:get(keyToLookFor)
     if newChildMap == nil then
@@ -259,7 +259,7 @@ function copiedDefaultMapHasChildDefaultMap(self)
     local oldChildMap = oldParentMap:getAndSetDefault(parentMapKey)
     oldChildMap:getAndSetDefault(childMapKey1)
     oldChildMap:set(childMapKey2, childMapCustomValue)
-    local newTable = deepCopy(nil, oldParentMap)
+    local newTable = deepCopy(nil, oldParentMap, SerializationType.NONE, "copiedDefaultMapHasChildDefaultMap")
     local newParentMap = newTable
     local newChildMap = newParentMap:get(parentMapKey)
     if newChildMap == nil then
@@ -289,12 +289,15 @@ end
 function copiedDefaultMapHasBrand(self)
     local oldDefaultValue = "foo"
     local oldDefaultMap = __TS__New(DefaultMap, oldDefaultValue)
-    local newTable = deepCopy(nil, oldDefaultMap, SerializationType.SERIALIZE)
+    local newTable = deepCopy(nil, oldDefaultMap, SerializationType.SERIALIZE, "copiedDefaultMapHasBrand")
     if not (newTable[SerializationBrand.DEFAULT_MAP] ~= nil) then
         error("The copied DefaultMap does not have the brand: " .. SerializationBrand.DEFAULT_MAP)
     end
 end
-function ____exports.deepCopyTests(self)
+--- Run the suite of tests that prove that the "deepCopy" helper function works properly.
+-- 
+-- This function is only useful if you are troubleshooting the "deepCopy" function.
+function ____exports.runDeepCopyTests(self)
     copiedObjectIsTable(nil)
     copiedObjectHasKeyAndValueString(nil)
     copiedTableHasKeyAndValueNumber(nil)

package/dist/functions/{entity.d.ts → entities.d.ts}

@@ -6,20 +6,20 @@ import { AnyEntity } from "../types/AnyEntity";
  * `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
  * enemies.
  *
- * @param entityType Default is -1. -1 matches every entity type.
- * @param variant Default is -1. -1 matches every variant.
- * @param subType Default is -1. -1 matches every sub-type.
- * @param ignoreFriendly Default is false.
+ * @param entityType Optional. Default is -1, which matches every entity type.
+ * @param variant Optional. Default is -1, which matches every variant.
+ * @param subType Optional. Default is -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
  */
 export declare function countEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): int;
 /**
  * Helper function to check if one or more of a specific kind of entity is present in the current
  * room. It uses the `countEntities` helper function to determine this.
  *
- * @param entityType Default is -1. -1 matches every entity type.
- * @param variant Default is -1. -1 matches every variant.
- * @param subType Default is -1. -1 matches every sub-type.
- * @param ignoreFriendly Default is false.
+ * @param entityType Optional. Default is -1, which matches every entity type.
+ * @param variant Optional. Default is -1, which matches every variant.
+ * @param subType Optional. Default is -1, which matches every sub-type.
+ * @param ignoreFriendly Optional. Default is false.
  */
 export declare function doesEntityExist(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): boolean;
 /**
@@ -46,20 +46,21 @@ export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity:
  * For example:
  *
  * ```ts
- * // Make all of the entities in the room invisible
+ * // Make all of the entities in the room invisible.
  * for (const entity of getEntities()) {
  *   entity.Visible = false;
  * }
  * ```
  *
- * @param entityType Optional. If specified, will only return NPCs that match this entity type.
- * @param variant Optional. If specified, will only return NPCs that match this variant. Default is
- *                -1. -1 matches every variant.
- * @param subType Optional. If specified, will only return NPCs that match this sub-type. Default is
- *                -1. -1 matches every sub-type.
+ * @param entityType Optional. If specified, will only get the entities that match the type. Default
+ *                   is -1, which matches every type.
+ * @param variant Optional. If specified, will only get the entities that match the variant. Default
+ *                is -1, which matches every variant.
+ * @param subType Optional. If specified, will only get the entities that match the sub-type.
+ *                Default is -1, which matches every sub-type.
  * @param ignoreFriendly Optional. If set to true, it will exclude friendly NPCs from being
- *                       returned. Default is false. Will only be taken into account if
- *                       `matchingEntityType` is specified.
+ *                       returned. Default is false. Will only be taken into account if the
+ *                       `entityType` is specified.
  */
 export declare function getEntities(entityType?: EntityType, variant?: number, subType?: number, ignoreFriendly?: boolean): Entity[];
 /**
@@ -117,8 +118,9 @@ export declare function parseEntityTypeVariantString(entityTypeVariantString: st
  * Helper function to remove all of the matching entities in the room.
  *
  * @param entityType The entity type to match.
- * @param entityVariant Optional. The variant to match. Default is -1. -1 matches every variant.
- * @param entitySubType Optional. The sub-type to match. Default is -1. -1 matches every sub-type.
+ * @param entityVariant Optional. The variant to match. Default is -1, which matches every variant.
+ * @param entitySubType Optional. The sub-type to match. Default is -1, which matches every
+ *                      sub-type.
  * @param cap Optional. If specified, will only remove the given amount of collectibles.
  * @returns An array of the entities that were removed.
  */
@@ -153,4 +155,4 @@ export declare function spawn(entityType: EntityType, variant: int, subType: int
  * need to specify the velocity or spawner.
  */
 export declare function spawnWithSeed(entityType: EntityType, variant: int, subType: int, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): Entity;
-//# sourceMappingURL=entity.d.ts.map
+//# sourceMappingURL=entities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAM/C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B7C;AAwBD,8FAA8F;AAC9F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAsCR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}

package/dist/functions/{entity.lua → entities.lua}

@@ -47,7 +47,7 @@ function ____exports.removeEntities(self, entities, cap)
         entity:Remove()
         entitiesRemoved[#entitiesRemoved + 1] = entity
         if cap ~= nil and #entitiesRemoved >= cap then
-            return entitiesRemoved
+            break
         end
     end
     return entitiesRemoved
@@ -56,10 +56,10 @@ end
 -- `Isaac.CountEntities` method to avoid having to specify a spawner and to handle ignoring charmed
 -- enemies.
 -- 
--- @param entityType Default is -1. -1 matches every entity type.
--- @param variant Default is -1. -1 matches every variant.
--- @param subType Default is -1. -1 matches every sub-type.
--- @param ignoreFriendly Default is false.
+-- @param entityType Optional. Default is -1, which matches every entity type.
+-- @param variant Optional. Default is -1, which matches every variant.
+-- @param subType Optional. Default is -1, which matches every sub-type.
+-- @param ignoreFriendly Optional. Default is false.
 function ____exports.countEntities(self, entityType, variant, subType, ignoreFriendly)
     if entityType == nil then
         entityType = -1
@@ -88,10 +88,10 @@ end
 --- Helper function to check if one or more of a specific kind of entity is present in the current
 -- room. It uses the `countEntities` helper function to determine this.
 -- 
--- @param entityType Default is -1. -1 matches every entity type.
--- @param variant Default is -1. -1 matches every variant.
--- @param subType Default is -1. -1 matches every sub-type.
--- @param ignoreFriendly Default is false.
+-- @param entityType Optional. Default is -1, which matches every entity type.
+-- @param variant Optional. Default is -1, which matches every variant.
+-- @param subType Optional. Default is -1, which matches every sub-type.
+-- @param ignoreFriendly Optional. Default is false.
 function ____exports.doesEntityExist(self, entityType, variant, subType, ignoreFriendly)
     if entityType == nil then
         entityType = -1
@@ -146,21 +146,25 @@ end
 -- For example:
 -- 
 -- ```ts
--- // Make all of the entities in the room invisible
+-- // Make all of the entities in the room invisible.
 -- for (const entity of getEntities()) {
 --   entity.Visible = false;
 -- }
 -- ```
 -- 
--- @param entityType Optional. If specified, will only return NPCs that match this entity type.
--- @param variant Optional. If specified, will only return NPCs that match this variant. Default is
--- -1. -1 matches every variant.
--- @param subType Optional. If specified, will only return NPCs that match this sub-type. Default is
--- -1. -1 matches every sub-type.
+-- @param entityType Optional. If specified, will only get the entities that match the type. Default
+-- is -1, which matches every type.
+-- @param variant Optional. If specified, will only get the entities that match the variant. Default
+-- is -1, which matches every variant.
+-- @param subType Optional. If specified, will only get the entities that match the sub-type.
+-- Default is -1, which matches every sub-type.
 -- @param ignoreFriendly Optional. If set to true, it will exclude friendly NPCs from being
--- returned. Default is false. Will only be taken into account if
--- `matchingEntityType` is specified.
+-- returned. Default is false. Will only be taken into account if the
+-- `entityType` is specified.
 function ____exports.getEntities(self, entityType, variant, subType, ignoreFriendly)
+    if entityType == nil then
+        entityType = -1
+    end
     if variant == nil then
         variant = -1
     end
@@ -170,7 +174,7 @@ function ____exports.getEntities(self, entityType, variant, subType, ignoreFrien
     if ignoreFriendly == nil then
         ignoreFriendly = false
     end
-    if entityType == nil then
+    if entityType == -1 then
         return Isaac.GetRoomEntities()
     end
     return Isaac.FindByType(entityType, variant, subType, ignoreFriendly)
@@ -290,8 +294,9 @@ end
 --- Helper function to remove all of the matching entities in the room.
 -- 
 -- @param entityType The entity type to match.
--- @param entityVariant Optional. The variant to match. Default is -1. -1 matches every variant.
--- @param entitySubType Optional. The sub-type to match. Default is -1. -1 matches every sub-type.
+-- @param entityVariant Optional. The variant to match. Default is -1, which matches every variant.
+-- @param entitySubType Optional. The sub-type to match. Default is -1, which matches every
+-- sub-type.
 -- @param cap Optional. If specified, will only remove the given amount of collectibles.
 -- @returns An array of the entities that were removed.
 function ____exports.removeAllMatchingEntities(self, entityType, entityVariant, entitySubType, cap)