This documentation is for an unreleased version of MPF!
This is the developer documentation for MPF 0.54, 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 lock device which locks balls for a multiball.
Accessing multiball_locks in code
The device collection which contains the multiball_locks in your machine is available via
self.machine.multiball_locks. For example, to access one called “foo”, you would use
self.machine.multiball_locks.foo. You can also access multiball_locks in dictionary form, e.g.
You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Multiball_locks have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
enable() → None¶
Return true if enabled.
Handle disable control event.
Handle enable control event.
Event handler for reset_all_counts event.
Event handler for reset_count_for_current_player event.
format_log_line(msg, context, error_no) → str¶
Return a formatted log line with log link and context.
Get the value of a placeholder.
Return true if lock is full.
Return the number of locked balls for the current player.
Return if enabled is persisted.
raise_config_error(msg, error_no, *, context=None) → NoReturn¶
Raise a ConfigFileError exception.
Return the remaining capacity of the lock.
Reset the locked balls for all players.
Reset the locked balls for the current player.
Subscribe to an attribute.