Warning

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

This is the documentation for MPF 0.57, 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. You can always update to the latest at any time.

player_turn_will_start

MPF Event

A new player’s turn will start. This event is only posted before the start of a new player’s turn. If that player gets an extra ball and shoots again, this event is not posted a second time.

Keyword arguments

(See the Conditional Events guide for details for how to create entries in your config file that only respond to certain combinations of the arguments below.)

number
The player number
player
The player object whose turn is starting.