document carousel events per 0.80.0.dev9

Author: bosh

docs/events/carousel/index.md

@@ -0,0 +1,16 @@
+---
+title: Carousel event index
+---
+
+# Carousel Events
+
+These events are posted by the built-in Carousel mode.
+
+See: [Carousel Mode Selection](../../cookbook/carousel.md) for pre-0.80 carousel configuration.
+
+See: [MPFCarousel](../../gmc/reference/mpf-carousel.md) for 0.80+ carousel configuration.
+
+* [item_highlighted](../item_highlighted.md) *Note: 0.80+ only*
+* [(carousel_name)\_items_empty](../carousel_name_items_empty.md)
+* [(carousel_name)\_(item_name)\_selected](../carousel_name_item_name_selected.md)
+* [(carousel_name)\_item_selected](../carousel_name_item_selected.md)

docs/events/carousel_name_item_name_selected.md

@@ -0,0 +1,12 @@
+---
+title: (carousel_name)_(item_name)_selected
+---
+
+# (carousel_name)\_(item_name)\_selected
+
+
+--8<-- "event.md"
+
+The carousel named (carousel_name) has just had the item named (item_name) get selected.
+
+--8<-- "event_no_keywords_notice.md"

docs/events/carousel_name_item_selected.md

@@ -0,0 +1,14 @@
+---
+title: (carousel_name)_item_selected
+---
+
+# (carousel_name)\_item_selected
+
+
+--8<-- "event.md"
+
+The carousel named (carousel_name) has just had an item selected.
+This event does not include the item name, and is generally used
+to close or end the carousel mode rather than to select the next mode.
+
+--8<-- "event_no_keywords_notice.md"

docs/events/carousel_name_items_empty.md

@@ -0,0 +1,16 @@
+---
+title: (carousel_name)_items_empty
+---
+
+# (carousel_name)\_item_empty
+
+
+--8<-- "event.md"
+
+The carousel named (carousel_name) determined that it has
+no selectable_items that are valid for display. This can be because
+the `mode_settings` for the carousel mode still needs to be set,
+or because all of the `selectable_items` were dynamically evaluated
+and removed from the valid option set.
+
+--8<-- "event_no_keywords_notice.md"

docs/events/index.md

@@ -288,6 +288,12 @@ will posted an event called *switch_s_left_slingshot_active*.
     * [bonus_start](bonus_start.md)
     * [bonus_subtotal](bonus_subtotal.md)
 
+* [Carousel Events](carousel/index.md)
+    * [item_highlighted](item_highlighted.md)
+    * [(carousel_name)\_items_empty](carousel_name_items_empty.md)
+    * [(carousel_name)\_(item_name)\_selected](carousel_name_item_name_selected.md)
+    * [(carousel_name)\_item_selected](carousel_name_item_selected.md)
+
 * Config Player Events
     * [clear](clear.md)
 

docs/events/item_highlighted.md

@@ -0,0 +1,32 @@
+---
+title: item_highlighted
+---
+
+# item_highlighted
+
+
+--8<-- "event.md"
+
+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](overview/conditional.md)
+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.

mkdocs.yml

@@ -1209,6 +1209,12 @@ nav:
       - bonus_multiplier: events/bonus_multiplier.md
       - bonus_start: events/bonus_start.md
       - bonus_subtotal: events/bonus_subtotal.md
+    - Carousel Events:
+      - events/carousel/index.md
+      - carousel_name_items_empty: events/carousel_name_items_empty.md
+      - carousel_name_item_name_selected: events/carousel_name_item_name_selected.md
+      - carousel_name_item_selected: events/carousel_name_item_selected.md
+      - item_highlighted: events/item_highlighted.md
     - Config Player Events:
       - clear: events/clear.md
     - Credit Events: