This is an old revision of the document!
Table of Contents
CUSTOM_MAP
Category: Asset
CUSTOM_MAP
is an asset that describes a map that can then be loaded in the game. A Custom Map must be included in a mod, and any number of Custom Maps can be added to a single mod. These maps will then be available in the map dropdown in the main menu.
See mod Example 03 for a complete example.
Properties
HeightMap
A grayscale texture that will be used to generate the map's topography. Best results can be achieved when using an 1024×1024 image with a single 16 bit layer.
- Type:
TEXTURE
- Expected:
Asset ID
MinHeight
The height of a pure black pixel in the HeightMap. Any other pixel is interpolated.
- Type:
Float
- Default value:
5
MaxHeight
The height of a pure white pixel in the HeightMap. Any other pixel is interpolated.
- Type:
Float
- Default value:
100
MaterialMask
An RGB texture that describes the ground's texture. Red is grass, green is sand, blue is currently unused.
- Type:
TEXTURE
- Expected:
Asset ID
VillagePathList
Designates the Entrances of the Newcomers and the Entrances and Exits of the Envoys and Trader. For the best results, make sure the two positions aren't separated by water.
- Type:
List<MAP_VILLAGE_PATH>
SpawnList
List of prefabs that will be added to the map when it is loaded. Use this list to add resources to the map, such as berries and rocks.
- Type:
List<MAP_SPAWN_INFO>
DensitySpawnList
Allows you to add objects randomly based on a texture.
- Type:
List<MAP_DENSITY_SPAWN_INFO>