Warning

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.

self.machine.settings

class mpf.core.settings_controller.SettingsController(machine)

Bases: mpf.core.mpf_controller.MpfController

Manages operator controllable settings.

Accessing the settings in code

There is only one instance of the settings in MPF, and it’s accessible via self.machine.settings.

Methods & Attributes

The settings has the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.

add_setting(setting: mpf.core.settings_controller.SettingEntry)

Add a setting.

get_setting_machine_var(setting_name)

Return machine var name.

get_setting_value(setting_name)

Return the current value of a setting.

get_setting_value_label(setting_name)

Return label for value.

get_settings() → List[mpf.core.settings_controller.SettingEntry]

Return all available settings.

set_setting_value(setting_name, value)

Set the value of a setting.