isaacscript-common 19.1.0 → 20.0.0

package/dist/index.d.ts

@@ -11294,26 +11294,31 @@ declare class ModdedElementSets extends Feature {
 export declare class ModFeature {
     private mod;
     /**
-     * An optional function that allows for conditional callback execution. If specified, any class
+     * An optional method that allows for conditional callback execution. If specified, any class
      * method that is annotated with a `@Callback` or `@CallbackCustom` decorator will only be fired
      * if the executed conditional function returns true.
      *
      * This property is used to easily turn entire mod features on and off (rather than repeating
      * conditional logic and early returning at the beginning of every callback function).
      *
-     * By default, this is set to null. Override this property in your class if you need to use it.
+     * Since the specific information for the firing callback is passed as arguments into the
+     * conditional method, you can also write logic that would only apply to a specific type of
+     * callback.
+     *
+     * By default, this is set to null, which means that all callback methods will fire
+     * unconditionally. Override this property in your class if you need to use it.
      *
      * The function has the following signature:
      *
      * ```ts
-     * (
-     *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
-     *   modCallback: ModCallback | ModCallbackCustom,
-     *   ...callbackArgs: unknown[]
+     * <T extends boolean>(
+     *   vanilla: T, // Whether or not this is a vanilla or custom callback.
+     *   modCallback: T extends true ? ModCallback : ModCallbackCustom,
+     *   ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
      * ) => boolean;
      * ```
      */
-    protected callbackConditionalFunc: ((vanilla: boolean, modCallback: ModCallback | ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
+    protected shouldCallbackMethodsFire: (<T extends boolean>(vanilla: T, modCallback: T extends true ? ModCallback : ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
     /**
      * Whether or not the feature has registered its callbacks yet (and submitted its variables to the
      * save data manager, if any).
@@ -11451,8 +11456,10 @@ export declare const MOVEMENT_ACTIONS_SET: ReadonlySet<ButtonAction>;
  * If there is more than one player, they will be distributed around the center in a circle.
  *
  * This function emulates what happens in the vanilla game when you travel to a new floor.
+ *
+ * @param radius Optional. The radius of the circle. Default is 10.
  */
-export declare function movePlayersToCenter(): void;
+export declare function movePlayersToCenter(radius?: float): void;
 
 /**
  * A cached version of the class returned from the `MusicManager()` constructor.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 19.1.0
+isaacscript-common 20.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -38046,8 +38046,10 @@ function movePlayerAndTheirFamiliars(self, player, position)
         familiar.Position = position
     end
 end
-local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
-function ____exports.movePlayersToCenter(self)
+function ____exports.movePlayersToCenter(self, radius)
+    if radius == nil then
+        radius = 10
+    end
     local isGreedMode = game:IsGreedMode()
     local startingPosition = isGreedMode and NEW_FLOOR_STARTING_POSITION_GREED_MODE or NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
     local players = getAllPlayers(nil)
@@ -38062,7 +38064,7 @@ function ____exports.movePlayersToCenter(self)
     local circlePoints = getCircleDiscretizedPoints(
         nil,
         startingPosition,
-        CIRCLE_RADIUS_BETWEEN_PLAYERS,
+        radius,
         #players,
         1,
         1,
@@ -49508,7 +49510,7 @@ function initDecoratedCallbacks(self, modFeature, constructor, tstlClassName, va
 end
 function addCallback(self, modFeature, modFeatureConstructor, mod, modCallback, callback, parameters, vanilla)
     local function wrappedCallback(____, ...)
-        local conditionalFunc = modFeature.callbackConditionalFunc
+        local conditionalFunc = modFeature.shouldCallbackMethodsFire
         if conditionalFunc ~= nil then
             local shouldRun = conditionalFunc(nil, vanilla, modCallback, ...)
             if not shouldRun then
@@ -49603,7 +49605,7 @@ function ModFeature.prototype.____constructor(self, mod, init)
     if init == nil then
         init = true
     end
-    self.callbackConditionalFunc = nil
+    self.shouldCallbackMethodsFire = nil
     self.initialized = false
     self.mod = mod
     if init then

package/dist/src/classes/ModFeature.d.ts

@@ -39,26 +39,31 @@ export declare const MOD_FEATURE_CUSTOM_CALLBACKS_KEY = "__customCallbacks";
 export declare class ModFeature {
     private mod;
     /**
-     * An optional function that allows for conditional callback execution. If specified, any class
+     * An optional method that allows for conditional callback execution. If specified, any class
      * method that is annotated with a `@Callback` or `@CallbackCustom` decorator will only be fired
      * if the executed conditional function returns true.
      *
      * This property is used to easily turn entire mod features on and off (rather than repeating
      * conditional logic and early returning at the beginning of every callback function).
      *
-     * By default, this is set to null. Override this property in your class if you need to use it.
+     * Since the specific information for the firing callback is passed as arguments into the
+     * conditional method, you can also write logic that would only apply to a specific type of
+     * callback.
+     *
+     * By default, this is set to null, which means that all callback methods will fire
+     * unconditionally. Override this property in your class if you need to use it.
      *
      * The function has the following signature:
      *
      * ```ts
-     * (
-     *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
-     *   modCallback: ModCallback | ModCallbackCustom,
-     *   ...callbackArgs: unknown[]
+     * <T extends boolean>(
+     *   vanilla: T, // Whether or not this is a vanilla or custom callback.
+     *   modCallback: T extends true ? ModCallback : ModCallbackCustom,
+     *   ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
      * ) => boolean;
      * ```
      */
-    protected callbackConditionalFunc: ((vanilla: boolean, modCallback: ModCallback | ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
+    protected shouldCallbackMethodsFire: (<T extends boolean>(vanilla: T, modCallback: T extends true ? ModCallback : ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
     /**
      * Whether or not the feature has registered its callbacks yet (and submitted its variables to the
      * save data manager, if any).

package/dist/src/classes/ModFeature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAS/D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AACvD,eAAO,MAAM,gCAAgC,sBAAsB,CAAC;AAyBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAE7B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,uBAAuB,EAC7B,CAAC,CACC,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,WAAW,GAAG,iBAAiB,EAC5C,GAAG,YAAY,EAAE,OAAO,EAAE,KACvB,OAAO,CAAC,GACb,IAAI,CAAQ;IAEhB;;;;;;OAMG;IACI,WAAW,UAAS;gBAEf,GAAG,EAAE,eAAe,EAAE,IAAI,UAAO;IAQ7C;;;;;OAKG;IACI,IAAI,CAAC,IAAI,UAAO,GAAG,IAAI;IAqB9B;;;;;;OAMG;IACI,MAAM,IAAI,IAAI;CAGtB"}
+{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAS/D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AACvD,eAAO,MAAM,gCAAgC,sBAAsB,CAAC;AAyBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,yBAAyB,EAC/B,CAAC,CAAC,CAAC,SAAS,OAAO,EACjB,OAAO,EAAE,CAAC,EACV,WAAW,EAAE,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,iBAAiB,EAC7D,GAAG,YAAY,EAAE,OAAO,EAAE,KACvB,OAAO,CAAC,GACb,IAAI,CAAQ;IAEhB;;;;;;OAMG;IACI,WAAW,UAAS;gBAEf,GAAG,EAAE,eAAe,EAAE,IAAI,UAAO;IAQ7C;;;;;OAKG;IACI,IAAI,CAAC,IAAI,UAAO,GAAG,IAAI;IAqB9B;;;;;;OAMG;IACI,MAAM,IAAI,IAAI;CAGtB"}

package/dist/src/classes/ModFeature.lua

@@ -64,7 +64,7 @@ function initDecoratedCallbacks(self, modFeature, constructor, tstlClassName, va
 end
 function addCallback(self, modFeature, modFeatureConstructor, mod, modCallback, callback, parameters, vanilla)
     local function wrappedCallback(____, ...)
-        local conditionalFunc = modFeature.callbackConditionalFunc
+        local conditionalFunc = modFeature.shouldCallbackMethodsFire
         if conditionalFunc ~= nil then
             local shouldRun = conditionalFunc(nil, vanilla, modCallback, ...)
             if not shouldRun then
@@ -190,7 +190,7 @@ function ModFeature.prototype.____constructor(self, mod, init)
     if init == nil then
         init = true
     end
-    self.callbackConditionalFunc = nil
+    self.shouldCallbackMethodsFire = nil
     self.initialized = false
     self.mod = mod
     if init then

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

@@ -1,3 +1,4 @@
+/// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to move all of the players to where they would normally go when arriving at a new
  * floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
@@ -6,6 +7,8 @@
  * If there is more than one player, they will be distributed around the center in a circle.
  *
  * This function emulates what happens in the vanilla game when you travel to a new floor.
+ *
+ * @param radius Optional. The radius of the circle. Default is 10.
  */
-export declare function movePlayersToCenter(): void;
+export declare function movePlayersToCenter(radius?: float): void;
 //# sourceMappingURL=playerCenter.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"playerCenter.d.ts","sourceRoot":"","sources":["../../../src/functions/playerCenter.ts"],"names":[],"mappings":"AAYA;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,IAAI,IAAI,CAqC1C"}
+{"version":3,"file":"playerCenter.d.ts","sourceRoot":"","sources":["../../../src/functions/playerCenter.ts"],"names":[],"mappings":";AAUA;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,KAAU,GAAG,IAAI,CAqC5D"}

package/dist/src/functions/playerCenter.lua

@@ -20,7 +20,6 @@ function movePlayerAndTheirFamiliars(self, player, position)
         familiar.Position = position
     end
 end
-local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
 --- Helper function to move all of the players to where they would normally go when arriving at a new
 -- floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
 -- door.)
@@ -28,7 +27,12 @@ local CIRCLE_RADIUS_BETWEEN_PLAYERS = 50
 -- If there is more than one player, they will be distributed around the center in a circle.
 -- 
 -- This function emulates what happens in the vanilla game when you travel to a new floor.
-function ____exports.movePlayersToCenter(self)
+-- 
+-- @param radius Optional. The radius of the circle. Default is 10.
+function ____exports.movePlayersToCenter(self, radius)
+    if radius == nil then
+        radius = 10
+    end
     local isGreedMode = game:IsGreedMode()
     local startingPosition = isGreedMode and NEW_FLOOR_STARTING_POSITION_GREED_MODE or NEW_FLOOR_STARTING_POSITION_NORMAL_MODE
     local players = getAllPlayers(nil)
@@ -43,7 +47,7 @@ function ____exports.movePlayersToCenter(self)
     local circlePoints = getCircleDiscretizedPoints(
         nil,
         startingPosition,
-        CIRCLE_RADIUS_BETWEEN_PLAYERS,
+        radius,
         #players,
         1,
         1,

package/package.json

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

package/src/classes/ModFeature.ts

@@ -74,29 +74,34 @@ export class ModFeature {
   private mod: ModUpgradedBase;
 
   /**
-   * An optional function that allows for conditional callback execution. If specified, any class
+   * An optional method that allows for conditional callback execution. If specified, any class
    * method that is annotated with a `@Callback` or `@CallbackCustom` decorator will only be fired
    * if the executed conditional function returns true.
    *
    * This property is used to easily turn entire mod features on and off (rather than repeating
    * conditional logic and early returning at the beginning of every callback function).
    *
-   * By default, this is set to null. Override this property in your class if you need to use it.
+   * Since the specific information for the firing callback is passed as arguments into the
+   * conditional method, you can also write logic that would only apply to a specific type of
+   * callback.
+   *
+   * By default, this is set to null, which means that all callback methods will fire
+   * unconditionally. Override this property in your class if you need to use it.
    *
    * The function has the following signature:
    *
    * ```ts
-   * (
-   *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
-   *   modCallback: ModCallback | ModCallbackCustom,
-   *   ...callbackArgs: unknown[]
+   * <T extends boolean>(
+   *   vanilla: T, // Whether or not this is a vanilla or custom callback.
+   *   modCallback: T extends true ? ModCallback : ModCallbackCustom,
+   *   ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
    * ) => boolean;
    * ```
    */
-  protected callbackConditionalFunc:
-    | ((
-        vanilla: boolean,
-        modCallback: ModCallback | ModCallbackCustom,
+  protected shouldCallbackMethodsFire:
+    | (<T extends boolean>(
+        vanilla: T,
+        modCallback: T extends true ? ModCallback : ModCallbackCustom,
         ...callbackArgs: unknown[]
       ) => boolean)
     | null = null;
@@ -250,7 +255,7 @@ function addCallback(
   // first argument. (Otherwise, the method will not be able to properly access `this`.
   const wrappedCallback = (...callbackArgs: unknown[]) => {
     // eslint-disable-next-line @typescript-eslint/dot-notation
-    const conditionalFunc = modFeature["callbackConditionalFunc"];
+    const conditionalFunc = modFeature["shouldCallbackMethodsFire"];
     if (conditionalFunc !== null) {
       const shouldRun = conditionalFunc(vanilla, modCallback, ...callbackArgs);
       if (!shouldRun) {

package/src/functions/playerCenter.ts

@@ -8,8 +8,6 @@ import { getPlayerFamiliars } from "./familiars";
 import { getCircleDiscretizedPoints } from "./math";
 import { getAllPlayers } from "./playerIndex";
 
-const CIRCLE_RADIUS_BETWEEN_PLAYERS = 50;
-
 /**
  * Helper function to move all of the players to where they would normally go when arriving at a new
  * floor. (In normal mode, this is the center of the room. In Greed Mode, this is below the top
@@ -18,8 +16,10 @@ const CIRCLE_RADIUS_BETWEEN_PLAYERS = 50;
  * If there is more than one player, they will be distributed around the center in a circle.
  *
  * This function emulates what happens in the vanilla game when you travel to a new floor.
+ *
+ * @param radius Optional. The radius of the circle. Default is 10.
  */
-export function movePlayersToCenter(): void {
+export function movePlayersToCenter(radius: float = 10): void {
   const isGreedMode = game.IsGreedMode();
   const startingPosition = isGreedMode
     ? NEW_FLOOR_STARTING_POSITION_GREED_MODE
@@ -41,7 +41,7 @@ export function movePlayersToCenter(): void {
   // (This is what happens in vanilla.)
   const circlePoints = getCircleDiscretizedPoints(
     startingPosition,
-    CIRCLE_RADIUS_BETWEEN_PLAYERS,
+    radius,
     players.length,
     1,
     1,