Warning

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

This is the documentation for MPF 0.57, 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. You can always update to the latest at any time.

ball_will_start

MPF Event

The ball is about to start. This event is posted just before ball_starting.

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.)

ball
The ball number
balls_remaining
The number of balls left in the game (not including this one)
is_extra_ball
True if this ball is an extra ball (default False)
player
The player number