Warning

This is the documentation the latest work-in-progress version of MPF!

This is the documentation for MPF 0.56, which is the “dev” (next) release of MPF that is a work-in-progress. This is probably ok, and means you’ll be on the latest, cutting-edge version of MPF.

However, if you want a more stable version, select the v:stable version from the lower-left corner of this page, which is the most recent version that is not getting new updates.

If you are new to MPF, we have recently rewritten the installation process which only applies to this “latest” 0.56, so you probably want to stay here because the prior installation process doesn’t work on the latest OS and Python versions.

balls_in_play

MPF Event

The number of balls in play has just changed, and there is at least 1 ball in play.

Note that the number of balls in play is not necessarily the same as the number of balls loose on the playfield. For example, if the player shoots a lock and is watching a cut scene, there is still one ball in play even though there are no balls on the playfield.

Keyword arguments

(See the Conditional Events guide for details for how to create entries in your config file that only respond to certain combinations of the arguments below.)

balls
The number of ball(s) in play.