dungeonmaker-js / dungeonmaker-js/export / toDungeonFile

Function: toDungeonFile()

toDungeonFile(dungeon, options?): object

Defined in: packages/dungeonmaker-js/src/export/dungeon-json.ts:51

The self-describing file structure for a dungeon; keys in a fixed order.

Parameters

dungeon

ExportableDungeon

options?

DungeonFileOptions = {}

Returns

object

$schema?

optional $schema?: string

cells

cells: { data: string; encoding: "base64"; } | { alphabet: string; data: string[]; encoding: "rows"; } | { data: number[]; encoding: "array"; } = CellsSchema

entities?

optional entities?: object[]

format

format: "dungeonmaker-js/dungeon"

formatVersion

formatVersion: 1

generator

generator: string

height

height: number

legend

legend: object

Index Signature

[key: string]: "open" | "closed" | "guaranteedOpen" | "guaranteedClosed" | "nonJoinOpen" | "nonJoinClosed" | "nonJoinGuaranteedOpen" | "nonJoinGuaranteedClosed" | "insideRoomOpen" | "insideTunnelOpen" | "insideAnteroomOpen" | "horizontalDoor" | "verticalDoor" | "mob1" | "mob2" | "mob3" | "treasure1" | "treasure2" | "treasure3" | "column"

[key: number]: "open" | "closed" | "guaranteedOpen" | "guaranteedClosed" | "nonJoinOpen" | "nonJoinClosed" | "nonJoinGuaranteedOpen" | "nonJoinGuaranteedClosed" | "insideRoomOpen" | "insideTunnelOpen" | "insideAnteroomOpen" | "horizontalDoor" | "verticalDoor" | "mob1" | "mob2" | "mob3" | "treasure1" | "treasure2" | "treasure3" | "column"

rooms?

optional rooms?: object

rooms.roomIds

roomIds: object = Base64Schema

rooms.roomIds.data

data: string

rooms.roomIds.encoding

encoding: "base64"

rooms.rooms

rooms: object[]

seed

seed: number

source?

optional source?: { preset: string; } | { design?: object; designHash: string; }

steps?

optional steps?: object

steps.cell

cell: string

steps.index

index: string

steps.offsets

offsets: string

width

width: number