tilt:
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 | NO |
mode config files | YES |
The tilt:
section of your config is where you configure a tilt mode.
Optional settings
The following sections are optional in the tilt:
section of your
config. (If you don't include them, the default will be used).
multiple_hit_window:
Single value, type: time string (ms) or template
(Instructions for entering time strings and
Instructions for entering templates). Default: 300ms
Window in which hits are ignored after a tilt hit.
reset_warnings_events:
List of one (or more) device control events
(Instructions for entering device control events). Default: ball_will_end
Default: ball_will_end
These events, when posted, will cause the warnings_to_tilt:
to be
reset to zero.
settle_time:
Single value, type: time string (ms) or template
(Instructions for entering time strings and
Instructions for entering templates). Default: 5s
Time to wait after the machine is tilted before a new ball can be started. This prevents that a player can tilt his ball and the first ball of the next player.
slam_tilt_switch_tag:
Single value, type: string
. Default: slam_tilt
Switch tags which will cause a slam tilt.
tilt_events:
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
Default: None
Events in this list, when posted, cause a tilt to occur which will end the current ball in progress with no end of ball bonus. You usually want to use tilt_warning_events because this one will instantly tilt the machine on the first event.
tilt_slam_tilt_events:
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
Default: None
Events in this list, when posted, cause a slam_tilt event to be posted. The slam tilt typically ends the current game and also clears all credits from the machine.
tilt_switch_tag:
Single value, type: string
. Default: tilt
Switch tag for switches which cause the machine to tilt (without prior
warnigns). You want to use the tag configured in
tilt_warning_switch_tag
in most cases.
tilt_warning_events:
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
Default: None
Events in this list, when posted, cause a tilt warning to occur. They
will post the tilt_warning
event, and if the warnings_to_tilt:
limit is hit, will also cause the
tilt event.
tilt_warning_switch_tag:
Single value, type: string
. Default: tilt_warning
Switch tags for switches which cause a tilt warning.
tilt_warnings_player_var:
Single value, type: string
. Default: tilt_warnings
Player var to use to store tilt warnings.
warnings_to_tilt:
Single value, type: integer
or template
(Instructions for entering templates). Default: 3
Number of warnings until the machine tilts.
Also note that you can use dynamic values here if you want to do math or use settings to make this configurable.
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