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.

balldevice_(name)_ball_eject_attempt

MPF Event

The ball device called “name” is attempting to eject a ball (or balls). This is a queue event. The eject will not actually be attempted 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.)

balls
The number of balls that are to be ejected.
mechanical_eject
Boolean as to whether this is a mechanical eject.
num_attempts
How many eject attempts have been tried so far.
source
The source device that will be ejecting the balls.
target
The target ball device that will receive these balls.

Event is posted by ball_devices: