JSONRoomsFile

Interfaces

JSONRoomsFile

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:16

The standard library has the feature to deploy a new room on-the-fly with the deployJSONRoom helper function. It requires a JSONRoomsFile as an argument, which is simply an XML file converted to JSON. (You can create XML room files using the Basement Renovator program.)

You can convert your XML files using the following command:

npx convert-xml-to-json foo.xml foo.json

Note that the custom stages feature of the standard library uses real XML/STB files, not JSON rooms, so you would only need to do this if you are using the deployJSONRoom command specifically.

Properties

rooms

readonly rooms: JSONRooms

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:17

---

JSONRooms

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:21

Part of JSONRoomsFile.

Properties

room

readonly room: readonly JSONRoom[]

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:22

---

JSONRoom

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:26

Part of JSONRoomsFile.

Properties

$

readonly $: object

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:27

difficulty

readonly difficulty: string

Needs to be converted to an int.

height

readonly height: string

Needs to be converted to an int.

name

readonly name: string

shape

readonly shape: string

Needs to be converted to an int.

subtype

readonly subtype: string

Needs to be converted to an int.

type

readonly type: string

Needs to be converted to an int.

variant

readonly variant: string

Needs to be converted to an int.

weight

readonly weight: string

Needs to be converted to a float.

width

readonly width: string

Needs to be converted to an int.

door

readonly door: readonly JSONDoor[]

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:55

spawn

readonly spawn: readonly JSONSpawn[]

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:56

---

JSONDoor

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:60

Part of JSONRoomsFile.

Properties

$

readonly $: object

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:61

exists

readonly exists: string

Equal to “True” or “False”. Needs to be converted to an boolean.

x

readonly x: string

Needs to be converted to an int.

y

readonly y: string

Needs to be converted to an int.

---

JSONSpawn

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:74

Part of JSONRoomsFile.

Properties

$

readonly $: object

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:75

x

readonly x: string

Needs to be converted to an int.

y

readonly y: string

Needs to be converted to an int.

entity

readonly entity: readonly JSONEntity[]

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:83

---

JSONEntity

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:87

Part of JSONRoomsFile.

Properties

$

readonly $: object

Defined in: packages/isaacscript-common/src/interfaces/JSONRoomsFile.ts:88

type

readonly type: string

Needs to be converted to an int.

variant

readonly variant: string

Needs to be converted to an int.

subtype

readonly subtype: string

Needs to be converted to an int.

weight

readonly weight: string

Needs to be converted to a float.