Skip to main content

CustomStageBossPoolEntry

An object that represents a possible boss for a custom stage. This can be for a vanilla boss or a custom boss.

Properties​

name​

• name: string

The name of the boss. This should correspond to the entry for the boss in the "entities2.xml" file.

Defined in​

packages/isaacscript-common/src/interfaces/CustomStageTSConfig.ts:517

subType​

• subType: number

The arbitrary sub-type chosen for this boss, ranging between 1 and 999. You must set the boss rooms for this boss to this sub-type in Basement Renovator by right-clicking on the room on the right-hand-side.

It does not matter if the arbitrary sub-type overlaps with any of the vanilla BossID values (e.g. vanilla Boss Room sub-types in "00.special_rooms.stb"). It also does not matter if this value overlaps with the values from other mods.

If you are creating an entry for a vanilla boss, it is recommended that you match the sub-type with the corresponding vanilla BossID value. This will make things a bit easier to understand for people working on your mod, but is not a hard requirement.

Minimum

1

Maximum

999

Defined in​

packages/isaacscript-common/src/interfaces/CustomStageTSConfig.ts:535

weight​

• weight: number

The weight of the boss. This is used when randomly selecting which boss to use for the floor. For example, use a value of 1 if you want this boss to be equally likely as any other boss, 0.5 if you want it to be half as likely, 2 if you want it to be twice as likely, and so on.

Defined in​

packages/isaacscript-common/src/interfaces/CustomStageTSConfig.ts:542

versusScreen​

• Optional versusScreen: Object

Optional. A collection of sprites used for the boss on the "versus" screen.

Type declaration​

NameTypeDescription
namePNGPathstringMandatory. The full path to the spritesheet that contains the graphics of the name of the boss that will be displayed on the top of the boss "versus" screen. If not specified, a sprite showing "???" will be used.
portraitPNGPathstringMandatory. The full path to the spritesheet that contains the portrait of the boss that will be displayed on the right side of the boss "versus" screen. If not specified, a sprite showing "???" will be used.

Defined in​

packages/isaacscript-common/src/interfaces/CustomStageTSConfig.ts:545