@@ -184,18 +184,49 @@ Single value, type: `time string (secs) or template`
184
184
([Instructions for entering time strings](instructions/time_strings.md) and
185
185
[Instructions for entering templates](instructions/dynamic_values.md)). Default : ` 1s`
186
186
187
+ # ### Using time strings:
188
+
187
189
A time value for how fast each tick is. The default is 1 second, but
188
190
quite often "pinball time" is slower than real world time, and a
189
191
countdown timer will actually tick a speed that's slower than 1 second
190
- per tick. (So in that case, you might set `tick_interval : 1.25s` or
191
- something like that. You can also set this really short if you want a
192
- hurry up, maybe every 100ms removed 77,000 worth of points or something.
192
+ per tick. If you want a countdown to count down by one number every 1.25 seconds,
193
+ you could set `tick_interval : 1.25s`. On the other hand, a hurryup might
194
+ count down very quickly, and you could use a value of `100ms` to
195
+ tick down ten times a second.
196
+
197
+ # ### Using dynamic value templates:
198
+
199
+ Also note that you can use [dynamic values](instructions/dynamic_values.md)
200
+ here if you want to do math or use settings to make this configurable.
201
+
202
+ Even though the other option is to use a time string, when using a dynamic value
203
+ you must resolve the value to a floating point value representing the number of seconds.
204
+ So if you want to resolve to half a second, you MUST calculate to the float 0.5, NOT "500ms" or "0.5s".
205
+ For example, when using a setting to control a timer speed, you might write :
206
+
207
+ ` ` ` yaml
208
+ #! settings.yaml
209
+ settings:
210
+ my_timer_speed:
211
+ label: "My timer's speed"
212
+ values:
213
+ 0.5: "Half a second"
214
+ 1.0: "1 second (default)"
215
+ 2.5: "2.5 seconds"
216
+ default: 1.0
217
+ key_type: float
218
+ sort: 123
219
+
220
+ #! a timer definition in some mode .yaml
221
+ timers:
222
+ my_timer:
223
+ end_value: 1
224
+ tick_interval: settings.my_timer_speed
225
+ start_running: true
226
+ ` ` `
193
227
194
- Also note that you can use
195
- [dynamic values](instructions/dynamic_values.md) here if you want to do math or use settings to make this
196
- configurable.
228
+ See : [settings:](settings.md)
197
229
198
- * [timer_control_events:](timer_control_events.md)
199
230
200
231
# ## console_log:
201
232
0 commit comments