Skip to content

Commit ba06386

Browse files
committed
link all three logic block type config references to default events
and add a deprecation notice on counter_(name)_hit per code comment from 2017 :)
1 parent 86b7b52 commit ba06386

File tree

4 files changed

+25
-0
lines changed

4 files changed

+25
-0
lines changed

docs/config/accruals.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,12 +210,18 @@ List of one (or more) events.
210210

211211
Events that will be posted when this device is completed.
212212

213+
If you do not provide a value for this config, the default
214+
[`logicblock_(name)_complete`](../events/logicblock_name_complete.md) will be used.
215+
213216
### events_when_hit:
214217

215218
List of one (or more) events.
216219

217220
Events that will be posted when this device is hit or advanced.
218221

222+
If you do not provide a value for this config, the default
223+
[`logicblock_(name)_hit`](../events/logicblock_name_hit.md) will be used.
224+
219225
### persist_state:
220226

221227
Single value, type: `boolean` (`true`/`false`). Default: `false`

docs/config/counters.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,12 +237,18 @@ List of one (or more) events.
237237

238238
Events that will be posted when this device is completed.
239239

240+
If you do not provide a value for this config, the default
241+
[`logicblock_(name)_complete`](../events/logicblock_name_complete.md) will be used.
242+
240243
### events_when_hit:
241244

242245
List of one (or more) events.
243246

244247
Events that will be posted when this device is hit or advanced.
245248

249+
If you do not provide a value for this config, the default
250+
[`logicblock_(name)_hit`](../events/logicblock_name_hit.md) will be used.
251+
246252
### persist_state:
247253

248254
Single value, type: `boolean` (`true`/`false`). Default: `false`

docs/config/sequences.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,12 +190,18 @@ List of one (or more) events.
190190

191191
Events that will be posted when this device is completed.
192192

193+
If you do not provide a value for this config, the default
194+
[`logicblock_(name)_complete`](../events/logicblock_name_complete.md) will be used.
195+
193196
### events_when_hit:
194197

195198
List of one (or more) events.
196199

197200
Events that will be posted when this device is hit or advanced.
198201

202+
If you do not provide a value for this config, the default
203+
[`logicblock_(name)_hit`](../events/logicblock_name_hit.md) will be used.
204+
199205
### persist_state:
200206

201207
Single value, type: `boolean` (`true`/`false`). Default: `false`

docs/events/logicblock_name_hit.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ Event is posted by [counters:](../config/counters.md), [accruals:](../config/acc
1111

1212
The logic block (name) was just hit.
1313

14+
## Deprecation warning:
15+
16+
In previous versions of MPF, the event `counter_(name)_hit` was used for counters instead of this event, `logicblock_(name)_hit`.
17+
Currently, both events are posted together (if you have not provided a custom [`events_when_hit`](../config/counters.md#events_when_hit) value for the counter),
18+
but `counter_(name)_hit` is considered deprecated and may be removed in future versions of MPF.
19+
20+
1421
## Keyword arguments
1522

1623
(See the [Conditional Events](overview/conditional.md)

0 commit comments

Comments
 (0)