Skip to main content

Gotchas

This page lists several "gotchas" or things that might be weird about IsaacScript.


Local Enums and Importing​

In the Isaac Lua environment, several enums are declared as global variables. In typical Lua code, you would just use them directly, like the following:

-- Lua code
local player = Isaac.GetPlayer()
player:AddCollectible(CollectibleType.COLLECTIBLE_SAD_ONION) -- The "CollectibleType" enum is a global.

However, relying on global variables is dangerous, as other mods can change the contents of the enums. (We have observed this happening in the past from time to time.) Thus, as an extra safety feature, IsaacScript includes a local copy of every enum for your personal use.

Additionally, since we don't have to rely on using the official enums, the local version of the IsaacScript enums can fix all of the spelling errors and inconsistencies that have gone unfixed in the official game. We can also remove all of the "fake" enum values that pollute the enum and destroy the type safety, like CollectibleType.NUM_COLLECTIBLES. Furthermore, as a big quality of life improvement, we also remove the prefix from every enum to make them easy to type. (For example, CollectibleType.COLLECTIBLE_SAD_ONION is changed to CollectibleType.SAD_ONION.)

Since enums are no longer global variables, you must import them in your code whenever you need to use them. For example, to write the Lua code snippet above in TypeScript:

// TypeScript code
import { CollectibleType } from "isaac-typescript-definitions";

const player = Isaac.GetPlayer();
player.AddCollectible(CollectibleType.SAD_ONION);

However, don't ever type the imports manually, because that's a big waste of time! If you tab-complete the name of an enum, VSCode should automatically import it for you. If you already have an enum that is written out, then you can auto-import it by putting the text cursor on the right-side of the enum and typing Ctrl + space + enter.


Bit Flags​

First, familiarize yourself with what bit flags are, if you haven't already.

Several things in Isaac use bit flags, such as tears and projectiles.

In IsaacScript, working with bit flags is different than it is in Lua. We have the benefit of bit flags being completely type safe - it is impossible to represent an invalid combination.

For example, the following is possible in Lua:

-- Lua code
-- Combine 3 tear flags together and assign it to the player.
player.TearFlags = TearFlag.TEAR_PIERCING | TearFlag.TEAR_SPECTRAL | 5

This is not a valid combination of bit flags, because 5 is not a tear flag. Thus, this code would have undefined behavior (and potentially crash the game).

In IsaacScript, assigning some arbitrary number to the player.TearFlags field would cause a compiler error.

In order to get type safety, all enums that are bit flags are extended from the BitFlag type. And a collection of 0 or more bit flags is represented by the BitFlags type. BitFlags takes a generic type parameter, so you can have BitFlags<TearFlag>, BitFlags<ProjectileFlag>, and so on.

To compose BitFlags yourself, you can use the addFlag and removeFlag helper functions, like so:

// TypeScript code
// Combine 3 tear flags together and assign it to the player.
player.TearFlags = addFlag(
  TearFlag.PIERCING,
  TearFlag.SPECTRAL,
  TearFlag.FREEZE,
);
// (The "addFlag" function is variadic.)

If you want to assign a specific flag to a BitFlags field, then simply assigning it won't work:

// TypeScript code
player.TearFlags = TearFlag.PIERCING; // Error

Doing this would give the following error:

Type 'TearFlagValue' is not assignable to type 'BitFlags<TearFlagValue>'.
Property '__bitFlagsBrand' is missing in type 'TearFlagValue' but required in type '{ readonly __bitFlagsBrand: TearFlagValue; }'.

This error is because TearFlag is not exactly the same thing as BitFlags<TearFlag>. (The former must be equal to one specific flag, and the latter can be 0 or more flags.)

To solve this problem, you can use the bitFlags helper function, which will convert the flag for you:

// TypeScript code
player.TearFlags = bitFlags(TearFlag.PIERCING);

Finally, note that you can also use the hasFlag helper function to check for the presence of a flag:

// TypeScript code
if (hasFlag(player.TearFlags, TearFlag.PIERCING)) {
  // Handle the piercing synergy.
  // Insert code here.
}

int and float​

In Lua, there is only one type of number. (The programming language does not differentiate between integers, floats, etc.)

TypeScript works the same way as Lua. There is only one type of number: number.

However, the official Isaac API documentation uses integers and floats. For example, this is the entry for the EntityPlayer.AddHearts function:

void AddHearts(int hearts)

In order to more closely match the API, the TypeScript API definitions use int and float types. Thus, the above function is declared like this:

AddHearts(hearts: int): void;

If you want, you can use the int and float types in your own code too (instead of just using number, like you would in other typical TypeScript code). But if you do use int and float, be aware that they are simply aliases for number, so they don't provide any actual type safety.

In other words, it is possible to do this, so beware:

// Give the player a Sad Onion.
player.AddCollectible(CollectibleType.COLLECTIBLE_SAD_ONION, 0, false);

// Find out how many Sad Onions they have.
let numSadOnions = player.GetCollectibleNum(
  CollectibleType.COLLECTIBLE_SAD_ONION,
);
// numSadOnions is now an "int" with a value of "1".

numSadOnions += 0.5;
// numSadOnions is still an "int", but now it has a value of "1.5".
// This is a bug and TypeScript won't catch this for you!

Extending Enums --> Custom Enums (Part 1)​

In your Lua mods, you may have extended the game's built-in enums. For example:

-- At the top of the mod:
CollectibleType.COLLECTIBLE_MY_CUSTOM_ITEM = Isaac.GetItemIdByName("My Custom Item")

-- Elsewhere in the code:
if (
  player:HasCollectible(CollectibleType.COLLECTIBLE_MY_CUSTOM_ITEM)
  and player:HasCollectible(CollectibleType.COLLECTIBLE_EPIC_FETUS)
) then
  -- Handle the specific synergy with My Custom Item + Epic Fetus.
end

In TypeScript, you cannot extend existing enums, because enums are immutable. (This is a good thing; it's how enums work in all sane programming languages.) Instead, create your own enum:

// At the top of the mod:
const CollectibleTypeCustom = {
  MY_CUSTOM_ITEM: Isaac.GetItemIdByName("My Custom Item"),
} as const;

// It's good practice to always validate enums with this helper function in order to prevent
// crashes.
validateCustomEnum("CollectibleTypeCustom", CollectibleTypeCustom);

// Elsewhere in the code:
if (
  player.HasCollectible(CollectibleTypeCustom.MY_CUSTOM_ITEM) &&
  player.HasCollectible(CollectibleType.EPIC_FETUS)
) {
  // Handle the specific synergy with My Custom Item + Epic Fetus.
}

As a side note, you might be wondering why the above code uses const CollectibleTypeCustom instead of enum CollectibleTypeCustom. The basic explanation is that we want the types of the values to be CollectibleType, so that we can use them later on in the API. For a more in-depth explanation, see the page on the differences between enums and objects.

Extending Enums --> Custom Enums (Part 2)​

In the previous section, we used an object to emulate an enum. Because the return value of the Isaac.GetItemIdByName method is equal to CollectibleType, the properties of CollectibleTypeCustom are of type CollectibleType. Thus, we can automatically use the values of CollectibleTypeCustom in any spot where we would normally be able to use CollectibleType. Nice!

However, this pattern won't work for all kinds of custom enums. For example, let's consider the case of making a mod with a custom effect. In this case, we would want to make a EffectVariantCustom that "extends" from EffectVariant:

const EffectVariantCustom = {
  MY_CUSTOM_EFFECT: Isaac.GetEntityVariantByName("My Custom Effect"),
} as const;

This is not like the previous example. Here, the value of EffectVariantCustom.MY_CUSTOM_EFFECT is equal to int instead of EffectVariant. This is because the return type of the Isaac.GetEntityVariantByName method is int. This should kind of make sense, because at compile-time, the method has no idea what type of entity name corresponds with what type of entity variant.

However, fixing this problem is easy. We just have to manually specify what the variant is using a type assertion, like this:

const EffectVariantCustom = {
  MY_CUSTOM_EFFECT: Isaac.GetEntityVariantByName(
    "My Custom Effect",
  ) as EntityEffect,
} as const;

Now, EffectVariantCustom can be used in any place that EffectVariant can.


Vector Operators​

In Isaac modding, working with Vectors is common. For example, you might want to double the speed of an enemy projectile. Doing this in Lua is simple:

-- Lua code
-- Double the speed of the projectile.
projectile.Velocity = projectile.Velocity * 2

This code is the actually the same as writing:

-- Lua code
-- Double the speed of the projectile.
projectile.Velocity = projectile.Velocity:__mul(2)

Under the hood, Lua converts the first code snippet to the second code snippet automatically. This is because it understands that __mul is a special operator method. Most people write code in the first way instead of the second way, because it is more convenient.

In TypeScript, we unfortunately cannot code in the first way due to limitations in TypeScriptToLua. Since operator overloads will not work, we instead call the convenience methods add, sub, mul, and div.

Here's an example:

-- Lua code
local vector = Vector(1, 1) * 5 + 2
// TypeScript code
const vector = Vector(1, 1).mul(5).add(2);

If you are converting Lua code, make sure to account for order of operations:

-- Lua code
local vector = Vector(1, 1) + Vector(3, 3) * 6
-- (multiplication happens before addition)
// TypeScript code
let vector = Vector(3, 3).mul(6).add(Vector(1, 1);

Note that if you really need to, you can restore operator overloading for Vectors by creating a branded type with something along the lines of:

type Vector = number & { readonly __vectorBrand: symbol };

But this is not recommended because vectors will not be type-safe anymore.


Using JSON​

Isaac mods are allowed to write save data to the "save1.dat", "save2.dat", and "save3.dat" files (for save slot 1, save slot 2, and save slot 3, respectively). This is accomplished via the Isaac.SaveModData() function.

Any non-trivial mod will need to save many different variables. Since the Isaac.SaveModData() function takes a string instead of a Lua table, it is standard practice to convert a Lua table to a string using JSON.

Handily, Lua functions to accomplish this are provided with the game in the C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac Rebirth\resources\scripts\json.lua file. All you have to do is require the file:

-- Lua code
local json = require("json")

-- Register the mod.
local Revelations = RegisterMod("Revelations", 1)

-- Define default values for the save data.
local RevelationsSaveData = {
  currentHP = 3,
  currentNumFamiliars = 4,
  currentCharge = 10,
}

local function saveModData()
  local encodedData = json.encode(RevelationsSaveData)
  Isaac.SaveModData(Revelations, encodedData)
end

In TypeScript, we can directly call the Lua code in the same way. Note that IsaacScript automatically includes type definitions for the json.lua file, so you don't have to worry about that part.

// TypeScript code
import * as json from "json";

// Register the mod.
const Revelations = RegisterMod("Revelations", 1);

// Define default values for the save data.
const RevelationsSaveData = {
  currentHP: 3,
  currentNumFamiliars: 4,
  currentCharge: 10,
};

function saveModData() {
  const encodedData = json.encode(RevelationsSaveData);
  Isaac.SaveModData(Revelations, encodedData);
}

Iterating Over Enums​

Sometimes, you might want to iterate over an enum. For example, the following Lua code is a pretty good way to detect if the player is pressing any particular button on the keyboard:

-- Lua code
-- "Keyboard" is an enum provided by the game.
for keyName, keyCode in pairs(Keyboard) do
  if Input.IsButtonPressed(keyCode, 0) then
    print("Player pressed: " .. keyName)
  end
end

In TypeScript, we can use the getEnumEntries helper function:

// TypeScript code
// "Keyboard" is an enum provided by the game.
for (const [keyName, keyCode] of getEnumEntries(Keyboard)) {
  if (Input.IsButtonPressed(keyCode, 0)) {
    print(`Player pressed: ${keyName}`);
  }
}

You can also use the getEnumKeys and getEnumValues helper functions, depending on what you need to do.

If you stick with these helper functions, everything should work great. If you want to know more about what is happening under-the-hood, then read the next section.

Enum Reverse Mappings​

First, see the previous section on iterating over enums.

Normally, TypeScript transpiles enums to JavaScript with a double mapping of key to value and value to key. TypeScriptToLua also copies this behavior when transpiling TypeScript to Lua. For example:

enum TestEnum {
  ONE = 1,
  TWO = 2,
  THREE = 3,
}

Will transpile to:

local TestEnum = {}
TestEnum.ONE = 1
TestEnum[TestEnum.ONE] = "ONE"
TestEnum.TWO = 2
TestEnum[TestEnum.TWO] = "TWO"
TestEnum.THREE = 3
TestEnum[TestEnum.THREE] = "THREE"

This is a great feature, because you can get the key name of an enum value super easily:

const currentTestValue = TestEnum.TWO;
print(`currentTestValue = ${currentTestValue}: ${TestEnum[currentTestValue]}`);
// Prints "currentTestValue: 2 (TWO)"

However, this means that if you were to naively iterate over the enum with Object.entries or pairs, you have to use some type-checking:

for (const [key, value] of Object.entries(TestEnum)) {
  // Ignore the reverse mappings created by TypeScriptToLua.
  if (isNumber(value)) {
    print(`Key: ${key}`);
    print(`Value: ${value}`);
  }
}

This is exactly what the getEnumValues helper function does.

Finally, there are some other small things to mention:

  1. Reverse mappings are not created for string-based enums, so you only have to worry about this for number-based enums.

  2. All of the "flag" enums (e.g. EntityFlag, TearFlag, etc.) do not have a reverse mapping. This is because they are not "real" TypeScript enums, but are instead objects that are branded with a BitFlag type. If you want to get the key of a "fake" enum like this, use the getEnumKey helper function. (The compiler won't let you index these types of enums, so the problem should be obvious if you ever come across it.)

  3. The getEnumEntries (and related) helper functions will return the entries sorted by value. This may be surprising to you. For example:

enum MyEnum {
  ThirdValue = "third-value",
  FourthValue = "fourth-value",
}

for (const key of getEnumKeys(MyEnum)) {
  print(key); // Will print "fourth-value", then "third-value".
}

Instead, you might expect that the enum helper functions would return the entries in the order that they were defined in. However, it is impossible to determine declaration order at run-time. This is because under-the-hood, the pairs function is used to iterate over an enum table, and it will always return the results in a random order.

Since number enums are always declared in order of value, you would probably only ever observe this oddity with an enum that has string values.


npm Dependencies​

Unfortunately, you can't use JavaScript or TypeScript libraries from npm, since TypeScriptToLua does not support that. However, if you need a specific function, then you can simply copy paste it into your own code.

On the other hand, if you want to split IsaacScript code between repositories or share a library with others, TypeScriptToLua does allow using and creating npm packages containing .lua files. This is exactly what the isaacscript-common package does. Check out the TypeScriptToLua docs for more details.


Throwing Errors​

Normally, in TypeScript programs, you would handle errors with throw new Error("foo"). For example:

const player = entity.ToPlayer(); // The type of player is "EntityPlayer | undefined".
if (player === undefined) {
  throw new Error("Failed to convert the player!");
}
player.AddSoulHearts(1); // The type of player is now "EntityPlayer".

However, in Isaac mods, this code won't work. It will error with something along the lines of the following:

[Foo] Error in "foo" call: ...n\The Binding of Isaac Rebirth/mods/foo/main.lua:100: attempt to index a nil value (global 'debug')

This is because TypeScriptToLua transpiles throw to a function that uses Lua's debug library, and Isaac does not normally have access to debug for sandboxing reasons. But not to worry, because we can simply use Lua's error() function instead. For example:

const player = Isaac.ToPlayer(); // The type of player is "EntityPlayer | undefined".
if (player === undefined) {
  error("Failed to convert the player!");
}
player.AddSoulHearts(1); // The type of player is now "EntityPlayer".

(TypeScript is smart enough to know that error() can constrain the type of player in the same way that throw normally would.)


Circular Dependencies​

In some programming languages, circular dependencies are allowed. JavaScript and TypeScript are two of those languages. However, Lua is not. Thus, if you compile a program with circular dependencies, it may cause a stack overflow at run-time.

By default, IsaacScript projects ship with the import/no-cycle ESLint rule turned on, which should immediately alert you to this problem if it happens.

Programs with circular dependencies are generally considered to be spaghetti. If you have circular dependencies in your Isaac mod, it is a sign that you almost certainly need to rethink your architecture to something more sane.


Save Data Manager​

IsaacScript includes a save data manager that you will almost certainly want to use in your mods. Most of the time, you can use the save data manager without any hassle. However, there are some complicated cases where the saveDataManager function will throw a compiler error when trying to register your local variables. This section documents the special errors that it throws.

Functions are not serializable​

(This is a compiler error.)

This error means that you are trying to put a function on one of the fields in your local variables. Doing that doesn't make much sense, because functions cannot be written to the "save#.dat" file when the player saves and quits a run.

In most cases, if you are trying to save a function, you are probably doing something wrong and should refactor your mod to use serializable data structures.

If you absolutely have to work with functions, then you could move this field to a room sub-object, which is never saved to disk. Otherwise, you can pass false as the second argument to the saveDataManager function to prevent it from writing any part of the variables to disk.

Isaac API classes are not serializable​

(This is a compiler error.)

This error means that you are trying to put an Isaac API class (such as e.g. Entity or RoomConfig) on one of the fields in your local variables. Doing that doesn't make much sense, because these kinds of objects cannot be written to the "save#.dat" file when the player saves and quits a run. (Even if some of the properties were copied, there would be no way to recreate the object on the other end.)

In most cases, if you are trying to save an Isaac API class, then you are probably doing something wrong, and you should instead use some kind of index. (For example, see the getPlayerIndex and getPickupIndex helper functions.)

If you absolutely have to work with Isaac API classes, then you could move this field to a room sub-object, which is never saved to disk. Otherwise, you can pass false as the third argument to the saveDataManager function to prevent it from writing any part of the variables to disk.

Failed to deep copy a DefaultMap​

(This is a run-time error, so you will see it in the console or in the "log.txt" file.)

The DefaultMap class is not serializable when it has a factory function generating the default value and is also inside of an array, map, or set.

In other words, the map cannot be written to the "save#.dat" file when the player saves and quits a run. (This is because functions cannot be serialized, so there is no way for the deserializer to execute the corresponding factory function.)

To work around this problem, you could use a normal Map instead of a DefaultMap. This is probably the most straightforward way to fix the problem.

Additionally, a DefaultMap that is placed as a field of a normal run or level sub-object is serializable. Thus, you could refactor your data structure so that the DefaultMap is not nested inside of the array, map, or set.

If you want to give up entirely on saving the data, then you could move this field to a room sub-object, which is never saved to disk. Alternatively, you can pass false as the third argument to the saveDataManager function to prevent it from writing any part of the variables to disk.

Failed to deserialize a TSTL class​

(This is a run-time error, so you will see it in the console or in the "log.txt" file.)

Here, a TSTL class refers to a TypeScriptToLua class. In other words, when you use the TypeScript class keyword, under the hood TypeScriptToLua will convert that to a special kind of Lua table.

The error message means that the player started a new run or continued an old run, which caused the save data manager to read the "save#.dat" file, which caused it to try and deserialize all the data, and it found a class that it could not instantiate because it has no corresponding constructor.

In order to create a TSTL class, you use the corresponding constructor (e.g. new Foo()). Normally, when the save data manager copies a TSTL class, it uses the constructor from the old object. However, when a TSTL class is nested inside of an array, map, or set, there is no reference object to "get" the constructor from. Thus, it can't copy classes in this situation without knowing about the class beforehand.

If you want to use nested classes in this way, you can register them with the save data manager immediately after upgrading your mod with the saveDataManagerRegisterClass method:

class Foo {}
class Bar {}

const mod = upgradeMod(modVanilla, [ISCFeature.SAVE_DATA_MANAGER]);
mod.saveDataManagerRegisterClass(Foo, Bar);