Interface HexPackManifest

interface HexPackManifest {
    version: number;
    name?: string;
    terrainDescriptors: TerrainDescriptor[];
    liquidDescriptors?: LiquidTypeDescriptor[];
    scatterDescriptors?: ScatterDescriptor[];
    scatterAssets?: ScatterAssetDescriptor[];
    resourceDescriptors?: ResourceDescriptor[];
    factions?: FactionDescriptor[];
    assets?: Record<string, string>;
    maps?: HexPackMapEntry[];
}

Index

Properties

version name? terrainDescriptors liquidDescriptors? scatterDescriptors? scatterAssets? resourceDescriptors? factions? assets? maps?

Properties

version

version: number

`Optional`name

name?: string

terrainDescriptors

terrainDescriptors: TerrainDescriptor[]

`Optional`liquidDescriptors

liquidDescriptors?: LiquidTypeDescriptor[]

`Optional`scatterDescriptors

scatterDescriptors?: ScatterDescriptor[]

`Optional`scatterAssets

scatterAssets?: ScatterAssetDescriptor[]

Shape recipes and material behaviour for the scatter assetIds. Models still ship as files under models/.

`Optional`resourceDescriptors

resourceDescriptors?: ResourceDescriptor[]

Resource types the packed maps' cellData resource entries refer to.

`Optional`factions

factions?: FactionDescriptor[]

Faction roster the packed maps' cellData ownership entries refer to.

`Optional`assets

assets?: Record<string, string>

assetId → relative path inside the zip.

`Optional`maps

maps?: HexPackMapEntry[]