isaacscript-common 6.6.1-dev.0 → 6.6.1-dev.4

package/dist/functions/enums.js

@@ -0,0 +1,151 @@
+import { getRandomArrayElement } from "./array";
+import { getRandomSeed } from "./rng";
+import { isString } from "./types";
+import { irange } from "./utils";
+/**
+ * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
+ * when you iterate over them, you will get both the names of the enums and the values of the enums,
+ * in a random order. Use this helper function to get the entries of the enum with the reverse
+ * mappings filtered out.
+ *
+ * This function will return the enum values in a sorted order, which may not necessarily be the
+ * same order as which they were declared in.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * Also see the `getEnumKeys` and `getEnumValues` helper functions.
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/gotchas#iterating-over-enums
+ */
+export function getEnumEntries(transpiledEnum) {
+    // The values cannot simply be type `T` due to the special construction of bit flag enums.
+    const enumEntries = [];
+    for (const [key, value] of pairs(transpiledEnum)) {
+        // Ignore the reverse mappings created by TypeScriptToLua. Note that reverse mappings are not
+        // created for string enums.
+        if (isString(key)) {
+            enumEntries.push([key, value]);
+        }
+    }
+    // The enums will be in a random order (because of "pairs"), so sort them based on the values.
+    // https://stackoverflow.com/questions/5199901/how-to-sort-an-associative-array-by-its-values-in-javascript
+    enumEntries.sort(([_key1, value1], [_key2, value2]) => value1 < value2 ? -1 : value1 > value2 ? 1 : 0);
+    return enumEntries;
+}
+/**
+ * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
+ * when you iterate over them, you will get both the names of the enums and the values of the enums,
+ * in a random order. If all you need are the keys of an enum, use this helper function.
+ *
+ * This function will return the enum keys in a sorted order, which may not necessarily be the same
+ * order as which they were declared in.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * Also see the `getEnumEntries` and `getEnumValues` helper functions.
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/gotchas#iterating-over-enums
+ */
+export function getEnumKeys(transpiledEnum) {
+    const enumEntries = getEnumEntries(transpiledEnum);
+    return enumEntries.map(([key, _value]) => key);
+}
+/** Helper function to get the amount of entries inside of an enum. */
+export function getEnumLength(transpiledEnum) {
+    const enumEntries = getEnumEntries(transpiledEnum);
+    return enumEntries.length;
+}
+/**
+ * TypeScriptToLua will transpile TypeScript enums to Lua tables that have a double mapping. Thus,
+ * when you iterate over them, you will get both the names of the enums and the values of the enums,
+ * in a random order. If all you need are the values of an enum, use this helper function.
+ *
+ * This function will return the enum values in a sorted order, which may not necessarily be the
+ * same order as which they were declared in.
+ *
+ * This function will work properly for both number enums and string enums. (Reverse mappings are
+ * not created for string enums.)
+ *
+ * Also see the `getEnumEntries` and `getEnumKeys` helper functions.
+ *
+ * For a more in depth explanation, see:
+ * https://isaacscript.github.io/gotchas#iterating-over-enums
+ */
+export function getEnumValues(transpiledEnum) {
+    const enumEntries = getEnumEntries(transpiledEnum);
+    return enumEntries.map(([_key, value]) => value);
+}
+/**
+ * Helper function to get the enum value with the highest value.
+ *
+ * Note that this is not necessarily the enum value that is declared last, since there is no way to
+ * infer that at run-time.
+ */
+export function getLastEnumValue(transpiledEnum) {
+    const enumValues = getEnumValues(transpiledEnum);
+    const lastElement = enumValues[enumValues.length - 1];
+    if (lastElement === undefined) {
+        error("Failed to get the last value from an enum since the enum was empty.");
+    }
+    return lastElement;
+}
+/**
+ * Helper function to get a random value from the provided enum.
+ *
+ * @param transpiledEnum The enum to get the value from.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param exceptions Optional. An array of elements to skip over if selected.
+ */
+export function getRandomEnumValue(transpiledEnum, seedOrRNG = getRandomSeed(), exceptions = []) {
+    const enumValues = getEnumValues(transpiledEnum);
+    return getRandomArrayElement(enumValues, seedOrRNG, exceptions);
+}
+/**
+ * Helper function to check every value of a custom enum for -1. Will throw an run-time error if any
+ * -1 values are found. This is helpful because many methods of the Isaac class return -1 if they
+ * fail.
+ *
+ * For example:
+ *
+ * ```ts
+ * enum EntityTypeCustom {
+ *   FOO = Isaac.GetEntityTypeByName("Foo"),
+ * }
+ *
+ * validateCustomEnum("EntityTypeCustom", EntityTypeCustom);
+ * ```
+ */
+export function validateCustomEnum(transpiledEnumName, transpiledEnum) {
+    for (const [key, value] of getEnumEntries(transpiledEnum)) {
+        if (value === -1) {
+            error(`Failed to find the custom enum value: ${transpiledEnumName}.${key}`);
+        }
+    }
+}
+/**
+ * Helper function to validate if every value in an enum is contiguous, starting at 0.
+ *
+ * This is useful to automate checking large enums for typos.
+ */
+export function validateEnumContiguous(transpiledEnumName, transpiledEnum) {
+    const values = getEnumValues(transpiledEnum);
+    const valuesSet = new Set(values);
+    const lastValue = values[values.length - 1];
+    if (lastValue === undefined) {
+        error("Failed to validate that an enum was contiguous, since the last value was undefined.");
+    }
+    if (typeof lastValue !== "number") {
+        error("Failed to validate that an enum was contiguous, since the last value was not a number.");
+    }
+    for (const value of irange(lastValue)) {
+        if (!valuesSet.has(value)) {
+            error(`Failed to find a custom enum value of ${value} for: ${transpiledEnumName}`);
+        }
+    }
+}
+//# sourceMappingURL=enums.js.map

package/dist/functions/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"../src/","sources":["functions/enums.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAC5B,cAAiB;IAEjB,0FAA0F;IAC1F,MAAM,WAAW,GAA4C,EAAE,CAAC;IAChE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,EAAE;QAChD,6FAA6F;QAC7F,4BAA4B;QAC5B,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE;YACjB,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;SAChC;KACF;IAED,8FAA8F;IAC9F,2GAA2G;IAC3G,WAAW,CAAC,IAAI,CACd,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CACnC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACjD,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,WAAW,CAAI,cAAiB;IAC9C,MAAM,WAAW,GAAG,cAAc,CAAC,cAAc,CAAC,CAAC;IACnD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;AACjD,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,aAAa,CAAI,cAAiB;IAChD,MAAM,WAAW,GAAG,cAAc,CAAC,cAAc,CAAC,CAAC;IACnD,OAAO,WAAW,CAAC,MAAM,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa,CAAI,cAAiB;IAChD,MAAM,WAAW,GAAG,cAAc,CAAC,cAAc,CAAC,CAAC;IACnD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAI,cAAiB;IACnD,MAAM,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,IAAI,WAAW,KAAK,SAAS,EAAE;QAC7B,KAAK,CACH,qEAAqE,CACtE,CAAC;KACH;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,cAAiB,EACjB,YAAwB,aAAa,EAAE,EACvC,aAA4D,EAAE;IAE9D,MAAM,UAAU,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;IACjD,OAAO,qBAAqB,CAAC,UAAU,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAClE,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,kBAAkB,CAChC,kBAA0B,EAC1B,cAAuB;IAEvB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,cAAc,CAAC,cAAc,CAAC,EAAE;QACzD,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YAChB,KAAK,CACH,yCAAyC,kBAAkB,IAAI,GAAG,EAAE,CACrE,CAAC;SACH;KACF;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,kBAA0B,EAC1B,cAAiB;IAEjB,MAAM,MAAM,GAAG,aAAa,CAAC,cAAc,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC5C,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,KAAK,CACH,qFAAqF,CACtF,CAAC;KACH;IACD,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACjC,KAAK,CACH,wFAAwF,CACzF,CAAC;KACH;IACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,SAAS,CAAC,EAAE;QACrC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAA8B,CAAC,EAAE;YAClD,KAAK,CACH,yCAAyC,KAAK,SAAS,kBAAkB,EAAE,CAC5E,CAAC;SACH;KACF;AACH,CAAC"}

package/dist/functions/enums.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/enums.ts"],"names":[],"mappings":";;;;;;AAAA,kBAAsC;AAA7B;AACT,gBAA8B;AAArB;AACT,kBAAyB;AAAhB;AACT,kBAAuB;AAAd;;;;;;;;;;;;;;;;AAmBT,0CACE;AAGM,wBAAuD;AAC7D,QAAY,KAAK,SAAU,MAAM;WAG3B,cAAS;AACX,4CAAiB,CAAC,KAAK;;;IAM3B;QAAA;QACE;kBAAS;kBAAP;YAAO;kBAAiB;kBAAP;YAAO;AACxB,4BAAS,YAAU,KAAI,UAAS,WAAS,KAAI;QAD/C;;AAIF,WAAO;AApBT;;;;;;;;;;;;;;;AAuCA,uCAA+B;AACvB,wBAAc,gCAAe;AACnC,WAAO;QAAA;QAAgB;kBAAE;YAAA;kBAAK;AAAY;QAAnB;;AAFzB;;AAMA,yCAAiC;AACzB,wBAAc,gCAAe;AACnC,WAAO;AAFT;;;;;;;;;;;;;;;AAqBA,yCAAiC;AACzB,wBAAc,gCAAe;AACnC,WAAO;QAAA;QAAgB;kBAAQ;kBAAN;YAAM;AAAW;QAAnB;;AAFzB;;;;;AAWA,4CAAoC;AAC5B,uBAAa,+BAAc;AAE3B,wBAAc,WAAW;OAC3B;QACF,MACE;;AAIJ,WAAO;AAVT;;;;;;;AAqBA,8CACE,gBACA,WACA;OADA;QAAA,YAAwB;;OACxB;QAAA,aAA4D;;AAEtD,uBAAa,+BAAc;AACjC,WAAO,2BAAsB,YAAY,WAAW;AANtD;;;;;;;;;;;;;;AAwBA,8CACE,oBACA;AAEA,kCAA2B,gCAAe;cAA9B;cAAK;WACX,UAAW;YACb,QACE,4CAAyC,uBAAkB,QAAI;;;AAPvE;;;;AAkBA,kDACE,oBACA;AAEM,mBAAS,+BAAc;AACvB,sBAAY,UAAI,KAAI;AACpB,sBAAY,OAAO;OACrB;QACF,MACE;;OAGA,KAAO,cAAc;QACvB,MACE;;AAGJ,cAAW,gBAAS,YAAO;eACpB,UAAU,IAAI;YACjB,QACE,qDAAyC,WAAK,aAAS;;;AApB/D","file":"enums.lua","sourceRoot":"../src/"}

package/dist/functions/familiars.js

@@ -0,0 +1,85 @@
+import { itemConfig } from "../cachedClasses";
+import { FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET } from "../sets/familiarsThatShootPlayerTearsSet";
+import { getFamiliars } from "./entitySpecific";
+/**
+ * Helper function to add and remove familiars based on a target amount that you specify.
+ *
+ * This is a convenience wrapper around the `EntityPlayer.CheckFamiliar` method. Use this helper
+ * function instead so that you do not have to retrieve the `ItemConfigItem` and so that you do not
+ * specify an incorrect RNG object. (The vanilla method is bugged in that it does not increment the
+ * RNG object; see the documentation of the method for more details.)
+ *
+ * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
+ * to `CacheFlag.FAMILIARS`).
+ *
+ * Note that this function is only meant to be used in special circumstances where the familiar
+ * count is completely custom and does not correspond to the amount of collectibles. For the general
+ * case, use the `checkFamiliarFromCollectibles` helper function instead.
+ *
+ * Note that this will spawn familiars with a completely random `InitSeed`. When calculating random
+ * events for this familiar, you should use a data structure that maps familiar `InitSeed` to RNG
+ * objects that are initialized based on the seed from
+ * `EntityPlayer.GetCollectibleRNG(collectibleType)`.
+ *
+ * @param player The player that owns the familiars.
+ * @param collectibleType The collectible type of the collectible associated with this familiar.
+ * @param targetCount The number of familiars that should exist. This function will add or remove
+ *                    familiars until it matches the target count.
+ * @param familiarVariant The variant of the familiar to spawn or remove.
+ * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
+ *                        specified, it will search for existing familiars of all sub-types, and
+ *                        spawn new familiars with a sub-type of 0.
+ */
+export function checkFamiliar(player, collectibleType, targetCount, familiarVariant, familiarSubType) {
+    const itemConfigItem = itemConfig.GetCollectible(collectibleType);
+    player.CheckFamiliar(familiarVariant, targetCount, RNG(), itemConfigItem, familiarSubType);
+}
+/**
+ * Helper function to add and remove familiars based on the amount of associated collectibles that a
+ * player has.
+ *
+ * Use this helper function instead of invoking the `EntityPlayer.CheckFamiliar` method directly so
+ * that the target count is handled automatically.
+ *
+ * This function is meant to be called in the EvaluateCache callback (when the cache flag is equal
+ * to `CacheFlag.FAMILIARS`).
+ *
+ * Use this function when the amount of familiars should be equal to the amount of associated
+ * collectibles that the player has (plus any extras from having used Box of Friends or Monster
+ * Manual). If you instead need to have a custom amount of familiars, use the `checkFamiliars`
+ * function instead.
+ *
+ * Note that this will spawn familiars with a completely random `InitSeed`. When calculating random
+ * events for this familiar, you should use a data structure that maps familiar `InitSeed` to RNG
+ * objects that are initialized based on the seed from
+ * `EntityPlayer.GetCollectibleRNG(collectibleType)`.
+ *
+ * @param player The player that owns the familiars and collectibles.
+ * @param collectibleType The collectible type of the collectible associated with this familiar.
+ * @param familiarVariant The variant of the familiar to spawn or remove.
+ * @param familiarSubType Optional. The sub-type of the familiar to spawn or remove. If not
+ *                        specified, it will search for existing familiars of all sub-types, and
+ *                        spawn new familiars with a sub-type of 0.
+ */
+export function checkFamiliarFromCollectibles(player, collectibleType, familiarVariant, familiarSubType) {
+    const numCollectibles = player.GetCollectibleNum(collectibleType);
+    const effects = player.GetEffects();
+    // Whenever Box of Friends or Monster Manual is used, it will automatically increment the number
+    // of collectible effects for this familiar.
+    const numCollectibleEffects = effects.GetCollectibleEffectNum(collectibleType);
+    const targetCount = numCollectibles + numCollectibleEffects;
+    checkFamiliar(player, collectibleType, targetCount, familiarVariant, familiarSubType);
+}
+/** Helper function to get only the familiars that belong to a specific player. */
+export function getPlayerFamiliars(player) {
+    const playerPtrHash = GetPtrHash(player);
+    const familiars = getFamiliars();
+    return familiars.filter((familiar) => {
+        const familiarPlayerPtrHash = GetPtrHash(familiar.Player);
+        return familiarPlayerPtrHash === playerPtrHash;
+    });
+}
+export function isFamiliarThatShootsPlayerTears(familiar) {
+    return FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET.has(familiar.Variant);
+}
+//# sourceMappingURL=familiars.js.map

package/dist/functions/familiars.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"familiars.js","sourceRoot":"../src/","sources":["functions/familiars.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,qCAAqC,EAAE,MAAM,0CAA0C,CAAC;AACjG,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAoB,EACpB,eAAgC,EAChC,WAAgB,EAChB,eAAgC,EAChC,eAAqB;IAErB,MAAM,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IAClE,MAAM,CAAC,aAAa,CAClB,eAAe,EACf,WAAW,EACX,GAAG,EAAE,EACL,cAAc,EACd,eAAe,CAChB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,6BAA6B,CAC3C,MAAoB,EACpB,eAAgC,EAChC,eAAgC,EAChC,eAAqB;IAErB,MAAM,eAAe,GAAG,MAAM,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAClE,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAEpC,gGAAgG;IAChG,4CAA4C;IAC5C,MAAM,qBAAqB,GACzB,OAAO,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC;IACnD,MAAM,WAAW,GAAG,eAAe,GAAG,qBAAqB,CAAC;IAE5D,aAAa,CACX,MAAM,EACN,eAAe,EACf,WAAW,EACX,eAAe,EACf,eAAe,CAChB,CAAC;AACJ,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,kBAAkB,CAAC,MAAoB;IACrD,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;IACjC,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE;QACnC,MAAM,qBAAqB,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC1D,OAAO,qBAAqB,KAAK,aAAa,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,+BAA+B,CAC7C,QAAwB;IAExB,OAAO,qCAAqC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACrE,CAAC"}

package/dist/functions/familiars.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/familiars.ts"],"names":[],"mappings":";;;AACA,0BAA2B;AAAlB;AACT,6CAAsD;AAA7C;AACT,2BAA6B;AAApB;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BT,yCACE,QACA,iBACA,aACA,iBACA;AAEM,2BAAiB,WAAW,eAAe;IACjD,OAAO;QACL;QACA;QACA;QACA;QACA;;AAbJ;;;;;;;;;;;;;;;;;;;;;;;;;;AA4CA,yDACE,QACA,iBACA,iBACA;AAEM,4BAAkB,OAAO,kBAAkB;AAC3C,oBAAU,OAAO;AAIjB,kCACJ,QAAQ,wBAAwB;AAC5B,wBAAc,kBAAkB;IAEtC;;QACE;QACA;QACA;QACA;QACA;;AApBJ;;AAyBA,8CAAmC;AAC3B,0BAAgB,WAAW;AAC3B,sBAAY;AAClB,WAAO;QAAA;QAAiB,eAAC;AACjB,0CAAwB,WAAW;AACzC,mBAAO,yBAA0B;QAFX;;AAH1B;AASA,2DACE;AAEA,WAAO,sCAAsC,IAAI;AAHnD","file":"familiars.lua","sourceRoot":"../src/"}

package/dist/functions/flag.js

@@ -0,0 +1,137 @@
+import { DamageFlag } from "isaac-typescript-definitions";
+/**
+ * Helper function to add a bit flag to an existing set of bit flags.
+ *
+ * This is a variadic function, so pass as many flags as you want to add.
+ *
+ * Example 1:
+ *
+ * ```ts
+ * // Give the player spectral tears
+ * const player = Isaac.GetPlayer();
+ * player.TearFlags = addFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL);
+ * ```
+ *
+ * Example 2:
+ *
+ * ```ts
+ * // Give the player spectral and homing tears
+ * const player = Isaac.GetPlayer();
+ * player.TearFlags = addFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL, TearFlags.TEAR_HOMING);
+ * ```
+ *
+ * @param flags The existing set of bit flags.
+ * @param flagsToAdd One or more bit flags to add, each as a separate argument.
+ * @returns The combined bit flags.
+ */
+export function addFlag(flags, ...flagsToAdd) {
+    let flagsAsInt = flags;
+    for (const flagToAdd of flagsToAdd) {
+        flagsAsInt |= flagToAdd;
+    }
+    return flagsAsInt;
+}
+/**
+ * Helper function for casting a flag enum value to a `BitFlags` object.
+ *
+ * This is useful because the compiler will prevent you from assigning a specific flag to a
+ * `BitFlags` property. (It does this to ensure type safety, since `BitFlags` can represent a zero
+ * value or a composition of N flags.)
+ *
+ * For example:
+ *
+ * ```ts
+ * player.TearFlags = bitFlags(TearFlag.SPECTRAL);
+ * ```
+ */
+export function bitFlags(flag) {
+    return flag;
+}
+/**
+ * Helper function to get the key associated with a particular flag.
+ *
+ * (Since bit flags are represented by custom objects instead of normal TypeScript enums, you cannot
+ * use the reverse mapping to find the associated key of a given enum value. Use this helper
+ * function instead of indexing the enum directly.)
+ */
+export function getFlagName(flag, flagEnum) {
+    for (const [key, value] of pairs(flagEnum)) {
+        if (value === flag) {
+            return key;
+        }
+    }
+    return undefined;
+}
+/**
+ * Helper function to determine if a particular bit flag is set to true.
+ *
+ * This is a variadic function, so pass as many flags as you want to check for. If passed multiple
+ * flags, it will only return true if all of the flags are set.
+ *
+ * For example:
+ *
+ * ```ts
+ * const player = Isaac.GetPlayer();
+ * if (hasFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL) {
+ *   // The player currently has spectral tears
+ * }
+ * ```
+ *
+ * @param flags The existing set of bit flags.
+ * @param flagsToCheck One or more bit flags to check for, each as a separate argument.
+ */
+export function hasFlag(flags, ...flagsToCheck) {
+    const flagsAsInt = flags;
+    for (const flagToCheck of flagsToCheck) {
+        if (!((flagsAsInt & flagToCheck) === flagToCheck)) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Helper function to check if every bit in the flag is turned off.
+ *
+ * (This is equivalent to checking if the flag is equal to 0, but this is not possible without
+ * casting the flag to a number.)
+ */
+export function isEmptyFlag(flag) {
+    return flag === 0;
+}
+/**
+ * Helper function to determine whether damage to a player in the EntityTakeDmg callback was
+ * self-inflicted. For example, damage from a Curse Room door, a Razor, or a Blood Donation Machine
+ * would count as self-inflicted damage.
+ */
+export function isSelfDamage(damageFlags) {
+    return (
+    // Exclude self-damage from e.g. Curse Room door spikes.
+    hasFlag(damageFlags, DamageFlag.NO_PENALTIES) ||
+        // Exclude self-damage from e.g. Razor.
+        hasFlag(damageFlags, DamageFlag.RED_HEARTS));
+}
+/**
+ * Helper function to remove a bit flag from an existing set of bit flags.
+ *
+ * This is a variadic function, so pass as many flags as you want to remove.
+ *
+ * For example:
+ *
+ * ```ts
+ * // Remove spectral tears from the player, if present
+ * const player = Isaac.GetPlayer();
+ * player.TearFlags = removeFlag(player.TearFlags, TearFlags.TEAR_SPECTRAL);
+ * ```
+ *
+ * @param flags The existing set of bit flags.
+ * @param flagsToRemove One or more bit flags to remove, each as a separate argument.
+ * @returns The combined bit flags.
+ */
+export function removeFlag(flags, ...flagsToRemove) {
+    let flagsAsInt = flags;
+    for (const flagToRemove of flagsToRemove) {
+        flagsAsInt &= ~flagToRemove;
+    }
+    return flagsAsInt;
+}
+//# sourceMappingURL=flag.js.map

package/dist/functions/flag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flag.js","sourceRoot":"../src/","sources":["functions/flag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,OAAO,CACrB,KAAsB,EACtB,GAAG,UAAe;IAElB,IAAI,UAAU,GAAG,KAAY,CAAC;IAE9B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;QAClC,UAAU,IAAI,SAAgB,CAAC;KAChC;IAED,OAAO,UAAyB,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ,CAAiC,IAAO;IAC9D,OAAO,IAAmB,CAAC;AAC7B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CACzB,IAAa,EACb,QAA2B;IAE3B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE;QAC1C,IAAI,KAAK,KAAK,IAAI,EAAE;YAClB,OAAO,GAAG,CAAC;SACZ;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,OAAO,CACrB,KAAsB,EACtB,GAAG,YAAiB;IAEpB,MAAM,UAAU,GAAG,KAAY,CAAC;IAEhC,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACtC,IAAI,CAAC,CAAC,CAAC,UAAU,GAAI,WAAmB,CAAC,KAAK,WAAW,CAAC,EAAE;YAC1D,OAAO,KAAK,CAAC;SACd;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAiC,IAAO;IACjE,OAAO,IAAI,KAAK,CAAC,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAC1B,WAA8C;IAE9C,OAAO;IACL,wDAAwD;IACxD,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,YAAY,CAAC;QAC7C,uCAAuC;QACvC,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,CAC5C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,UAAU,CACxB,KAAsB,EACtB,GAAG,aAAkB;IAErB,IAAI,UAAU,GAAG,KAAY,CAAC;IAE9B,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;QACxC,UAAU,IAAI,CAAC,YAAY,CAAC;KAC7B;IAED,OAAO,UAAyB,CAAC;AACnC,CAAC"}

package/dist/functions/flag.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/flag.ts"],"names":[],"mappings":";AAAA,6CAA2B;AAAlB;;;;;;;;;;;;;;;;;;;;;;;;AA2BT,mCACE;UACG;AAEC,uBAAa;AAEjB,cAAW,oBAAa;AACtB,kCAAc;;AAGhB,WAAO;AAVT;;;;;;;;;;;;AA0BA,oCAAyD;AACvD,WAAO;AADT;;;;;;AAWA,uCACE,MACA;AAEA,QAAY,KAAK,SAAU,MAAM;WAC3B,SAAU;AACZ,mBAAO;;;AAIX;AAVF;;;;;;;;;;;;;;;;;AA+BA,mCACE;UACG;AAEG,uBAAa;AAEnB,cAAW,sBAAe;eAClB,CAAC,aAAc,eAAyB;AAC5C,mBAAO;;;AAIX,WAAO;AAZT;;;;;AAqBA,uCAA4D;AAC1D,WAAO,QAAS;AADlB;;;;AASA,wCACE;AAEA,WAEE,yBAAQ,aAAa,4BAErB,yBAAQ,aAAa;AAPzB;;;;;;;;;;;;;;;;AA4BA,sCACE;UACG;AAEC,uBAAa;AAEjB,cAAW,uBAAgB;AACzB,kCAAc,CAAC;;AAGjB,WAAO;AAVT","file":"flag.lua","sourceRoot":"../src/"}

package/dist/functions/flying.js

@@ -0,0 +1,88 @@
+import { CacheFlag, CollectibleType, NullItemID, PlayerType, TrinketType, } from "isaac-typescript-definitions";
+import { getCollectiblesForCacheFlag } from "./collectibleCacheFlag";
+import { copySet, deleteSetsFromSet } from "./set";
+const FLYING_CHARACTERS = new Set([
+    PlayerType.AZAZEL,
+    PlayerType.THE_LOST,
+    PlayerType.THE_SOUL,
+    PlayerType.THE_LOST_B,
+    PlayerType.JACOB_2_B,
+    PlayerType.THE_SOUL_B, // 40
+]);
+const FLYING_TRINKETS = new Set([
+    TrinketType.BAT_WING,
+    TrinketType.AZAZELS_STUMP, // 162
+]);
+const FLYING_NULL_ITEMS = [
+    NullItemID.REVERSE_SUN,
+    NullItemID.SPIRIT_SHACKLES_SOUL,
+    NullItemID.LOST_CURSE, // 112
+];
+const CONDITIONAL_FLYING_COLLECTIBLE_TYPES = [
+    CollectibleType.BIBLE,
+    CollectibleType.EMPTY_VESSEL,
+    CollectibleType.ASTRAL_PROJECTION,
+    CollectibleType.RECALL,
+];
+/**
+ * Returns a set of all of the collectibles that grant flight. This is derived from collectibles
+ * that have `CacheFlag.FLYING` set in the "items.xml" file.
+ *
+ * Collectibles that only grant flight conditionally are manually pruned. Collectibles such as Empty
+ * Vessel should be checked for via the `hasFlyingTemporaryEffect` function.
+ *
+ * @param pruneConditionalItems Whether or not collectibles that only grant flight conditionally
+ *                              should be included in the set (like Empty Vessel).
+ */
+export function getFlyingCollectibles(pruneConditionalItems) {
+    // Instead of manually compiling a list of collectibles that grant flying, we can instead
+    // dynamically look for collectibles that have `CacheFlag.FLYING`.
+    const collectiblesWithFlyingCacheFlag = getCollectiblesForCacheFlag(CacheFlag.FLYING);
+    // None of the collectibles with a cache of "all" grant flying, so we can safely remove them from
+    // the list.
+    const collectiblesWithAllCacheFlag = getCollectiblesForCacheFlag(CacheFlag.ALL);
+    deleteSetsFromSet(collectiblesWithFlyingCacheFlag, collectiblesWithAllCacheFlag);
+    if (pruneConditionalItems) {
+        for (const collectibleType of CONDITIONAL_FLYING_COLLECTIBLE_TYPES) {
+            collectiblesWithFlyingCacheFlag.delete(collectibleType);
+        }
+    }
+    return collectiblesWithFlyingCacheFlag;
+}
+/**
+ * Returns a set of all of the trinkets that grant flight. (All trinkets that grant flight do so
+ * conditionally, like Bat Wing.)
+ */
+export function getFlyingTrinkets() {
+    // We use a different algorithm than the "getFlyingCollectibles" function because Azazel's Stump
+    // has a cache of "all".
+    return copySet(FLYING_TRINKETS);
+}
+export function hasFlyingTemporaryEffect(player) {
+    const effects = player.GetEffects();
+    // - Hanged Man card gives a Transcendence temporary effect.
+    // - Pinking Shears gives a Transcendence temporary effect.
+    const flyingCollectibles = getFlyingCollectibles(false);
+    for (const collectibleType of flyingCollectibles.values()) {
+        if (effects.HasCollectibleEffect(collectibleType)) {
+            return true;
+        }
+    }
+    const flyingTrinkets = getFlyingTrinkets();
+    for (const trinketType of flyingTrinkets.values()) {
+        if (effects.HasTrinketEffect(trinketType)) {
+            return true;
+        }
+    }
+    for (const nullItemID of FLYING_NULL_ITEMS) {
+        if (effects.HasNullEffect(nullItemID)) {
+            return true;
+        }
+    }
+    return false;
+}
+export function isFlyingCharacter(player) {
+    const character = player.GetPlayerType();
+    return FLYING_CHARACTERS.has(character);
+}
+//# sourceMappingURL=flying.js.map

package/dist/functions/flying.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flying.js","sourceRoot":"../src/","sources":["functions/flying.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,eAAe,EACf,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEnD,MAAM,iBAAiB,GAA4B,IAAI,GAAG,CAAC;IACzD,UAAU,CAAC,MAAM;IACjB,UAAU,CAAC,QAAQ;IACnB,UAAU,CAAC,QAAQ;IACnB,UAAU,CAAC,UAAU;IACrB,UAAU,CAAC,SAAS;IACpB,UAAU,CAAC,UAAU,EAAE,KAAK;CAC7B,CAAC,CAAC;AAEH,MAAM,eAAe,GAA6B,IAAI,GAAG,CAAC;IACxD,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,aAAa,EAAE,MAAM;CAClC,CAAC,CAAC;AAEH,MAAM,iBAAiB,GAA0B;IAC/C,UAAU,CAAC,WAAW;IACtB,UAAU,CAAC,oBAAoB;IAC/B,UAAU,CAAC,UAAU,EAAE,MAAM;CAC9B,CAAC;AAEF,MAAM,oCAAoC,GAA+B;IACvE,eAAe,CAAC,KAAK;IACrB,eAAe,CAAC,YAAY;IAC5B,eAAe,CAAC,iBAAiB;IACjC,eAAe,CAAC,MAAM;CACvB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB,CACnC,qBAA8B;IAE9B,yFAAyF;IACzF,kEAAkE;IAClE,MAAM,+BAA+B,GAAG,2BAA2B,CACjE,SAAS,CAAC,MAAM,CACjB,CAAC;IAEF,iGAAiG;IACjG,YAAY;IACZ,MAAM,4BAA4B,GAAG,2BAA2B,CAC9D,SAAS,CAAC,GAAG,CACd,CAAC;IACF,iBAAiB,CACf,+BAA+B,EAC/B,4BAA4B,CAC7B,CAAC;IAEF,IAAI,qBAAqB,EAAE;QACzB,KAAK,MAAM,eAAe,IAAI,oCAAoC,EAAE;YAClE,+BAA+B,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;SACzD;KACF;IAED,OAAO,+BAA+B,CAAC;AACzC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB;IAC/B,gGAAgG;IAChG,wBAAwB;IACxB,OAAO,OAAO,CAAC,eAAe,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAAoB;IAC3D,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAEpC,4DAA4D;IAC5D,2DAA2D;IAC3D,MAAM,kBAAkB,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;IACxD,KAAK,MAAM,eAAe,IAAI,kBAAkB,CAAC,MAAM,EAAE,EAAE;QACzD,IAAI,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE;YACjD,OAAO,IAAI,CAAC;SACb;KACF;IAED,MAAM,cAAc,GAAG,iBAAiB,EAAE,CAAC;IAC3C,KAAK,MAAM,WAAW,IAAI,cAAc,CAAC,MAAM,EAAE,EAAE;QACjD,IAAI,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC;SACb;KACF;IAED,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE;QAC1C,IAAI,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;YACrC,OAAO,IAAI,CAAC;SACb;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAoB;IACpD,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IACzC,OAAO,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAC1C,CAAC"}

package/dist/functions/flying.lua.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../packages/isaacscript-common/src/functions/flying.ts"],"names":[],"mappings":";;;;;AAAA,6CAMO;AALL;AACA;AACA;AACA;AACA;AAEF,iCAA4C;AAAnC;AACT,gBAA2C;AAAlC;AAAS;AAEZ,0BAA6C,UAAI,KAAI;IACzD;IACA;IACA;IACA;IACA;IACA;;AAGI,wBAA4C,UAAI,KAAI,CACxD,sBACA;AAGI,0BAA2C,CAC/C,wBACA,iCACA;AAGI,6CAAmE,CACvE,uBACA,8BACA,mCACA;;;;;;;;;AAaF,iDACE;AAIM,4CAAkC,iCACtC;AAKI,yCAA+B,iCACnC;IAEF,uBACE,iCACA;OAGE;AACF,kBAAW,0BAAmB;YAC5B,gCAAgC,OAAO;;;AAI3C,WAAO;AAzBT;;;AAgCA;AAGE,WAAO,aAAQ;AAHjB;AAMA,oDAAyC;AACjC,oBAAU,OAAO;AAIjB,+BAAqB,uCAAsB;AACjD,cAAW,mBAAmB,kCAAmB;WAC3C,QAAQ,qBAAqB;AAC/B,mBAAO;;;AAIL,2BAAiB;AACvB,cAAW,eAAe,8BAAe;WACnC,QAAQ,iBAAiB;AAC3B,mBAAO;;;AAIX,cAAW,qBAAc;WACnB,QAAQ,cAAc;AACxB,mBAAO;;;AAIX,WAAO;AAzBT;AA4BA,6CAAkC;AAC1B,sBAAY,OAAO;AACzB,WAAO,kBAAkB,IAAI;AAF/B","file":"flying.lua","sourceRoot":"../src/"}