extra_ball_groups:
This is a config file reference. Click for instructions.
This page is reference material which explains every setting and option for this section of an MPF yaml config file. See the instructions for config files for formatting and other details. See our guide to config file examples for more examples of real configs in action.
| Valid in | |
|---|---|
| machine config files | YES  |
| mode config files | NO  |
The extra_ball_groups: section of your config is where you...
Help us write it!
This section is unwritten or needs an update or edit. Can you help write it? Get your name in lights and geeky pinball bragging rights! Hit the magic sparkly wand to the right of the title to see this page source on GitHub. Then add/edit and submit your change. It's easy!
Optional settings
The following sections are optional in the extra_ball_groups: section
of your config. (If you don't include them, the default will be used).
award_events:
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
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_lit_events:
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
Events to award a lit extra ball. If the player does not have any lit extra balls, this method does nothing.
enabled:
Single value, type: boolean (true/false). Default: true
Whether this ball group is enabled.
light_events:
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
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.
lit_memory:
Single value, type: boolean (true/false). Default: true
Help us write it!
This section is unwritten or needs an update or edit. Can you help write it? Get your name in lights and geeky pinball bragging rights! Hit the magic sparkly wand to the right of the title to see this page source on GitHub. Then add/edit and submit your change. It's easy!
max_lit:
Single value, type: integer. Defaults to empty.
Max concurrent lit extra balls.
max_per_ball:
Single value, type: integer. Defaults to empty.
Maximum number of extra balls per ball.
max_per_game:
Single value, type: integer. Defaults to empty.
Maximum number of extra balls per game.
console_log:
Single value, type: one of the following options: none, basic, full.
Default: basic
Log level for the console log for this device.
debug:
Single value, type: boolean (true/false). Default: false
Set this to true to see additional debug output. This might impact the performance of MPF.
file_log:
Single value, type: one of the following options: none, basic, full.
Default: basic
Log level for the file log for this device.
label:
Single value, type: string. Default: %
Name of this device in service mode.
tags:
List of one (or more) values, each is a type: string. Defaults to
empty.
Not used.
Related How To guides
Something missing or wrong? You can fix it!
This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?
Please help us! You can fix it yourself and be an official "open source" contributor!
It's easy! See our Beginner's guide to editing the docs.
Page navigation via the keyboard: < >
You can navigate this site via the keyboard. There are two modes:
General navigation, when search is not focused:
- F , S , / : open search dialog
- P , , : go to previous page
- N , . : go to next page
While using the search function:
- Down , Up : select next / previous result
- Esc , Tab : close search
- Enter : go to highlighted page in the results