Skip to content

high_score_award_display

This is an MPF Event

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

Event is posted by high_score built-in mode when a player has entered their name for an award.

This event will be posted for every award earned in every category of the game that was just completed. Prior to MPF 0.80, the category and award information was included in the name of this event and its variants, but with MPF 0.80+ only high_score_award_display is used.

If you want to make behaviors unique to the different categories or awards, you can use conditional events. For example, the default high score configuration includes a "score" category. To write a conditional event binding for only award display events in this category, you would write:

event_player:
  high_score_award_display{category_name=="score"}:
    - my_score_award_granted_behavior

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.)

player_name:

The letters that the player has entered as their name.

award:

The name of the award the player earned.

value:

The number value of the record. This may be score or the custom value used to rank the performance.

player_num:

player_num added in MPF 0.80

The number (1-4) of the player.

category_name:

category_name added in MPF 0.80

The name of the overall category of the award.

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