Skip to content

self.machine.text_ui

class mpf.core.text_ui.TextUi(machine: MachineController)

Bases: mpf.core.mpf_controller.MpfController

Handles the text-based UI.

Accessing the text_ui in code

There is only one instance of the text_ui in MPF, and it’s accessible via self.machine.text_ui.

Methods & Attributes

The text_ui has the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.

stop(**kwargs)

Stop the Text UI and restore the original console screen.

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