User Tools

Site Tools


openomf:animation_string

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
openomf:animation_string [2023/04/21 19:49] joneirikopenomf:animation_string [2024/10/17 14:37] (current) – [M-O] katajakasa
Line 1: Line 1:
 ===== Animation string ===== ===== Animation string =====
 +[[omf2097_file_formats|<-back]]
  
-|[[omf2097_file_formats|<back]]|+Animation Strings are the code inside the .AF files (HAR/Bots), that defines how moves and various other things works. They're a string of various tags and values, that instructs the game/engine on what actions to pull at what stage of each move etc. This page is a list of all the tags and with what the OpenOMF team have figured out about them so far.
  
-==== 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 ''italics'' may be unreliable. Here's a complete list of all tags. Descriptions in ''italics'' may be unreliable.
  
-=== 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 - indicates how many palette entries to copy? used with bc 
-| bc<n> | Only used by CREDITS.BK |+| bc<n> | Only used by CREDITS.BK - indicates the number of palette entries to copy? used with ba|
 | 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 - some kind of offset or counter used with ba/bc and possibly bpn|
 | bk<n> | crashes if not in arena? | | bk<n> | crashes if not in arena? |
 | bn | Unblockable.  Used in Flail's Spinning Throw, Shadow's Shadow Grab, and Nova's Earthquake Smash | | bn | Unblockable.  Used in Flail's Spinning Throw, Shadow's Shadow Grab, and Nova's Earthquake Smash |
Line 113: Line 117:
 | by | | | by | |
  
-=== C===+==== C ====
  
 ^ Tag ^ Notes ^ ^ Tag ^ Notes ^
Line 133: Line 137:
 | cy<n> | The player has vertical control by holding up/down. Larger numbers mean faster movement. | | 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. <code> | mp<n> | Bitmask (1 byte). Affects at least how mn tag is handled. <code>
-0x1  Unknown+0x1  Run sprite pixel colors through the palette remapping multiple times (how many?)
 0x2  Unknown 0x2  Unknown
-0x4  Somehow refers to HAR 1+0x4  Unknown, HAR 1 related ?
 0x8  Unknown 0x8  Unknown
-0x10 Somehow refers to HAR 2 +0x10 Unknown, HAR 2 related ? 
-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 215: Line 219:
 | 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<n+1>, overrides sl if both sl and se are present in this frame. | | se<n> | similar to sl<n+1>, overrides sl if both sl and se are present in this frame. |
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 | 'velocity' modifier for x/y tags | | v | 'velocity' modifier for x/y tags |
 | 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
 </code> </code>
 +
 +----
  
 ==== Error handling ==== ==== Error handling ====
Line 380: Line 388:
 ^ Tag ^ Used by ^ Notes ^ ^ Tag ^ Used by ^ Notes ^
 | zc | Pyros' Shadow Super Thrust <code>x+4zcubs21l50zp</code> | Probably a typo for zp. It looks like someone added 'zp's at the end of all the tags later when it was found to be not working properly (probably because of this zc). The tags for the frames before and after both contain zp. | | zc | Pyros' Shadow Super Thrust <code>x+4zcubs21l50zp</code> | Probably a typo for zp. It looks like someone added 'zp's at the end of all the tags later when it was found to be not working properly (probably because of this zc). The tags for the frames before and after both contain zp. |
 +
 +----
openomf/animation_string.1682128195.txt.gz · Last modified: 2023/04/21 19:49 by joneirik