Differences

This shows you the differences between two versions of the page.

--- preview:api:custom_map [2019/10/04 18:04] – [SpawnList] polymorphgames
+++ preview:api:custom_map [2023/12/12 12:15] (current) – external edit 127.0.0.1
@@ Line 3: / Line 3: @@
 **Category**: Asset
+Parent class:  [[preview:api:asset|ASSET]]\\
-[[preview:assets:custom_map| List of CUSTOM_MAP assets]]
-''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.
+[[preview:assets:custom_map| List of CUSTOM_MAP assets]]
-See mod Example 03 for a complete example.
 ===== Properties =====
@@ Line 15: / Line 14: @@
 ==== 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''
+  * **Expected**: ''asset ID''
 ----
 ==== MinHeight ====
+//[[:annotations#serialized|Serialized]]//
 The height of a pure black pixel in the HeightMap. Any other pixel is interpolated.
-  * **Type**: ''Float''
+  * **Type**: ''[[preview:data-types#float|float]]''
+  * **Expected**: ''float value''
   * **Default value**: ''5''
@@ Line 29: / Line 35: @@
 ==== MaxHeight ====
+//[[:annotations#serialized|Serialized]]//
 The height of a pure white pixel in the HeightMap. Any other pixel is interpolated.
-  * **Type**: ''Float''
+  * **Type**: ''[[preview:data-types#float|float]]''
+  * **Expected**: ''float value''
   * **Default value**: ''100''
@@ Line 36: / Line 46: @@
 ==== 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''
+  * **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**: ''List<[[preview:api:map_village_path|MAP_VILLAGE_PATH]]>''
+  * **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**: ''List<[[preview:api:map_spawn_info|MAP_SPAWN_INFO]]>''
+  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:map_spawn_info|MAP_SPAWN_INFO]]>''
+  * **Expected**: ''list of MAP_SPAWN_INFO values''
 ----
 ==== DensitySpawnList ====
-DensitySpawnList allows you to add objects randomly based on a texture.
+//[[:annotations#serialized|Serialized]]//
-  * **Type**: ''List<[[preview:api:map_density_spawn_info|MAP_DENSITY_SPAWN_INFO]]>''
+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''