Skip to content

Commit e947a38

Browse files
committed
add queue_event_complete event to docs to go with missionpinball/mpf#1910
1 parent 44c3a96 commit e947a38

File tree

4 files changed

+40
-2
lines changed

4 files changed

+40
-2
lines changed

docs/config/queue_event_player.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,12 @@ Single event. This device will be posted by the device. Defaults to
6969
empty.
7070

7171
The event name that will be posted when all the handlers of this queue
72-
event are done processing it. This setting is optional.
72+
event are done processing it. This setting is optional. If no value is
73+
given, a default event will be posted when complete, [queue_event_complete](../events/queue_event_complete.md).
74+
75+
With either the generic `queue_event_complete` or your custom `events_when_finished`,
76+
the custom parameters defined in the `args` option will be included, as well as
77+
the parameter *queue_event*, which will have the value of the queue_event from the config.
7378

7479
## Related Pages:
7580

docs/events/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,8 @@ will posted an event called *switch_s_left_slingshot_active*.
247247
* [machine_reset_phase_2](machine_reset_phase_2.md) *Queue Event*
248248
* [machine_reset_phase_3](machine_reset_phase_3.md) *Queue Event*
249249

250+
* [Queue Event Player Events]
251+
* [queue_event_complete](queue_event_complete.md)
250252

251253
* Audio Management Events
252254
* [master_volume_decrease](master_volume_decrease.md)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: queue_event_complete
3+
---
4+
5+
# queue_event_complete
6+
7+
8+
--8<-- "event.md"
9+
10+
A queue event has completed and normal behavior will resume. This is posted
11+
by the `queue_event_player` when no [`events_when_finished`](../config/queue_event_player.md#events_when_finished) is provided.
12+
If you have defined custom `events_when_finished`, this event name will not be posted,
13+
but the custom names you have picked will have the following keyword arguments included.
14+
15+
This is *NOT* itself a queue event.
16+
17+
## Keyword arguments
18+
19+
(See the [Conditional Events](overview/conditional.md)
20+
guide for details for how to create entries in your config file that
21+
only respond to certain combinations of the arguments below.)
22+
23+
#### `queue_event`:
24+
25+
The name of the queue event that
26+
27+
#### `**args`:
28+
29+
Additional args may be provided if you have configured them
30+
via [`args`](../config/queue_event_player.md#args)

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1176,7 +1176,8 @@ nav:
11761176
- mode_(name)_starting: events/mode_name_starting.md
11771177
- mode_(name)_stopping: events/mode_name_stopping.md
11781178
- balldevice_(name)_ball_eject_attempt: events/queue_events/balldevice_ball_device_ball_eject_attempt.md
1179-
1179+
- Queue Event Player Events:
1180+
- queue_event_complete: events/queue_event_complete.md
11801181
- Audio Management Events:
11811182
- master_volume_decrease: events/master_volume_decrease.md
11821183
- master_volume_increase: events/master_volume_increase.md

0 commit comments

Comments
 (0)