Skip to content

Commit e83159f

Browse files
authored
Merge pull request #588 from bosh/more_anchors
Cleaning up more anchors
2 parents 3bcec43 + fa4d679 commit e83159f

File tree

34 files changed

+457
-479
lines changed

34 files changed

+457
-479
lines changed

docs/config/multiballs.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,8 @@ Single value, type: `time string (ms) or template`
122122
[Instructions for entering templates](instructions/dynamic_values.md)). Default: `0`
123123

124124
The time before the add-a-ball ball save ends (in MPF time string
125-
format) that will cause the [multiball](../index.md)_\(name\)_hurry_up event to be
126-
posted. Use this to change the script for the light or trigger other
127-
effect.
125+
format) that will cause the [multiball_(name)\_hurry_up](../events/multiball_multiball_hurry_up.md) event to be
126+
posted. Use this to change the script for the light or trigger other effect.
128127

129128
### add_a_ball_shoot_again:
130129

@@ -149,21 +148,21 @@ number of balls it should add into play. Adjusting this setting is
149148
useful when you have multiple (or stacked) multiballs and you want to
150149
control how the combined counts work.
151150

152-
*total*
151+
#### *total*:
153152

154-
: Means the `ball_count:` setting will provide a target for the total
155-
number of balls that should be in play when this multiball starts.
156-
So if this multiball has a `ball_count: 3`, and it starts when 2
157-
balls are live on the playfield, then this multiball will only add 1
158-
more ball to bring the total to 3.
153+
Means the `ball_count:` setting will provide a target for the total
154+
number of balls that should be in play when this multiball starts.
155+
So if this multiball has a `ball_count: 3`, and it starts when 2
156+
balls are live on the playfield, then this multiball will only add 1
157+
more ball to bring the total to 3.
159158

160-
*add*
159+
#### *add*:
161160

162-
: Means that the `ball_count:` setting will specify the number of
163-
balls that are added into play on top of whatever number of balls
164-
are already in play. So if this multiball is set to `ball_count: 2`
165-
and there are already 2 balls in play, then this multiball will add
166-
2 more balls for a total of 4 balls live.
161+
Means that the `ball_count:` setting will specify the number of
162+
balls that are added into play on top of whatever number of balls
163+
are already in play. So if this multiball is set to `ball_count: 2`
164+
and there are already 2 balls in play, then this multiball will add
165+
2 more balls for a total of 4 balls live.
167166

168167
### ball_locks:
169168

@@ -217,7 +216,7 @@ Single value, type: `time string (ms) or template`
217216
[Instructions for entering templates](instructions/dynamic_values.md)). Default: `0`
218217

219218
The time before the ball save ends (in MPF time string format) that will
220-
cause the [multiball](../index.md)_\(name\)_hurry_up event to be posted. Use this
219+
cause the [multiball_(name)\_hurry_up](../events/multiball_multiball_hurry_up.md) event to be posted. Use this
221220
to change the script for the light or trigger other effect.
222221

223222
### replace_balls_in_play:

docs/config/show_player.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,39 +46,37 @@ your config. (If you don't include them, the default will be used).
4646
Single value, type: one of the following options: play, stop, pause,
4747
resume, advance, step_back, update, queue. Default: `play`
4848

49-
`play`
49+
#### `play`:
5050

51-
: Starts playing the show. This is the default action which will
52-
happen if you don't include an `action:` setting.
51+
Starts playing the show. This is the default action which will
52+
happen if you don't include an `action:` setting.
5353

54-
`stop`
54+
#### `stop`:
5555

56-
: Stops the show. Removes and "undoes" anything the show did, and
57-
posts the show stop events.
56+
Stops the show. Removes and "undoes" anything the show did, and
57+
posts the show stop events.
5858

59-
`pause`
59+
#### `pause`:
6060

61-
: Pauses the show by holding it at the current step. Posts the show
62-
pause events.
61+
Pauses the show by holding it at the current step. Posts the show pause events.
6362

64-
`resume`
63+
#### `resume`:
6564

66-
: Resumes a previously paused show.
65+
Resumes a previously paused show.
6766

68-
`advance`
67+
#### `advance`:
6968

70-
: Manually advances a show to the next step. Posts the show advance
71-
events.
69+
Manually advances a show to the next step. Posts the show advance events.
7270

73-
`step_back`
71+
#### `step_back`
7472

75-
: Manually moves the show back to the previous step. Posts the show
76-
step_back events.
73+
Manually moves the show back to the previous step. Posts the show
74+
step_back events.
7775

78-
`update`
76+
#### `update`:
7977

80-
: Not yet implemented. In the future it will be used to change a
81-
setting of a running show, like changing the playback speed.
78+
Not yet implemented. In the future it will be used to change a
79+
setting of a running show, like changing the playback speed.
8280

8381
### block_queue:
8482

docs/config/slide_player.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,25 +42,24 @@ your config. (If you don't include them, the default will be used).
4242
Single value, type: one of the following options: play, remove. Default:
4343
`play`
4444

45-
`play`
45+
#### `play`:
4646

47-
: Makes the slide active. Note that the actual slide shown on a
48-
display will be whichever active slide has the highest priority, so
49-
depending on what other slides are active, this action might not
50-
technically show the slide.
47+
Makes the slide active. Note that the actual slide shown on a
48+
display will be whichever active slide has the highest priority, so
49+
depending on what other slides are active, this action might not
50+
technically show the slide.
5151

52-
Also note that if a transition is specified (either in the slide
53-
definition or the `transition:` section here, then than transition
54-
will be used when showing this slide.
52+
Also note that if a transition is specified (either in the slide
53+
definition or the `transition:` section here, then than transition
54+
will be used when showing this slide.
5555

56-
`remove`
56+
#### `remove`:
5757

58-
: Removes the slide from the list of active slides. If this slide is
59-
the highest priority slide that's currently showing, then the
60-
next-highest priority slide will be shown in its place.
58+
Removes the slide from the list of active slides. If this slide is
59+
the highest priority slide that's currently showing, then the
60+
next-highest priority slide will be shown in its place.
6161

62-
If a `transition_out:` setting is used, then that transition will be
63-
used here.
62+
If a `transition_out:` setting is used, then that transition will be used here.
6463

6564
For example, to remove *slide1* when the event *remove_slide_1* is
6665
posted:

docs/config/timer_control_events.md

Lines changed: 46 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -60,77 +60,76 @@ change_tick_interval, reset_tick_interval.
6060
Take a look at the various types of actions you can perform on timers
6161
with control events:
6262

63-
`add`
63+
#### `add`:
6464

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.
6969

70-
This action does not change the timer's running state.
70+
This action does not change the timer's running state.
7171

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.
7676

77-
`subtract`
77+
#### `subtract`:
7878

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.
8282

83-
`jump`
83+
#### `jump`:
8484

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.
8787

88-
`start`
88+
#### `start`:
8989

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.
9292

93-
`stop`
93+
#### `stop`:
9494

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.
9797

98-
`reset`
98+
#### `reset`:
9999

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.
102102

103-
`restart`
103+
#### `restart`:
104104

105-
: Acts as a combination of reset, then start.
105+
Acts as a combination of reset, then start.
106106

107-
`pause`
107+
#### `pause`:
108108

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.
114114

115-
`set_tick_interval`
115+
#### `set_tick_interval`:
116116

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).
119118

120-
`change_tick_interval`
119+
#### `change_tick_interval`:
121120

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.
127126

128-
`reset_tick_interval`
127+
#### `reset_tick_interval`:
129128

130-
: (added in MPF 0.33)
129+
(added in MPF 0.33)
131130

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.
134133

135134
### event:
136135

docs/config/widget_player.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,18 +82,17 @@ your config. (If you don't include them, the default will be used).
8282
Single value, type: one of the following options: add, remove, update.
8383
Default: `add`
8484

85-
`add`
85+
#### `add`:
8686

87-
: The widget or widget group is added to the slide or display target.
87+
The widget or widget group is added to the slide or display target.
8888

89-
`remove`
89+
#### `remove`:
9090

91-
: The widget or widget group is removed from the slide or display
92-
target.
91+
The widget or widget group is removed from the slide or display target.
9392

94-
`update`
93+
#### `update`:
9594

96-
: One or more of the widget or widget group's properties is updated.
95+
One or more of the widget or widget group's properties is updated.
9796

9897
### key:
9998

0 commit comments

Comments
 (0)