Skip to content

state_machine_states:

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 🚫

The state_machine_states: section of your config is where you configure the states of your state machine.

See state machines for details.

Optional settings

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

events_when_started:

List of one (or more) events.

The event will be posted when the state machine enters this state. This is the entry action for this state in your finite state machine.

events_when_stopped:

List of one (or more) events.

The event will be posted when the state machine leaves this state. This is the exit action for this state in your finite state machine.

label:

Single value, type: string.

The full name/description of this state.

show_when_active:

Single value, type: show_config:.

A show which is played when the state machine is in this state. This is kind of an entry action as you could use events_when_started and a /game_logic/logic_blocks/state_machines to achieve the same. It is meant as a helper because it is common to play one show per step.

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