Sequence Step (Data Type)

One position in the key_sequence of apoli:action_on_key_sequence. It is written either as a plain String naming a key, or as an Object when that position needs to be a multi-tap or a hold.

"key.origins.primary_active"

{
  "key": "key.origins.primary_active",
  "taps": 2,
  "max_gap": 6
}

Fields

Field	Type	Default	Description
`key`	Key	required	The keybinding this position expects.
`taps`	Integer	`1`	How many presses of that key complete this position. `2` is a double tap and `3` a triple. The most is `16`.
`hold`	Integer	`0`	Ticks the key must stay down after the last of those presses. `0` means the press alone is enough. The most is `1200`.
`max_gap`	Integer	`0`	Ticks allowed before this position's press, and between its own taps. `0` means only the power's `timeout` applies. The most is `1200`.

A bare string is exactly { "key": "<that key>", "taps": 1, "hold": 0, "max_gap": 0 }, so a combo written as plain strings works the same either way.

Taps

taps is a shorter way to write the same key several times in a row. These two are the same combo:

"key_sequence": [
  "key.apoli.primary_active",
  "key.apoli.primary_active",
  "key.apoli.secondary_active"
]

"key_sequence": [
  {
    "key": "key.apoli.primary_active",
    "taps": 2
  },
  "key.apoli.secondary_active"
]

The difference is that a step can carry a max_gap, which the expanded form can't. { "taps": 2, "max_gap": 6 } is a real double tap, two presses within 6 ticks, while two plain entries only have to land within the power's much longer timeout.

Holds

hold makes the position finish on the key still being down instead of on the press. The combo only moves on after the key has been held for that many ticks, and letting go early breaks the run and fires fail_action.

Three presses of the same key, with the last one held for half a second:

"key_sequence": [
  "key.origins.primary_active",
  "key.origins.primary_active",
  {
    "key": "key.origins.primary_active",
    "hold": 10
  }
]

Written with taps, which is the same thing:

"key_sequence": [
  {
    "key": "key.origins.primary_active",
    "taps": 3,
    "hold": 10
  }
]

A hold on the last position means success_action runs when the hold completes, not when the key goes down. A hold in the middle only gates the rest of the combo. Once it completes the matcher carries on, and the key doesn't have to stay down.

note

While a hold is counting down, the combo ignores further presses, so a key that is already down can't advance the next position. If the position after a hold uses the same key, the player has to let go and press it again.