Skip to content

shot_control_events:

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 NO 🚫

Shot can contain control_events: which can move the shot to a specific state.

Required settings

The following sections are required in the shot_control_events: section of your config:

events:

One or more values, type: string. Use commas to separate multiple values.

A list of one or more events, which triggers the move of the shot to a specified state.

state:

Single value, type: int.

The integer that is provided for the state the shot should move to when the event is posted. States are indexed at 0, which means the first state is 0, second state is 1, etc.

Optional settings

The following sections are optional in the shot_control_events: section of your config. (If you don't include them, the default will be used).

force:

Single value, type: boolean (true/false). Default: true

If set to true, the state of shot will be modified even if the shot is disabled. If set to false, this will be ignored unless the shot is currently enabled when the event is posted.

force_show:

Single value, type: boolean (true/false). Default: false

IF set to true, the show associated with this shot state will be played, even if the shot is already in that state.

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