====== CUSTOM_MAP ======

**Category**: Asset

Parent class:  [[preview:api:asset|ASSET]]\\



[[preview:assets:custom_map| List of CUSTOM_MAP assets]]

===== Properties =====

----

==== HeightMap ====
//[[:annotations#serialized|Serialized]]//

A grayscale texture that will be used to generate the map's topography. Best results can be achieved when using an 1024x1024 image with a single 16 bit layer.

  * **Type**: ''[[preview:api:texture|TEXTURE]]''
  * **Expected**: ''asset ID''

----

==== MinHeight ====
//[[:annotations#serialized|Serialized]]//

The height of a pure black pixel in the HeightMap. Any other pixel is interpolated.

  * **Type**: ''[[preview:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''5''

----

==== MaxHeight ====
//[[:annotations#serialized|Serialized]]//

The height of a pure white pixel in the HeightMap. Any other pixel is interpolated.

  * **Type**: ''[[preview:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''100''

----

==== MaterialMask ====
//[[:annotations#serialized|Serialized]]//

An RGB texture that describes the ground's texture. Red is grass, green is sand, blue is currently unused.

  * **Type**: ''[[preview:api:texture|TEXTURE]]''
  * **Expected**: ''asset ID''

----

==== VillagePathList ====
//[[:annotations#serialized|Serialized]]//

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**: ''[[preview:data-types#list|list]]<[[preview:api:map_village_path|MAP_VILLAGE_PATH]]>''
  * **Expected**: ''list of MAP_VILLAGE_PATH values''

----

==== SpawnList ====
//[[:annotations#serialized|Serialized]]//

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**: ''[[preview:data-types#list|list]]<[[preview:api:map_spawn_info|MAP_SPAWN_INFO]]>''
  * **Expected**: ''list of MAP_SPAWN_INFO values''

----

==== DensitySpawnList ====
//[[:annotations#serialized|Serialized]]//

Allows you to add objects randomly based on a texture.

  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:map_density_spawn_info|MAP_DENSITY_SPAWN_INFO]]>''
  * **Expected**: ''list of MAP_DENSITY_SPAWN_INFO values''