Warning

This documentation is for an unreleased version of MPF!

This is the developer documentation for MPF 0.51, which is the “dev” (next) release of MPF that is a work-in-progress. Use the “Read the Docs” link in the lower left corner to view the developer docs for the version of MPF you’re using.

self.machine.extra_ball_groups.*

class mpf.devices.extra_ball_group.ExtraBallGroup(*args, **kwargs)

Bases: mpf.core.system_wide_device.SystemWideDevice

Tracks and manages groups of extra balls devices.

Accessing extra_ball_groups in code

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

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

Methods & Attributes

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

award(posted_unlit_events=False, **kwargs)

Immediately awards an extra ball.

This event first checks to make sure the limits of the max extra balls have not been exceeded and that this group is enabled.

Note that this method will work even if this group does not have any extra balls or extra balls lit. You can use this to directly award an extra ball.

award_disabled()

Post the events when an extra ball connect be awarded.

award_lit(**kwargs)

Award a lit extra ball.

If the player does not have any lit extra balls, this method does nothing.

enabled

Return whether this extra ball group is enabled.

This attribute considers the enabled setting plus the max balls per game and ball settings.

is_ok_to_light()

Check if it’s possible to light an extra ball.

Returns:True of False

This method checks to see if the group is enabled and whether the max_lit setting has been exceeded.

light(**kwargs)

Light the extra ball for possible collection by the player.

This method checks that the group is enabled and that the max lit value has not been exceeded. If so, this method will post the extra ball disabled events.

raise_config_error(msg, error_no, *, context=None)

Raise a ConfigFileError exception.