TerrainGraphicsWML - Revision history

Soliton at 13:11, 30 April 2025

2025-04-30T13:11:20Z

Soliton: /* The [tile] subtag */

2024-07-11T16:43:37Z

‎The [tile] subtag

Soliton: sync name attribute description

2024-07-11T16:36:54Z

sync name attribute description

Soliton: /* The [image] subtag */ variations is actually just taken from the parent tag

2024-07-11T16:17:38Z

‎The [image] subtag: variations is actually just taken from the parent tag

Soliton: /* The [image] subtag */

2024-07-11T15:25:29Z

‎The [image] subtag

Soliton: /* The [image] subtag */ document variations attribute and clarify name documentation

2024-07-11T11:13:31Z

‎The [image] subtag: document variations attribute and clarify name documentation

Celtic Minstrel: Bold tag name

2024-05-10T13:38:18Z

Bold tag name

Celtic Minstrel: /* The [image] subtag */ Add an anchor that can be linked to

2024-05-10T13:33:21Z

‎The [image] subtag: Add an anchor that can be linked to

Celtic Minstrel: /* The toplevel [terrain_graphics] tag */ Link to the subtags

2024-05-10T13:30:18Z

‎The toplevel [terrain_graphics] tag: Link to the subtags

Celtic Minstrel: /* See Also */ Link to TerrainMacrosWML

2023-05-07T20:58:32Z

‎See Also: Link to TerrainMacrosWML

@@ Line 3: / Line 3: @@
 For information about the multi-hex tiling system, see [[MultiHexTutorial]]
-In terrain graphics, all images are assumed to be relative to images/terrain/. For example, writing 'image=grassland.png' means that the image file is images/terrain/grassland.png.
+In terrain graphics, all image paths are assumed to be relative to images/terrain/. For example, writing 'image=grassland.png' means that the image file is images/terrain/grassland.png.
 The multi-hex tiling system adds a new top-level element to WML, '''[terrain_graphics]'''.

@@ Line 30: / Line 30: @@
 * '''name''': for animated terrain this takes the form of a comma separated list of image names with durations specified after a colon. For the image name also see [[AnimationWML#Progressive_strings|Progressive Strings]] and [[ImagePathFunctions]].
 * '''no_draw''' (default: no): {{DevFeature1.13|5}} whether to actually draw images of this rule onto this hex.
-* '''set_flag''': a comma-separated list of strings or square bracket expansion as in AnimationWML. Attaches flags from that list to the corresponding tile if the rule matches. The only difference a flag makes is being detected by ''has_flag'' and ''no_flag'' in [tile]. This is determined by the order of the [terrain_graphics] tags; a tag after another one cannot influence it. See also ''has_flag'', ''no_flag''
+* '''set_flag''': a comma-separated list of normal or [[AnimationWML#Progressive_strings|progressive]] strings. Attaches flags from that list to the corresponding tile if the rule matches. The only difference a flag makes is being detected by ''has_flag'' and ''no_flag'' in [tile]. This is determined by the order of the [terrain_graphics] tags; a tag after another one cannot influence it. See also ''has_flag'', ''no_flag''
-* '''has_flag''': a comma-separated list of strings or square bracket expansion as in AnimationWML. Matches if all flags in that list are attached to the corresponding tile. Flags are attached using the ''set_flag'' key.
+* '''has_flag''': a comma-separated list of normal or [[AnimationWML#Progressive_strings|progressive]] strings. Matches if all flags in that list are attached to the corresponding tile. Flags are attached using the ''set_flag'' key.
-* '''no_flag''': a comma-separated list of strings or square bracket expansion as in AnimationWML. Matches if none of the flags in that list are attached to the corresponding tile. Flags are attached using the ''set_flag'' key.
+* '''no_flag''': a comma-separated list of normal or [[AnimationWML#Progressive_strings|progressive]] strings. Matches if none of the flags in that list are attached to the corresponding tile. Flags are attached using the ''set_flag'' key.
 * '''set_no_flag''': helper combining ''set_flag'' and ''no_flag''. Same effect as using them with the same flags. Added because it's the most common use; ''set_flag'' or ''no_flag'' can still be used to add flags in one group only.
 * '''[image]''': images specified as a subtag to '''[tile]''' sets the images for a single tile.

@@ Line 28: / Line 28: @@
 * '''pos''': a shortcut to specifying coordinates. Used in combination with ''map''
 * '''type''': a comma-separated list of terrain codes (See [[TerrainWML]], data/terrain.cfg). In order for a tile to match this condition, it must be one of the terrains specified. However, if the string is preceded by "!", the terrain must not be listed in order to match. If the string is '*', or if it is empty, any tile matches.
-* '''name''': for animated terrain this takes the form of a comma separated list of images with durations specified after ':'. A square bracket expansion can also be used as in AnimationWML (see in example below).
+* '''name''': for animated terrain this takes the form of a comma separated list of image names with durations specified after a colon. For the image name also see [[AnimationWML#Progressive_strings|Progressive Strings]] and [[ImagePathFunctions]].
 * '''no_draw''' (default: no): {{DevFeature1.13|5}} whether to actually draw images of this rule onto this hex.
 * '''set_flag''': a comma-separated list of strings or square bracket expansion as in AnimationWML. Attaches flags from that list to the corresponding tile if the rule matches. The only difference a flag makes is being detected by ''has_flag'' and ''no_flag'' in [tile]. This is determined by the order of the [terrain_graphics] tags; a tag after another one cannot influence it. See also ''has_flag'', ''no_flag''
@@ Line 38: / Line 38: @@
 == The [image] subtag ==
-* '''name''': a comma separated list of images to apply on this tile if appropriate. Format: ''<image name>[:<timing>],...'' For the image name see [[AnimationWML#Progressive_strings|Progressive Strings]] and [[ImagePathFunctions]].
+* '''name''': for animated terrain this takes the form of a comma separated list of image names with durations specified after a colon. For the image name also see [[AnimationWML#Progressive_strings|Progressive Strings]] and [[ImagePathFunctions]].
-* '''variations''': A semicolon separated list of strings used to replace every '''@V''' in '''name''' and extend the list of image names with these variations.
+* '''variations''': A semicolon separated list of strings used to replace every occurrence of '''@V''' in '''name''' and extend the list of image names with these variations.
 * '''random_start''' (default: yes): Tells engine to start animation at random point instead of at the beginning for every tile {{DevFeature1.13|9}} If given a positive integer, limits the range of the random shift of the start time to the given amount of milliseconds. For example, if the animation duration is 700ms, then ''random_start=yes'' and ''random_start=700'' are equivalent, whereas ''random_start=100'' limits the start times of different instances of the animation to be at most 100ms apart.
 * '''layer''': an integer, usually negative. The more negative it is, the earlier it is drawn, and thus the farther "back" it is when compositing the terrain images together.

@@ Line 46: / Line 46: @@
 * {{anchor|variant|'''[variant]'''}}: an alternate image to use for differing times of day
 ** '''name''': Same as in the parent tag.
 ** '''random_start''': Same as in the parent tag.
 ** '''tod''': the time of day for which this variant applies. Accepts a comma separated list of times of day.

@@ Line 38: / Line 38: @@
 == The [image] subtag ==
 * '''name''': a comma separated list of images to apply on this tile if appropriate. Format: ''<image name>[:<timing>],...'' For the image name see [[AnimationWML#Progressive_strings|Progressive Strings]] and [[ImagePathFunctions]].
 * '''variations''': A semicolon separated list of strings used to replace every '''@V''' in '''name''' and extend the list of image names with these variations.
 * '''random_start''' (default: yes): Tells engine to start animation at random point instead of at the beginning for every tile {{DevFeature1.13|9}} If given a positive integer, limits the range of the random shift of the start time to the given amount of milliseconds. For example, if the animation duration is 700ms, then ''random_start=yes'' and ''random_start=700'' are equivalent, whereas ''random_start=100'' limits the start times of different instances of the animation to be at most 100ms apart.
 * '''base''': specifies the point at which the image is considered to be for layering purposes.  ''base'' is specified as '''x,y''' where x and y indicate distances in pixels from the top-left corner of the '''image'''. This is translated to a certain pixel on the map, and all images with the ''base'' attribute are drawn from top-to-bottom in terms of these specified pixel positions '''on the map'''.
 * '''center''': (multihex images only) specifies the point which the image will be centered on. If it is not specified, the image will instead be aligned with the top left corner of the tile.
 * {{anchor|variant|'''[variant]'''}}: an alternate image to use for differing times of day
 ** '''name''': Same as in the parent tag.
 ** '''variations''': Same as in the parent tag.
 ** '''random_start''': Same as in the parent tag.
 ** '''has_flag''' {{DevFeature1.13|1}} comma-separated list of flags that the tile must have for this variant to apply.

@@ Line 5: / Line 5: @@
 In terrain graphics, all images are assumed to be relative to images/terrain/. For example, writing 'image=grassland.png' means that the image file is images/terrain/grassland.png.
-The multi-hex tiling system adds a new top-level element to WML, [terrain_graphics].
+The multi-hex tiling system adds a new top-level element to WML, '''[terrain_graphics]'''.
 A building rule is used to specify images to place when terrains are in a certain formation.
 When a building rule is applied to a map, it is applied once to each coordinate on the map;

@@ Line 16: / Line 16: @@
 * '''x''','''y''': constrains the rule to given absolute map coordinates. Primarily useful to place map-specific features.
 * '''mod_x''','''mod_y''': {{DevFeature1.13|1}} constrains the rule to absolute map coordinates which are multiples of the given values. For example, mod_x=4 would only match locations with an x coordinate of 4, 8, 12, 16, etc.
-* '''[tile]''': whenever a building rule is applied, each [tile] tag corresponds to a tile on the map. The corresponding tile must match each condition contained in [tile] for the [tile] tag to match. All [tile] tags must match in order for a rule to match. If the rule for a [tile] tag is applied, each action within [tile] will be executed on the tile corresponding to that [tile] tag
+* '''[tile]''': whenever a building rule is applied, each [tile] tag corresponds to a tile on the map. The corresponding tile must match each condition contained in [tile] for the [tile] tag to match. All [tile] tags must match in order for a rule to match. If the rule for a [tile] tag is applied, each action within [tile] will be executed on the tile corresponding to that [tile] tag. See [[#The_.5Btile.5D_subtag|below]] for details.
-* '''[image]''': image may also be used directly in the rule, to specify multihex images. The following additional attributes are recognized for multihex images (as well as all the ones for images within '''[tile]''').
+* '''[image]''': image may also be used directly in the rule, to specify multihex images. The following additional attributes are recognized for multihex images (as well as all the ones for images within '''[tile]'''). See [[#The_.5Bimage.5D_subtag|below]] for details.
 * '''probability''': the percent probability for each position that if the position matches, then the rule will be applied. Default is 100(%).
 * '''rotations''': 6 comma(''',''') separated input strings. A rule that contains this key is not actually checked against the terrain; it instead is used as a template to create 6 new rules, each corresponding to a rotated version of the current rule. Whenever a rotated version is applied, instances of @(at-sign)R0, @R1, ... @R6 in attributes in the [terrain_graphics] tag will be adjusted by the corresponding amount and replaced with the letters specified by that numbered rotation in the ''rotations'' list. Each value corresponds to the rotated version that is -Pi/3 (60° clockwise) from the previous version; the first value corresponds to the unrotated version.<br>For example, if '''rotations=n,ne,se,s,sw,nw''' and it is being rotated 120°, then "@R0"->"@R2"->"se", "@R1"->"@R3"->"s", ... "@R6"->"@R1"->"ne".<br>Basically the important thing is that this lets the rule be applied in any of the six hex-directions, allowing you to adjust the name of the image files automatically.

@@ Line 104: / Line 104: @@
 * [[ReferenceWML]]
 * [[ImagePathFunctions]]
 * [[TerrainGraphicsReference]] - Second (partial) half of Ayin's document, wikified
 * [[TerrainMacros]] - Some somewhat old documentation of macros that can be used for terrain graphics
 [[Category: WML Reference]]