hex-world
    Preparing search index...

    Interface HexPackage

    Fully resolved, render-ready contents of a hexpack.

    interface HexPackage {
        terrainDescriptors: TerrainDescriptor[];
        terrainDefinitions: TerrainDefinition[];
        terrainTexture: DataArrayTexture;
        terrainMaterial: ShaderMaterial;
        liquidDescriptors: LiquidTypeDescriptor[];
        liquidMaterials: Map<string, LiquidMaterialSet>;
        scatterDescriptors: ScatterDescriptor[];
        scatterAssets: ScatterAssetDescriptor[];
        scatterDefinitions: ScatterDefinition[];
        resourceDescriptors: ResourceDescriptor[];
        factions: FactionDescriptor[];
        maps: Map<string, HexMap>;
    }
    Index

    Properties

    terrainDescriptors terrainDefinitions terrainTexture terrainMaterial liquidDescriptors liquidMaterials scatterDescriptors scatterAssets scatterDefinitions resourceDescriptors factions maps

    Properties

    terrainDescriptors: TerrainDescriptor[]
    terrainDefinitions: TerrainDefinition[]
    terrainTexture: DataArrayTexture

    The DataArrayTexture used to build terrainMaterial — pass to createTerrainMaterial to use custom lighting.

    terrainMaterial: ShaderMaterial

    Pre-built terrain material using terrainMaterialOptions (or defaults).

    liquidDescriptors: LiquidTypeDescriptor[]
    liquidMaterials: Map<string, LiquidMaterialSet>
    scatterDescriptors: ScatterDescriptor[]
    scatterAssets: ScatterAssetDescriptor[]
    scatterDefinitions: ScatterDefinition[]

    Resolved from scatterAssets (shapes need nothing; models need a gltfLoader) — or, for packs without asset descriptors, from the GLB files alone when a loader is supplied. Empty when neither applies.

    resourceDescriptors: ResourceDescriptor[]

    Resource types carried by the pack — hand to a ResourceLayer. Empty when the pack defines none.

    factions: FactionDescriptor[]

    Faction roster carried by the pack — hand to a TerritoryLayer. Empty when the pack defines none.

    maps: Map<string, HexMap>

    Loaded maps keyed by HexPackMapEntry.id.

    Settings

    Member Visibility

    On This Page

    Properties