Skip to content

Commit 8a51f1b

Browse files
authored
Merge pull request #590 from bosh/flipper_cancel_links
add more links to the flipper_cancel event page where it is referenced
2 parents 6b6ec0c + d1fff11 commit 8a51f1b

File tree

9 files changed

+18
-14
lines changed

9 files changed

+18
-14
lines changed

docs/config/bonus.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,15 @@ want to jump directly to the last slide, then you can enter a value of
6464

6565
### hurry_up_event:
6666

67-
Name of an event. Default is `flipper_cancel`.
67+
Name of an event. Default is `flipper_cancel`.
6868

6969
The event that will cause the bonus mode to change its delay between
7070
slides from the `display_delay_ms:` time to the `hurry_up_delay_ms:`
7171
time. When this event is posted, the next slide is shown immediately,
7272
and the timing is set to the new hurry up value.
7373

74+
See: [flipper_cancel](../events/flipper_cancel.md)
75+
7476
### end_bonus_event:
7577

7678
Name of an event. Default is `None`.

docs/events/flipper_cancel.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,7 @@ Note that in order for this event to work, you have to add
1616

1717
See [combo_switches:](../config/combo_switches.md) for details.
1818

19+
This event is used as the default [hurry_up_event](../config/bonus.md#hurry_up_event)
20+
for MPF's built-in bonus mode.
21+
1922
--8<-- "event_no_keywords_notice.md"

docs/game_logic/ball_start_end.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ shows:
238238
```
239239

240240
Both shows can be canceled using both flippers which will post the
241-
`flipper_cancel` event. Remove that
241+
[`flipper_cancel` event](../events/flipper_cancel.md). Remove that
242242
[show_player](../config/show_player.md) entry
243243
if you don't want that. See the
244244
[flipper mech](../mechs/flippers/index.md)

docs/game_logic/bonus/index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,7 @@ The bonus mode can be configured with more options, including:
122122

123123
* Reset player variables and/or multipliers after bonuses are awarded
124124
* Show bonus scores for entries that awarded zero points
125-
* "Hurry up" the bonus mode based on a triggering event (e.g.
126-
*flipper_cancel*)
125+
* "Hurry up" the bonus mode based on a triggering event (e.g. [*flipper_cancel*](../../events/flipper_cancel.md))
127126
* After awarding all bonuses, wait for an event before ending the mode
128127

129128
All these options are detailed in the [bonus (mode_settings:)](../../config/bonus.md) documentation.
@@ -133,7 +132,6 @@ All these options are detailed in the [bonus (mode_settings:)](../../config/bonu
133132
* [bonus_multiplier](../../events/bonus_multiplier.md)
134133
* [bonus_start](../../events/bonus_start.md)
135134
* [bonus_subtotal](../../events/bonus_subtotal.md)
136-
* Plus other events defined in your bonus mode's `bonus_entries`
137-
settings
135+
* Plus other events defined in your bonus mode's `bonus_entries` settings
138136

139137
* [How to configure End of Ball Bonus](configuring_bonus.md)

docs/game_logic/combo_switches.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ the same time. In fact MPF contains built-in support for the flipper
1818
cancel combo. If you add the tag `left_flipper` to your left flipper
1919
switch, and `right_flipper` to your right flipper switch, then whenever
2020
the player hits both flippers at the same time, an MPF event called
21-
*flipper_cancel* will be posted.
21+
[*flipper_cancel*](../events/flipper_cancel.md) will be posted.
2222

2323
Combo switches are also used for things like different kinds of skill
2424
shots. For example, in *Attack From Mars*, if the player hits the launch
@@ -61,7 +61,7 @@ player hits the flipper buttons within 500ms, then you can copy and add
6161
this section to your own machine config file and it will overwrite this
6262
default config.
6363

64-
Here is an example of using flipper_cancel to cancel a show:
64+
Here is an example of using [flipper_cancel](../events/flipper_cancel.md) to cancel a show:
6565

6666
``` yaml
6767
switches:
@@ -124,5 +124,6 @@ wil be one of the following: *inactive*, *both* or *one*.
124124
* [(combo_switch_name)_one](../events/combo_switch_one.md)
125125
* [(combo_switch_name)_both](../events/combo_switch_both.md)
126126
* [(combo_switch_name)_inactive](../events/combo_switch_inactive.md)
127-
* [(combo_switch_name)_switches_1](../events/combo_switch_switches_1.md)
128-
* [(combo_switch_name)_switches_2](../events/combo_switch_switches_2.md)
127+
* [(combo_switch_name)\_switches_1](../events/combo_switch_switches_1.md)
128+
* [(combo_switch_name)\_switches_2](../events/combo_switch_switches_2.md)
129+
* [flipper_cancel](../events/flipper_cancel.md)

docs/mechs/flippers/dual_wound.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ We also added tags called `left_flipper` and `right_flipper`. These are
7676
optional, but recommended. The reason is that MPF includes a
7777
[combo switch](../../game_logic/combo_switches.md) feature which posts events when player switches are held in
7878
combination. If you add these tags to your flipper switches, an event
79-
called *flipper_cancel* will be posted when the player hits both flipper
79+
called [*flipper_cancel*](../../events/flipper_cancel.md) will be posted when the player hits both flipper
8080
buttons at the same time which you can use to cancel shows and other
8181
things you want the player to be able to skip.
8282

docs/mechs/flippers/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ flipper device class).
8282
MPF contains built-in support for the flipper cancel combo. If you add
8383
the tag `left_flipper` to your left flipper switch, and `right_flipper`
8484
to your right flipper switch, then whenever the player hits both
85-
flippers at the same time, an MPF event called *flipper_cancel* will be
85+
flippers at the same time, an MPF event called [*flipper_cancel*](../../events/flipper_cancel.md) will be
8686
posted. This is implemented as
8787
[combo switch](../../game_logic/combo_switches.md).
8888

docs/mechs/flippers/single_wound.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ We also added tags called `left_flipper` and `right_flipper`. These are
5353
optional, but recommended. The reason is that MPF includes a
5454
[combo switch](../../game_logic/combo_switches.md) feature which posts events when player switches are held in
5555
combination. If you add these tags to your flipper switches, an event
56-
called *flipper_cancel* will be posted when the player hits both flipper
56+
called [*flipper_cancel*](../../events/flipper_cancel.md) will be posted when the player hits both flipper
5757
buttons at the same time which you can use to cancel shows and other
5858
things you want the player to be able to skip.
5959

docs/tutorial/3_get_flipping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Notice that we added tags called `left_flipper` and `right_flipper`.
6262
These are optional, but recommended. The reason is that MPF includes a
6363
[combo switch](../game_logic/combo_switches.md) feature which posts events when player switches are held in
6464
combination. If you add these tags to your flipper switches, an event
65-
called *flipper_cancel* will be posted when the player hits both flipper
65+
called [*flipper_cancel*](../../events/flipper_cancel.md) will be posted when the player hits both flipper
6666
buttons at the same time which you can use to cancel shows and other
6767
things you want the player to be able to skip.
6868

0 commit comments

Comments
 (0)