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.


MPF Event

This even is posted when an extra ball is lit during play. It is NOT posted when a player’s turn starts if they have a lit extra ball from their previous turn. Therefore this event is a good event to use for your award slides and shows when a player lights the extra ball, because you don’t want to use extra_ball_group_(name)_lit because that is also posted when the player’s turn starts and you don’t want the award show to play again when they’re starting their turn.

This event does not have any keyword arguments

Event is posted by extra_ball_groups: