isaacscript-common 1.0.602 → 1.0.606

package/dist/functions/globals.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * Helper function to get a set containing all of the global variable names that are contained
+ * within the Isaac environment by default.
+ *
+ * Returns a slightly different set depending on whether the "--luadebug" flag is enabled or not.
+ */
+export declare function getDefaultGlobals(): Set<string>;
+/**
+ * Helper function to get an array of any added global variables in the Isaac Lua environment.
+ * Returns an array of key/value tuples.
+ */
+export declare function getNewGlobals(): [AnyNotNil, unknown][];
+export declare function logNewGlobals(): void;

package/dist/functions/globals.lua

@@ -0,0 +1,221 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+require("lualib_bundle");
+local ____exports = {}
+local twoDimensionalSort
+local ____log = require("functions.log")
+local log = ____log.log
+local ____util = require("functions.util")
+local addSetsToSet = ____util.addSetsToSet
+local copySet = ____util.copySet
+local isLuaDebugEnabled = ____util.isLuaDebugEnabled
+function twoDimensionalSort(self, a, b)
+    if a[1] == b[1] then
+        return 0
+    end
+    return a[1] < b[1] and -1 or 1
+end
+local DEFAULT_GLOBALS = __TS__New(Set, {
+    "ActionTriggers",
+    "ActiveSlot",
+    "BabySubType",
+    "BackdropType",
+    "BatterySubType",
+    "BedSubType",
+    "BitSet128",
+    "BombSubType",
+    "BombVariant",
+    "ButtonAction",
+    "CacheFlag",
+    "Card",
+    "Challenge",
+    "ChampionColor",
+    "ChestSubType",
+    "CoinSubType",
+    "CollectibleType",
+    "Color",
+    "CppContainer",
+    "DamageFlag",
+    "Difficulty",
+    "Direction",
+    "DoorSlot",
+    "DoorState",
+    "DoorVariant",
+    "EffectVariant",
+    "Entity",
+    "EntityBomb",
+    "EntityCollisionClass",
+    "EntityEffect",
+    "EntityFamiliar",
+    "EntityFlag",
+    "EntityGridCollisionClass",
+    "EntityKnife",
+    "EntityLaser",
+    "EntityNPC",
+    "EntityPartition",
+    "EntityPickup",
+    "EntityPlayer",
+    "EntityProjectile",
+    "EntityPtr",
+    "EntityRef",
+    "EntityTear",
+    "EntityType",
+    "FamiliarVariant",
+    "Font",
+    "Game",
+    "GameStateFlag",
+    "GetPtrHash",
+    "GridCollisionClass",
+    "GridEntity",
+    "GridEntityDesc",
+    "GridEntityDoor",
+    "GridEntityPit",
+    "GridEntityPoop",
+    "GridEntityPressurePlate",
+    "GridEntityRock",
+    "GridEntitySpikes",
+    "GridEntityTNT",
+    "GridEntityType",
+    "GridRooms",
+    "HUD",
+    "HeartSubType",
+    "Input",
+    "InputHook",
+    "Isaac",
+    "ItemConfig",
+    "ItemPool",
+    "ItemPoolType",
+    "ItemType",
+    "KColor",
+    "KeySubType",
+    "Keyboard",
+    "LaserOffset",
+    "LaserSubType",
+    "Level",
+    "LevelCurse",
+    "LevelStage",
+    "LevelStateFlag",
+    "LocustSubtypes",
+    "ModCallbacks",
+    "Mouse",
+    "Music",
+    "MusicManager",
+    "NpcState",
+    "NullItemID",
+    "Options",
+    "PathFinder",
+    "PickupPrice",
+    "PickupVariant",
+    "PillColor",
+    "PillEffect",
+    "PlayerForm",
+    "PlayerSpriteLayer",
+    "PlayerType",
+    "PlayerTypes",
+    "PoopPickupSubType",
+    "PoopSpellType",
+    "ProjectileFlags",
+    "ProjectileParams",
+    "ProjectileVariant",
+    "QueueItemData",
+    "REPENTANCE",
+    "RNG",
+    "Random",
+    "RandomVector",
+    "RegisterMod",
+    "RenderMode",
+    "Room",
+    "RoomConfig",
+    "RoomDescriptor",
+    "RoomShape",
+    "RoomTransitionAnim",
+    "RoomType",
+    "SFXManager",
+    "SackSubType",
+    "SeedEffect",
+    "Seeds",
+    "ShockwaveParams",
+    "SkinColor",
+    "SortingLayer",
+    "SoundEffect",
+    "Sprite",
+    "StageType",
+    "StartDebug",
+    "TearFlags",
+    "TearParams",
+    "TearVariant",
+    "TemporaryEffect",
+    "TemporaryEffects",
+    "TrinketType",
+    "UseFlag",
+    "Vector",
+    "WeaponType",
+    "_G",
+    "_VERSION",
+    "assert",
+    "collectgarbage",
+    "coroutine",
+    "dofile",
+    "error",
+    "getmetatable",
+    "include",
+    "ipairs",
+    "load",
+    "loadfile",
+    "math",
+    "next",
+    "pairs",
+    "pcall",
+    "print",
+    "rawequal",
+    "rawget",
+    "rawlen",
+    "rawset",
+    "require",
+    "select",
+    "setmetatable",
+    "string",
+    "table",
+    "tonumber",
+    "tostring",
+    "type",
+    "utf8",
+    "xpcall"
+})
+local LUA_DEBUG_ADDED_GLOBALS = __TS__New(Set, {"debug", "io", "os", "package"})
+local RACING_PLUS_SANDBOX_ADDED_GLOBALS = __TS__New(Set, {"sandboxTraceback", "sandboxGetTraceback", "getParentFunctionDescription"})
+function ____exports.getDefaultGlobals(self)
+    local defaultGlobals = copySet(nil, DEFAULT_GLOBALS)
+    if isLuaDebugEnabled(nil) then
+        addSetsToSet(nil, defaultGlobals, LUA_DEBUG_ADDED_GLOBALS)
+    end
+    addSetsToSet(nil, defaultGlobals, RACING_PLUS_SANDBOX_ADDED_GLOBALS)
+    return defaultGlobals
+end
+function ____exports.getNewGlobals(self)
+    local defaultGlobals = ____exports.getDefaultGlobals(nil)
+    local newGlobals = {}
+    for key, value in pairs(_G) do
+        if not defaultGlobals:has(key) then
+            local keyValueTuple = {key, value}
+            __TS__ArrayPush(newGlobals, keyValueTuple)
+        end
+    end
+    __TS__ArraySort(newGlobals, twoDimensionalSort)
+    return newGlobals
+end
+function ____exports.logNewGlobals(self)
+    local newGlobals = ____exports.getNewGlobals(nil)
+    log("List of added global variables in the Isaac environment:")
+    if #newGlobals == 0 then
+        log("- n/a (no extra global variables found)")
+    end
+    do
+        local i = 0
+        while i < #newGlobals do
+            local key, value = table.unpack(newGlobals[i + 1])
+            log((((tostring(i + 1) .. ") ") .. tostring(key)) .. " - ") .. tostring(value))
+            i = i + 1
+        end
+    end
+end
+return ____exports

package/dist/functions/player.lua

@@ -11,6 +11,8 @@ local LOST_STYLE_PLAYER_TYPES = ____constants.LOST_STYLE_PLAYER_TYPES
 local MAX_PLAYER_HEART_CONTAINERS = ____constants.MAX_PLAYER_HEART_CONTAINERS
 local ____HealthType = require("types.HealthType")
 local HealthType = ____HealthType.HealthType
+local ____array = require("functions.array")
+local arraySum = ____array.arraySum
 local ____bitwise = require("functions.bitwise")
 local getKBitOfN = ____bitwise.getKBitOfN
 local getNumBitsOfN = ____bitwise.getNumBitsOfN
@@ -308,14 +310,14 @@ end
 function ____exports.getPlayersOfType(self, ...)
     local characters = {...}
     local charactersSet = __TS__New(Set, characters)
-    local players = {}
-    for ____, player in ipairs(____exports.getPlayers(nil)) do
-        local character = player:GetPlayerType()
-        if charactersSet:has(character) then
-            __TS__ArrayPush(players, player)
+    local players = ____exports.getPlayers(nil)
+    return __TS__ArrayFilter(
+        players,
+        function(____, player)
+            local character = player:GetPlayerType()
+            return charactersSet:has(character)
         end
-    end
-    return players
+    )
 end
 function ____exports.getTotalCharge(self, player, activeSlot)
     local activeCharge = player:GetActiveCharge(activeSlot)
@@ -323,11 +325,12 @@ function ____exports.getTotalCharge(self, player, activeSlot)
     return activeCharge + batteryCharge
 end
 function ____exports.getTotalPlayerCollectibles(self, collectibleType)
-    local numCollectibles = 0
-    for ____, player in ipairs(____exports.getPlayers(nil)) do
-        numCollectibles = numCollectibles + player:GetCollectibleNum(collectibleType)
-    end
-    return numCollectibles
+    local players = ____exports.getPlayers(nil)
+    local numCollectiblesArray = __TS__ArrayMap(
+        players,
+        function(____, player) return player:GetCollectibleNum(collectibleType) end
+    )
+    return arraySum(nil, numCollectiblesArray)
 end
 function ____exports.hasLostCurse(self, player)
     local effects = player:GetEffects()
@@ -452,9 +455,9 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
         itemPool:RemoveCollectible(collectibleType)
     end
     repeat
-        local ____switch112 = activeSlot
-        local ____cond112 = ____switch112 == ActiveSlot.SLOT_PRIMARY
-        if ____cond112 then
+        local ____switch109 = activeSlot
+        local ____cond109 = ____switch109 == ActiveSlot.SLOT_PRIMARY
+        if ____cond109 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -463,8 +466,8 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond112 = ____cond112 or ____switch112 == ActiveSlot.SLOT_SECONDARY
-        if ____cond112 then
+        ____cond109 = ____cond109 or ____switch109 == ActiveSlot.SLOT_SECONDARY
+        if ____cond109 then
             do
                 if primaryCollectibleType ~= CollectibleType.COLLECTIBLE_NULL then
                     player:RemoveCollectible(primaryCollectibleType)
@@ -479,16 +482,16 @@ function ____exports.setActiveItem(self, player, collectibleType, activeSlot, ch
                 break
             end
         end
-        ____cond112 = ____cond112 or ____switch112 == ActiveSlot.SLOT_POCKET
-        if ____cond112 then
+        ____cond109 = ____cond109 or ____switch109 == ActiveSlot.SLOT_POCKET
+        if ____cond109 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 player:SetActiveCharge(charge, activeSlot)
                 break
             end
         end
-        ____cond112 = ____cond112 or ____switch112 == ActiveSlot.SLOT_POCKET2
-        if ____cond112 then
+        ____cond109 = ____cond109 or ____switch109 == ActiveSlot.SLOT_POCKET2
+        if ____cond109 then
             do
                 player:SetPocketActiveItem(collectibleType, activeSlot, keepInPools)
                 break

package/dist/functions/util.d.ts

@@ -1,5 +1,12 @@
 /// <reference types="isaac-typescript-definitions" />
 /// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * Helper function to add all of the contents of one set to another set. The first set passed will
+ * be modified in place.
+ *
+ * This function is variadic, meaning that you can specify N sets to add to the first set.
+ */
+export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T>>): void;
 /**
  * Using a Map constructor to copy a Map does not seem to work properly, so use this helper function
  * instead.
@@ -10,6 +17,12 @@ export declare function copyMap<K, V>(oldMap: Map<K, V>): Map<K, V>;
  * instead.
  */
 export declare function copySet<T>(oldSet: Set<T>): Set<T>;
+/**
+ * Helper function to create a new set that is the composition of two or more sets.
+ *
+ * This function is variadic, meaning that you can specify N sets.
+ */
+export declare function combineSets<T>(...sets: Array<Set<T>>): Set<T>;
 /**
  * Helper function to get type safety on a switch statement.
  * Very useful to be future-safe against people adding values to a type or an enum.

package/dist/functions/util.lua

@@ -2,6 +2,14 @@
 require("lualib_bundle");
 local ____exports = {}
 local HEX_STRING_LENGTH = 6
+function ____exports.addSetsToSet(self, mainSet, ...)
+    local setsToAdd = {...}
+    for ____, set in ipairs(setsToAdd) do
+        for ____, value in __TS__Iterator(set:values()) do
+            mainSet:add(value)
+        end
+    end
+end
 function ____exports.copyMap(self, oldMap)
     local newMap = __TS__New(Map)
     for ____, ____value in __TS__Iterator(oldMap:entries()) do
@@ -18,6 +26,16 @@ function ____exports.copySet(self, oldSet)
     end
     return newSet
 end
+function ____exports.combineSets(self, ...)
+    local sets = {...}
+    local newSet = __TS__New(Set)
+    for ____, set in ipairs(sets) do
+        for ____, value in __TS__Iterator(set:values()) do
+            newSet:add(value)
+        end
+    end
+    return newSet
+end
 ____exports.ensureAllCases = function(____, obj) return obj end
 function ____exports.getEnumValues(self, transpiledEnum)
     local enumValues = {}

package/dist/index.d.ts

@@ -23,6 +23,7 @@ export * from "./functions/doors";
 export * from "./functions/entity";
 export * from "./functions/familiars";
 export * from "./functions/flag";
+export * from "./functions/globals";
 export * from "./functions/gridEntity";
 export * from "./functions/input";
 export * from "./functions/json";

package/dist/index.lua

@@ -190,6 +190,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.globals")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.gridEntity")
     for ____exportKey, ____exportValue in pairs(____export) do

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.0.602",
+  "version": "1.0.606",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.332",
+    "isaac-typescript-definitions": "^1.0.333",
     "isaacscript-lint": "^1.0.79",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.11",