class mpf.devices.multiball.Multiball(*args, **kwargs)

Bases: mpf.core.system_wide_device.SystemWideDevice, mpf.core.mode_device.ModeDevice

Multiball device for MPF.

Accessing multiballs in code

The device collection which contains the multiballs in your machine is available via self.machine.multiballs. For example, to access one called “foo”, you would use You can also access multiballs in dictionary form, e.g. self.machine.multiballs['foo'].

You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.

Methods & Attributes

Multiballs have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.


Add a ball if multiball has started.


Disable the multiball.

If the multiball is not enabled, it cannot start. Will not stop a running multiball.

Parameters:**kwargs – unused

Enable the multiball.

If the multiball is not enabled, it cannot start.

Parameters:**kwargs – unused
raise_config_error(msg, error_no, *, context=None)

Raise a ConfigFileError exception.


Reset the multiball and disable it.

Parameters:**kwargs – unused

Start multiball.


Start multiball or add a ball if multiball has started.


Stop shoot again.