carousel_item_highlighted
This is an MPF Event
The content on this page is technical documentation for an MPF Event.
An item was highlighted in a carousel. This event is posted when the carousel initially displays and highlights its initial item and also when moving the carousel to the next or previous item.
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.)
carousel
:
The name of the carousel that had an item selected.
direction
:
The direction that the highlight change was performed in. Can be any of:
"forwards", "backwards", or None
. Note that None
is the Python keyword, not the string "None".
item
:
The string name of the newly-highlighted item.
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