Merge pull request #595 from bosh/queue_event_list

Queue event list

Author: bosh

docs/events/index.md

@@ -9,4 +9,7 @@ title: init_phase_1
 
 Posted during the initial boot up of MPF.
 
+This is a queue event. The machine init phase 1
+will not be complete until the queue is cleared.
+
 --8<-- "event_no_keywords_notice.md"

docs/events/init_phase_1.md

@@ -9,4 +9,7 @@ title: init_phase_2
 
 Posted during the initial boot up of MPF.
 
+This is a queue event. The machine init phase 2
+will not be complete until the queue is cleared.
+
 --8<-- "event_no_keywords_notice.md"

docs/events/init_phase_2.md

@@ -9,4 +9,7 @@ title: init_phase_3
 
 Posted during the initial boot up of MPF.
 
+This is a queue event. The machine init phase 3
+will not be complete until the queue is cleared.
+
 --8<-- "event_no_keywords_notice.md"

docs/events/init_phase_3.md

@@ -9,4 +9,7 @@ title: init_phase_4
 
 Posted during the initial boot up of MPF.
 
+This is a queue event. The machine init phase 4
+will not be complete until the queue is cleared.
+
 --8<-- "event_no_keywords_notice.md"

docs/events/init_phase_4.md

@@ -9,4 +9,7 @@ title: init_phase_5
 
 Posted during the initial boot up of MPF.
 
+This is a queue event. The machine init phase 5
+will not be complete until the queue is cleared.
+
 --8<-- "event_no_keywords_notice.md"

docs/events/init_phase_5.md

@@ -9,6 +9,9 @@ title: match_has_match
 
 At least one player has a match.
 
+This is a queue event. The match mode match_has_match
+will not be complete until the queue is cleared.
+
 ## Keyword arguments
 
 (See the [Conditional Events](overview/conditional.md)

docs/events/match_has_match.md

@@ -9,6 +9,9 @@ title: match_no_match
 
 All players missed the match number.
 
+This is a queue event. The match mode match_no_match
+will not be complete until the queue is cleared.
+
 ## Keyword arguments
 
 (See the [Conditional Events](overview/conditional.md)
@@ -33,4 +36,4 @@ Winner number
 
 #### `winners`:
 
-Number of winners (always 0 here)
+Number of winners (always 0 here as there are no matches)

docs/events/match_no_match.md

@@ -47,6 +47,10 @@ You can create your own queue events with the
 [queue_relay_player:](../../config/queue_relay_player.md) config file
 sections.
 
+Queue Events are categorized in the Events Reference by their device
+or other grouping type, but are also listed together in the
+[Queue Events event listing page](../queue_events/index.md).
+
 ## Note for Programmers
 
 If you're a programmer and familiar with Python, you'll notice in the

docs/events/overview/event_types.md

@@ -0,0 +1,40 @@
+---
+title: balldevice_(name)_ball_eject_attempt
+---
+
+# balldevice_(name)\_ball_eject_attempt
+
+
+--8<-- "event.md"
+
+Event is posted by [ball_devices:](../../config/ball_devices.md)
+
+The ball device called (name) is attempting to eject a ball (or
+balls). This is a queue event. The eject will not actually be attempted
+until the queue is cleared.
+
+## 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.)
+
+#### `balls`:
+
+The number of balls that are to be ejected.
+
+#### `mechanical_eject`:
+
+Boolean as to whether this is a mechanical eject.
+
+#### `num_attempts`:
+
+How many eject attempts have been tried so far.
+
+#### `source`:
+
+The source device that will be ejecting the balls.
+
+#### `target`:
+
+The target ball device that will receive these balls.