dungeonmaker-js / dungeonmaker-js / parseDesignText

Function: parseDesignText()

parseDesignText(text): object

Defined in: packages/dungeonmaker-js/src/config/parse.ts:533

Parses a legacy design text into a DesignConfig.

Parameters

text

string

Returns

object

$schema?

optional $schema?: string

behaviour

behaviour: object

behaviour.mutator

mutator: number

behaviour.noHeadingProbability

noHeadingProbability: number

behaviour.patience

patience: number

crawlers

crawlers: object

crawlers.corridorWidth

corridorWidth: number[]

crawlers.inTunnels

inTunnels: object

crawlers.inTunnels.closedProbability

closedProbability: number

crawlers.inTunnels.enabled

enabled: boolean

crawlers.inTunnels.generation

generation: number

crawlers.inTunnels.genes

genes: object

crawlers.inTunnels.genes.changeDirection

changeDirection: number

crawlers.inTunnels.genes.straightDoubleSpawn

straightDoubleSpawn: number

crawlers.inTunnels.genes.straightSingleSpawn

straightSingleSpawn: number

crawlers.inTunnels.genes.turnDoubleSpawn

turnDoubleSpawn: number

crawlers.inTunnels.genes.turnSingleSpawn

turnSingleSpawn: number

crawlers.inTunnels.inAnterooms

inAnterooms: boolean

crawlers.inTunnels.maxAge

maxAge: number

crawlers.inTunnels.seedCount

seedCount: number

crawlers.inTunnels.stepLength

stepLength: number

crawlers.maxAge

maxAge: number[]

crawlers.pairs?

optional pairs?: object[]

crawlers.random

random: object

crawlers.random.genes

genes: object

crawlers.random.genes.changeDirection

changeDirection: number

crawlers.random.genes.straightDoubleSpawn

straightDoubleSpawn: number

crawlers.random.genes.straightSingleSpawn

straightSingleSpawn: number

crawlers.random.genes.turnDoubleSpawn

turnDoubleSpawn: number

crawlers.random.genes.turnSingleSpawn

turnSingleSpawn: number

crawlers.random.perThousandWallSquares

perThousandWallSquares: number[]

crawlers.seeds?

optional seeds?: object[]

crawlers.stepLength

stepLength: number[]

map

map: object

map.background

background: "open" | "closed"

map.height

height: number

map.joinDistance

joinDistance: number

map.openings

openings: ("N" | "NE" | "E" | "SE" | "S" | "SW" | "W" | "NW")[]

map.tunnelJoinDistance

tunnelJoinDistance: number

map.width

width: number

population?

optional population?: object

population.mobs

mobs: object

population.mobs.dungeon

dungeon: object

population.mobs.dungeon.open

open: object

population.mobs.dungeon.open.anteroomProbability

anteroomProbability: number

population.mobs.dungeon.open.byLevel

byLevel: number[]

population.mobs.dungeon.rooms

rooms: object

population.mobs.dungeon.rooms.byLevel

byLevel: number[]

population.mobs.dungeon.rooms.groupSize

groupSize: number

population.mobs.dungeon.rooms.groupSizeVariance

groupSizeVariance: number

population.mobs.labyrinth

labyrinth: object

population.mobs.labyrinth.open

open: object

population.mobs.labyrinth.open.byLevel

byLevel: number[]

population.mobs.labyrinth.rooms

rooms: object

population.mobs.labyrinth.rooms.byLevel

byLevel: number[]

population.mobs.labyrinth.rooms.groupSize

groupSize: number

population.mobs.labyrinth.rooms.groupSizeVariance

groupSizeVariance: number

population.treasure

treasure: object

population.treasure.dungeon

dungeon: object

population.treasure.dungeon.byLevel

byLevel: number[]

population.treasure.dungeon.groupSize

groupSize: number

population.treasure.dungeon.groupSizeVariance

groupSizeVariance: number

population.treasure.labyrinth

labyrinth: object

population.treasure.labyrinth.byLevel

byLevel: number[]

population.treasure.labyrinth.groupSize

groupSize: number

population.treasure.labyrinth.groupSizeVariance

groupSizeVariance: number

rectangles?

optional rectangles?: object[]

rooms

rooms: object

rooms.aspectRatio

aspectRatio: number

rooms.count

count: object

rooms.count.dungeon

dungeon: object

rooms.count.dungeon.large

large: number

rooms.count.dungeon.medium

medium: number

rooms.count.dungeon.small

small: number

rooms.count.labyrinth

labyrinth: object

rooms.count.labyrinth.large

large: number

rooms.count.labyrinth.medium

medium: number

rooms.count.labyrinth.small

small: number

rooms.size

size: object

rooms.size.large

large: number

rooms.size.max

max: number

rooms.size.medium

medium: number

rooms.size.min

min: number

rooms.sizeProbability

sizeProbability: object

rooms.sizeProbability.branching

branching: object[]

rooms.sizeProbability.sideways

sideways: object[]

spawnDelay

spawnDelay: object

spawnDelay.crawler

crawler: number[]

spawnDelay.roomie

roomie: number[]

spawnDelay.tunneler

tunneler: number[]

tunnelers

tunnelers: object

tunnelers.anteroomGenerationSpeedUp

anteroomGenerationSpeedUp: number

tunnelers.anteroomProbability

anteroomProbability: number[]

tunnelers.columns

columns: boolean

tunnelers.joinPreference

joinPreference: number[]

tunnelers.lastChance

lastChance: object

tunnelers.lastChance.changeDirection

changeDirection: number

tunnelers.lastChance.generationDelay

generationDelay: number

tunnelers.lastChance.makeRoomsLeft

makeRoomsLeft: number

tunnelers.lastChance.makeRoomsRight

makeRoomsRight: number

tunnelers.lastChance.straightDoubleSpawn

straightDoubleSpawn: number

tunnelers.lastChance.turnDoubleSpawn

turnDoubleSpawn: number

tunnelers.maxAge

maxAge: number[]

tunnelers.seeds?

optional seeds?: object[]

tunnelers.sizeDownProbability

sizeDownProbability: number[]

tunnelers.sizeUpGenerationDelay

sizeUpGenerationDelay: number

tunnelers.sizeUpProbability

sizeUpProbability: number[]

Throws

DesignValidationError with path: '' issues: one line <n>: … issue for the first problem, or one missing <TAG> record issue per missing required record.