Constants

Variables

ALL_DISPLAY_FLAGS

const ALL_DISPLAY_FLAGS: BitFlags<DisplayFlagValue>

Defined in: packages/isaacscript-common/src/core/constants.ts:28

The combination of the following flags:

DisplayFlag.VISIBLE (1 << 0)
DisplayFlag.SHADOW (1 << 1)
DisplayFlag.SHOW_ICON (1 << 2)

AZAZEL_DEFAULT_BRIMSTONE_DISTANCE

const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE: 75.125 = 75.125

Defined in: packages/isaacscript-common/src/core/constants.ts:38

The distance of the laser when Azazel does not have any range up items yet. For more info, see the documentation for the getAzazelBrimstoneDistance function.

BLIND_ITEM_PNG_PATH

const BLIND_ITEM_PNG_PATH: "gfx/items/collectibles/questionmark.png" = "gfx/items/collectibles/questionmark.png"

Defined in: packages/isaacscript-common/src/core/constants.ts:44

The path to the PNG file for collectible items during Curse of the Blind, making them appear with a red question mark.

BOMB_EXPLODE_FRAME

const BOMB_EXPLODE_FRAME: 45 = 45

Defined in: packages/isaacscript-common/src/core/constants.ts:47

Bombs explode when their frame count is equal to this value.

CHEST_PICKUP_VARIANTS

const CHEST_PICKUP_VARIANTS: readonly [CHEST, BOMB_CHEST, SPIKED_CHEST, ETERNAL_CHEST, MIMIC_CHEST, OLD_CHEST, WOODEN_CHEST, MEGA_CHEST, HAUNTED_CHEST, LOCKED_CHEST, RED_CHEST, MOMS_CHEST]

Defined in: packages/isaacscript-common/src/core/constants.ts:49

CHEST_PICKUP_VARIANTS_SET

const CHEST_PICKUP_VARIANTS_SET: ReadonlySet<PickupVariant>

Defined in: packages/isaacscript-common/src/core/constants.ts:64

COLLECTIBLE_INITIAL_WAIT

const COLLECTIBLE_INITIAL_WAIT: 20 = 20

Defined in: packages/isaacscript-common/src/core/constants.ts:69

This is the initial value of the EntityPickup.Wait field after a collectible is spawned.

DEFAULT_ITEM_POOL_TYPE

const DEFAULT_ITEM_POOL_TYPE: TREASURE = ItemPoolType.TREASURE

Defined in: packages/isaacscript-common/src/core/constants.ts:71

DISTANCE_OF_GRID_TILE

const DISTANCE_OF_GRID_TILE: 40 = 40

Defined in: packages/isaacscript-common/src/core/constants.ts:74

This is also the distance that a player spawns from the door that they enter a room from.

DOGMA_ROOM_GRID_INDEX

const DOGMA_ROOM_GRID_INDEX: 109 = 109

Defined in: packages/isaacscript-common/src/core/constants.ts:76

DOOR_HITBOX_RADIUS

const DOOR_HITBOX_RADIUS: 11 = 11

Defined in: packages/isaacscript-common/src/core/constants.ts:78

EGGY_STATE_FRAME_OF_FINAL_SPIDER

const EGGY_STATE_FRAME_OF_FINAL_SPIDER: 45 = 45

Defined in: packages/isaacscript-common/src/core/constants.ts:85

When Eggies take fatal damage, they go into NPCState.STATE_SUICIDE and spawn 14 Swarm Spiders while their StateFrame ticks upwards. The 14th spider appears when the StateFrame is at this value.

EMPTY_PNG_PATH

const EMPTY_PNG_PATH: "gfx/none.png" = "gfx/none.png"

Defined in: packages/isaacscript-common/src/core/constants.ts:91

A non-existent or completely transparent PNG file for use in clearing sprites. For more information, see the documentation for the clearSprite helper function.

FIRST_GLITCHED_COLLECTIBLE_TYPE

const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType

Defined in: packages/isaacscript-common/src/core/constants.ts:101

The random items that appear when the player has TMTRAINER are generated on the fly as they are encountered by the player. The first TMTRAINER item takes the final possible 32 bit number. The second TMTRAINER item subtracts one from that, and so on.

This is equal to 4294967295.

FLYING_CHARACTERS

const FLYING_CHARACTERS: readonly [AZAZEL, LOST, SOUL, LOST_B, JACOB_2_B, SOUL_B]

Defined in: packages/isaacscript-common/src/core/constants.ts:106

An array containing every flying character. This includes non-main characters such as The Soul.

GAME_FRAMES_PER_SECOND

const GAME_FRAMES_PER_SECOND: 30 = 30

Defined in: packages/isaacscript-common/src/core/constants.ts:116

Game frames are what is returned by the Game.GetFrameCount method.

GAME_FRAMES_PER_MINUTE

const GAME_FRAMES_PER_MINUTE: number

Defined in: packages/isaacscript-common/src/core/constants.ts:119

Game frames are what is returned by the Game.GetFrameCount method.

MAIN_CHARACTERS

const MAIN_CHARACTERS: readonly [ISAAC, MAGDALENE, CAIN, JUDAS, BLUE_BABY, EVE, SAMSON, AZAZEL, LAZARUS, EDEN, LOST, LILITH, KEEPER, APOLLYON, FORGOTTEN, BETHANY, JACOB, ISAAC_B, MAGDALENE_B, CAIN_B, JUDAS_B, BLUE_BABY_B, EVE_B, SAMSON_B, AZAZEL_B, LAZARUS_B, EDEN_B, LOST_B, LILITH_B, KEEPER_B, APOLLYON_B, FORGOTTEN_B, BETHANY_B, JACOB_B]

Defined in: packages/isaacscript-common/src/core/constants.ts:125

An array containing every character that is selectable from the main menu (and has achievements related to completing the various bosses and so on).

RENDER_FRAMES_PER_SECOND

const RENDER_FRAMES_PER_SECOND: 60 = 60

Defined in: packages/isaacscript-common/src/core/constants.ts:163

Render frames are what is returned by the Isaac.GetFrameCount method.

RENDER_FRAMES_PER_MINUTE

const RENDER_FRAMES_PER_MINUTE: number

Defined in: packages/isaacscript-common/src/core/constants.ts:166

Render frames are what is returned by the Isaac.GetFrameCount method.

GRID_INDEX_CENTER_OF_1X1_ROOM

const GRID_INDEX_CENTER_OF_1X1_ROOM: 67 = 67

Defined in: packages/isaacscript-common/src/core/constants.ts:168

LEVEL_GRID_COLUMN_HEIGHT

const LEVEL_GRID_COLUMN_HEIGHT: 13 = 13

Defined in: packages/isaacscript-common/src/core/constants.ts:174

The floor is represented by a 13x13 grid. Room indexes start at 0. The first column is represented by grid indexes 0, 13, 26, and so on.

LEVEL_GRID_ROW_WIDTH

const LEVEL_GRID_ROW_WIDTH: 13 = 13

Defined in: packages/isaacscript-common/src/core/constants.ts:181

The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so on.

MAPPING_COLLECTIBLES

const MAPPING_COLLECTIBLES: readonly [COMPASS, TREASURE_MAP, SPELUNKER_HAT, CRYSTAL_BALL, BLUE_MAP, BOOK_OF_SECRETS, MIND, SOL, LUNA, CRACKED_ORB]

Defined in: packages/isaacscript-common/src/core/constants.ts:194

All of the collectibles that grant vision on the map.

Note that:

Spelunker Hat is included. Historically, Spelunker Hat was not considered to be mapping, but it was buffed in Repentance to show rooms two or more away.
Book of Secrets is included, which is an “active mapping” instead of passive.
Luna is included, even though it is not a very powerful mapping item.
Cracked Orb is included, even though it requires the player to be damaged in order for it to be activated.

MAX_LEVEL_GRID_INDEX

const MAX_LEVEL_GRID_INDEX: 168 = 168

Defined in: packages/isaacscript-common/src/core/constants.ts:212

The floor is represented by a 13x13 grid. Room indexes start at 0. The first row is represented by grid indexes from 0 to 12. The second row is represented by grid indexes from 13 to 25, and so on. The maximum room index possible is 168. (It is not 169 because we start at 0 instead of 1.)

MAX_NUM_FAMILIARS

const MAX_NUM_FAMILIARS: 64 = 64

Defined in: packages/isaacscript-common/src/core/constants.ts:219

The game has a limit on the number of currently spawned familiars and will refuse to spawn any more if it reaches the limit. Blue flies and blue spiders have a lower priority and will be deleted to make room for other familiars.

MAX_NUM_INPUTS

const MAX_NUM_INPUTS: 4 = 4

Defined in: packages/isaacscript-common/src/core/constants.ts:222

The game can only handle up to four different players.

MAX_PLAYER_HEART_CONTAINERS

const MAX_PLAYER_HEART_CONTAINERS: 18 = 18

Defined in: packages/isaacscript-common/src/core/constants.ts:225

With Birthright, it is possible for Magdalene to have 18 heart containers.

MAX_PLAYER_SPEED_IN_UNITS

const MAX_PLAYER_SPEED_IN_UNITS: 9.8 = 9.8

Defined in: packages/isaacscript-common/src/core/constants.ts:233

As the player continues to move in a direction, they will accelerate. When going from one wall to another in a 2x2 room at 2.0 speed (the maximum that the speed stat can rise to), the amount of units moved per update frame will climb to around 9.797 as they hit the opposite wall. The constant specifies a value of 9.8 to be safe.

MAX_PLAYER_TRINKET_SLOTS

const MAX_PLAYER_TRINKET_SLOTS: int

Defined in: packages/isaacscript-common/src/core/constants.ts:235

MIN_PLAYER_SHOT_SPEED_STAT

const MIN_PLAYER_SHOT_SPEED_STAT: 0.6 = 0.6

Defined in: packages/isaacscript-common/src/core/constants.ts:238

If you set EntityPlayer.ShotSpeed lower than this value, it will have no effect.

MIN_PLAYER_SPEED_STAT

const MIN_PLAYER_SPEED_STAT: 0.1 = 0.1

Defined in: packages/isaacscript-common/src/core/constants.ts:241

If you set EntityPlayer.Speed lower than this value, it will have no effect.

MAX_SPEED_STAT

const MAX_SPEED_STAT: 2 = 2

Defined in: packages/isaacscript-common/src/core/constants.ts:247

The maximum speed stat that a player can have. Any additional speed beyond this will not take effect.

NEW_FLOOR_STARTING_POSITION_NORMAL_MODE

const NEW_FLOOR_STARTING_POSITION_NORMAL_MODE: Readonly<Vector>

Defined in: packages/isaacscript-common/src/core/constants.ts:250

This is in the center of the room.

NEW_FLOOR_STARTING_POSITION_GREED_MODE

const NEW_FLOOR_STARTING_POSITION_GREED_MODE: Readonly<Vector>

Defined in: packages/isaacscript-common/src/core/constants.ts:256

This is near the top door.

NEW_RUN_PLAYER_STARTING_POSITION

const NEW_RUN_PLAYER_STARTING_POSITION: Readonly<Vector>

Defined in: packages/isaacscript-common/src/core/constants.ts:265

This is next to the bottom door. Presumably, the player does not start in the center of the room (like they do when getting to a new stage) so that the controls graphic is more visible.

MAX_TAINTED_SAMSON_BERSERK_CHARGE

const MAX_TAINTED_SAMSON_BERSERK_CHARGE: 100000 = 100_000

Defined in: packages/isaacscript-common/src/core/constants.ts:268

Corresponds to the maximum value for EntityPlayer.SamsonBerserkCharge.

NUM_DIMENSIONS

const NUM_DIMENSIONS: number

Defined in: packages/isaacscript-common/src/core/constants.ts:274

The number of dimensions, not including Dimension.CURRENT. (This is derived from the Dimension enum.)

DIMENSIONS

const DIMENSIONS: readonly Dimension[]

Defined in: packages/isaacscript-common/src/core/constants.ts:282

An array containing every valid Dimension, not including Dimension.CURRENT. (This is derived from the NUM_DIMENSIONS constant.)

We cannot use the values of the Dimension enum because it includes -1.

NUM_PILL_COLORS_IN_POOL

const NUM_PILL_COLORS_IN_POOL: number = NUM_NORMAL_PILL_COLORS

Defined in: packages/isaacscript-common/src/core/constants.ts:290

The pill pool for each run is comprised of one effect for each unique pill color (minus gold and horse pills.)

ONE_BY_ONE_ROOM_GRID_SIZE

const ONE_BY_ONE_ROOM_GRID_SIZE: 135 = 135

Defined in: packages/isaacscript-common/src/core/constants.ts:292

QUALITIES

const QUALITIES: readonly Quality[]

Defined in: packages/isaacscript-common/src/core/constants.ts:299

An array representing every valid collectible type quality. Specifically, this is: [0, 1, 2, 3, 4]

MAX_QUALITY

const MAX_QUALITY: Quality = 4

Defined in: packages/isaacscript-common/src/core/constants.ts:300

SECOND_IN_MILLISECONDS

const SECOND_IN_MILLISECONDS: 1000 = 1000

Defined in: packages/isaacscript-common/src/core/constants.ts:302

MINUTE_IN_MILLISECONDS

const MINUTE_IN_MILLISECONDS: number

Defined in: packages/isaacscript-common/src/core/constants.ts:303

RESOLUTION_FULL_SCREEN

const RESOLUTION_FULL_SCREEN: Vector

Defined in: packages/isaacscript-common/src/core/constants.ts:306

This is equivalent to the bottom-right screen position when the game is in full screen mode.

RESOLUTION_1600_900

const RESOLUTION_1600_900: Vector

Defined in: packages/isaacscript-common/src/core/constants.ts:312

This is equivalent to the bottom-right screen position when the game is in windowed mode in a 1600x900 resolution.

STARTING_ROOM_GRID_INDEX

const STARTING_ROOM_GRID_INDEX: 84 = 84

Defined in: packages/isaacscript-common/src/core/constants.ts:318

The starting room of the floor is always at the same grid index, which is in the middle of the 13x13 grid.

TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE

const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE: 10000 = 10_000

Defined in: packages/isaacscript-common/src/core/constants.ts:321

After taking damage, EntityPlayer.SamsonBerserkCharge is incremented by this amount.

TELEPORTER_ACTIVATION_DISTANCE

const TELEPORTER_ACTIVATION_DISTANCE: number

Defined in: packages/isaacscript-common/src/core/constants.ts:324

For GridEntityType.TELEPORTER (23).

TIME_GAME_OPENED

const TIME_GAME_OPENED: int

Defined in: packages/isaacscript-common/src/core/constants.ts:327

In milliseconds, as reported by the Isaac.GetTime method.

UI_HEART_WIDTH

const UI_HEART_WIDTH: 12 = 12

Defined in: packages/isaacscript-common/src/core/constants.ts:333

This is the number of draw coordinates that each heart spans on the UI in the upper left hand corner.

VectorOne

const VectorOne: Readonly<Vector>

Defined in: packages/isaacscript-common/src/core/constants.ts:341

Equal to Vector(1, 1).

This is a safe version of the Vector.One constant. (Other mods can mutate Vector.One, so it is not safe to use.)

VectorZero

const VectorZero: Readonly<Vector>

Defined in: packages/isaacscript-common/src/core/constants.ts:349

Equal to Vector(0, 0).

This is a safe version of the Vector.Zero constant. (Other mods can mutate Vector.Zero, so it is not safe to use.)

ColorDefault

const ColorDefault: Readonly<Color>

Defined in: packages/isaacscript-common/src/core/constants.ts:359

Equal to Color(1, 1, 1).

This is a safe version of the Color.Default constant. (Other mods can mutate Color.Default, so it is not safe to use.)

If you need to mutate this, make a copy first with the copyColor helper function.

KColorDefault

const KColorDefault: Readonly<KColor>

Defined in: packages/isaacscript-common/src/core/constants.ts:366

Equal to KColor(1, 1, 1, 1).

If you need to mutate this, make a copy first with the copyKColor helper function.