Warning

This is the documentation the latest work-in-progress version of MPF!

This is the documentation for MPF 0.56, which is the “dev” (next) release of MPF that is a work-in-progress. This is probably ok, and means you’ll be on the latest, cutting-edge version of MPF.

However, if you want a more stable version, select the v:stable version from the lower-left corner of this page, which is the most recent version that is not getting new updates.

If you are new to MPF, we have recently rewritten the installation process which only applies to this “latest” 0.56, so you probably want to stay here because the prior installation process doesn’t work on the latest OS and Python versions.

display_(name)_ready

MPF-MC Event

The display target called (name) is now ready and available to show slides. This event is useful with display widgets where you want to add a display to an existing slide which shows some content, but you need to make sure the display exists before showing a slide. So if you have a display called “overlay”, then you can add it to a slide however you want, and when it’s added, the event “display_overlay_ready” will be posted, and then you can use that event in your slide_player to trigger the first slide you want to show. Note that this event is posted by MPF-MC and will not exist on the MPF side. So you can use this event for slide_player, widget_player, etc., but not to start shows or other things controlled by MPF.

This event does not have any keyword arguments

Event is posted by displays: