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.
An achievement in a pinball machine.
It is tracked per player and can automatically restore state on the next ball.
Accessing achievements in code
The device collection which contains the achievements in your machine is available via
self.machine.achievements. For example, to access one called “foo”, you would use
self.machine.achievements.foo. You can also access achievements in dictionary form, e.g.
You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Achievements have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
Return if this achievement can be selected and started.
Enable the achievement.
It can only start if it was enabled before.
Event handler for complete event.
Event handler for disable event.
Event handler for enable event.
Event handler for reset event.
Event handler for select event.
Event handler for start event.
Event handler for stop event.
Event handler for unselect 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.
raise_config_error(msg, error_no, *, context=None) → NoReturn¶
Raise a ConfigFileError exception.
Reset the achievement to its initial state.
Highlight (select) this achievement.
Return current selection state.
Return current state.
Subscribe to an attribute.
Remove highlight (unselect) this achievement.