Skip to content

Commit d6471eb

Browse files
committed
add docs for shot:delay_events
1 parent 2187939 commit d6471eb

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

docs/config/sequence_shots.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,7 @@ but with events.
114114
### cancel_switches:
115115

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

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

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

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

156155
Single value, type: `string` name of a
157-
[playfields:](playfields.md) device. Default:
158-
`playfield`
156+
[playfields:](playfields.md) device. Default: `playfield`
159157

160158
The playfield this sequence is on.
161159

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

179177
List of one (or more) values, each is a type: string name of a
180-
[switches:](switches.md) device. Defaults to
181-
empty.
178+
[switches:](switches.md) device. Defaults to empty.
182179

183180
A sequence of switches which will complete the sequence.
184181

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

212209
### tags:
213210

214-
List of one (or more) values, each is a type: `string`. Defaults to
215-
empty.
211+
List of one (or more) values, each is a type: `string`. Defaults to empty.
216212

217213
Not used.
218214

docs/config/shots.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,8 @@ shots:
129129

130130
### delay_switch:
131131

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

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

175+
### delay_events:
176+
177+
List of one (or more) device control events
178+
([Instructions for entering device control events](instructions/device_control_events.md)). Defaults to empty.
179+
180+
Events which will temporarily prevent new sequences from starting. Same as `delay_switch` but with events.
181+
176182
### disable_events:
177183

178184
List of one (or more) device control events

0 commit comments

Comments
 (0)