isaacscript-common 17.5.0 → 17.6.0

package/dist/index.d.ts

@@ -6965,7 +6965,16 @@ declare interface IsaacAPIClassTypeToType {
 }
 
 /**
- * Iterates over all inputs to determine if a particular button is pressed (i.e. held down).
+ * Helper function to check if a player is pressing a specific button (i.e. holding it down).
+ *
+ * This is a variadic version of `Input.IsActionPressed`, meaning that you can pass as many buttons
+ * as you want to check for. This function will return true if any of the buttons are pressed.
+ */
+export declare function isActionPressed(controllerIndex: ControllerIndex, ...buttonActions: ButtonAction[]): boolean;
+
+/**
+ * Helper function to iterate over all inputs to determine if a specific button is pressed (i.e.
+ * being held down).
  *
  * This function is variadic, meaning you can pass as many buttons as you want to check for. This
  * function will return true if any of the buttons are pressed.
@@ -6973,8 +6982,18 @@ declare interface IsaacAPIClassTypeToType {
 export declare function isActionPressedOnAnyInput(...buttonActions: ButtonAction[]): boolean;
 
 /**
- * Iterates over all inputs to determine if a particular button is triggered (i.e. held down and
- * then released).
+ * Helper function to check if a player is triggering a specific button (i.e. pressing and releasing
+ * it).
+ *
+ * This is a variadic version of `Input.IsActionTriggered`, meaning that you can pass as many
+ * buttons as you want to check for. This function will return true if any of the buttons are
+ * triggered.
+ */
+export declare function isActionTriggered(controllerIndex: ControllerIndex, ...buttonActions: ButtonAction[]): boolean;
+
+/**
+ * Iterates over all inputs to determine if a specific button is triggered (i.e. held down and then
+ * released).
  *
  * This function is variadic, meaning you can pass as many buttons as you want to check for. This
  * function will return true if any of the buttons are pressed.
@@ -7507,7 +7526,7 @@ export declare function isKeeper(player: EntityPlayer): boolean;
 export declare function isKey(pickup: EntityPickup): pickup is EntityPickupKey;
 
 /**
- * Helper function to see if a particular keyboard key is being pressed down by the player.
+ * Helper function to see if a specific keyboard key is being held down by the player.
  *
  * This function is variadic, meaning you can pass as many keyboard values as you want to check for.
  * This function will return true if any of the values are pressed.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 17.5.0
+isaacscript-common 17.6.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -34863,25 +34863,41 @@ end
 function ____exports.getShootActions(self)
     return ____exports.SHOOTING_ACTIONS_SET
 end
+function ____exports.isActionPressed(self, controllerIndex, ...)
+    local buttonActions = {...}
+    return __TS__ArraySome(
+        buttonActions,
+        function(____, buttonAction) return Input.IsActionPressed(buttonAction, controllerIndex) end
+    )
+end
 function ____exports.isActionPressedOnAnyInput(self, ...)
     local buttonActions = {...}
     local controllerIndexes = getEnumValues(nil, ControllerIndex)
     return __TS__ArraySome(
         controllerIndexes,
-        function(____, controllerIndex) return __TS__ArraySome(
-            buttonActions,
-            function(____, buttonAction) return Input.IsActionPressed(buttonAction, controllerIndex) end
+        function(____, controllerIndex) return ____exports.isActionPressed(
+            nil,
+            controllerIndex,
+            table.unpack(buttonActions)
         ) end
     )
 end
+function ____exports.isActionTriggered(self, controllerIndex, ...)
+    local buttonActions = {...}
+    return __TS__ArraySome(
+        buttonActions,
+        function(____, buttonAction) return Input.IsActionTriggered(buttonAction, controllerIndex) end
+    )
+end
 function ____exports.isActionTriggeredOnAnyInput(self, ...)
     local buttonActions = {...}
     local controllerIndexes = getEnumValues(nil, ControllerIndex)
     return __TS__ArraySome(
         controllerIndexes,
-        function(____, controllerIndex) return __TS__ArraySome(
-            buttonActions,
-            function(____, buttonAction) return Input.IsActionTriggered(buttonAction, controllerIndex) end
+        function(____, controllerIndex) return ____exports.isActionTriggered(
+            nil,
+            controllerIndex,
+            table.unpack(buttonActions)
         ) end
     )
 end

package/dist/src/functions/input.d.ts

@@ -1,4 +1,4 @@
-import { ButtonAction, Controller, Keyboard } from "isaac-typescript-definitions";
+import { ButtonAction, Controller, ControllerIndex, Keyboard } from "isaac-typescript-definitions";
 export declare const MOVEMENT_ACTIONS_SET: ReadonlySet<ButtonAction>;
 export declare const SHOOTING_ACTIONS_SET: ReadonlySet<ButtonAction>;
 /**
@@ -11,22 +11,39 @@ export declare function controllerToString(controller: Controller): string | und
 export declare function getMoveActions(): ReadonlySet<ButtonAction>;
 export declare function getShootActions(): ReadonlySet<ButtonAction>;
 /**
- * Iterates over all inputs to determine if a particular button is pressed (i.e. held down).
+ * Helper function to check if a player is pressing a specific button (i.e. holding it down).
+ *
+ * This is a variadic version of `Input.IsActionPressed`, meaning that you can pass as many buttons
+ * as you want to check for. This function will return true if any of the buttons are pressed.
+ */
+export declare function isActionPressed(controllerIndex: ControllerIndex, ...buttonActions: ButtonAction[]): boolean;
+/**
+ * Helper function to iterate over all inputs to determine if a specific button is pressed (i.e.
+ * being held down).
  *
  * This function is variadic, meaning you can pass as many buttons as you want to check for. This
  * function will return true if any of the buttons are pressed.
  */
 export declare function isActionPressedOnAnyInput(...buttonActions: ButtonAction[]): boolean;
 /**
- * Iterates over all inputs to determine if a particular button is triggered (i.e. held down and
- * then released).
+ * Helper function to check if a player is triggering a specific button (i.e. pressing and releasing
+ * it).
+ *
+ * This is a variadic version of `Input.IsActionTriggered`, meaning that you can pass as many
+ * buttons as you want to check for. This function will return true if any of the buttons are
+ * triggered.
+ */
+export declare function isActionTriggered(controllerIndex: ControllerIndex, ...buttonActions: ButtonAction[]): boolean;
+/**
+ * Iterates over all inputs to determine if a specific button is triggered (i.e. held down and then
+ * released).
  *
  * This function is variadic, meaning you can pass as many buttons as you want to check for. This
  * function will return true if any of the buttons are pressed.
  */
 export declare function isActionTriggeredOnAnyInput(...buttonActions: ButtonAction[]): boolean;
 /**
- * Helper function to see if a particular keyboard key is being pressed down by the player.
+ * Helper function to see if a specific keyboard key is being held down by the player.
  *
  * This function is variadic, meaning you can pass as many keyboard values as you want to check for.
  * This function will return true if any of the values are pressed.

package/dist/src/functions/input.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../../src/functions/input.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EAEV,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAuBtC,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,YAAY,CAE1D,CAAC;AASF,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,YAAY,CAE1D,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAQ7E;AAED,wBAAgB,cAAc,IAAI,WAAW,CAAC,YAAY,CAAC,CAE1D;AAED,wBAAgB,eAAe,IAAI,WAAW,CAAC,YAAY,CAAC,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,aAAa,EAAE,YAAY,EAAE,GAC/B,OAAO,CAOT;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,aAAa,EAAE,YAAY,EAAE,GAC/B,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAI9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C;AAED,wBAAgB,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEhE;AAED,wBAAgB,6BAA6B,IAAI,OAAO,CAIvD;AAED,wBAAgB,+BAA+B,IAAI,OAAO,CAIzD;AAED,wBAAgB,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEjE;AAED,wBAAgB,8BAA8B,IAAI,OAAO,CAIxD;AAED,wBAAgB,gCAAgC,IAAI,OAAO,CAI1D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,OAAO,GACjB,MAAM,GAAG,SAAS,CAQpB"}
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../../src/functions/input.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EACV,eAAe,EACf,QAAQ,EACT,MAAM,8BAA8B,CAAC;AAuBtC,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,YAAY,CAE1D,CAAC;AASF,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,YAAY,CAE1D,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAQ7E;AAED,wBAAgB,cAAc,IAAI,WAAW,CAAC,YAAY,CAAC,CAE1D;AAED,wBAAgB,eAAe,IAAI,WAAW,CAAC,YAAY,CAAC,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,eAAe,EAAE,eAAe,EAChC,GAAG,aAAa,EAAE,YAAY,EAAE,GAC/B,OAAO,CAIT;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,aAAa,EAAE,YAAY,EAAE,GAC/B,OAAO,CAKT;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,eAAe,EAChC,GAAG,aAAa,EAAE,YAAY,EAAE,GAC/B,OAAO,CAIT;AAED;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,aAAa,EAAE,YAAY,EAAE,GAC/B,OAAO,CAKT;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAAG,OAAO,CAI9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAE9C;AAED,wBAAgB,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEhE;AAED,wBAAgB,6BAA6B,IAAI,OAAO,CAIvD;AAED,wBAAgB,+BAA+B,IAAI,OAAO,CAIzD;AAED,wBAAgB,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAEjE;AAED,wBAAgB,8BAA8B,IAAI,OAAO,CAIxD;AAED,wBAAgB,gCAAgC,IAAI,OAAO,CAI1D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,OAAO,GACjB,MAAM,GAAG,SAAS,CAQpB"}

package/dist/src/functions/input.lua

@@ -45,7 +45,19 @@ end
 function ____exports.getShootActions(self)
     return ____exports.SHOOTING_ACTIONS_SET
 end
---- Iterates over all inputs to determine if a particular button is pressed (i.e. held down).
+--- Helper function to check if a player is pressing a specific button (i.e. holding it down).
+-- 
+-- This is a variadic version of `Input.IsActionPressed`, meaning that you can pass as many buttons
+-- as you want to check for. This function will return true if any of the buttons are pressed.
+function ____exports.isActionPressed(self, controllerIndex, ...)
+    local buttonActions = {...}
+    return __TS__ArraySome(
+        buttonActions,
+        function(____, buttonAction) return Input.IsActionPressed(buttonAction, controllerIndex) end
+    )
+end
+--- Helper function to iterate over all inputs to determine if a specific button is pressed (i.e.
+-- being held down).
 -- 
 -- This function is variadic, meaning you can pass as many buttons as you want to check for. This
 -- function will return true if any of the buttons are pressed.
@@ -54,14 +66,28 @@ function ____exports.isActionPressedOnAnyInput(self, ...)
     local controllerIndexes = getEnumValues(nil, ControllerIndex)
     return __TS__ArraySome(
         controllerIndexes,
-        function(____, controllerIndex) return __TS__ArraySome(
-            buttonActions,
-            function(____, buttonAction) return Input.IsActionPressed(buttonAction, controllerIndex) end
+        function(____, controllerIndex) return ____exports.isActionPressed(
+            nil,
+            controllerIndex,
+            table.unpack(buttonActions)
         ) end
     )
 end
---- Iterates over all inputs to determine if a particular button is triggered (i.e. held down and
--- then released).
+--- Helper function to check if a player is triggering a specific button (i.e. pressing and releasing
+-- it).
+-- 
+-- This is a variadic version of `Input.IsActionTriggered`, meaning that you can pass as many
+-- buttons as you want to check for. This function will return true if any of the buttons are
+-- triggered.
+function ____exports.isActionTriggered(self, controllerIndex, ...)
+    local buttonActions = {...}
+    return __TS__ArraySome(
+        buttonActions,
+        function(____, buttonAction) return Input.IsActionTriggered(buttonAction, controllerIndex) end
+    )
+end
+--- Iterates over all inputs to determine if a specific button is triggered (i.e. held down and then
+-- released).
 -- 
 -- This function is variadic, meaning you can pass as many buttons as you want to check for. This
 -- function will return true if any of the buttons are pressed.
@@ -70,13 +96,14 @@ function ____exports.isActionTriggeredOnAnyInput(self, ...)
     local controllerIndexes = getEnumValues(nil, ControllerIndex)
     return __TS__ArraySome(
         controllerIndexes,
-        function(____, controllerIndex) return __TS__ArraySome(
-            buttonActions,
-            function(____, buttonAction) return Input.IsActionTriggered(buttonAction, controllerIndex) end
+        function(____, controllerIndex) return ____exports.isActionTriggered(
+            nil,
+            controllerIndex,
+            table.unpack(buttonActions)
         ) end
     )
 end
---- Helper function to see if a particular keyboard key is being pressed down by the player.
+--- Helper function to see if a specific keyboard key is being held down by the player.
 -- 
 -- This function is variadic, meaning you can pass as many keyboard values as you want to check for.
 -- This function will return true if any of the values are pressed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "17.5.0",
+  "version": "17.6.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/input.ts

@@ -66,7 +66,23 @@ export function getShootActions(): ReadonlySet<ButtonAction> {
 }
 
 /**
- * Iterates over all inputs to determine if a particular button is pressed (i.e. held down).
+ * Helper function to check if a player is pressing a specific button (i.e. holding it down).
+ *
+ * This is a variadic version of `Input.IsActionPressed`, meaning that you can pass as many buttons
+ * as you want to check for. This function will return true if any of the buttons are pressed.
+ */
+export function isActionPressed(
+  controllerIndex: ControllerIndex,
+  ...buttonActions: ButtonAction[]
+): boolean {
+  return buttonActions.some((buttonAction) =>
+    Input.IsActionPressed(buttonAction, controllerIndex),
+  );
+}
+
+/**
+ * Helper function to iterate over all inputs to determine if a specific button is pressed (i.e.
+ * being held down).
  *
  * This function is variadic, meaning you can pass as many buttons as you want to check for. This
  * function will return true if any of the buttons are pressed.
@@ -76,15 +92,30 @@ export function isActionPressedOnAnyInput(
 ): boolean {
   const controllerIndexes = getEnumValues(ControllerIndex);
   return controllerIndexes.some((controllerIndex) =>
-    buttonActions.some((buttonAction) =>
-      Input.IsActionPressed(buttonAction, controllerIndex),
-    ),
+    isActionPressed(controllerIndex, ...buttonActions),
+  );
+}
+
+/**
+ * Helper function to check if a player is triggering a specific button (i.e. pressing and releasing
+ * it).
+ *
+ * This is a variadic version of `Input.IsActionTriggered`, meaning that you can pass as many
+ * buttons as you want to check for. This function will return true if any of the buttons are
+ * triggered.
+ */
+export function isActionTriggered(
+  controllerIndex: ControllerIndex,
+  ...buttonActions: ButtonAction[]
+): boolean {
+  return buttonActions.some((buttonAction) =>
+    Input.IsActionTriggered(buttonAction, controllerIndex),
   );
 }
 
 /**
- * Iterates over all inputs to determine if a particular button is triggered (i.e. held down and
- * then released).
+ * Iterates over all inputs to determine if a specific button is triggered (i.e. held down and then
+ * released).
  *
  * This function is variadic, meaning you can pass as many buttons as you want to check for. This
  * function will return true if any of the buttons are pressed.
@@ -94,14 +125,12 @@ export function isActionTriggeredOnAnyInput(
 ): boolean {
   const controllerIndexes = getEnumValues(ControllerIndex);
   return controllerIndexes.some((controllerIndex) =>
-    buttonActions.some((buttonAction) =>
-      Input.IsActionTriggered(buttonAction, controllerIndex),
-    ),
+    isActionTriggered(controllerIndex, ...buttonActions),
   );
 }
 
 /**
- * Helper function to see if a particular keyboard key is being pressed down by the player.
+ * Helper function to see if a specific keyboard key is being held down by the player.
  *
  * This function is variadic, meaning you can pass as many keyboard values as you want to check for.
  * This function will return true if any of the values are pressed.