This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
openomf:animation_string [2021/08/13 15:05] – external edit 127.0.0.1 | openomf:animation_string [2024/10/17 14:37] (current) – [M-O] katajakasa | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== Animation string ===== | ===== Animation string ===== | ||
+ | [[omf2097_file_formats|< | ||
- | |[[omf2097_file_formats|< | + | Animation Strings are the code inside the .AF files (HAR/Bots), that defines how moves and various other things works. They' |
- | ==== Basic format ==== | + | ---- |
+ | ===== Basic format | ||
Animation strings are of the form: | Animation strings are of the form: | ||
Line 25: | Line 27: | ||
| x-1 | D | 1 | | | x-1 | D | 1 | | ||
- | ==== Tags ==== | + | ---- |
+ | |||
+ | ===== Tags ===== | ||
There are a lot of available tags. Not all of them are understood. Some of them take numeric parameters, which are indicated in angle brackets below. Such parameters must match the regular expression: | There are a lot of available tags. Not all of them are understood. Some of them take numeric parameters, which are indicated in angle brackets below. Such parameters must match the regular expression: | ||
Line 35: | Line 39: | ||
Here's a complete list of all tags. Descriptions in '' | Here's a complete list of all tags. Descriptions in '' | ||
- | === A- === | + | ==== A ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 55: | Line 59: | ||
| al | Never used? | | | al | Never used? | | ||
- | === B- === | + | ==== B ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 101: | Line 105: | ||
| bpo | bpo := 1 Disables palette effects. Only used in CREDITS.BK. | | | bpo | bpo := 1 Disables palette effects. Only used in CREDITS.BK. | | ||
| bz | If specified, a colour tint effect will be used, otherwise a green-blue lightning effect will be used. | | | bz | If specified, a colour tint effect will be used, otherwise a green-blue lightning effect will be used. | | ||
- | | ba<n> | Only used by CREDITS.BK | | + | | ba<n> | Only used by CREDITS.BK |
- | | bc<n> | Only used by CREDITS.BK | | + | | bc<n> | Only used by CREDITS.BK |
| bd | Only used by CREDITS.BK | | | bd | Only used by CREDITS.BK | | ||
| bg | Only used by CREDITS.BK | | | bg | Only used by CREDITS.BK | | ||
- | | bi<n> | Only used by CREDITS.BK | | + | | bi<n> | Only used by CREDITS.BK |
| bk<n> | crashes if not in arena? | | | bk<n> | crashes if not in arena? | | ||
- | | bn | | | + | | bn | Unblockable. |
| bo<n> | | | | bo<n> | | | ||
| br | Draw additively | | | br | Draw additively | | ||
Line 113: | Line 117: | ||
| by | | | | by | | | ||
- | === C- === | + | ==== C ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 119: | Line 123: | ||
| cg | Used by Katana' | | cg | Used by Katana' | ||
| cl | Used by Pyros' scrap (both parts) (AF3:35,38) | | | cl | Used by Pyros' scrap (both parts) (AF3:35,38) | | ||
- | | cp | | | + | | cp | resources/ |
| cw | Used by Flail' | | cw | Used by Flail' | ||
- | | cx<n> | Used by: | | + | | cx<n> | The player has horizontal control by holding left/right. Larger numbers mean faster movement. |
| ::: | < | | ::: | < | ||
- | | + | |
| | ||
- | | + | |
| | ||
| | ||
| | ||
- | | + | |
</ | </ | ||
- | | cy<n> | | | + | | cy<n> | The player has vertical control by holding up/down. Larger numbers mean faster movement. |
- | === D-I === | + | ==== D-I ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 143: | Line 147: | ||
| i | | | | i | | | ||
- | === J- === | + | ==== J ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 158: | Line 162: | ||
| jn<n> | Frame can chain to animation <n> | | | jn<n> | Frame can chain to animation <n> | | ||
- | === K-L === | + | ==== K-L ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 164: | Line 168: | ||
| l<n> | The volume of the sound. The range of n is 0 to 100 (0 effectively mutes the sound, no differences above 100) | | | l<n> | The volume of the sound. The range of n is 0 to 100 (0 effectively mutes the sound, no differences above 100) | | ||
- | === M-O === | + | ==== M-O ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 175: | Line 179: | ||
| mo | Enables some flag on animation selected with MM. Possibly used on other HAR ? | | | mo | Enables some flag on animation selected with MM. Possibly used on other HAR ? | | ||
| mu<n> | Sets animation MM unavailable for use for the next <n> ticks. N < 1024. | | | mu<n> | Sets animation MM unavailable for use for the next <n> ticks. N < 1024. | | ||
- | | mn<n> | | | + | | mn<n> | Sets z-index for the current and following animation sprites and created animations (by m tag). 0 disables, 1-n enables. Empty value means 0. | |
| mp<n> | Bitmask (1 byte). Affects at least how mn tag is handled. < | | mp<n> | Bitmask (1 byte). Affects at least how mn tag is handled. < | ||
- | 0x1 | + | 0x1 |
0x2 Unknown | 0x2 Unknown | ||
- | 0x4 | + | 0x4 |
0x8 Unknown | 0x8 Unknown | ||
- | 0x10 Somehow refers to HAR 2 | + | 0x10 Unknown, |
- | 0x20 Flip X axis operations | + | 0x20 Unknown |
0x40 Unknown | 0x40 Unknown | ||
0x80 Unknown | 0x80 Unknown | ||
Line 196: | Line 200: | ||
| oy<n> | Y coordinate correction; is only applied while ox tag is enabled. | | | oy<n> | Y coordinate correction; is only applied while ox tag is enabled. | | ||
- | === P-T === | + | ==== P-T ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
Line 210: | Line 214: | ||
| ptp< | | ptp< | ||
| ptr< | | ptr< | ||
- | | q<n> | Enable hit on current and the next n-1 frames. | | + | | q<n> | Enable |
| r |toggle a global Flip sprite horizontally | | r |toggle a global Flip sprite horizontally | ||
| s<n> | Play sound n. Also resets the sf and sb values to default. | | | s<n> | Play sound n. Also resets the sf and sb values to default. | | ||
| sa | | | | sa | | | ||
| sb<n> | Sound panning. The range of n is -100 (far left) to 100 (Far right). Value above 126 causes overflow to -128, value lower than -128 is capped to -128. | | | sb<n> | Sound panning. The range of n is -100 (far left) to 100 (Far right). Value above 126 causes overflow to -128, value lower than -128 is capped to -128. | | ||
- | | sc<n> | sc0 is different from other sc tags | | + | | sc<n> | sc0 is different from other sc tags -- This is possibly sound channel selection |
| sd | | | | sd | | | ||
| se<n> | similar to sl< | | se<n> | similar to sl< | ||
Line 235: | Line 239: | ||
| sw<n> | sw<n> sets an internal counter to max(current value, n). This counter is decreased at a rate of either 2 or 4 units per game tick, down to 0. If the counter gets to 100 or above, the game pauses for a little while. | | | sw<n> | sw<n> sets an internal counter to max(current value, n). This counter is decreased at a rate of either 2 or 4 units per game tick, down to 0. If the counter gets to 100 or above, the game pauses for a little while. | | ||
- | === T-Z === | + | ==== T-Z ==== |
^ Tag ^ Notes ^ | ^ Tag ^ Notes ^ | ||
| t | Prevent sound from playing, if other HAR is blocking. | | | t | Prevent sound from playing, if other HAR is blocking. | | ||
- | | ua | Sets enemy HAR to damage animation, if not already set. | | + | | ua | Sets enemy HAR to damage animation, if not already set. Used to keep opponent immobilized during shadow grab, until the grab fades. | |
| ub | Motion blur effect for the current object | | | ub | Motion blur effect for the current object | | ||
| uc | | | | uc | | | ||
Line 252: | Line 256: | ||
| ur | | | | ur | | | ||
| us | | | | us | | | ||
- | | uz | | | + | | uz | Used in shadow grab. Causes the shadow to disappear when the opponent takes damage |
| v | ' | | v | ' | ||
| vsx | also does v. Never used? | | | vsx | also does v. Never used? | | ||
Line 285: | Line 289: | ||
| zp |0x0100 Player is invincible to projectiles | | | zp |0x0100 Player is invincible to projectiles | | ||
| zz |0xFFFF Combination of all other z flags. Player is invincible for this frame| | | zz |0xFFFF Combination of all other z flags. Player is invincible for this frame| | ||
+ | |||
+ | ---- | ||
==== ChaosBM Hidden Comments ==== | ==== ChaosBM Hidden Comments ==== | ||
Line 373: | Line 379: | ||
n: during recovery; or during entirety of Concussion Cannon | n: during recovery; or during entirety of Concussion Cannon | ||
</ | </ | ||
+ | |||
+ | ---- | ||
==== Error handling ==== | ==== Error handling ==== | ||
Line 380: | Line 388: | ||
^ Tag ^ Used by ^ Notes ^ | ^ Tag ^ Used by ^ Notes ^ | ||
| zc | Pyros' Shadow Super Thrust < | | zc | Pyros' Shadow Super Thrust < | ||
+ | |||
+ | ---- |