This is the dev documentation for an unreleased 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. 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.


MPF Event

A ball is starting. This is a queue event, so the ball won’t actually start until the queue is cleared.

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

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