Warning

This is the dev documentation for an unreleased 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. Unless you’re specifically looking for this version, you probably want to use the version of documentation called “latest” which is for the latest released version of MPF. That documentation is at docs.missionpinball.org/en/latest.

extra_ball_group_(name)_lit

MPF Event

An extra ball was just lit. This is a good event to use to start your extra ball lit mode, to turn on an extra ball light, to play the “get that extra ball” sound, etc.

Note that this event is posted if an extra ball is lit during play and also when a player’s turn starts if they have a lit extra ball.

See also the extra_ball_(name)_lit for a similar event that is only posted when an extra ball is lit during play, and not if the player starts their turn with the extra ball lit.

This event does not have any keyword arguments

Event is posted by extra_ball_groups: