Function serializeMapJSON

serializeMapJSON(
    map: HexMap,
    metadata?: MapMetadata,
    descriptors?: MapDescriptorSets,
): string
Serializes a HexMap to a JSON string with base64-encoded cell data. Suitable for clipboard, editor state, or human-readable export. Pair with deserializeMapJSON.

Descriptor sets can be passed either as a single MapDescriptorSets object (which is the only way to include resource and faction sets) or, for backwards compatibility, positionally as scatter, terrain, and liquid arrays.
Parameters
- map: HexMap
- Optionalmetadata: MapMetadata
- Optionaldescriptors: MapDescriptorSets
Returns string
Example
```
serializeMapJSON(map, { name: 'Kelmar Basin' }, {
  terrainDescriptors, liquidDescriptors, resourceDescriptors, factions,
});
```
- Defined in map/MapSerializer.ts:383
serializeMapJSON(
    map: HexMap,
    metadata?: MapMetadata,
    scatterDescriptors?: ScatterDescriptor[],
    terrainDescriptors?: TerrainDescriptor[],
    liquidDescriptors?: LiquidTypeDescriptor[],
): string
Serializes a HexMap to a JSON string with base64-encoded cell data. Suitable for clipboard, editor state, or human-readable export. Pair with deserializeMapJSON.

Descriptor sets can be passed either as a single MapDescriptorSets object (which is the only way to include resource and faction sets) or, for backwards compatibility, positionally as scatter, terrain, and liquid arrays.
Parameters
- map: HexMap
- Optionalmetadata: MapMetadata
- OptionalscatterDescriptors: ScatterDescriptor[]
- OptionalterrainDescriptors: TerrainDescriptor[]
- OptionalliquidDescriptors: LiquidTypeDescriptor[]
Returns string
Example
```
serializeMapJSON(map, { name: 'Kelmar Basin' }, {
  terrainDescriptors, liquidDescriptors, resourceDescriptors, factions,
});
```
- Defined in map/MapSerializer.ts:388

Function serializeMapJSON

Parameters

Returns string

Example

Parameters

Returns string

Example

Settings