Skip to content

Commit 86b7b52

Browse files
committed
add event args for logic_block_name_hit events, which vary on type
and even within counter, based on whether there is a goal number
1 parent 8949265 commit 86b7b52

File tree

1 file changed

+36
-5
lines changed

1 file changed

+36
-5
lines changed

docs/events/logicblock_name_hit.md

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

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

14-
Note that this is the default hit event for logic blocks, but this can
15-
be changed in a logic block's "events_when_hit:" setting, so this
16-
might not be the actual event that's posted for all logic blocks in
17-
your machine.
14+
## Keyword arguments
1815

19-
--8<-- "event_no_keywords_notice.md"
16+
(See the [Conditional Events](overview/conditional.md)
17+
guide for details for how to create entries in your config file that
18+
only respond to certain combinations of the arguments below.)
19+
20+
Accruals, Counters, and Sequences each have different keyword arguments.
21+
22+
### Accrual Keyword arguments
23+
24+
#### `step`:
25+
26+
The 0-based integer number of the step that was just hit.
27+
28+
### Counter Keyword arguments
29+
30+
If the counter has a config setting for `count_complete_value`,
31+
`count`, `hits` and `remaining` towards that goal will be included as arguments.
32+
If `count_complete_value` is `None`, then only `count` will be included.
33+
34+
#### `count`:
35+
36+
The current value of the counter.
37+
38+
#### `hits`:
39+
40+
The numbers of hits made on this counter.
41+
42+
#### `remaining`:
43+
44+
The numbers of hits remaining before completing this counter.
45+
46+
### Sequence Keyword arguments
47+
48+
#### `step`:
49+
50+
The 0-based integer number of the step that was just hit.

0 commit comments

Comments
 (0)