Skip to content

self.machine.state_machines.*

class mpf.devices.state_machine.StateMachine(*args, **kwargs)

Bases: mpf.core.system_wide_device.SystemWideDevice, mpf.core.mode_device.ModeDevice

A generic state machine.

Accessing state_machines in code

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

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

Methods & Attributes

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

enable() → None

Enable handler.

event_enable(**kwargs)

Event handler for enable event.

format_log_line(msg, context, error_no) → str

Return a formatted log line with log link and context.

get_placeholder_value(item)

Get the value of a placeholder.

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

Raise a ConfigFileError exception.

state

Return the current state.

subscribe_attribute(item, machine)

Subscribe to an attribute.

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