Warning

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.

balldevice_(name)_ball_entered

MPF Event

A ball (or balls) have just entered the ball device called “name”.

The ball was also added to balls and available_balls of the device.

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

device
A reference to the ball device object that is posting this event.
new_balls
The number of new balls that have not been claimed (by locks or similar).

Event is posted by ball_devices: