Merge pull request #624 from bosh/logic_block_events

Logic block events

Author: bosh

docs/config/accruals.md

@@ -210,12 +210,18 @@ List of one (or more) events.
 
 Events that will be posted when this device is completed.
 
+If you do not provide a value for this config, the default
+[`logicblock_(name)_complete`](../events/logicblock_name_complete.md) will be used.
+
 ### events_when_hit:
 
 List of one (or more) events.
 
 Events that will be posted when this device is hit or advanced.
 
+If you do not provide a value for this config, the default
+[`logicblock_(name)_hit`](../events/logicblock_name_hit.md) will be used.
+
 ### persist_state:
 
 Single value, type: `boolean` (`true`/`false`). Default: `false`

docs/config/counters.md

@@ -237,12 +237,18 @@ List of one (or more) events.
 
 Events that will be posted when this device is completed.
 
+If you do not provide a value for this config, the default
+[`logicblock_(name)_complete`](../events/logicblock_name_complete.md) will be used.
+
 ### events_when_hit:
 
 List of one (or more) events.
 
 Events that will be posted when this device is hit or advanced.
 
+If you do not provide a value for this config, the default
+[`logicblock_(name)_hit`](../events/logicblock_name_hit.md) will be used.
+
 ### persist_state:
 
 Single value, type: `boolean` (`true`/`false`). Default: `false`

docs/config/sequences.md

@@ -190,12 +190,18 @@ List of one (or more) events.
 
 Events that will be posted when this device is completed.
 
+If you do not provide a value for this config, the default
+[`logicblock_(name)_complete`](../events/logicblock_name_complete.md) will be used.
+
 ### events_when_hit:
 
 List of one (or more) events.
 
 Events that will be posted when this device is hit or advanced.
 
+If you do not provide a value for this config, the default
+[`logicblock_(name)_hit`](../events/logicblock_name_hit.md) will be used.
+
 ### persist_state:
 
 Single value, type: `boolean` (`true`/`false`). Default: `false`

docs/cookbook/TAF_mansion_awards.md

@@ -531,7 +531,7 @@ for the achievement group, so hitting either one of those will start the
 selected achievement (if the group is enabled) and also stop this mode.
 
 You may be wondering why we have both of those ball enter events listed
-here? Why not just use an "events_when_started" setting in the
+here? Why not just use an `events_when_started:` setting in the
 achievement group to stop this mode? The reason is for this rule here:
 
 * Accumulating 15, 25, 35, 45, 55, 65, 75, 85, 95 bear kicks (center

docs/events/logicblock_name_complete.md

@@ -12,7 +12,7 @@ Event is posted by [counters:](../config/counters.md), [accruals:](../config/acc
 The logic block called (name) has just been completed.
 
 Note that this is the default completion event for logic blocks, but
-this can be changed in a logic block's "events_when_complete:"
+this can be changed in a logic block's `events_when_complete:`
 setting, so this might not be the actual event that's posted for all
 logic blocks in your machine.
 

docs/events/logicblock_name_hit.md

@@ -11,9 +11,52 @@ Event is posted by [counters:](../config/counters.md), [accruals:](../config/acc
 
 The logic block (name) was just hit.
 
-Note that this is the default hit event for logic blocks, but this can
-be changed in a logic block's "events_when_hit:" setting, so this
-might not be the actual event that's posted for all logic blocks in
-your machine.
+Note that this is the default completion event for logic blocks, but
+this can be changed in a logic block's `events_when_hit:`
+setting, so this might not be the actual event that's posted for all
+logic blocks in your machine.
 
---8<-- "event_no_keywords_notice.md"
+#### Deprecation warning:
+
+In previous versions of MPF, the event `counter_(name)_hit` was used for counters instead of this event, `logicblock_(name)_hit`.
+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),
+but `counter_(name)_hit` is considered deprecated and may be removed in future versions of MPF.
+
+
+## Keyword arguments
+
+(See the [Conditional Events](overview/conditional.md)
+guide for details for how to create entries in your config file that
+only respond to certain combinations of the arguments below.)
+
+Accruals, Counters, and Sequences each have different keyword arguments.
+
+### Accrual Keyword arguments
+
+#### `step`:
+
+The 0-based integer number of the step that was just hit.
+
+### Counter Keyword arguments
+
+If the counter has a config setting for `count_complete_value`,
+`count`, `hits` and `remaining` towards that goal will be included as arguments.
+If `count_complete_value` is `None`, then only `count` will be included.
+
+#### `count`:
+
+The current value of the counter.
+
+#### `hits`:
+
+The numbers of hits made on this counter.
+
+#### `remaining`:
+
+The numbers of hits remaining before completing this counter.
+
+### Sequence Keyword arguments
+
+#### `step`:
+
+The 0-based integer number of the step that was just hit.