WML Abilities - Revision history

Pabliiiito1: /* Initiative */

2026-01-21T19:41:04Z

‎Initiative

Pabliiiito1: /* Knockback */

2026-01-21T17:01:38Z

‎Knockback

Shiki: /* Soultaker */ grey out special on undrainable opponents

2025-04-06T14:07:47Z

‎Soultaker: grey out special on undrainable opponents

Shiki: /* Soultaker */ indent

2025-04-06T14:06:51Z

‎Soultaker: indent

Shiki: Charm

2025-04-06T13:55:18Z

Charm

Name: Events can now be included directly in ability and weapon special tags

2024-11-23T21:10:02Z

Events can now be included directly in ability and weapon special tags

Celtic Minstrel: Recommending [resource] for this is overkill; putting events in the campaign tag is probably better in typical cases.

2023-02-14T02:15:24Z

Recommending [resource] for this is overkill; putting events in the campaign tag is probably better in typical cases.

Shiki: /* Whirlwind Attack */ update WML

2023-02-12T21:22:37Z

‎Whirlwind Attack: update WML

Show changes

Shiki: tweaks

2023-02-12T20:24:36Z

tweaks

Shiki: Delete 2nd charm ability

2023-02-11T22:55:51Z

Delete 2nd charm ability

Show changes

@@ Line 670: / Line 670: @@
 Initiative is an aura ability. Much like leadership, it affects adjacent allies but not the unit itself.
-The ability is used in HttT by Li’sar, you can copy the code from [https://github.com/wesnoth/wesnoth/blob/master/data/campaigns/Heir_To_The_Throne/utils/abilities.cfg data/campaigns/Heir_To_The_Throne/utils/abilities.cfg]
+The ability is used in HttT by Li’sar, you can copy the code from [https://github.com/wesnoth/wesnoth/blob/master/data/campaigns/Heir_To_The_Throne/utils/specials_and_abilities.cfg data/campaigns/Heir_To_The_Throne/utils/specials_and_abilities.cfg]
 == Blitz ==

@@ Line 57: / Line 57: @@
              greater_than=0
          [/variable]
+        [then]
              [store_locations]
                  [not]

@@ Line 491: / Line 491: @@
          name= _ "soultaker"
          description=_ "This unit gains an additional point added to its melee damage whenever it kills a living unit."
      [/dummy]
 #enddef

@@ Line 487: / Line 487: @@
 <syntaxhighlight lang='wml'>
 #define SOULTAKER_DUMMY
-   [dummy]
+    [dummy]
-       id=soultaker
+        id=soultaker
-       name= _ "soultaker"
+        name= _ "soultaker"
-       description=_ "This unit gains an additional point added to its melee damage whenever it kills a living unit."
+        description=_ "This unit gains an additional point added to its melee damage whenever it kills a living unit."
-   [/dummy]
+    [/dummy]
 #enddef

@@ Line 235: / Line 235: @@
 <syntaxhighlight lang='wml'>
 #define WEAPON_SPECIAL_CHARM
-     # dummy weapon special used to describe the effect to the user and filter on special's id
+     # dummy weapon special used to describe the effect to the user and filter on special's id.
      [dummy]
          id=weapon_charm
@@ Line 241: / Line 241: @@
          description= _ "Turns a living level 1 or level 0 unit to your side. Beware, if all of your attacks miss, the charm user turns to the defender side, even if it is your leader. You can not charm an enemy leader or a non-living creature."
          apply_to=opponent
          active_on=offense
      [/dummy]
 #enddef
 #define CHARMING_EVENTS
-     # event that creates a "charm has worked" variable
+     # Event that creates a "charm has worked" variable
      # and sets it to "yes" if the attacker hits at least once.
      [event]

@@ Line 1: / Line 1: @@
 The more complex abilities and weapon specials often consist of two parts:
 * The ability / weapon special, which is only a dummy to provide a description and to see whether a unit has this ability. It is something one gives to a unit. Mainline abilities / weapon specials only need this part.
-* One or multiple [event]s, which make things happen. These [event]s must be added to the game ''explicitly'', in addition to the unit with the ability / weapon special!
+* One or multiple [event]s, which make things happen. These can be included directly in the ability or weapon special tag {{DevFeature1.19|4}}. For earlier versions, these [event]s must be added to the game ''explicitly'', in addition to the unit with the ability or weapon special!
 How to include [event]s?
 * Add it directly to the scenario file.
 * Add it directly to the [era].

@@ Line 7: / Line 7: @@
 * Add it directly to the [era].
 * Add it inside a [unit_type] definition.
-* Add it inside a [resource].
+* Add it directly in your [campaign] tag.
 If you add it both via an [era] and and the scenario, they are added twice … i.e. the pickpocket ability would give the gold twice! To avoid that, give each event an '''id'''. This is even mandatory when adding it in a [unit_type].

@@ Line 262: / Line 262: @@
          [/filter_second]
-         [set_variable]
+         [modify_unit]
-             name=unit.variables.charm_has_worked
+             [filter]
-             value=yes
+                id=$unit.id
-        [/set_variable]
+             [/filter]
-        [unstore_unit]
+            [variables]
-             variable=unit
+                charm_has_worked=yes
-         [/unstore_unit]
+             [/variables]
      [/event]
      # Event that shifts a unit to the other side,
      # if the defending unit:
-     #       - was not lvl1 or lvl0
+     #       - is lvl0 or lvl1
-     #       - and was not a leader unit
+     #       - and is not a leader unit
-     #       - and was a not a "non-living" creature
+     #       - and is a not a "non-living" creature
      # Then:
      # -> if the attacker missed all attacks, it goes to the defender’s side.
@@ Line 304: / Line 305: @@
                  [unstore_unit]
                      variable=unit
-                     text="Charm failed!"
+                     text= _ "Charm failed!"
                      {COLOR_HARM}
                  [/unstore_unit]
@@ Line 312: / Line 313: @@
                  [unstore_unit]
                      variable=second_unit
-                     text="Charmed!"
+                     text= _ "Charmed!"
                      {COLOR_HEAL}
                  [/unstore_unit]
@@ Line 505: / Line 506: @@
          # [/filter_second_attack]
-        # only to display a text
+         [floating_text]
-         [unstore_unit]
+             x,y=$x2,$y2
-             variable=second_unit
+             text="<span color='#00ff00'>" + _ "+1 damage" + "</span>"
-            {COLOR_HEAL}
+         [/floating_text]
          [object]
@@ Line 576: / Line 575: @@
              [floating_text]
                  x,y=$this_item.x,$this_item.y
-                 text="<span color='#ffff00'>"+_"+1 gold"+"</span>"
+                 text="<span color='#ffff00'>" + _ "+1 gold" + "</span>"
              [/floating_text]
          [/do]
@@ Line 620: / Line 619: @@
      first_time_only=no
      [filter_attack]
-         special_id=mind flay
+         special_id=mind_flay
      [/filter_attack]
      {VARIABLE hit_number 0}
@@ Line 628: / Line 627: @@
      first_time_only=no
      [filter_attack]
-         special_id=mind flay
+         special_id=mind_flay
      [/filter_attack]
      {VARIABLE_OP hit_number add 1}
@@ Line 636: / Line 635: @@
      first_time_only=no
      [filter_attack]
-         special_id=mind flay
+         special_id=mind_flay
      [/filter_attack]
      {VARIABLE_OP second_unit.experience sub $hit_number}