Skip to content

Ball Holds

Related Config File Sections:

MPF's ball holds are used to temporarily hold a ball that has entered a Ball Devices while something else happens.

The most common use cases are to hold a ball while you play a show, or while a video mode is going on. Ball holds do not affect the balls in play count, and if all other balls drain while a ball hold is in progress, the players ball does not end.

Ball holds are not used to lock balls for multiball. (See the multiball_locks device for that).

You can have lots of different ball holds in your game, typically configured per mode.

Video about ball locks and multiballs:

Monitorable Properties

For dynamic values and conditional events, the prefix for ball holds is device.ball_holds.(name).

balls_held

: The number of balls this ball hold is currently holding

enabled

: Boolean (true/false) which shows whether this ball hold is enabled.

Something missing or wrong? You can fix it!

This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?

Please help us! You can fix it yourself and be an official "open source" contributor!

It's easy! See our Beginner's guide to editing the docs.

Page navigation via the keyboard: < >

You can navigate this site via the keyboard. There are two modes:

General navigation, when search is not focused:

  • F , S , / : open search dialog
  • P , , : go to previous page
  • N , . : go to next page

While using the search function:

  • Down , Up : select next / previous result
  • Esc , Tab : close search
  • Enter : go to highlighted page in the results