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.
Ball save device which will give back the ball within a certain time.
Accessing ball_saves in code
The device collection which contains the ball_saves in your machine is available via
self.machine.ball_saves. For example, to access one called “foo”, you would use
self.machine.ball_saves.foo. You can also access ball_saves in dictionary form, e.g.
You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Ball_saves have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
Trigger eject of all scheduled balls.
disable(**kwargs) → None¶
Disable ball save.
early_ball_save(**kwargs) → None¶
Perform early ball save if enabled.
enable(**kwargs) → None¶
Enable ball save.
raise_config_error(msg, error_no, *, context=None)¶
Raise a ConfigFileError exception.
timer_start(**kwargs) → None¶
Start the timer.
This is usually called after the ball was ejected while the ball save may have been enabled earlier.