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.
MachineController(mpf_path: str, machine_path: str, options: dict)¶
Base class for the Machine Controller object.
The machine controller is the main entity of the entire framework. It’s the main part that’s in charge and makes things happen.
- options (dict) – A dictionary of options built from the command line options used to launch mpf.py.
- machine_path – The root path of this machine_files folder
Accessing the machine controller in code
The machine controller is the main component in MPF, accessible via
self.machine. See the Overview & Tour of MPF code for details.
Methods & Attributes
The machine controller has the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
add_platform(name: str) → None¶
Make an additional hardware platform interface available to MPF.
Parameters: name – String name of the platform to add. Must match the name of a platform file in the mpf/platforms folder (without the .py extension).
clear_boot_hold(hold: str) → None¶
Clear a boot hold.
configure_machine_var(name: str, persist: bool, expire_secs: int = None) → None¶
Create a new machine variable.
- name – String name of the variable.
- persist – Boolean as to whether this variable should be saved to disk so it’s available the next time MPF boots.
- expire_secs – Optional number of seconds you’d like this variable to persist on disk for. When MPF boots, if the expiration time of the variable is in the past, it will not be loaded. For example, this lets you write the number of credits on the machine to disk to persist even during power off, but you could set it so that those only stay persisted for an hour.
create_data_manager(config_name: str) → mpf.core.data_manager.DataManager¶
Return a new DataManager for a certain config.
Parameters: config_name – Name of the config
get_machine_var(name: str) → Any¶
Return the value of a machine variable.
Parameters: name – String name of the variable you want to get that value for. Returns: The value of the variable if it exists, or None if the variable does not exist.
get_platform_sections(platform_section: str, overwrite: str) → SmartVirtualHardwarePlatform¶
Return platform section.
init_done() → Generator[[int, None], None]¶
Called when init is done and all boot holds are cleared.
initialise() → Generator[[int, None], None]¶
initialise_core_and_hardware() → Generator[[int, None], None]¶
Load core modules and hardware.
is_machine_var(name: str) → bool¶
Return true if machine variable exists.
register_boot_hold(hold: str) → None¶
Register a boot hold.
register_monitor(monitor_class: str, monitor: Callable[..., Any]) → None¶
Register a monitor.
- monitor_class – String name of the monitor class for this monitor that’s being registered.
- monitor – Callback to notify
MPF uses monitors to allow components to monitor certain internal elements of MPF.
For example, a player variable monitor could be setup to be notified of any changes to a player variable, or a switch monitor could be used to allow a plugin to be notified of any changes to any switches.
The MachineController’s list of registered monitors doesn’t actually do anything. Rather it’s a dictionary of sets which the monitors themselves can reference when they need to do something. We just needed a central registry of monitors.
remove_machine_var(name: str) → None¶
Remove a machine variable by name.
If this variable persists to disk, it will remove it from there too.
Parameters: name – String name of the variable you want to remove.
remove_machine_var_search(startswith: str = '', endswith: str = '') → None¶
Remove a machine variable by matching parts of its name.
- startswith – Optional start of the variable name to match.
- endswith – Optional end of the variable name to match.
For example, if you pass startswit=’player’ and endswith=’score’, this method will match and remove player1_score, player2_score, etc.
reset() → Generator[[int, None], None]¶
Reset the machine.
This method is safe to call. It essentially sets up everything from scratch without reloading the config files and assets from disk. This method is called after a game ends and before attract mode begins.
run() → None¶
Start the main machine run loop.
set_default_platform(name: str) → None¶
Set the default platform.
It is used if a device class-specific or device-specific platform is not specified.
Parameters: name – String name of the platform to set to default.
set_machine_var(name: str, value: Any) → None¶
Set the value of a machine variable.
- name – String name of the variable you’re setting the value for.
- value – The value you’re setting. This can be any Type.
shutdown() → None¶
Shutdown the machine.
stop(**kwargs) → None¶
Perform a graceful exit of MPF.
validate_machine_config_section(section: str) → None¶
Validate a config section.
Dump information about the Python installation to the log.
Information includes Python version, Python executable, platform, and core architecture.