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.


class mpf.devices.shot_profile.ShotProfile(machine: mpf.core.machine.MachineController, name: str)

Bases: mpf.core.mode_device.ModeDevice, mpf.core.system_wide_device.SystemWideDevice

A shot profile.

Accessing shot_profiles in code

The device collection which contains the shot_profiles in your machine is available via self.machine.shot_profiles. For example, to access one called “foo”, you would use self.machine.shot_profiles.foo. You can also access shot_profiles in dictionary form, e.g. self.machine.shot_profiles['foo'].

You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.

Methods & Attributes

Shot_profiles have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.

enable() → None

Enable handler.


Event handler for enable event.

format_log_line(msg, context, error_no) → str

Return a formatted log line with log link and context.

raise_config_error(msg, error_no, *, context=None) → NoReturn

Raise a ConfigFileError exception.