Skip to content

API Reference

MPF’s API reference is broken into several categories. All of it is presented in the way that the modules and classes are actually used in MPF.

  • Core Components: MPF core components.

  • Devices: MPF devices, including physical devices like flippers, ball devices, switches, lights, etc. as well as logical devices like ball saves, extra balls, multiballs, etc.

  • Modes: Built-in modes, such as game, attract, tilt, credits, etc.

  • Platforms: Hardware platforms interfacess for all supported hardware.

  • Config Players: Modules responsible for all config players (show_player, light_player, score_player, etc.)

  • Tests: All unit test base classes for writing tests for MPF and your own game.

  • Miscellaneous Components: Things that don’t fit into other categories, including utility functions, the base classes for modes, players, timers, and other utility functions.

Something missing or wrong? You can fix it!

This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?

Please help us! You can fix it yourself and be an official "open source" contributor!

It's easy! See our Beginner's guide to editing the docs.

Page navigation via the keyboard: < >

You can navigate this site via the keyboard. There are two modes:

General navigation, when search is not focused:

  • F , S , / : open search dialog
  • P , , : go to previous page
  • N , . : go to next page

While using the search function:

  • Down , Up : select next / previous result
  • Esc , Tab : close search
  • Enter : go to highlighted page in the results