Skip to content

playfield_transfers:

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 playfield_transfers: section of your config is where you configure devices which transfer balls between playfields.

This is an example:

switches:
  s_transfer:
    number:
playfield_transfers:
  transfer1:
    ball_switch: s_transfer
    captures_from: playfield1
    eject_target: playfield2
  transfer2:
    transfer_events: transfer_ball
    captures_from: playfield1
    eject_target: playfield2
playfields:
  playfield1:
    label: Playfield 1
    default_source_device: None
  playfield2:
    label: Playfield 2
    default_source_device: None

Required settings

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

captures_from:

Single value, type: string name of a ball_devices: device. Defaults to empty.

Source playfield for the transfer.

eject_target:

Single value, type: string name of a ball_devices: device. Defaults to empty.

Target playfield for the transfer.

Optional settings

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

ball_switch:

Single value, type: string name of a switches: device. Defaults to empty.

Ball switch which triggers the transfer.

transfer_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, will trigger a ball transfer.

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 more debug output.

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 in service mode.

tags:

List of one (or more) values, each is a type: string. Defaults to empty.

Tags of the device. Not used currently.

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