isaacscript-common 1.2.232 → 1.2.233

package/dist/callbacks/postCustomDoorEnter.lua

@@ -6,6 +6,8 @@ local ____exports = {}
 local hasSubscriptions, postEffectUpdaterCustomEntity, doorChangedState, getAnimationForCustomDoor, postEffectRenderCustomEntity, isPlayerPastDoorThreshold, roomClearChange, getPositionOffset, POSITION_OFFSET_MULTIPLIER, v
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
 local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
@@ -185,7 +187,7 @@ function ____exports.spawnCustomDoor(self, effectVariant, doorSlot)
         effectVariant,
         0,
         position,
-        Vector.Zero,
+        VectorZero,
         nil
     ):ToEffect()
     if effect == nil then

package/dist/constants.d.ts

@@ -116,3 +116,5 @@ export declare const TRINKET_ID_MASK = 32767;
  * corner.
  */
 export declare const UI_HEART_WIDTH = 12;
+export declare const VectorOne: ReadonlyVector;
+export declare const VectorZero: ReadonlyVector;

package/dist/constants.lua

@@ -37,4 +37,6 @@ ____exports.TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000
 ____exports.TRINKET_GOLDEN_FLAG = 32768
 ____exports.TRINKET_ID_MASK = 32767
 ____exports.UI_HEART_WIDTH = 12
+____exports.VectorOne = Vector(1, 1)
+____exports.VectorZero = Vector(0, 0)
 return ____exports

package/dist/features/deployJSONRoom.lua

@@ -10,6 +10,8 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____DefaultMap = require("classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____entity = require("functions.entity")
@@ -77,7 +79,7 @@ function respawnPersistentEntities(self)
             persistentEntity.variant,
             persistentEntity.subType,
             position,
-            Vector.Zero,
+            VectorZero,
             nil
         )
     end
@@ -253,7 +255,7 @@ function spawnNormalEntityForJSONRoom(self, entityType, variant, subType, x, y,
             entityType,
             variant,
             position,
-            Vector.Zero,
+            VectorZero,
             nil,
             subType,
             seed

package/dist/features/extraConsoleCommands/commands.lua

@@ -10,6 +10,7 @@ local sfxManager = ____cachedClasses.sfxManager
 local ____constants = require("constants")
 local PILL_GIANT_FLAG = ____constants.PILL_GIANT_FLAG
 local TRINKET_GOLDEN_FLAG = ____constants.TRINKET_GOLDEN_FLAG
+local VectorZero = ____constants.VectorZero
 local ____HealthType = require("enums.HealthType")
 local HealthType = ____HealthType.HealthType
 local ____cards = require("functions.cards")
@@ -380,7 +381,7 @@ function ____exports.cards(self)
                         300,
                         cardType,
                         position,
-                        Vector.Zero,
+                        VectorZero,
                         nil
                     )
                     cardType = cardType + 1
@@ -662,7 +663,7 @@ function ____exports.pills(self)
                         70,
                         subType,
                         position,
-                        Vector.Zero,
+                        VectorZero,
                         nil
                     )
                     pillColor = pillColor + 1
@@ -885,7 +886,7 @@ function ____exports.spawnGoldenTrinket(self, params)
         350,
         goldenTrinketType,
         centerPos,
-        Vector.Zero,
+        VectorZero,
         nil
     )
 end

package/dist/features/playerInventory.d.ts

@@ -16,5 +16,8 @@ export declare function getPlayerInventory(player: EntityPlayer, includeActiveCo
  * Helper function to add a collectible to a player. Use this instead of the
  * `EntityPlayer.AddCollectible` method if you want the collectible that is added to be
  * automatically tracked by the player inventory tracker feature.
+ *
+ * You only need to use this function if you are using the inventory feature from the standard
+ * library.
  */
 export declare function addCollectible(player: EntityPlayer, collectibleType: CollectibleType, charge?: int, firstTimePickingUp?: boolean, activeSlot?: ActiveSlot, varData?: int): void;

package/dist/functions/chargeBar.lua

@@ -1,6 +1,8 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
 local getChargeBarClamp
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 function getChargeBarClamp(self, charges, maxCharges)
     local meterMultiplier = 24 / maxCharges
     local meterClip = 26 - charges * meterMultiplier
@@ -32,11 +34,11 @@ function ____exports.newChargeBarSprites(self, maxCharges)
     }
 end
 function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
-    sprites.back:Render(position, Vector.Zero, Vector.Zero)
+    sprites.back:Render(position, VectorZero, VectorZero)
     local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)
-    sprites.meter:Render(position, normalChargesClamp, Vector.Zero)
+    sprites.meter:Render(position, normalChargesClamp, VectorZero)
     local batteryChargesClamp = getChargeBarClamp(nil, batteryCharges, sprites.maxCharges)
-    sprites.meterBattery:Render(position, batteryChargesClamp, Vector.Zero)
-    sprites.lines:Render(position, Vector.Zero, Vector.Zero)
+    sprites.meterBattery:Render(position, batteryChargesClamp, VectorZero)
+    sprites.lines:Render(position, VectorZero, VectorZero)
 end
 return ____exports

package/dist/functions/familiars.lua

@@ -4,6 +4,8 @@ local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____familiarsThatShootPlayerTearsSet = require("sets.familiarsThatShootPlayerTearsSet")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET = ____familiarsThatShootPlayerTearsSet.FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET
 local ____array = require("functions.array")
@@ -59,7 +61,7 @@ function ____exports.checkFamiliar(self, player, collectibleType, numTargetFamil
                 EntityType.ENTITY_FAMILIAR,
                 familiarVariant,
                 player.Position,
-                Vector.Zero,
+                VectorZero,
                 player,
                 familiarSubTypeToUse,
                 seed

package/dist/functions/log.d.ts

@@ -64,7 +64,7 @@ export declare function logUseFlags(this: void, flags: int): void;
  * the Isaac API).
  */
 export declare function logUserdata(this: void, userdata: unknown): void;
-export declare function logVector(this: void, vector: Vector): void;
+export declare function logVector(this: void, vector: Vector, round?: boolean): void;
 /**
  * Converts every `isaacscript-common` function that begins with "log" to a global function.
  * This is useful for printing out variables from the in-game debug console.

package/dist/functions/log.lua

@@ -39,6 +39,8 @@ local ____trinkets = require("functions.trinkets")
 local getTrinketName = ____trinkets.getTrinketName
 local ____utils = require("functions.utils")
 local printConsole = ____utils.printConsole
+local ____vector = require("functions.vector")
+local vectorToString = ____vector.vectorToString
 function ____exports.getDebugPrependString(self, msg, numParentFunctions)
     if numParentFunctions == nil then
         numParentFunctions = 3
@@ -442,8 +444,12 @@ function ____exports.logUserdata(userdata)
     end
     ____exports.logTable(metatable)
 end
-function ____exports.logVector(vector)
-    ____exports.log(((("Vector: (" .. tostring(vector.X)) .. ", ") .. tostring(vector.Y)) .. ")")
+function ____exports.logVector(vector, round)
+    if round == nil then
+        round = false
+    end
+    local vectorString = vectorToString(nil, vector, round)
+    ____exports.log("Vector: " .. vectorString)
 end
 function ____exports.setLogFunctionsGlobal(self)
     local globals = _G

package/dist/functions/math.lua

@@ -39,7 +39,7 @@ function ____exports.getCircleDiscretizedPoints(self, centerPos, radius, numPoin
     return positions
 end
 function ____exports.inRectangle(self, position, topLeft, bottomRight)
-    return position.X >= topLeft.X and position.X <= bottomRight.X and position.Y <= topLeft.Y and position.Y >= bottomRight.Y
+    return position.X >= topLeft.X and position.X <= bottomRight.X and position.Y >= topLeft.Y and position.Y <= bottomRight.Y
 end
 function ____exports.isCircleIntersectingRectangle(self, circleCenter, circleRadius, rectangleTopLeft, rectangleBottomRight)
     local nearestX = math.max(

package/dist/functions/roomData.d.ts

@@ -3,7 +3,7 @@
  * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
  * `RoomDescriptor` object that you are retrieving.
  */
-export declare function getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOnly;
+export declare function getCurrentRoomDescriptorReadOnly(): ReadonlyRoomDescriptor;
 /**
  * Helper function to get the set of allowed door slots for the room at the supplied grid index.
  * This corresponds to the doors that are enabled in the STB/XML file for the room.

package/dist/functions/roomGrid.lua

@@ -6,6 +6,7 @@ local L_ROOM_SHAPE_TO_RECTANGLES = ____LRoomShapeToRectangles.L_ROOM_SHAPE_TO_RE
 local ____math = require("functions.math")
 local inRectangle = ____math.inRectangle
 local ____roomShape = require("functions.roomShape")
+local getRoomShapeBottomRightPosition = ____roomShape.getRoomShapeBottomRightPosition
 local getRoomShapeTopLeftPosition = ____roomShape.getRoomShapeTopLeftPosition
 local getRoomShapeWidth = ____roomShape.getRoomShapeWidth
 local isLRoom = ____roomShape.isLRoom
@@ -16,7 +17,7 @@ function ____exports.gridPositionToWorldPosition(self, gridPosition)
 end
 function isValidGridPositionNormal(self, gridPosition, roomShape)
     local topLeft = getRoomShapeTopLeftPosition(nil, roomShape)
-    local bottomRight = getRoomShapeTopLeftPosition(nil, roomShape)
+    local bottomRight = getRoomShapeBottomRightPosition(nil, roomShape)
     return inRectangle(nil, gridPosition, topLeft, bottomRight)
 end
 function isValidGridPositionLRoom(self, gridPosition, roomShape)

package/dist/functions/spawnCollectible.lua

@@ -2,6 +2,8 @@
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____preventCollectibleRotate = require("features.preventCollectibleRotate")
 local preventCollectibleRotate = ____preventCollectibleRotate.preventCollectibleRotate
 local ____featuresInitialized = require("featuresInitialized")
@@ -29,7 +31,7 @@ function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG
         EntityType.ENTITY_PICKUP,
         100,
         position,
-        Vector.Zero,
+        VectorZero,
         nil,
         collectibleType,
         seed

package/dist/functions/sprite.lua

@@ -2,13 +2,14 @@
 local ____exports = {}
 local ____constants = require("constants")
 local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
+local VectorZero = ____constants.VectorZero
 local ____kColor = require("functions.kColor")
 local kColorEquals = ____kColor.kColorEquals
 local ____math = require("functions.math")
 local range = ____math.range
 function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
-    local kColor1 = sprite1:GetTexel(position, Vector.Zero, 1, layerID)
-    local kColor2 = sprite2:GetTexel(position, Vector.Zero, 1, layerID)
+    local kColor1 = sprite1:GetTexel(position, VectorZero, 1, layerID)
+    local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)
     return kColorEquals(nil, kColor1, kColor2)
 end
 function ____exports.clearSprite(self, sprite, ...)

package/dist/functions/ui.lua

@@ -4,13 +4,16 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("constants")
 local UI_HEART_WIDTH = ____constants.UI_HEART_WIDTH
+local VectorZero = ____constants.VectorZero
+local ____vector = require("functions.vector")
+local copyVector = ____vector.copyVector
 function ____exports.getScreenBottomRightPos(self)
     local screenWidth = Isaac.GetScreenWidth()
     local screenHeight = Isaac.GetScreenHeight()
     return Vector(screenWidth, screenHeight)
 end
 function ____exports.getHUDOffsetVector(self)
-    local defaultVector = Vector.Zero
+    local defaultVector = copyVector(nil, VectorZero)
     local hudOffset = math.floor(Options.HUDOffset * 10)
     if hudOffset < 1 or hudOffset > 10 then
         return defaultVector
@@ -70,7 +73,7 @@ function ____exports.getScreenCenterPos(self)
     return bottomRight / 2
 end
 function ____exports.getScreenTopLeftPos(self)
-    return Vector.Zero
+    return copyVector(nil, VectorZero)
 end
 function ____exports.getScreenTopRightPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)

package/dist/functions/vector.d.ts

@@ -19,16 +19,6 @@ interface CopyVectorReturn {
 export declare function copyVector<V extends Vector | SerializedVector, S extends SerializationType>(vector: V, serializationType: S): CopyVectorReturn[S];
 export declare function copyVector<V extends Vector | SerializedVector>(vector: V): CopyVectorReturn[SerializationType.NONE];
 export declare function directionToVector(direction: Direction): Vector;
-/**
- * Helper function to get a new vector of length 1. Using this is safer than using the `Vector.One`
- * variable because the variable can be overwritten or modified.
- */
-export declare function getOneVector(): Vector;
-/**
- * Helper function to get a new vector of length 0. Using this is safer than using the `Vector.Zero`
- * variable because the variable can be overwritten or modified.
- */
-export declare function getZeroVector(): Vector;
 /**
  * Used to determine is the given table is a serialized `Vector` object created by the save data
  * manager and/or the `deepCopy` function.
@@ -37,6 +27,9 @@ export declare function isSerializedVector(object: unknown): object is Serialize
 /** Helper function to check if something is an instantiated Vector object. */
 export declare function isVector(object: unknown): object is Vector;
 export declare function vectorEquals(vector1: Vector, vector2: Vector): boolean;
+/** Helper function to get a new vector of length N. */
+export declare function vectorN(n: int): Vector;
 /** Helper function for finding out which way a vector is pointing. */
 export declare function vectorToDirection(vector: Vector): Direction;
+export declare function vectorToString(vector: Vector, round?: boolean): string;
 export {};

package/dist/functions/vector.lua

@@ -74,12 +74,6 @@ end
 function ____exports.directionToVector(self, direction)
     return DIRECTION_TO_VECTOR[direction]
 end
-function ____exports.getOneVector(self)
-    return Vector(1, 1)
-end
-function ____exports.getZeroVector(self)
-    return Vector(0, 0)
-end
 function ____exports.isSerializedVector(self, object)
     local objectType = type(object)
     if objectType ~= "table" then
@@ -95,6 +89,9 @@ end
 function ____exports.vectorEquals(self, vector1, vector2)
     return isaacAPIClassEquals(nil, vector1, vector2, KEYS)
 end
+function ____exports.vectorN(self, n)
+    return Vector(n, n)
+end
 function ____exports.vectorToDirection(self, vector)
     local degrees = vector:GetAngleDegrees()
     if degrees > -45 and degrees < 45 then
@@ -111,4 +108,12 @@ function ____exports.vectorToDirection(self, vector)
     end
     return Direction.NO_DIRECTION
 end
+function ____exports.vectorToString(self, vector, round)
+    if round == nil then
+        round = false
+    end
+    local x = round and math.floor(vector.X + 0.5) or vector.X
+    local y = round and math.floor(vector.Y + 0.5) or vector.Y
+    return ((("(" .. tostring(x)) .. ", ") .. tostring(y)) .. ")"
+end
 return ____exports

package/dist/objects/LRoomShapeToRectangles.lua

@@ -1,5 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local TWO_BY_TWO_BOTTOM_RIGHT = Vector(25, 13)
 ____exports.L_ROOM_SHAPE_TO_RECTANGLES = {
     [RoomShape.ROOMSHAPE_LTL] = {
@@ -9,21 +11,21 @@ ____exports.L_ROOM_SHAPE_TO_RECTANGLES = {
         TWO_BY_TWO_BOTTOM_RIGHT
     },
     [RoomShape.ROOMSHAPE_LTR] = {
-        Vector.Zero,
+        VectorZero,
         Vector(12, 13),
         Vector(0, 7),
         TWO_BY_TWO_BOTTOM_RIGHT
     },
     [RoomShape.ROOMSHAPE_LBL] = {
-        Vector.Zero,
+        VectorZero,
         Vector(25, 6),
         Vector(13, 0),
         TWO_BY_TWO_BOTTOM_RIGHT
     },
     [RoomShape.ROOMSHAPE_LBR] = {
-        Vector.Zero,
+        VectorZero,
         Vector(25, 6),
-        Vector.Zero,
+        VectorZero,
         Vector(12, 13)
     }
 }

package/dist/objects/directionToVector.lua

@@ -1,7 +1,9 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 ____exports.DIRECTION_TO_VECTOR = {
-    [Direction.NO_DIRECTION] = Vector.Zero,
+    [Direction.NO_DIRECTION] = VectorZero,
     [Direction.LEFT] = Vector(-1, 0),
     [Direction.UP] = Vector(0, -1),
     [Direction.RIGHT] = Vector(1, 0),

package/dist/objects/roomShapeBounds.lua

@@ -1,5 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____roomShapeVolumes = require("objects.roomShapeVolumes")
 local NARROW_CONTENTS_HEIGHT = ____roomShapeVolumes.NARROW_CONTENTS_HEIGHT
 local NARROW_CONTENTS_WIDTH = ____roomShapeVolumes.NARROW_CONTENTS_WIDTH
@@ -19,6 +21,6 @@ ____exports.ROOM_SHAPE_BOUNDS = {
     [RoomShape.ROOMSHAPE_LTR] = TWO_BY_TWO_BOUNDS,
     [RoomShape.ROOMSHAPE_LBL] = TWO_BY_TWO_BOUNDS,
     [RoomShape.ROOMSHAPE_LBR] = TWO_BY_TWO_BOUNDS,
-    [RoomShape.NUM_ROOMSHAPES] = Vector.Zero
+    [RoomShape.NUM_ROOMSHAPES] = VectorZero
 }
 return ____exports

package/dist/objects/roomShapeToBottomRightPosition.lua

@@ -1,5 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local TWO_BY_TWO_BOTTOM_RIGHT_POSITION = Vector(25, 13)
 local ONE_BY_TWO_VERTICAL_BOTTOM_RIGHT_POSITION = Vector(12, 13)
 ____exports.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = {
@@ -15,6 +17,6 @@ ____exports.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = {
     [RoomShape.ROOMSHAPE_LTR] = TWO_BY_TWO_BOTTOM_RIGHT_POSITION,
     [RoomShape.ROOMSHAPE_LBL] = TWO_BY_TWO_BOTTOM_RIGHT_POSITION,
     [RoomShape.ROOMSHAPE_LBR] = ONE_BY_TWO_VERTICAL_BOTTOM_RIGHT_POSITION,
-    [RoomShape.NUM_ROOMSHAPES] = Vector.Zero
+    [RoomShape.NUM_ROOMSHAPES] = VectorZero
 }
 return ____exports

package/dist/objects/roomShapeToTopLeftPosition.lua

@@ -1,20 +1,22 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local NARROW_HORIZONTAL_TOP_LEFT_POSITION = Vector(0, 2)
 local NARROW_VERTICAL_TOP_LEFT_POSITION = Vector(4, 0)
 ____exports.ROOM_SHAPE_TO_TOP_LEFT_POSITION = {
-    [RoomShape.ROOMSHAPE_1x1] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_1x1] = VectorZero,
     [RoomShape.ROOMSHAPE_IH] = NARROW_HORIZONTAL_TOP_LEFT_POSITION,
     [RoomShape.ROOMSHAPE_IV] = NARROW_VERTICAL_TOP_LEFT_POSITION,
-    [RoomShape.ROOMSHAPE_1x2] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_1x2] = VectorZero,
     [RoomShape.ROOMSHAPE_IIV] = NARROW_VERTICAL_TOP_LEFT_POSITION,
-    [RoomShape.ROOMSHAPE_2x1] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_2x1] = VectorZero,
     [RoomShape.ROOMSHAPE_IIH] = NARROW_HORIZONTAL_TOP_LEFT_POSITION,
-    [RoomShape.ROOMSHAPE_2x2] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_2x2] = VectorZero,
     [RoomShape.ROOMSHAPE_LTL] = Vector(13, 0),
-    [RoomShape.ROOMSHAPE_LTR] = Vector.Zero,
-    [RoomShape.ROOMSHAPE_LBL] = Vector.Zero,
-    [RoomShape.ROOMSHAPE_LBR] = Vector.Zero,
-    [RoomShape.NUM_ROOMSHAPES] = Vector.Zero
+    [RoomShape.ROOMSHAPE_LTR] = VectorZero,
+    [RoomShape.ROOMSHAPE_LBL] = VectorZero,
+    [RoomShape.ROOMSHAPE_LBR] = VectorZero,
+    [RoomShape.NUM_ROOMSHAPES] = VectorZero
 }
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.232",
+  "version": "1.2.233",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.385",
+    "isaac-typescript-definitions": "^1.0.386",
     "isaacscript-lint": "^1.0.95",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",