This documentation is for an unreleased version of MPF!
This is the developer documentation for MPF 0.51, which is the “dev” (next) release of MPF that is a work-in-progress. Use the “Read the Docs” link in the lower left corner to view the developer docs for the version of MPF you’re using.
One playfield in a pinball machine.
Accessing playfields in code
The device collection which contains the playfields in your machine is available via
self.machine.playfields. For example, to access one called “foo”, you would use
self.machine.playfields.foo. You can also access playfields in dictionary form, e.g.
You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Playfields have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
add_ball(balls=1, source_device=None, player_controlled=False)¶
Add live ball(s) to the playfield.
- balls – Integer of the number of balls you’d like to add.
- source_device – Optional ball device object you’d like to add the ball(s) from.
- player_controlled – Boolean which specifies whether this event is player controlled. (See not below for details)
True if it’s able to process the add_ball() request, False if it cannot.
The source_device arg is included to give you an options for specifying the source of the ball(s) to be added. This argument is optional, so if you don’t supply them then MPF will use the default_source_device of this playfield.
This method does not increase the game controller’s count of the number of balls in play. So if you want to add balls (like in a multiball scenario), you need to call this method along with
MPF tracks the number of balls in play separately from the actual balls on the playfield because there are numerous situations where the two counts are not the same. For example, if a ball is in a VUK while some animation is playing, there are no balls on the playfield but still one ball in play, or if the player has a two-ball multiball and they shoot them both into locks, there are still two balls in play even though there are no balls on the playfield. The opposite can also be true, like when the player tilts then there are still balls on the playfield but no balls in play.
Explanation of the player_controlled parameter:
Set player_controlled to True to indicate that MPF should wait for the player to eject the ball from the source_device rather than firing a coil. The logic works like this:
If the source_device does not have an eject_coil defined, then it’s assumed that player_controlled is the only option. (e.g. this is a traditional plunger.) If the source_device does have an eject_coil defined, then there are two ways the eject could work. (1) there could be a “launch” button of some kind that’s used to fire the eject coil, or (2) the device could be the auto/manual combo style where there’s a mechanical plunger but also a coil which can eject the ball.
If player_controlled is true and the device has an eject_coil, MPF will look for the player_controlled_eject_tag and eject the ball when a switch with that tag is activated.
If there is no player_controlled_eject_tag, MPF assumes it’s a manual plunger and will wait for the ball to disappear from the device based on the device’s ball count decreasing.
Track an incoming ball.
Notify the playfield that it probably received a ball which went missing elsewhere.
Confirm first ball in queue.
An instance of
mpf.core.ball_search.BallSearchwhich handles ball search for this playfield.
Block ball search for this playfield.
Blocking will disable ball search if it’s enabled or running, and will prevent ball search from enabling if it’s disabled until ball_search_resume() is called.
Disable ball search for this playfield.
If the ball search timer is running, it will stop and disable it. If an actual ball search process is running, it will stop.
Enable ball search for this playfield.
Note this does not start the ball search process, rather, it starts the timer running.
Unblock ball search for this playfield.
This will check to see if there are balls on the playfield, and if so, enable ball search.
Return the number of balls on the playfield.
Handle an expected ball.
Return the number of ball which can be added.
Used to find out how many more balls this device can hold. Since this is the playfield device, this method always returns 999.
Return true since it is a playfield.
Mark playfield active because a device on the playfield detected activity.
raise_config_error(msg, error_no, *, context=None)¶
Raise a ConfigFileError exception.
Stop tracking an incoming ball.
Handle an unexpected ball.
Playfield is always ready to receive.