InterfaceActionsWML - Revision history

Lea: /* [remove_unit_overlay] */

2026-02-21T20:12:58Z

‎[remove_unit_overlay]

Lea at 20:10, 21 February 2026

2026-02-21T20:10:37Z

Pentarctagon: /* [sound_source] */

2025-11-10T17:18:21Z

‎[sound_source]

Octalot: /* [item] */ The image= is shown centered, not aligned to the top-left

2025-09-10T10:38:23Z

‎[item]: The image= is shown centered, not aligned to the top-left

Soliton: /* [label] */

2025-09-01T11:21:52Z

‎[label]

Laela: /* [message] */ second_image https://github.com/wesnoth/wesnoth/commit/cb63cd3778b870cd51c058fabaacc28db8b99e54

2025-07-06T12:14:08Z

‎[message]: second_image https://github.com/wesnoth/wesnoth/commit/cb63cd3778b870cd51c058fabaacc28db8b99e54

Soliton: /* [item] */

2025-07-02T12:10:08Z

‎[item]

Soliton: /* [item] */ fix external links

2025-07-02T12:09:22Z

‎[item]: fix external links

Soliton: /* [item] */ move example where it belongs

2025-07-02T12:02:09Z

‎[item]: move example where it belongs

Soliton: /* [item] */ document submerge and z_order

2025-07-02T11:57:47Z

‎[item]: document submerge and z_order

@@ Line 371: / Line 371: @@
 * '''object_id''': object id to use
 Using [[DirectActionsWML#.5Bremove_object.5D|'''[remove_object]''']] is also possible, see https://github.com/wesnoth/wesnoth/commit/26c2f941f2bcdd89528481e114c0375ad2a46271
 Note that [[DirectActionsWML#.5Bremove_object.5D|'''[remove_object]''']] also rebuilds affected units so any changes done via [modify_unit] (or via the [store_unit] + [set_variable] + [unstore_unit] technique) will be reset, unlike when using [remove_unit_overlay]

@@ Line 371: / Line 371: @@
 * '''object_id''': object id to use
 Using [[DirectActionsWML#.5Bremove_object.5D|'''[remove_object]''']] is also possible, see https://github.com/wesnoth/wesnoth/commit/26c2f941f2bcdd89528481e114c0375ad2a46271
 === [animate_unit] ===

@@ Line 310: / Line 310: @@
 * '''check_shrouded''': possible values ''yes'' and ''no'' - ''yes'' means the source will not play if its locations are shrouded
 * '''x,y''': similar to x,y as found in a [[StandardLocationFilter]], these are the locations associated with the sound source
-* '''fade_range''' (default = 3): distance in hexes that determines a "circular" area around the one specified by '''full_range''' where sound volume fades out linearly
+* '''fade_range''' (default = 14): distance in hexes that determines a "circular" area around the one specified by '''full_range''' where sound volume fades out linearly
-* '''full_range''' (default = 14): distance in hexes that determines a "circular" area where source plays with full volume, relative to screen center
+* '''full_range''' (default = 3): distance in hexes that determines a "circular" area where source plays with full volume, relative to screen center
 * '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)

@@ Line 197: / Line 197: @@
 Makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. <tt>''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros).)''</tt>
 * '''x''', '''y''': the location to place the item. (only for [event][item]: full [[StandardLocationFilter|SLF]] support)
-* '''image''': the image (in ''images/'' as .png) to place on the hex. This image is aligned with the top-left of the hex (which is 72 pixels wide and 72 pixels tall). It is drawn underneath units. ''('''Hint:''' If using an image smaller than 72x72, then it might be useful to [[ImagePathFunctions#Blit_Function|BLIT]] the image onto <tt>misc/blank-hex.png</tt> (a blank 72x72 image).)''
+* '''image''': the image (in ''images/'' as .png) to place on the hex. This image is aligned with the center of the hex (which is 72 pixels wide and 72 pixels tall). It is drawn underneath units. ''('''Hint:''' To position a small image somewhere other than the center, [[ImagePathFunctions#Blit_Function|BLIT]] the image onto <tt>misc/blank-hex.png</tt> (a blank 72x72 image). The image is centered since {{DevFeature1.17|7}}, previously the images were aligned to the top-left; however this difference doesn't affect any image BLITted onto blank-hex.png, as that is the same size as a hex.)''
 * '''halo''': an image to place centered on the hex. It is drawn on top of units. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image ([https://github.com/wesnoth/wesnoth/issues/1219 #1219]). ''Example (where the integer after the colon is the duration of each frame or square bracket expansion as per [[AnimationWML]] is used): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100'' or equivalently (requires Wesnoth 1.11.2+): ''halo=scenery/fire[1~8].png:100''
 * '''name''' an id that can be used to remove the item.

@@ Line 398: / Line 398: @@
 * '''immutable''': whether this label is protected from being removed or changed by players. Default yes.
 * '''category''': the Show/Hide Labels dialog allows showing/hiding all labels of a given category by toggling a checkbox.
-* '''tooltip''': A tooltip visible when mouseovering the hex the label is on
+* '''tooltip''': A tooltip visible when putting the mouse over the hex the label is on
 * '''side''': the number of the side that placed the label. Can be 0 for labels placed by WML.

@@ Line 31: / Line 31: @@
 ** {{DevFeature1.13|0}} <b>none:</b> display no image
 * '''mirror''': {{DevFeature1.13|5}} whether to mirror the image specified by the '''image''' attribute.
-* '''second_image''': {{DevFeature1.13|6}} same as the '''image''' attribute, but the image is displayed on the right of the message text. {{DevFeature1.17|7}} not working anymore, but there is plan to fix it eventually https://github.com/wesnoth/wesnoth/issues/8770
+* '''second_image''': {{DevFeature1.13|6}} same as the '''image''' attribute, but the image is displayed on the right of the message text. {{DevFeature1.17|7}} not working anymore {{DevFeature1.19|9}} working again
 * '''second_mirror''': {{DevFeature1.13|6}} same as '''mirror''', but for the '''second_image''' attribute.
 * '''image_pos''': {{DevFeature1.13|5}} whether to show the image on the left or right; supercedes the use of ~RIGHT() described above

@@ Line 198: / Line 198: @@
 * '''x''', '''y''': the location to place the item. (only for [event][item]: full [[StandardLocationFilter|SLF]] support)
 * '''image''': the image (in ''images/'' as .png) to place on the hex. This image is aligned with the top-left of the hex (which is 72 pixels wide and 72 pixels tall). It is drawn underneath units. ''('''Hint:''' If using an image smaller than 72x72, then it might be useful to [[ImagePathFunctions#Blit_Function|BLIT]] the image onto <tt>misc/blank-hex.png</tt> (a blank 72x72 image).)''
-* '''halo''': an image to place centered on the hex. It is drawn on top of units. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image (https://github.com/wesnoth/wesnoth/issues/1219). ''Example (where the integer after the colon is the duration of each frame or square bracket expansion as per AnimationWML is used): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100'' or equivalently (requires Wesnoth 1.11.2+): ''halo=scenery/fire[1~8].png:100''
+* '''halo''': an image to place centered on the hex. It is drawn on top of units. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image ([https://github.com/wesnoth/wesnoth/issues/1219 #1219]). ''Example (where the integer after the colon is the duration of each frame or square bracket expansion as per AnimationWML is used): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100'' or equivalently (requires Wesnoth 1.11.2+): ''halo=scenery/fire[1~8].png:100''
 * '''name''' an id that can be used to remove the item.
-* '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas. {{DevFeature1.15|0}} In 1.14 the '''[side]team_name''' attribute was expected to be a substring of this '''team_name'''. In 1.15 both are expected to be comma-separated lists of names and the item is visible if the lists intersect. ([[https://github.com/wesnoth/wesnoth/pull/3533|#3533]])
+* '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas. {{DevFeature1.15|0}} In 1.14 the '''[side]team_name''' attribute was expected to be a substring of this '''team_name'''. In 1.15 both are expected to be comma-separated lists of names and the item is visible if the lists intersect. ([https://github.com/wesnoth/wesnoth/pull/3533 #3533])
 * '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.
 * '''submerge''': float, between 0 and 1: specifies how much of the image should be submerged. Gets multiplied with [[TerrainWML|[terrain]]]<nowiki/>submerge. Default 0.
 * '''z_order''': float: defines the order the items get drawn in. Default 0.
 * '''redraw''': (boolean yes|no, default: yes): If no, disables implicit calls to [[InterfaceActionsWML#.5Bredraw.5D|[redraw]]] when placing the items.
-* '''[filter_team]''': {{DevFeature1.15|0}} A [[StandardSideFilter]]. Set '''team_name''' to the union of all '''[side]team_name''' attributes of all sides that match the SSF. ([[https://github.com/wesnoth/wesnoth/pull/3533|#3533]])
+* '''[filter_team]''': {{DevFeature1.15|0}} A [[StandardSideFilter]]. Set '''team_name''' to the union of all '''[side]team_name''' attributes of all sides that match the SSF. ([https://github.com/wesnoth/wesnoth/pull/3533 #3533])
 * {{DevFeature1.15|0}} If both '''team_name''' and '''[filter_team]''' are set, '''team_name''' is ignored.