Skip to content

Commit b3dced9

Browse files
committed
add default note to logicblock_name_hit event
and use backticks on some event names
1 parent ba06386 commit b3dced9

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

docs/cookbook/TAF_mansion_awards.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ for the achievement group, so hitting either one of those will start the
531531
selected achievement (if the group is enabled) and also stop this mode.
532532

533533
You may be wondering why we have both of those ball enter events listed
534-
here? Why not just use an "events_when_started" setting in the
534+
here? Why not just use an `events_when_started:` setting in the
535535
achievement group to stop this mode? The reason is for this rule here:
536536

537537
* Accumulating 15, 25, 35, 45, 55, 65, 75, 85, 95 bear kicks (center

docs/events/logicblock_name_complete.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Event is posted by [counters:](../config/counters.md), [accruals:](../config/acc
1212
The logic block called (name) has just been completed.
1313

1414
Note that this is the default completion event for logic blocks, but
15-
this can be changed in a logic block's "events_when_complete:"
15+
this can be changed in a logic block's `events_when_complete:`
1616
setting, so this might not be the actual event that's posted for all
1717
logic blocks in your machine.
1818

docs/events/logicblock_name_hit.md

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

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

14-
## Deprecation warning:
14+
Note that this is the default completion event for logic blocks, but
15+
this can be changed in a logic block's `events_when_hit:`
16+
setting, so this might not be the actual event that's posted for all
17+
logic blocks in your machine.
18+
19+
#### Deprecation warning:
1520

1621
In previous versions of MPF, the event `counter_(name)_hit` was used for counters instead of this event, `logicblock_(name)_hit`.
1722
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),

0 commit comments

Comments
 (0)