AnimationWML - Revision history

Soliton: /* Progressive strings */

2024-07-11T16:53:19Z

‎Progressive strings

Soliton: /* Progressive strings */ typo fix

2024-07-11T16:50:51Z

‎Progressive strings: typo fix

Celtic Minstrel: /* Conditional Branches */ Try to be a bit more clear that if/else syntax is basically a clone of the toplevel animation syntax

2024-04-19T01:16:36Z

‎Conditional Branches: Try to be a bit more clear that if/else syntax is basically a clone of the toplevel animation syntax

Celtic Minstrel: Move the list of events under /* How animations are chosen */

2024-02-26T06:46:22Z

Move the list of events under ‎How animations are chosen

Show changes

Celtic Minstrel: /* Shorthand Animation Tags */ Strip more _anim suffixes from anchors

2024-02-26T06:35:28Z

‎Shorthand Animation Tags: Strip more _anim suffixes from anchors

Celtic Minstrel: /* Shorthand Animation Tags */ Strip some _anim suffixes from anchors

2024-02-26T06:34:33Z

‎Shorthand Animation Tags: Strip some _anim suffixes from anchors

Celtic Minstrel: Rewrite page to give a clearer summary of the available syntax

2024-02-26T06:28:02Z

Rewrite page to give a clearer summary of the available syntax

Show changes

Celtic Minstrel: /* Cycling */ typos and commas

2024-02-25T01:20:48Z

‎Cycling: typos and commas

Celtic Minstrel: /* Optimization */ typos

2024-02-25T01:19:54Z

‎Optimization: typos

Egallager: /* See Also */ additional link

2023-04-01T04:08:11Z

‎See Also: additional link

@@ Line 686: / Line 686: @@
 If '''<var>x</var> < <var>y</var>''', then the numbers in this list increase by increments of 1; if '''<var>x</var> > <var>y</var>''', then the numbers in this list decrease by decrements of 1. E.g., “1~3” would become “1,2,3”, and “3~1” would become “3,2,1”.
-If '''<var>x</var> = <var>y</var>''', then this list has only one element, which is <var>x</var> (and is also <var>y</var>, of course). E.g., “2~2” would becomes “2”.
+If '''<var>x</var> = <var>y</var>''', then this list has only one element, which is <var>x</var> (and is also <var>y</var>, of course). E.g., “2~2” would become “2”.
 As with progressive numbers, ranges can not only be from a lesser number to a greater number (e.g., “1~5”), but can also be '''backward''' — from a greater number to a lesser number (e.g., “5~1”).

@@ Line 668: / Line 668: @@
 | <tt>halo=halo[5~3,1].png</tt> || <tt>halo=halo5.png,halo4.png,halo3.png,halo1.png</tt>
 |-
-| <tt>image=image[1~2]-ex[4~5].png:[100,200]</tt> || <tt>image=image1-ex4.png:100,image2-ex5:200.png</tt>
+| <tt>image=image[1~2]-ex[4~5].png:[100,200]</tt> || <tt>image=image1-ex4.png:100,image2-ex5.png:200</tt>
 |-
 | <tt>image=image[1~4].png:[10,20*3]</tt> || <tt>image1.png:10,image2.png:20,image3.png:20,image4.png:20</tt>

@@ Line 344: / Line 344: @@
 Often, you need to do very slight variations in an animation (like a different sound depending on whether the unit hits or misses its attack). The '''[if]''' and '''[else]''' tags are meant to help you do that.  ('''Attention:''' These do not have the same syntax as the action tag [if] and its subtag [else] in [[ConditionalActionsWML]].)
-Using these in an animation is equivalent to having multiple animations, one with the '''[if]''' block and one with each of the ''[else]'' blocks. Any filtering flags in these blocks will replace the toplevel filters. You can have multiple '''[if]''' blocks in an animation, and from 1.11.7+ you can nest an '''[if]''' inside another. These should be written directly inside the '''[animation]''' block. The following example would make the '''[frame]''' inside the '''[if]''' be played when the attack misses, and the '''[frame]''' inside the '''[else]''' be played when the attack hits (producing a different sound):
+Using these in an animation is equivalent to having multiple animations, one with the '''[if]''' block and one with each of the '''[else]''' blocks. In other words, an '''[if]''' or '''[else]''' tag has the same possible content as the '''[animation]''' tag. Any filtering flags in these blocks will replace the toplevel filters of the same type. You can have multiple '''[if]''' blocks in an animation, and from 1.11.7+ you can nest an '''[if]''' inside another. These should be written directly inside the '''[animation]''' block. The following example would make the '''[frame]''' inside the '''[if]''' be played when the attack misses, and the '''[frame]''' inside the '''[else]''' be played when the attack hits (producing a different sound):
 <syntaxhighlight lang=wml>

@@ Line 300: / Line 300: @@
 |An [[#event-idling|idling]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-levelout_anim|[levelout_anim]}}
+! {{anchor|short-levelout|[levelout_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 309: / Line 309: @@
 |A [[#event-levelout|level out]] advancement animation.
 |- style="vertical-align:top;"
-! {{anchor|short-levelin_anim|[levelin_anim]}}
+! {{anchor|short-levelin|[levelin_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 318: / Line 318: @@
 |A [[#event-levelin|level in]] advancement animation.
 |- style="vertical-align:top;"
-! {{anchor|short-healing_anim|[healing_anim]}}
+! {{anchor|short-healing|[healing_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 328: / Line 328: @@
 |A [[#event-healing|healing]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-healed_anim|[healed_anim]}}
+! {{anchor|short-healed|[healed_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 341: / Line 341: @@
 |A [[#event-healed|healed]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-poison_anim|[poison_anim]}}
+! {{anchor|short-poison|[poison_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 354: / Line 354: @@
 |A [[#event-poisoned|poisoned]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-movement_anim|[movement_anim]}}
+! {{anchor|short-movement|[movement_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 364: / Line 364: @@
 |A [[#event-movement|movement]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-pre_movement_anim|[pre_movement_anim]}}
+! {{anchor|short-pre_movement|[pre_movement_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 373: / Line 373: @@
 |A [[#event-pre_movement|pre-movement]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-post_movement_anim|[post_movement_anim]}}
+! {{anchor|short-post_movement|[post_movement_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 382: / Line 382: @@
 |A [[#event-post_movement|post-movement]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-draw_weapon_anim|[draw_weapon_anim]}}
+! {{anchor|short-draw_weapon|[draw_weapon_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 391: / Line 391: @@
 |A [[#event-draw_weapon|draw weapon]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-sheath_weapon_anim|[sheath_weapon_anim]}}
+! {{anchor|short-sheath_weapon|[sheath_weapon_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 416: / Line 416: @@
 There are some subtle changes compared to what is described here to avoid the red flash when value=0, but it should work as expected as far as WML author is concerned.
 |- style="vertical-align:top;"
-! {{anchor|short-attack_anim|[attack_anim]}}
+! {{anchor|short-attack|[attack_anim]}}
 | If the animation contains a missile frame:
 <syntaxhighlight lang=wml>
@@ Line 447: / Line 447: @@
 |A [[#event-death|death]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-victory_anim|[victory_anim]}}
+! {{anchor|short-victory|[victory_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 456: / Line 456: @@
 |A [[#event-victory|victory]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-extra_anim|[extra_anim]}}
+! {{anchor|short-extra|[extra_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 465: / Line 465: @@
 |An [[#Custom animation events|extra custom]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-teleport_anim|[teleport_anim]}}
+! {{anchor|short-teleport|[teleport_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]

@@ Line 255: / Line 255: @@
 !style="width"40%"|Notes
 |- style="vertical-align:top;"
-! {{anchor|short-leading_anim|[leading_anim]}}
+! {{anchor|short-leading|[leading_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 264: / Line 264: @@
 |A [[#event-leading|leading]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-recruit_anim|[recruit_anim]}}
+! {{anchor|short-recruit|[recruit_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 273: / Line 273: @@
 |A [[#event-recruited|recruited]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-recruiting_anim|[recruiting_anim]}}
+! {{anchor|short-recruiting|[recruiting_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 282: / Line 282: @@
 |A [[#event-recruiting|recruiting]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-standing_anim|[standing_anim]}}
+! {{anchor|short-standing|[standing_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]
@@ Line 291: / Line 291: @@
 | This animation will be used to build [[#event-default|default]] animations in addition to being used as the [[#event-standing|standing]] animation.
 |- style="vertical-align:top;"
-! {{anchor|short-idle_anim|[idle_anim]}}
+! {{anchor|short-idle|[idle_anim]}}
 | <syntaxhighlight lang=wml>
 [animation]

@@ Line 801: / Line 801: @@
 == Cycling ==
-there is a special boolean parameter that can be put in an animation block (not the frame)
+There is a special boolean parameter that can be put in an animation block (not the frame):
-* ''cycles'' a boolean value. if set to true the animation will cycles forever until it is replaced. That animation will not influence the end time of all related animations (for example a cycling defense animation will play normally but the overall duration of the fight animation will be only decided by the attack animation)
+* ''cycles'' a boolean value. If set to true, the animation will cycle forever until it is replaced. That animation will not influence the end time of all related animations (for example, a cycling defense animation will play normally, but the overall duration of the fight animation will be decided only by the attack animation).
 == See Also ==

@@ Line 795: / Line 795: @@
 == Optimization ==
-there is a special flag that goes into the animation block (not the frame)
+There is a special flag that goes into the animation block (not the frame):
-* ''offscreen'' a boolean saying if the unit's animation should be played when the unit is offscreen. You want the animation to play offscreen if the animation contains some usefull sound effects.This attribute defaults to true (play offscreen) except for standing and idle animations where it defaults to false
+* ''offscreen'' a boolean saying if the unit's animation should be played when the unit is offscreen. You want the animation to play offscreen if the animation contains some useful sound effects. This attribute defaults to true (play offscreen) except for standing and idle animations where it defaults to false.
 == Cycling ==

@@ Line 809: / Line 809: @@
 * [[UnitTypeWML]]
 * [[ReferenceWML]]
+* [[Advanced Animation Tutorial]]
 [[Category: WML Reference]]