Effectwml - Revision history

Shiki: specials_list inside [set_specials]

2025-12-16T00:30:54Z

specials_list inside [set_specials]

Shiki: abilities_list

2025-12-15T21:22:05Z

abilities_list

Shiki: document set_alignment

2025-11-30T14:47:16Z

document set_alignment

Celtic Minstrel: typo

2025-11-05T01:25:15Z

typo

Bssarkar: /* [effect] */

2025-11-03T04:13:48Z

‎[effect]

Bssarkar: /* [effect] */ Add abilities key (PR #10644)

2025-11-03T04:13:04Z

‎[effect]: Add abilities key (PR #10644)

Celtic Minstrel: typo

2025-09-07T01:27:51Z

typo

Shiki: /* Examples */ use syntax highlighting

2025-06-24T14:42:29Z

‎Examples: use syntax highlighting

Shiki: Document set and set_total for hitpoints

2025-03-04T18:11:05Z

Document set and set_total for hitpoints

Newfrenchy83 at 17:17, 3 November 2024

2024-11-03T17:17:35Z

@@ Line 22: / Line 22: @@
 ** '''set_icon''': change the attack's icon.
 ** {{anchor|set_specials|'''[set_specials]'''}}: change the attack's specials. The specials to add are given exactly as in the [[AbilitiesWML#The_.5Bspecials.5D_tag|[specials]]] tag.
 *** '''mode''': if '''append''', adds the given specials to the attack. If '''replace''', replaces the existing specials with the given ones. Default '''replace'''.
 **** {{DevFeature1.15|3}} A deprecation warning is triggered unless the '''mode''' attribute is set, although the effect will still be '''replace'''. This is to allow the default to change in the 1.17.x series.

@@ Line 109: / Line 109: @@
 *** To remove a note, you can simply suffix '''{NOTE_REMOVE}''' to the regular note macro, eg '''{NOTE_HEALS}{NOTE_REMOVE}'''.
 * {{anchor|apply_to-new_ability|'''new_ability'''}}: Adds one or more abilities to a unit.
-** '''abilities''': {{DevFeature1.19|17}} A comma-separated list of ability [[AbilitiesWML#Common_keys_and_tags_for_every_ability|'''unique_id''']]s. If defined in the registry [[UnitsWML#.5Babilities.5D|[units][abilities]]], these will be added to this effect as if their full definition was included in '''[abilities]'''. Example: ''abilities=heals_8,regenerates''.
+** '''abilities_list''': {{DevFeature1.19|18}} A comma-separated list of ability [[AbilitiesWML#Common_keys_and_tags_for_every_ability|'''unique_id''']]s. If defined in the registry [[UnitsWML#.5Babilities.5D|[units][abilities]]], these will be added to this effect as if their full definition was included in '''[abilities]'''. Example: ''abilities=heals_8,regenerates''.
 ** '''[abilities]''': A subtag that contains the ability definitions.
 * '''remove_ability''': Removes one or more abilities from a unit. Abilities are not reference counted. Adding twice and removing once still means the ability is gone.

@@ Line 38: / Line 38: @@
 ** '''set_movement_used''' {{DevFeature1.13|2}} like increase_movement_used, but sets the movement used to a specific value instead of setting it relative to its original value
 ** '''set_attacks_used''' {{DevFeature1.17|13}} like increase_attacks_used, but sets the attacks used to a specific value instead of setting it relative to its original value
 ** '''attack_weight''': change the attack's attack_weight. See [attack] in [[UnitTypeWML#Attacks|UnitTypeWML]] for explanations about attack_weight.
 ** '''defense_weight''': change the attack's defense_weight. See [attack] in [[UnitTypeWML#Attacks|UnitTypeWML]] for explanations about defense_weight.

@@ Line 108: / Line 108: @@
 *** To remove a note, you can simply suffix '''{NOTE_REMOVE}''' to the regular note macro, eg '''{NOTE_HEALS}{NOTE_REMOVE}'''.
 * {{anchor|apply_to-new_ability|'''new_ability'''}}: Adds one or more abilities to a unit.
-** '''abilities''': {{DevFeature1.19|17}} A comma-separated list of ability [[AbilitiesWML#Common_keys_and_tags_for_every_ability|'''unique_id''']]s. If defined in the registry [[UnitsWML#.5Babilities.5D|[units][abilities]]], these will be added to this effect as if there full definition was included in '''[abilities]'''. Example: ''abilities=heals_8,regenerates''.
+** '''abilities''': {{DevFeature1.19|17}} A comma-separated list of ability [[AbilitiesWML#Common_keys_and_tags_for_every_ability|'''unique_id''']]s. If defined in the registry [[UnitsWML#.5Babilities.5D|[units][abilities]]], these will be added to this effect as if their full definition was included in '''[abilities]'''. Example: ''abilities=heals_8,regenerates''.
 ** '''[abilities]''': A subtag that contains the ability definitions.
 * '''remove_ability''': Removes one or more abilities from a unit. Abilities are not reference counted. Adding twice and removing once still means the ability is gone.

@@ Line 108: / Line 108: @@
 *** To remove a note, you can simply suffix '''{NOTE_REMOVE}''' to the regular note macro, eg '''{NOTE_HEALS}{NOTE_REMOVE}'''.
 * {{anchor|apply_to-new_ability|'''new_ability'''}}: Adds one or more abilities to a unit.
-* '''abilities''': {{DevFeature1.19|17}} A comma-separated list of ability [[AbilitiesWML#Common_keys_and_tags_for_every_ability|'''unique_id''']]s. If defined in the registry [[UnitsWML#.5Babilities.5D|[units][abilities]]], these will be added to this effect as if there full definition was included in '''[abilities]'''. Example: ''abilities=heals_8,regenerates''.
+** '''abilities''': {{DevFeature1.19|17}} A comma-separated list of ability [[AbilitiesWML#Common_keys_and_tags_for_every_ability|'''unique_id''']]s. If defined in the registry [[UnitsWML#.5Babilities.5D|[units][abilities]]], these will be added to this effect as if there full definition was included in '''[abilities]'''. Example: ''abilities=heals_8,regenerates''.
 ** '''[abilities]''': A subtag that contains the ability definitions.
 * '''remove_ability''': Removes one or more abilities from a unit. Abilities are not reference counted. Adding twice and removing once still means the ability is gone.

@@ Line 52: / Line 52: @@
 ** '''increase_total''': will increase the total HP of the unit.  Can be specified either as a negative or a positive value.  It can also be specified as a percentage of the current total; i.e. "-50%" will cut max HP in half.
 ** '''set_total''': will set the unit's max HP to the specified value.
-** '''violate_maximum''': it the unit ends up with more than its max HP after these modifications, and this key is present (set to any non-null value, ex. '''yes'''), the unit's HP won't be lowered to its max HP.
+** '''violate_maximum''': if the unit ends up with more than its max HP after these modifications, and this key is present (set to any non-null value, ex. '''yes'''), the unit's HP won't be lowered to its max HP.
 * {{anchor|apply_to-movement|'''movement'''}}: modifies the unit's movement points.
 ** '''increase''': maximum movement is increased by this amount. It can be positive, negative, or specified as a percentage.

@@ Line 169: / Line 169: @@
 This is the only way to change animations of units after they have been placed on the map.
 In this example, I add very simple idle animation (taken from Goblin Spearman) to the unit, which moves to hex (x=1, y=5). If you want something more complex, you need to check [[AnimationWML]] page.
+<syntaxhighlight lang='wml'>
-  [event]
+[event]
-     name = moveto
+     name=moveto
      [filter]
-      x,y = 1,5
+        x,y = 1,5
      [/filter]
      [object]
-      [filter]
+        [filter]
-        x,y = 1,5
+            x,y=1,5
-      [/filter]
+        [/filter]
-      [effect]
+        [effect]
-        apply_to = new_animation
+            apply_to=new_animation
-        [idle_anim]
+            [idle_anim]
-          {STANDARD_IDLE_FILTER}
+                {STANDARD_IDLE_FILTER}
-          start_time=0
+                start_time=0
-          [frame]
+                [frame]
-            image="units/goblins/spearman-idle-[1~12].png:[150*3,300,150*8]"
+                    image="units/goblins/spearman-idle-[1~12].png:[150*3,300,150*8]"
-          [/frame]
+                [/frame]
-        [/idle_anim]
+            [/idle_anim]
-      [/effect]
+        [/effect]
      [/object]
-  [/event]
+[/event]
+</syntaxhighlight>
 If you are going to use '''advanced WML''' and want to add animation to unit, stored in variable, then following example might help you. '''This way is not efficient if you have no additional logic like inventoriy, shops, advanced unit modifications in your add-on.''' Is is preferred to use first variant or define all needed animation in unit_type.
-  [event]
+<syntaxhighlight lang='wml'>
-     name = moveto
+[event]
      [filter]
-      x,y = 1,5
+        x,y=1,5
      [/filter]
      [store_unit]
-      [filter]
+        [filter]
-        x,y=1,5
+            x,y=1,5
-      [/filter]
+        [/filter]
-      variable = stored_unit
+        variable=stored_unit
      [/store_unit]
      [set_variables]
-      name = stored_unit.modifications.object
+        name=stored_unit.modifications.object
-      [value]
+        [value]
-        [effect]
+            [effect]
-          apply_to = new_animation
+                apply_to=new_animation
-          [idle_anim]
+                [idle_anim]
-            {STANDARD_IDLE_FILTER}
+                    {STANDARD_IDLE_FILTER}
-            start_time=0
+                    start_time=0
-            [frame]
+                    [frame]
-              image="units/goblins/spearman-idle-[1~12].png:[150*3,300,150*8]"
+                        image="units/goblins/spearman-idle-[1~12].png:[150*3,300,150*8]"
-            [/frame]
+                    [/frame]
-          [/idle_anim]
+                [/idle_anim]
-        [/effect]
+            [/effect]
-      [/value]
+        [/value]
      [/set_variables]
      [unstore_unit]
-      variable = stored_unit
+        variable=stored_unit
      [/unstore_unit]
-  [/event]
+[/event]
 == Where to Use Effects ==

@@ Line 48: / Line 48: @@
 * {{anchor|apply_to-hitpoints|'''hitpoints'''}}: modifies the unit's HP and/or max HP.
 ** '''increase''': the amount to increase the unit's HP.
 ** '''heal_full''': if present  and not set to "no" the unit will be put back to full HP.
 ** '''increase_total''': will increase the total HP of the unit.  Can be specified either as a negative or a positive value.  It can also be specified as a percentage of the current total; i.e. "-50%" will cut max HP in half.
 ** '''violate_maximum''': it the unit ends up with more than its max HP after these modifications, and this key is present (set to any non-null value, ex. '''yes'''), the unit's HP won't be lowered to its max HP.
 * {{anchor|apply_to-movement|'''movement'''}}: modifies the unit's movement points.

@@ Line 25: / Line 25: @@
 **** {{DevFeature1.15|3}} A deprecation warning is triggered unless the '''mode''' attribute is set, although the effect will still be '''replace'''. This is to allow the default to change in the 1.17.x series.
 ** '''remove_specials''': remove the listed specials. The value of this key is the comma-separated list of the id of the specials to remove. This key is always evaluated before a [set_specials] tags in the same [effect]
 ** '''increase_damage''': increases the attack's damage.  This can be positive or negative, so you can use it to decrease damage as well.  If it ends in a percent(''''%''''), the change in damage will be a percentage ratio of the attack's original damage.
 ** '''increase_attacks''': increases the number of attack strikes. Like '''increase_damage''', it can be positive or negative, or a percentage.