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.

request_to_start_game

MPF Event

This event is posted when to start a game. This is a boolean event. Any handler can return False and the game will not be started. Otherwise when this event is done, a new game is started.

Posting this event is the only way to start a game in MPF, since many systems have to “approve” the start. (Are the balls in the right places, are there enough credits, etc.)

This event does not have any keyword arguments