Skip to main content

Constants (Miscellaneous)

Variables

ALL_DISPLAY_FLAGS

Const ALL_DISPLAY_FLAGS: BitFlags<DisplayFlagValue>

The combination of the following flags:

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

Defined in

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


AZAZEL_DEFAULT_BRIMSTONE_DISTANCE

Const AZAZEL_DEFAULT_BRIMSTONE_DISTANCE: 75.125

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.

Defined in

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


BLIND_ITEM_PNG_PATH

Const BLIND_ITEM_PNG_PATH: "gfx/items/collectibles/questionmark.png"

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

Defined in

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


BOMB_EXPLODE_FRAME

Const BOMB_EXPLODE_FRAME: 45

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

Defined in

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


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

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

Defined in

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


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

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

Defined in

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


DOGMA_ROOM_GRID_INDEX

Const DOGMA_ROOM_GRID_INDEX: 109

Defined in

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


DOOR_HITBOX_RADIUS

Const DOOR_HITBOX_RADIUS: 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

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.

Defined in

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


EMPTY_PNG_PATH

Const EMPTY_PNG_PATH: "gfx/none.png"

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

Defined in

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


FIRST_GLITCHED_COLLECTIBLE_TYPE

Const FIRST_GLITCHED_COLLECTIBLE_TYPE: CollectibleType

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.

Defined in

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


FLYING_CHARACTERS

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

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

Defined in

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


GAME_FRAMES_PER_SECOND

Const GAME_FRAMES_PER_SECOND: 30

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

Defined in

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


GAME_FRAMES_PER_MINUTE

Const GAME_FRAMES_PER_MINUTE: number

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

Defined in

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


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]

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

Defined in

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


RENDER_FRAMES_PER_SECOND

Const RENDER_FRAMES_PER_SECOND: 60

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

Defined in

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


RENDER_FRAMES_PER_MINUTE

Const RENDER_FRAMES_PER_MINUTE: number

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

Defined in

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


GRID_INDEX_CENTER_OF_1X1_ROOM

Const GRID_INDEX_CENTER_OF_1X1_ROOM: 67

Defined in

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


LEVEL_GRID_COLUMN_HEIGHT

Const LEVEL_GRID_COLUMN_HEIGHT: 13

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.

Defined in

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


LEVEL_GRID_ROW_WIDTH

Const LEVEL_GRID_ROW_WIDTH: 13

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.

Defined in

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


MAPPING_COLLECTIBLES

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

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.

Defined in

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


MAX_LEVEL_GRID_INDEX

Const MAX_LEVEL_GRID_INDEX: 168

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.)

Defined in

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


MAX_NUM_FAMILIARS

Const MAX_NUM_FAMILIARS: 64

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.

Defined in

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


MAX_NUM_INPUTS

Const MAX_NUM_INPUTS: 4

The game can only handle up to four different players.

Defined in

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


MAX_PLAYER_HEART_CONTAINERS

Const MAX_PLAYER_HEART_CONTAINERS: 18

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

Defined in

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


MAX_PLAYER_SPEED_IN_UNITS

Const MAX_PLAYER_SPEED_IN_UNITS: 9.8

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.

Defined in

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


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

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

Defined in

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


MIN_PLAYER_SPEED_STAT

Const MIN_PLAYER_SPEED_STAT: 0.1

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

Defined in

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


MAX_SPEED_STAT

Const MAX_SPEED_STAT: 2

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

Defined in

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


NEW_FLOOR_STARTING_POSITION_NORMAL_MODE

Const NEW_FLOOR_STARTING_POSITION_NORMAL_MODE: Readonly<Vector>

This is in the center of the room.

Defined in

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


NEW_FLOOR_STARTING_POSITION_GREED_MODE

Const NEW_FLOOR_STARTING_POSITION_GREED_MODE: Readonly<Vector>

This is near the top door.

Defined in

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


NEW_RUN_PLAYER_STARTING_POSITION

Const NEW_RUN_PLAYER_STARTING_POSITION: Readonly<Vector>

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.

Defined in

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


MAX_TAINTED_SAMSON_BERSERK_CHARGE

Const MAX_TAINTED_SAMSON_BERSERK_CHARGE: 100000

Corresponds to the maximum value for EntityPlayer.SamsonBerserkCharge.

Defined in

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


NUM_DIMENSIONS

Const NUM_DIMENSIONS: number

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

Defined in

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


DIMENSIONS

Const DIMENSIONS: readonly Dimension[]

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

Defined in

packages/isaacscript-common/src/core/constants.ts:280


NUM_PILL_COLORS_IN_POOL

Const NUM_PILL_COLORS_IN_POOL: number = NUM_NORMAL_PILL_COLORS

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

Defined in

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


ONE_BY_ONE_ROOM_GRID_SIZE

Const ONE_BY_ONE_ROOM_GRID_SIZE: 135

Defined in

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


QUALITIES

Const QUALITIES: readonly Quality[]

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

Defined in

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


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

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

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

Defined in

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


RESOLUTION_1600_900

Const RESOLUTION_1600_900: Vector

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

Defined in

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


STARTING_ROOM_GRID_INDEX

Const STARTING_ROOM_GRID_INDEX: 84

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

Defined in

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


TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE

Const TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE: 10000

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

Defined in

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


TELEPORTER_ACTIVATION_DISTANCE

Const TELEPORTER_ACTIVATION_DISTANCE: number

For GridEntityType.TELEPORTER (23).

Defined in

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


TIME_GAME_OPENED

Const TIME_GAME_OPENED: int

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

Defined in

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


UI_HEART_WIDTH

Const UI_HEART_WIDTH: 12

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

Defined in

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


VectorOne

Const VectorOne: Readonly<Vector>

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.)

Defined in

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


VectorZero

Const VectorZero: Readonly<Vector>

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.)

Defined in

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


ColorDefault

Const ColorDefault: Readonly<Color>

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.

Defined in

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


KColorDefault

Const KColorDefault: Readonly<KColor>

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

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

Defined in

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