dungeonmaker-js / dungeonmaker-js/node / GenerateToFilesOptions

Interface: GenerateToFilesOptions

Defined in: packages/dungeonmaker-js/src/node/generate.ts:40

Properties

design?

optional design?: string | { $schema?: string; behaviour: { mutator: number; noHeadingProbability: number; patience: number; }; crawlers: { corridorWidth: number[]; inTunnels: { closedProbability: number; enabled: boolean; generation: number; genes: { changeDirection: number; straightDoubleSpawn: number; straightSingleSpawn: number; turnDoubleSpawn: number; turnSingleSpawn: number; }; inAnterooms: boolean; maxAge: number; seedCount: number; stepLength: number; }; maxAge: number[]; pairs?: object[]; random: { genes: { changeDirection: number; straightDoubleSpawn: number; straightSingleSpawn: number; turnDoubleSpawn: number; turnSingleSpawn: number; }; perThousandWallSquares: number[]; }; seeds?: object[]; stepLength: number[]; }; map: { background: "open" | "closed"; height: number; joinDistance: number; openings: ("N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW")[]; tunnelJoinDistance: number; width: number; }; population?: { mobs: { dungeon: { open: { anteroomProbability: number; byLevel: number[]; }; rooms: { byLevel: number[]; groupSize: number; groupSizeVariance: number; }; }; labyrinth: { open: { byLevel: number[]; }; rooms: { byLevel: number[]; groupSize: number; groupSizeVariance: number; }; }; }; treasure: { dungeon: { byLevel: number[]; groupSize: number; groupSizeVariance: number; }; labyrinth: { byLevel: number[]; groupSize: number; groupSizeVariance: number; }; }; }; rectangles?: object[]; rooms: { aspectRatio: number; count: { dungeon: { large: number; medium: number; small: number; }; labyrinth: { large: number; medium: number; small: number; }; }; size: { large: number; max: number; medium: number; min: number; }; sizeProbability: { branching: object[]; sideways: object[]; }; }; spawnDelay: { crawler: number[]; roomie: number[]; tunneler: number[]; }; tunnelers: { anteroomGenerationSpeedUp: number; anteroomProbability: number[]; columns: boolean; joinPreference: number[]; lastChance: { changeDirection: number; generationDelay: number; makeRoomsLeft: number; makeRoomsRight: number; straightDoubleSpawn: number; turnDoubleSpawn: number; }; maxAge: number[]; seeds?: object[]; sizeDownProbability: number[]; sizeUpGenerationDelay: number; sizeUpProbability: number[]; }; }

Defined in: packages/dungeonmaker-js/src/node/generate.ts:42

A design object or legacy design text. Exactly one of design and preset.

---

designName?

optional designName?: string

Defined in: packages/dungeonmaker-js/src/node/generate.ts:45

Value of {name} for a design. Default dungeon.

---

embedDesign?

optional embedDesign?: boolean

Defined in: packages/dungeonmaker-js/src/node/generate.ts:55

Embed the design in the dungeon JSON (never for presets).

---

formats

formats: readonly ExportFormat[]

Defined in: packages/dungeonmaker-js/src/node/generate.ts:47

---

generator?

optional generator?: string

Defined in: packages/dungeonmaker-js/src/node/generate.ts:59

Generator string for the files; default dungeonmaker-js@<version>.

---

manifest?

optional manifest?: boolean

Defined in: packages/dungeonmaker-js/src/node/generate.ts:53

Also write manifest.json.

---

name?

optional name?: string

Defined in: packages/dungeonmaker-js/src/node/generate.ts:50

File name template without extension; default {name}-{seed}.

---

outDir

outDir: string

Defined in: packages/dungeonmaker-js/src/node/generate.ts:48

---

output?

optional output?: OutputOptions

Defined in: packages/dungeonmaker-js/src/node/generate.ts:51

---

preset?

optional preset?: "design" | "design2" | "design3A" | "design3WithTunnelers" | "design4A" | "design5" | "design6" | "design7" | "designEmpty" | "designEmpty2" | "designOld1"

Defined in: packages/dungeonmaker-js/src/node/generate.ts:43

---

scale?

optional scale?: number

Defined in: packages/dungeonmaker-js/src/node/generate.ts:57

PNG scale, default 1.

---

seeds

seeds: readonly number[]

Defined in: packages/dungeonmaker-js/src/node/generate.ts:46