Warning

This is the dev documentation for an unreleased version of MPF!

This is the documentation for MPF 0.55+, which is the “dev” (next) release of MPF that is a work-in-progress. Unless you’re specifically looking for this version, you probably want to use the version of documentation called “latest” which is for the latest released version of MPF. That documentation is at docs.missionpinball.org/en/latest.

Kickbacks

Related Config File Sections
kickbacks:
ball_saves:

A kickback mechanism is a type of autofire coil that kicks the ball back into play, typically located in an outlane. It is often paired with a ball_save to compensate for missed kickbacks.

TODO: Add a picture of a kickback

This is an example:

switches:
  s_kickback:
    number: 5
coils:
  c_kickback:
    number: 7
    default_pulse_ms: 15
kickbacks:
  ac_kickback:
    coil: c_kickback
    switch: s_kickback
ball_saves:
  kickback_ball_save:
    active_time: 5s
    enable_events: kickback_ac_kickback_fired
    auto_launch: true
    balls_to_save: 1
This example is tested to be valid MPF config. However, it is not integration tested.
switches:
  s_kickback:
    number: 5
coils:
  c_kickback:
    number: 7
    default_pulse_ms: 15
kickbacks:
  ac_kickback:
    coil: c_kickback
    switch: s_kickback
ball_saves:
  kickback_ball_save:
    active_time: 5s
    enable_events: kickback_ac_kickback_fired
    auto_launch: true
    balls_to_save: 1

Monitorable Properties

For dynamic values and conditional events, the prefix for kickbacks is device.kickbacks.<name>.

enabled
Boolean (true/false) which shows whether this kickback is enabled.