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.


MPF Event

Posted when a machine variable is added or changes value. (Machine variables are like player variables, except they’re maintained machine-wide instead of per-player or per-game.)

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.)

If the machine variable just changed, this will be the amount of the change. If it’s not possible to determine a numeric change (for example, if this machine variable is a list), then this change value will be set to the boolean True.
The previous value of this machine variable, e.g. what it was before the current value.
The new value of this machine variable.

Event is posted by machine_vars: