Skip to content

add docs for shot:delay_event_list #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add docs for shot:delay_event_list #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 6 additions & 10 deletions docs/config/sequence_shots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,7 @@ but with events.
### cancel_switches:

List of one (or more) values, each is a type: string name of a
[switches:](switches.md) device. Defaults to
empty.
[switches:](switches.md) device. Defaults to empty.

A switch (or list of switches) that will cause any in-progress switch
sequence tracking to be canceled. (Think of it like a cancel "abort"
Expand All @@ -135,8 +134,8 @@ as `delay_switch_list` but with events.
### delay_switch_list:

One or more sub-entries. Each in the format of string name of a
[switches:](switches.md) device :
`time string (ms)`
`switch_device:time string (ms)`. Example: `s_delay_detector: 500ms`

([Instructions for entering time strings](instructions/time_strings.md))

Switches which will temporarily prevent new sequences from starting.
Expand All @@ -154,8 +153,7 @@ A sequence of events which will complete the sequence.
### playfield:

Single value, type: `string` name of a
[playfields:](playfields.md) device. Default:
`playfield`
[playfields:](playfields.md) device. Default: `playfield`

The playfield this sequence is on.

Expand All @@ -177,8 +175,7 @@ activations and the shot would count.)
### switch_sequence:

List of one (or more) values, each is a type: string name of a
[switches:](switches.md) device. Defaults to
empty.
[switches:](switches.md) device. Defaults to empty.

A sequence of switches which will complete the sequence.

Expand Down Expand Up @@ -211,8 +208,7 @@ Name of this device in service mode.

### tags:

List of one (or more) values, each is a type: `string`. Defaults to
empty.
List of one (or more) values, each is a type: `string`. Defaults to empty.

Not used.

Expand Down
12 changes: 9 additions & 3 deletions docs/config/shots.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,8 @@ shots:

### delay_switch:

One or more sub-entries. Each in the format of string name of a
[switches:](switches.md) device :
`time string (ms)`
One or more sub-entries. Each in the format `switch_device: time string (ms)`.
Example: `s_delay_detector: 500ms`
([Instructions for entering time strings](instructions/time_strings.md))

A dictionary of switches and times which prevent hits for a certain
Expand Down Expand Up @@ -173,6 +172,13 @@ shots:
In this example an activation of `s_other_lane` will prevent the shot
from being hit for two seconds.

### delay_events:

List of one (or more) device control events
([Instructions for entering device control events](instructions/device_control_events.md)). Defaults to empty.

Events which will temporarily prevent new sequences from starting. Same as `delay_switch` but with events.

### disable_events:

List of one (or more) device control events
Expand Down