TerrainMaskWML - Revision history

Dalas120: Add documentation for [terrain_mask] mask_file key

2026-04-27T21:44:41Z

Add documentation for [terrain_mask] mask_file key

← Older revision		Revision as of 21:44, 27 April 2026
Line 8:		Line 8:
	* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).		* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).
	* '''mask''': a Wesnoth map; see [[BuildingMaps]].		* '''mask''': a Wesnoth map; see [[BuildingMaps]].
			* '''mask_file''': path to a file containing Wesnoth map data. Overrides '''mask'''.
	* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is only used if '''alignment''' is empty/invalid.		* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is only used if '''alignment''' is empty/invalid.
	* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter\|filtering by location_id]]. Setting this to 'yes' prevents that.		* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter\|filtering by location_id]]. Setting this to 'yes' prevents that.

Soliton: Correct border documentation

2025-04-29T13:36:51Z

Correct border documentation

← Older revision		Revision as of 13:36, 29 April 2025
Line 8:		Line 8:
	* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).		* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).
	* '''mask''': a Wesnoth map; see [[BuildingMaps]].		* '''mask''': a Wesnoth map; see [[BuildingMaps]].
	* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is ~~no longer~~ used ~~instead the mandatory~~ '~~alignment~~' ~~key is used,~~ '~~border~~' ~~will be ignored if~~ '~~alignment~~' is ~~set to any value~~.		* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is only used if '''alignment''' is empty/invalid.
	* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter\|filtering by location_id]]. Setting this to 'yes' prevents that.		* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter\|filtering by location_id]]. Setting this to 'yes' prevents that.
	<ul><li>'''alignment''': ({{DevFeature1.15\|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):		<ul><li>'''alignment''': (falls back to '''border''' if empty/invalid) ({{DevFeature1.15\|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):
	<pre>		<pre>
	__/10\__/30\		__/10\__/30\

Celtic Minstrel: Bold tag name

2024-05-10T13:37:23Z

Bold tag name

← Older revision		Revision as of 13:37, 10 May 2024
Line 1:		Line 1:
	{{WML Tags}}		{{WML Tags}}

	The [terrain_mask] tag makes map manipulation from within WML much easier.		The '''[terrain_mask]''' tag makes map manipulation from within WML much easier.
	It uses a Wesnoth map as a "mask" over a given location,		It uses a Wesnoth map as a "mask" over a given location,
	placing it down on top of the scenario map.		placing it down on top of the scenario map.

Celtic Minstrel: Fix issues with list nesting

2024-02-27T05:54:14Z

Fix issues with list nesting

Celtic Minstrel: Add an anchor that can be linked to

2024-02-27T05:50:54Z

Add an anchor that can be linked to

← Older revision		Revision as of 05:50, 27 February 2024
Line 31:		Line 31:
	</pre>		</pre>
	. Using '''raw''' will assume the map data is aligned in the same way as the map square that starts at (x,y)		. Using '''raw''' will assume the map data is aligned in the same way as the map square that starts at (x,y)
	* '''[rule]''': specifies a rule for blending the mask with the scenario.		* {{anchor\|rule\|'''[rule]'''}}: specifies a rule for blending the mask with the scenario.<br>
	The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.		The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.
	** '''old''': a comma-separated list of terrain codes. The rule fits only those hexes that have one of these terrains in the scenario. If omitted, matches any hex on the base map.		** '''old''': a comma-separated list of terrain codes. The rule fits only those hexes that have one of these terrains in the scenario. If omitted, matches any hex on the base map.

Octalot: Document [terrain_mask]ignore_special_locations=, which was added in 1.13.6.

2023-05-06T09:27:18Z

Document [terrain_mask]ignore_special_locations=, which was added in 1.13.6.

← Older revision		Revision as of 09:27, 6 May 2023
Line 8:		Line 8:
	* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).		* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).
	* '''mask''': a Wesnoth map; see [[BuildingMaps]].		* '''mask''': a Wesnoth map; see [[BuildingMaps]].
	* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the ~~manditory~~ 'alignment' key is used, 'border' will be ignored if 'alignment' is set to any value.		* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the mandatory 'alignment' key is used, 'border' will be ignored if 'alignment' is set to any value.
			* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter\|filtering by location_id]]. Setting this to 'yes' prevents that.
	* '''alignment''': ({{DevFeature1.15\|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):		* '''alignment''': ({{DevFeature1.15\|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):
	<pre>		<pre>

Gfgtdf at 04:40, 19 February 2020

2020-02-19T04:40:35Z

← Older revision		Revision as of 04:40, 19 February 2020
Line 6:		Line 6:
	Fog ('_f') and Shroud ('_s') are used like alpha in an image; i.e. they cause the previous terrain to be used.		Fog ('_f') and Shroud ('_s') are used like alpha in an image; i.e. they cause the previous terrain to be used.

	* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto		* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto. Important note: if 'border=yes (default)' and alignment is unset, then (x,y) will not denote the place of the top-left corner but rather of the place of the location (1,1) of the mask data (the top left corner of the 'inner' part of the mask). So the top-left corner of the mask will be placed at (x-1,y-1) or (x-1,1).
	* '''mask''': a Wesnoth map; see [[BuildingMaps]].		* '''mask''': a Wesnoth map; see [[BuildingMaps]].
	* '''border''': (default=no) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the manditory 'alignment' ~~kay~~ is used:		* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the manditory 'alignment' key is used, 'border' will be ignored if 'alignment' is set to any value.
	* '''alignment''': ({{DevFeature1.15\|1}}~~, manditory~~, leaving out this key will fallback to 1.12 ~~behviour which is strange~~). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):		* '''alignment''': ({{DevFeature1.15\|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):
	<pre>		<pre>
	__/10\__/30\		__/10\__/30\

Gfgtdf at 04:20, 19 February 2020

2020-02-19T04:20:15Z

← Older revision		Revision as of 04:20, 19 February 2020
Line 9:		Line 9:
	* '''mask''': a Wesnoth map; see [[BuildingMaps]].		* '''mask''': a Wesnoth map; see [[BuildingMaps]].
	* '''border''': (default=no) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the manditory 'alignment' kay is used:		* '''border''': (default=no) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the manditory 'alignment' kay is used:
	* '''alignment''': (manditory, leaving out this key will fallback to 1.12 behviour which is strange). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):		* '''alignment''': ({{DevFeature1.15\|1}}, manditory, leaving out this key will fallback to 1.12 behviour which is strange). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):
	<pre>		<pre>
	__/10\__/30\		__/10\__/30\

Gfgtdf at 04:20, 19 February 2020

2020-02-19T04:20:01Z

@@ Line 8: / Line 8: @@
 * '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto
 * '''mask''': a Wesnoth map; see [[BuildingMaps]].
-* '''border''': (default=no) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored
+* '''border''': (default=no) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15|1}} the '''border''' key is no longer used instead  the manditory 'alignment' kay is used:
 * '''[rule]''': specifies a rule for blending the mask with the scenario.
 The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.

8680: Update references to obsolete terrain codes. Also "alot" -> "a lot".

2013-03-18T16:36:04Z

Update references to obsolete terrain codes. Also "alot" -> "a lot".

← Older revision		Revision as of 16:36, 18 March 2013
Line 44:		Line 44:
	</pre>		</pre>

	For instance, suppose you want snow to fall in an area. You want villages (v) to turn into ~~snowed-~~villages (V), forest		For instance, suppose you want snow to fall in an area. You want villages on green grass (Gg^Vh) to turn into snowy villages on snow (Aa^Vha), pine forest on semi-dry grass (Gs^Fp) to turn into snowy pine forest on snow (Aa^Fpa), hills (Hh) to turn into snowy hills (Ha), and green grass (Gg) and regular dirt (Re) to turn into snow (Aa), while other terrain remains untouched. You could look over your destination map and work out which terrain type is which and draw your mask, but that's a lot of effort, you want to just draw a simple mask which has areas of snow and areas of no snow, and make the game work out the rest.
	(f) to turn into ~~snowed-~~forest (F), hills
	(h) to turn into ~~snowed-~~hills (H), and ~~grassland~~ (g) and ~~roads~~ (r) to turn into snow (S), while other terrain remains
	untouched. You could look over your
	destination map and work out which terrain type is which and draw your mask, but that's ~~alot~~ of effort, you want to just
	draw a simple mask which has
	areas of snow and areas of no snow, and make the game work out the rest.

	You can do it like this:		You can do it like this:

← Older revision		Revision as of 05:54, 27 February 2024
Line 10:		Line 10:
	* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the mandatory 'alignment' key is used, 'border' will be ignored if 'alignment' is set to any value.		* '''border''': (default=yes) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored. {{DevFeature1.15\|1}} the '''border''' key is no longer used instead the mandatory 'alignment' key is used, 'border' will be ignored if 'alignment' is set to any value.
	* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter\|filtering by location_id]]. Setting this to 'yes' prevents that.		* '''ignore_special_locations''': (default=no) By default, any special location names given in the mask will be added to the map, allowing them to be used for [[StandardLocationFilter\|filtering by location_id]]. Setting this to 'yes' prevents that.
	* '''alignment''': ({{DevFeature1.15\|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):		<ul><li>'''alignment''': ({{DevFeature1.15\|1}}, leaving out this key will fallback to 1.12 behaviour). possible values '''even''', '''odd''' or '''raw''', describes how the data in 'mask' is aligned, there is the even alignment (this is what the map editor produces thus you usually want to use `aligment=even`):
	<pre>		<pre>
	__/10\__/30\		__/10\__/30\
Line 30:		Line 30:
	\__/ \__/		\__/ \__/
	</pre>		</pre>
	. Using '''raw''' will assume the map data is aligned in the same way as the map square that starts at (x,y)		. Using '''raw''' will assume the map data is aligned in the same way as the map square that starts at (x,y)</li>
	* {{anchor\|rule\|'''[rule]'''}}: specifies a rule for blending the mask with the scenario.<br>		<li>{{anchor\|rule\|'''[rule]'''}}: specifies a rule for blending the mask with the scenario.<br>
	The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.		The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.
	** '''old''': a comma-separated list of terrain codes. The rule fits only those hexes that have one of these terrains in the scenario. If omitted, matches any hex on the base map.		* '''old''': a comma-separated list of terrain codes. The rule fits only those hexes that have one of these terrains in the scenario. If omitted, matches any hex on the base map.
	** '''new''': a list of terrain letters. The rule fits only those hexes with this terrain specified in the mask. If omitted, matches any hex on the mask.		* '''new''': a list of terrain letters. The rule fits only those hexes with this terrain specified in the mask. If omitted, matches any hex on the mask.
	** '''terrain''': the letter of the terrain to change hexes which fit this rule (i.e. for which the '''new''' terrain code in the mask falls on top of the '''old''' terrain in the scenario) into. If omitted, defaults to either the old or new terrain depending on the value of use_old.		* '''terrain''': the letter of the terrain to change hexes which fit this rule (i.e. for which the '''new''' terrain code in the mask falls on top of the '''old''' terrain in the scenario) into. If omitted, defaults to either the old or new terrain depending on the value of use_old.
	** '''layer''': (overlay\|base\|both, default=both) only change the specified layer.		* '''layer''': (overlay\|base\|both, default=both) only change the specified layer.
	** '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.		* '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.
	** '''use_old''': if yes, no change is done to hexes matching this rule. If no, the hex is changed to the new terrain or, if specified, the value of the terrain key.		* '''use_old''': if yes, no change is done to hexes matching this rule. If no, the hex is changed to the new terrain or, if specified, the value of the terrain key.</li></ul>

	As an example, suppose you want to lay down a road somewhere. You could specify by hand the path the road takes using		As an example, suppose you want to lay down a road somewhere. You could specify by hand the path the road takes using