@@ -60,77 +60,76 @@ change_tick_interval, reset_tick_interval.
60
60
Take a look at the various types of actions you can perform on timers
61
61
with control events :
62
62
63
- ` add`
63
+ # ### `add`:
64
64
65
- : Adds the time (specified in the `value:` setting) to the timer. If
66
- the value would be higher than the timer's `max_value:` setting,
67
- then the value is set to the max value. Posts the
68
- *timer_\(name\)_time_added* event.
65
+ Adds the time (specified in the `value:` setting) to the timer. If
66
+ the value would be higher than the timer's `max_value:` setting,
67
+ then the value is set to the max value. Posts the
68
+ *timer_\(name\)_time_added* event.
69
69
70
- This action does not change the timer's running state.
70
+ This action does not change the timer's running state.
71
71
72
- The timer is checked for done after the value has been added. (So,
73
- for example, if you have a timer that's set to count up, and the
74
- timer finishes at 10, and the timer is currently at 6, and you add
75
- value of 5, then the timer will be complete.
72
+ The timer is checked for done after the value has been added. (So,
73
+ for example, if you have a timer that's set to count up, and the
74
+ timer finishes at 10, and the timer is currently at 6, and you add
75
+ value of 5, then the timer will be complete.
76
76
77
- ` subtract`
77
+ # ### `subtract`:
78
78
79
- : Subtracts time (specified in the `value:` setting) from the timer.
80
- Posts the *timer_\(name\)_time_subtracted* event and checks to see
81
- if the timer is complete.
79
+ Subtracts time (specified in the `value:` setting) from the timer.
80
+ Posts the *timer_\(name\)_time_subtracted* event and checks to see
81
+ if the timer is complete.
82
82
83
- ` jump`
83
+ # ### `jump`:
84
84
85
- : "Jumps" the timer to a specific new value (specified in the
86
- ` value:` setting) and checks to see if the timer is complete.
85
+ " Jumps" the timer to a specific new value (specified in the
86
+ ` value:` setting) and checks to see if the timer is complete.
87
87
88
- ` start`
88
+ # ### `start`:
89
89
90
- : Starts the timer if it's not running. Does nothing if the timer is
91
- already running. Posts the *timer_\(name\)_started* event.
90
+ Starts the timer if it's not running. Does nothing if the timer is
91
+ already running. Posts the *timer_\(name\)_started* event.
92
92
93
- ` stop`
93
+ # ### `stop`:
94
94
95
- : Stops the timer and posts the *timer_\(name\)_stopped* event.
96
- Removes any outstanding "pause" delays.
95
+ Stops the timer and posts the *timer_\(name\)_stopped* event.
96
+ Removes any outstanding "pause" delays.
97
97
98
- ` reset`
98
+ # ### `reset`:
99
99
100
- : Changes the timers current value back to the `start_value:`. Nothing
101
- else is touched, so if the timer is running, it stays running, etc.
100
+ Changes the timers current value back to the `start_value:`. Nothing
101
+ else is touched, so if the timer is running, it stays running, etc.
102
102
103
- ` restart`
103
+ # ### `restart`:
104
104
105
- : Acts as a combination of reset, then start.
105
+ Acts as a combination of reset, then start.
106
106
107
- ` pause`
107
+ # ### `pause`:
108
108
109
- : Pauses the timer for a given `value:` time (in seconds). Note that
110
- the timer pause value is real world seconds and does not take the
111
- timers tick interval into consideration. If the pause value is 0,
112
- the timer is paused indefinitely. Posts the
113
- *timer_\(name\)_paused* event.
109
+ Pauses the timer for a given `value:` time (in seconds). Note that
110
+ the timer pause value is real world seconds and does not take the
111
+ timers tick interval into consideration. If the pause value is 0,
112
+ the timer is paused indefinitely. Posts the
113
+ *timer_\(name\)_paused* event.
114
114
115
- ` set_tick_interval`
115
+ # ### `set_tick_interval`:
116
116
117
- : Sets the tick interval to a new value (specified in the `value:`
118
- setting).
117
+ Sets the tick interval to a new value (specified in the `value:` setting).
119
118
120
- ` change_tick_interval`
119
+ # ### `change_tick_interval`:
121
120
122
- : Changes the tick interval by multiplying the current tick interval
123
- by the new one specified in the `value:` setting. In other words, if
124
- you want to make the tick interval 10% faster, than set this to
125
- `value : 1.1`. If you want to make it 50% slower, set this to
126
- `value : 0.5`, etc.
121
+ Changes the tick interval by multiplying the current tick interval
122
+ by the new one specified in the `value:` setting. In other words, if
123
+ you want to make the tick interval 10% faster, than set this to
124
+ `value : 1.1`. If you want to make it 50% slower, set this to
125
+ `value : 0.5`, etc.
127
126
128
- ` reset_tick_interval`
127
+ # ### `reset_tick_interval`:
129
128
130
- : (added in MPF 0.33)
129
+ (added in MPF 0.33)
131
130
132
- Resets the timer's tick interval back to the original from the
133
- ` tick_interval:` setting.
131
+ Resets the timer's tick interval back to the original from the
132
+ ` tick_interval:` setting.
134
133
135
134
# ## event:
136
135
0 commit comments