Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/config/queue_event_player.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,12 @@ Single event. This device will be posted by the device. Defaults to
empty.

The event name that will be posted when all the handlers of this queue
event are done processing it. This setting is optional.
event are done processing it. This setting is optional. If no value is
given, a default event will be posted when complete, [queue_event_complete](../events/queue_event_complete.md).

With either the generic `queue_event_complete` or your custom `events_when_finished`,
the custom parameters defined in the `args` option will be included, as well as
the parameter *queue_event*, which will have the value of the queue_event from the config.

## Related Pages:

Expand Down
2 changes: 2 additions & 0 deletions docs/events/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,8 @@ will posted an event called *switch_s_left_slingshot_active*.
* [machine_reset_phase_2](machine_reset_phase_2.md) *Queue Event*
* [machine_reset_phase_3](machine_reset_phase_3.md) *Queue Event*

* [Queue Event Player Events]
* [queue_event_complete](queue_event_complete.md)

* Audio Management Events
* [master_volume_decrease](master_volume_decrease.md)
Expand Down
30 changes: 30 additions & 0 deletions docs/events/queue_event_complete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: queue_event_complete
---

# queue_event_complete


--8<-- "event.md"

A queue event has completed and normal behavior will resume. This is posted
by the `queue_event_player` when no [`events_when_finished`](../config/queue_event_player.md#events_when_finished) is provided.
If you have defined custom `events_when_finished`, this event name will not be posted,
but the custom names you have picked will have the following keyword arguments included.

This is *NOT* itself a queue event.

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

#### `queue_event`:

The name of the queue event that

#### `**args`:

Additional args may be provided if you have configured them
via [`args`](../config/queue_event_player.md#args)
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1176,7 +1176,8 @@ nav:
- mode_(name)_starting: events/mode_name_starting.md
- mode_(name)_stopping: events/mode_name_stopping.md
- balldevice_(name)_ball_eject_attempt: events/queue_events/balldevice_ball_device_ball_eject_attempt.md

- Queue Event Player Events:
- queue_event_complete: events/queue_event_complete.md
- Audio Management Events:
- master_volume_decrease: events/master_volume_decrease.md
- master_volume_increase: events/master_volume_increase.md
Expand Down