isaacscript-common 1.2.4 → 1.2.8

package/dist/constants.d.ts

@@ -102,10 +102,14 @@ export declare const MAX_PLAYER_TRINKET_SLOTS = 2;
 export declare const MAX_ROOM_INDEX = 168;
 export declare const MAX_VANILLA_CHARACTER = PlayerType.PLAYER_THESOUL_B;
 export declare const MAX_VANILLA_COLLECTIBLE_TYPE = CollectibleType.COLLECTIBLE_MOMS_RING;
-export declare const MOVEMENT_ACTIONS: Set<ButtonAction>;
+export declare const SECOND_IN_MILLISECONDS = 1000;
+export declare const MINUTE_IN_MILLISECONDS: number;
+export declare const MOVEMENT_ACTIONS: ButtonAction[];
+export declare const MOVEMENT_ACTIONS_SET: Set<ButtonAction>;
 export declare const ONE_BY_ONE_ROOM_GRID_SIZE = 135;
 export declare const SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES: Set<CollectibleType>;
-export declare const SHOOTING_ACTIONS: Set<ButtonAction>;
+export declare const SHOOTING_ACTIONS: ButtonAction[];
+export declare const SHOOTING_ACTIONS_SET: Set<ButtonAction>;
 export declare const STORY_BOSSES: Set<EntityType>;
 /**
  * This is the number of draw coordinates that each heart spans on the UI in the upper left hand

package/dist/constants.lua

@@ -88,7 +88,10 @@ ____exports.MAX_PLAYER_TRINKET_SLOTS = 2
 ____exports.MAX_ROOM_INDEX = 168
 ____exports.MAX_VANILLA_CHARACTER = PlayerType.PLAYER_THESOUL_B
 ____exports.MAX_VANILLA_COLLECTIBLE_TYPE = CollectibleType.COLLECTIBLE_MOMS_RING
-____exports.MOVEMENT_ACTIONS = __TS__New(Set, {ButtonAction.ACTION_LEFT, ButtonAction.ACTION_RIGHT, ButtonAction.ACTION_UP, ButtonAction.ACTION_DOWN})
+____exports.SECOND_IN_MILLISECONDS = 1000
+____exports.MINUTE_IN_MILLISECONDS = 60 * ____exports.SECOND_IN_MILLISECONDS
+____exports.MOVEMENT_ACTIONS = {ButtonAction.ACTION_LEFT, ButtonAction.ACTION_RIGHT, ButtonAction.ACTION_UP, ButtonAction.ACTION_DOWN}
+____exports.MOVEMENT_ACTIONS_SET = __TS__New(Set, ____exports.MOVEMENT_ACTIONS)
 ____exports.ONE_BY_ONE_ROOM_GRID_SIZE = 135
 ____exports.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES = __TS__New(Set, {
     CollectibleType.COLLECTIBLE_FORGET_ME_NOW,
@@ -100,7 +103,8 @@ ____exports.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES = __TS__New(Set, {
     CollectibleType.COLLECTIBLE_DEATH_CERTIFICATE,
     CollectibleType.COLLECTIBLE_R_KEY
 })
-____exports.SHOOTING_ACTIONS = __TS__New(Set, {ButtonAction.ACTION_SHOOTLEFT, ButtonAction.ACTION_SHOOTRIGHT, ButtonAction.ACTION_SHOOTUP, ButtonAction.ACTION_SHOOTDOWN})
+____exports.SHOOTING_ACTIONS = {ButtonAction.ACTION_SHOOTLEFT, ButtonAction.ACTION_SHOOTRIGHT, ButtonAction.ACTION_SHOOTUP, ButtonAction.ACTION_SHOOTDOWN}
+____exports.SHOOTING_ACTIONS_SET = __TS__New(Set, ____exports.SHOOTING_ACTIONS)
 ____exports.STORY_BOSSES = __TS__New(Set, {
     EntityType.ENTITY_MOM,
     EntityType.ENTITY_MOMS_HEART,

package/dist/features/disableInputs.lua

@@ -4,8 +4,8 @@ local Set = ____lualib.Set
 local ____exports = {}
 local isActionPressed, isActionTriggered, getActionValue, getReturnValue, v
 local ____constants = require("constants")
-local MOVEMENT_ACTIONS = ____constants.MOVEMENT_ACTIONS
-local SHOOTING_ACTIONS = ____constants.SHOOTING_ACTIONS
+local MOVEMENT_ACTIONS_SET = ____constants.MOVEMENT_ACTIONS_SET
+local SHOOTING_ACTIONS_SET = ____constants.SHOOTING_ACTIONS_SET
 local ____errors = require("errors")
 local getUpgradeErrorMsg = ____errors.getUpgradeErrorMsg
 local ____exports = require("features.saveDataManager.exports")
@@ -85,9 +85,9 @@ function ____exports.disableAllInputsExceptFor(self, whitelist)
     v.run.blacklist = nil
 end
 function ____exports.disableMovementInputs(self)
-    ____exports.enableAllInputsExceptFor(nil, MOVEMENT_ACTIONS)
+    ____exports.enableAllInputsExceptFor(nil, MOVEMENT_ACTIONS_SET)
 end
 function ____exports.disableShootingInputs(self)
-    ____exports.enableAllInputsExceptFor(nil, SHOOTING_ACTIONS)
+    ____exports.enableAllInputsExceptFor(nil, SHOOTING_ACTIONS_SET)
 end
 return ____exports

package/dist/features/saveDataManager/exports.d.ts

@@ -50,12 +50,17 @@ import { SaveData } from "../../types/SaveData";
  * }
  * ```
  *
- * - Save data is loaded from disk in the MC_POST_PLAYER_INIT callback
- * (i.e. the first callback that can possibly run).
+ * - Save data is loaded from disk in the MC_POST_PLAYER_INIT callback (i.e. the first callback that
+ * can possibly run).
  * - Save data is recorded to disk in the MC_PRE_GAME_EXIT callback.
  *
  * Note that before using the save data manager, you must call the [[`upgradeMod`]] function.
  *
+ * If you want the save data manager to load data before the MC_POST_PLAYER_INIT callback (i.e. in
+ * the main menu), then you should explicitly call the [[`saveDataManagerLoad`]] function. (The save
+ * data manager cannot do this on its own because it cannot know when your mod features are finished
+ * initializing.)
+ *
  * Finally, some features may have variables that need to be automatically reset per run/level, but
  * not saved to disk on game exit. (For example, if they contain functions or other non-serializable
  * data.) For these cases, set a special key of "dontSave" alongside "run", "level", and so forth.
@@ -65,8 +70,8 @@ import { SaveData } from "../../types/SaveData";
  * @param saveData An object that corresponds to the `SaveData` interface. The object is
  * conventionally called "v" for brevity (which is short for "local variables").
  * @param conditionalFunc An optional function to run upon saving this key to disk. If the function
- * is false, the key will not be written to disk. This allows mod features to avoid cluttering the
- * "save#.dat" file with unnecessary keys.
+ * returns false, the key will not be written to disk. This allows mod features to avoid cluttering
+ * the "save#.dat" file with unnecessary keys.
  */
 export declare function saveDataManager(key: string, saveData: SaveData, conditionalFunc?: () => boolean): void;
 /**
@@ -75,6 +80,14 @@ export declare function saveDataManager(key: string, saveData: SaveData, conditi
  * of its variables to disk immediately.
  */
 export declare function saveDataManagerSave(): void;
+/**
+ * The save data manager will automatically load variables from disk at the appropriate times (i.e.
+ * when a new run is started). Use this function to explicitly force the save data manager to load
+ * all of its variables from disk immediately.
+ *
+ * Note that doing this will overwrite current data, which can potentially result in lost state.
+ */
+export declare function saveDataManagerLoad(): void;
 /**
  * Sets the global variable of "g" equal to all of the save data variables for this mod.
  * Sets the global variable of "gd" equal to all of the save data default variables for this mod.

package/dist/features/saveDataManager/exports.lua

@@ -10,6 +10,7 @@ local deepCopy = ____deepCopy.deepCopy
 local SerializationType = ____deepCopy.SerializationType
 local ____main = require("features.saveDataManager.main")
 local FEATURE_NAME = ____main.FEATURE_NAME
+local forceSaveDataManagerLoad = ____main.forceSaveDataManagerLoad
 local forceSaveDataManagerSave = ____main.forceSaveDataManagerSave
 local isSaveDataManagerInitialized = ____main.isSaveDataManagerInitialized
 local ____maps = require("features.saveDataManager.maps")
@@ -48,6 +49,13 @@ function ____exports.saveDataManagerSave(self)
     end
     forceSaveDataManagerSave(nil)
 end
+function ____exports.saveDataManagerLoad(self)
+    if not isSaveDataManagerInitialized(nil) then
+        local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
+        error(msg)
+    end
+    forceSaveDataManagerLoad(nil)
+end
 function ____exports.saveDataManagerSetGlobal(self)
     g = saveDataMap
     gd = saveDataDefaultsMap

package/dist/features/saveDataManager/main.lua

@@ -109,4 +109,10 @@ function ____exports.forceSaveDataManagerSave(self)
     end
     saveToDisk(nil, mod, saveDataMap, saveDataConditionalFuncMap)
 end
+function ____exports.forceSaveDataManagerLoad(self)
+    if mod == nil then
+        return
+    end
+    loadFromDisk(nil, mod, saveDataMap)
+end
 return ____exports

package/dist/functions/array.d.ts

@@ -61,6 +61,15 @@ export declare function arrayRemoveInPlace<T>(array: T[], ...elements: T[]): boo
  * @param exceptions Optional. An array of elements to skip over if selected.
  */
 export declare function getRandomArrayElement<T>(array: T[], seed?: number, exceptions?: T[]): T;
+/**
+ * Helper function to get a random element from the provided array. Once the random element is
+ * decided, it is then removed from the array (in-place).
+ *
+ * @param array The array to get an element from.
+ * @param seed Optional. The seed used to select the random element. `Random()` by default.
+ * @param exceptions Optional. An array of elements to skip over if selected.
+ */
+export declare function getRandomArrayElementAndRemove<T>(array: T[], seed?: number, exceptions?: T[]): T;
 export declare function getRandomArrayIndex<T>(array: T[], seed?: number): int;
 /**
  * Since Lua uses tables for every non-primitive data structure, it is non-trivial to determine if a

package/dist/functions/array.lua

@@ -145,6 +145,17 @@ function ____exports.getRandomArrayElement(self, array, seed, exceptions)
     local randomIndex = ____exports.getRandomArrayIndex(nil, arrayWithoutExceptions, seed)
     return arrayWithoutExceptions[randomIndex + 1]
 end
+function ____exports.getRandomArrayElementAndRemove(self, array, seed, exceptions)
+    if seed == nil then
+        seed = Random()
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    local randomArrayElement = ____exports.getRandomArrayElement(nil, array, seed, exceptions)
+    ____exports.arrayRemoveInPlace(nil, array, randomArrayElement)
+    return randomArrayElement
+end
 function ____exports.isArray(self, ____table)
     local metatable = getmetatable(____table)
     if metatable ~= nil then

package/dist/functions/input.lua

@@ -1,15 +1,16 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
 local __TS__StringReplace = ____lualib.__TS__StringReplace
 local __TS__ObjectEntries = ____lualib.__TS__ObjectEntries
-local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__ArraySome = ____lualib.__TS__ArraySome
 local __TS__StringSlice = ____lualib.__TS__StringSlice
 local ____exports = {}
 local ____constants = require("constants")
 local MAX_NUM_INPUTS = ____constants.MAX_NUM_INPUTS
 local MOVEMENT_ACTIONS = ____constants.MOVEMENT_ACTIONS
 local SHOOTING_ACTIONS = ____constants.SHOOTING_ACTIONS
+local ____math = require("functions.math")
+local range = ____math.range
 local ControllerLiteral = ControllerLiteral or ({})
 ControllerLiteral.DPAD_LEFT = 0
 ControllerLiteral[ControllerLiteral.DPAD_LEFT] = "DPAD_LEFT"
@@ -72,63 +73,45 @@ function ____exports.controllerToString(self, controller)
     return "unknown"
 end
 function ____exports.isActionPressedOnAnyInput(self, buttonAction)
-    do
-        local i = 0
-        while i < MAX_NUM_INPUTS do
-            if Input.IsActionPressed(buttonAction, i) then
-                return true
-            end
-            i = i + 1
-        end
-    end
-    return false
+    local validInputs = range(nil, 0, MAX_NUM_INPUTS - 1)
+    return __TS__ArraySome(
+        validInputs,
+        function(____, input) return Input.IsActionPressed(buttonAction, input) end
+    )
 end
 function ____exports.isActionTriggeredOnAnyInput(self, buttonAction)
-    do
-        local i = 0
-        while i < MAX_NUM_INPUTS do
-            if Input.IsActionTriggered(buttonAction, i) then
-                return true
-            end
-            i = i + 1
-        end
-    end
-    return false
+    local validInputs = range(nil, 0, MAX_NUM_INPUTS - 1)
+    return __TS__ArraySome(
+        validInputs,
+        function(____, input) return Input.IsActionTriggered(buttonAction, input) end
+    )
 end
 function ____exports.isKeyboardPressed(self, key)
     return Input.IsButtonPressed(key, 0)
 end
 function ____exports.isMoveActionPressedOnAnyInput(self)
-    for ____, buttonAction in __TS__Iterator(MOVEMENT_ACTIONS:values()) do
-        if ____exports.isActionPressedOnAnyInput(nil, buttonAction) then
-            return true
-        end
-    end
-    return false
+    return __TS__ArraySome(
+        MOVEMENT_ACTIONS,
+        function(____, moveAction) return ____exports.isActionPressedOnAnyInput(nil, moveAction) end
+    )
 end
 function ____exports.isMoveActionTriggeredOnAnyInput(self)
-    for ____, buttonAction in __TS__Iterator(MOVEMENT_ACTIONS:values()) do
-        if ____exports.isActionTriggeredOnAnyInput(nil, buttonAction) then
-            return true
-        end
-    end
-    return false
+    return __TS__ArraySome(
+        MOVEMENT_ACTIONS,
+        function(____, moveAction) return ____exports.isActionTriggeredOnAnyInput(nil, moveAction) end
+    )
 end
 function ____exports.isShootActionPressedOnAnyInput(self)
-    for ____, buttonAction in __TS__Iterator(SHOOTING_ACTIONS:values()) do
-        if ____exports.isActionPressedOnAnyInput(nil, buttonAction) then
-            return true
-        end
-    end
-    return false
+    return __TS__ArraySome(
+        SHOOTING_ACTIONS,
+        function(____, shootAction) return ____exports.isActionPressedOnAnyInput(nil, shootAction) end
+    )
 end
 function ____exports.isShootActionTriggeredOnAnyInput(self)
-    for ____, buttonAction in __TS__Iterator(SHOOTING_ACTIONS:values()) do
-        if ____exports.isActionTriggeredOnAnyInput(nil, buttonAction) then
-            return true
-        end
-    end
-    return false
+    return __TS__ArraySome(
+        SHOOTING_ACTIONS,
+        function(____, shootAction) return ____exports.isActionTriggeredOnAnyInput(nil, shootAction) end
+    )
 end
 function ____exports.keyboardToString(self, keyboard)
     for ____, ____value in ipairs(__TS__ObjectEntries(Keyboard)) do

package/dist/functions/math.d.ts

@@ -17,6 +17,8 @@ export declare function isEven(num: int): boolean;
 export declare function isOdd(num: int): boolean;
 export declare function lerp(a: number, b: number, pos: float): number;
 export declare function lerpAngleDegrees(aStart: number, aEnd: number, percent: float): number;
+/** Helper function to return an array with the elements from start to end, inclusive. */
+export declare function range(start: int, end: int): int[];
 /**
  * If rounding fails, this function returns 0.
  * From: http://lua-users.org/wiki/SimpleRound

package/dist/functions/math.lua

@@ -87,6 +87,17 @@ end
 function ____exports.lerpAngleDegrees(self, aStart, aEnd, percent)
     return aStart + ____exports.getAngleDifference(nil, aStart, aEnd) * percent
 end
+function ____exports.range(self, start, ____end)
+    local array = {}
+    do
+        local i = start
+        while i <= ____end do
+            __TS__ArrayPush(array, i)
+            i = i + 1
+        end
+    end
+    return array
+end
 function ____exports.round(self, num, numDecimalPlaces)
     if numDecimalPlaces == nil then
         numDecimalPlaces = 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.4",
+  "version": "1.2.8",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.0",
-    "isaac-typescript-definitions": "^1.0.334",
+    "isaac-typescript-definitions": "^1.0.336",
     "isaacscript-lint": "^1.0.79",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.11",