Skip to content

logicblock_(name)_hit

This is an MPF Event

The content on this page is technical documentation for an MPF Event.

Event is posted by counters:, accruals:, and sequences:

The logic block (name) was just hit.

Note that this is the default completion event for logic blocks, but this can be changed in a logic block's events_when_hit: setting, so this might not be the actual event that's posted for all logic blocks in your machine.

Deprecation warning:

In previous versions of MPF, the event counter_(name)_hit was used for counters instead of this event, logicblock_(name)_hit. Currently, both events are posted together (if you have not provided a custom events_when_hit value for the counter), but counter_(name)_hit is considered deprecated and may be removed in future versions of MPF.

Keyword arguments

(See the Conditional Events guide for details for how to create entries in your config file that only respond to certain combinations of the arguments below.)

Accruals, Counters, and Sequences each have different keyword arguments.

Accrual Keyword arguments

step:

The 0-based integer number of the step that was just hit.

Counter Keyword arguments

If the counter has a config setting for count_complete_value, count, hits and remaining towards that goal will be included as arguments. If count_complete_value is None, then only count will be included.

count:

The current value of the counter.

hits:

The numbers of hits made on this counter.

remaining:

The numbers of hits remaining before completing this counter.

Sequence Keyword arguments

step:

The 0-based integer number of the step that was just hit.

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