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_drain

MPF Event

A ball (or balls) has just drained. (More specifically, ball(s) have entered a ball device tagged with “drain”.)

This is a relay event.

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 balls that have just drained. Any balls remaining after the relay will be processed as newly-drained balls.
device
The ball device object that received the ball(s)