five-on-it / apps/tools/src/region-level / writeRegion

Function: writeRegion()

writeRegion(spec, outDir, options?): Promise<{ build?: RegionBuild; issues: SpecIssue[]; kits: string[]; places?: Record<string, unknown>; written: string[]; }>

Defined in: apps/tools/src/region-level.ts:372

Builds a region from its spec and writes its files into outDir (its towns built with Blender, see the module documentation); the problems instead when the spec has any. Returns the region's own kits too (its own and its towns'), and its named places as its places file holds them: the solver's, its towns' merged in under their names, and the spawns of the town it starts in. The solver's build.places has neither.

Parameters

spec

unknown

outDir

string

options?

TownOptions = {}

Returns

Promise<{ build?: RegionBuild; issues: SpecIssue[]; kits: string[]; places?: Record<string, unknown>; written: string[]; }>