Merge pull request #530 from bosh/patch3

Event reference survey and cleanup
missionpinball · Jan 1, 2025 · 2cf8fc5 · 2cf8fc5
2 parents f39c6a2 + a2d0743
commit 2cf8fc5
Show file tree

Hide file tree

Showing 155 changed files with 506 additions and 505 deletions.
diff --git a/docs/config/plugins.md b/docs/config/plugins.md
@@ -15,6 +15,6 @@ title: "plugins:"
 The `plugins:` section of your config is where you list all plugin
 classes to load. By default it contains:
 
-* [auditor](info_lights.md)
-* [auditor](switch_player.md)
+* [info_lights:](info_lights.md)
+* [switch_player:](switch_player.md)
 * [auditor:](auditor.md)
diff --git a/docs/events/achievement_achievement_changed_state.md b/docs/events/achievement_achievement_changed_state.md
@@ -1,13 +1,13 @@
 ---
-title: [achievement](../index.md)(name)_changed_state
+title: achievement_(name)_changed_state
 ---
 
-# [achievement](../index.md)(name)_changed_state
+# achievement_(name)_changed_state
 
 
 --8<-- "event.md"
 
-Achievement (name) changed state.
+The achievement called (name) changed state.
 
 Valid states are: disabled, enabled, started, completed, stopped
 

diff --git a/docs/events/achievement_achievement_state_state.md b/docs/events/achievement_achievement_state_state.md
@@ -1,13 +1,13 @@
 ---
-title: [achievement](../index.md)(name)_[state](../index.md)(state)
+title: achievement_(name)_state_(state)
 ---
 
-# [achievement](../index.md)(name)_[state](../index.md)(state)
+# achievement_(name)_state_(state)
 
 
 --8<-- "event.md"
 
-Achievement (name) changed to state (state).
+The achievement called (name) changed to state (state).
 
 Valid states are: disabled, enabled, started, completed, stopped
 

diff --git a/docs/events/ball_hold_ball_hold_balls_released.md b/docs/events/ball_hold_ball_hold_balls_released.md
@@ -1,13 +1,13 @@
 ---
-title: [ball_hold](../index.md)(name)_balls_released
+title: ball_hold_(name)_balls_released
 ---
 
-# [ball_hold](../index.md)(name)_balls_released
+# ball_hold_(name)_balls_released
 
 
 --8<-- "event.md"
 
-The ball hold device (name) has just released a ball(s).
+The ball hold device called (name) has just released a ball(s).
 
 ## Keyword arguments
 

diff --git a/docs/events/ball_hold_ball_hold_full.md b/docs/events/ball_hold_ball_hold_full.md
@@ -1,13 +1,13 @@
 ---
-title: [ball_hold](../index.md)(name)_full
+title: ball_hold_(name)_full
 ---
 
-# [ball_hold](../index.md)(name)_full
+# ball_hold_(name)_full
 
 
 --8<-- "event.md"
 
-The ball hold device (name) is now full.
+The ball hold device called (name) is now full.
 
 ## Keyword arguments
 

diff --git a/docs/events/ball_hold_ball_hold_held_ball.md b/docs/events/ball_hold_ball_hold_held_ball.md
@@ -1,13 +1,13 @@
 ---
-title: [ball_hold](../index.md)(name)_held_ball
+title: ball_hold_(name)_held_ball
 ---
 
-# [ball_hold](../index.md)(name)_held_ball
+# ball_hold_(name)_held_ball
 
 
 --8<-- "event.md"
 
-The ball hold device (name) has just held additional ball(s).
+The ball hold device called (name) has just held additional ball(s).
 
 ## Keyword arguments
 

diff --git a/docs/events/ball_save_ball_save_disabled.md b/docs/events/ball_save_ball_save_disabled.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_disabled
+title: ball_save_(name)_disabled
 ---
 
-# [ball_save](../index.md)(name)_disabled
+# ball_save_(name)_disabled
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_save_ball_save_enabled.md b/docs/events/ball_save_ball_save_enabled.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_enabled
+title: ball_save_(name)_enabled
 ---
 
-# [ball_save](../index.md)(name)_enabled
+# ball_save_(name)_enabled
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_save_ball_save_grace_period.md b/docs/events/ball_save_ball_save_grace_period.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_grace_period
+title: ball_save_(name)_grace_period
 ---
 
-# [ball_save](../index.md)(name)_grace_period
+# ball_save_(name)_grace_period
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_save_ball_save_hurry_up.md b/docs/events/ball_save_ball_save_hurry_up.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_hurry_up
+title: ball_save_(name)_hurry_up
 ---
 
-# [ball_save](../index.md)(name)_hurry_up
+# ball_save_(name)_hurry_up
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_save_ball_save_saving_ball.md b/docs/events/ball_save_ball_save_saving_ball.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_saving_ball
+title: ball_save_(name)_saving_ball
 ---
 
-# [ball_save](../index.md)(name)_saving_ball
+# ball_save_(name)_saving_ball
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_save_ball_save_timer_start.md b/docs/events/ball_save_ball_save_timer_start.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_timer_start
+title: ball_save_(name)_timer_start
 ---
 
-# [ball_save](../index.md)(name)_timer_start
+# ball_save_(name)_timer_start
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_save_multiball_add_a_ball_timer_start.md b/docs/events/ball_save_multiball_add_a_ball_timer_start.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_add_a_ball_timer_start
+title: ball_save_(name)_add_a_ball_timer_start
 ---
 
-# [ball_save](../index.md)(name)_add_a_ball_timer_start
+# ball_save_(name)_add_a_ball_timer_start
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_save_multiball_timer_start.md b/docs/events/ball_save_multiball_timer_start.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_save](../index.md)(name)_timer_start
+title: ball_save_(name)_timer_start
 ---
 
-# [ball_save](../index.md)(name)_timer_start
+# ball_save_(name)_timer_start
 
 
 --8<-- "event.md"

diff --git a/docs/events/ball_search_phase_num.md b/docs/events/ball_search_phase_num.md
@@ -1,8 +1,8 @@
 ---
-title: [ball_search_phase](../index.md)(num)
+title: ball_search_phase_(num)
 ---
 
-# [ball_search_phase](../index.md)(num)
+# ball_search_phase_(num)
 
 
 --8<-- "event.md"

diff --git a/docs/events/balldevice_ball_device_ball_count_changed.md b/docs/events/balldevice_ball_device_ball_count_changed.md
@@ -1,8 +1,8 @@
 ---
-title: [balldevice](../index.md)(name)_ball_count_changed
+title: balldevice_(name)_ball_count_changed
 ---
 
-# [balldevice](../index.md)(name)_ball_count_changed
+# balldevice_(name)_ball_count_changed
 
 
 --8<-- "event.md"

diff --git a/docs/events/balldevice_ball_device_ball_eject_attempt.md b/docs/events/balldevice_ball_device_ball_eject_attempt.md
@@ -1,13 +1,13 @@
 ---
-title: [balldevice](../index.md)(name)_ball_eject_attempt
+title: balldevice_(name)_ball_eject_attempt
 ---
 
-# [balldevice](../index.md)(name)_ball_eject_attempt
+# balldevice_(name)_ball_eject_attempt
 
 
 --8<-- "event.md"
 
-The ball device called "name" is attempting to eject a ball (or
+The ball device called (name) is attempting to eject a ball (or
 balls). This is a queue event. The eject will not actually be attempted
 until the queue is cleared.
 

diff --git a/docs/events/balldevice_ball_device_ball_eject_failed.md b/docs/events/balldevice_ball_device_ball_eject_failed.md
@@ -1,8 +1,8 @@
 ---
-title: [balldevice](../index.md)(name)_ball_eject_failed
+title: balldevice_(name)_ball_eject_failed
 ---
 
-# [balldevice](../index.md)(name)_ball_eject_failed
+# balldevice_(name)_ball_eject_failed
 
 
 --8<-- "event.md"

diff --git a/docs/events/balldevice_ball_device_ball_eject_success.md b/docs/events/balldevice_ball_device_ball_eject_success.md
@@ -1,13 +1,13 @@
 ---
-title: [balldevice](../index.md)(name)_ball_eject_success
+title: balldevice_(name)_ball_eject_success
 ---
 
-# [balldevice](../index.md)(name)_ball_eject_success
+# balldevice_(name)_ball_eject_success
 
 
 --8<-- "event.md"
 
-One or more balls has successfully ejected from the device (name).
+One or more balls has successfully ejected from the device called (name).
 
 ## Keyword arguments
 

diff --git a/docs/events/balldevice_ball_device_ball_enter.md b/docs/events/balldevice_ball_device_ball_enter.md
@@ -1,13 +1,13 @@
 ---
-title: [balldevice](../index.md)(name)_ball_enter
+title: balldevice_(name)_ball_enter
 ---
 
-# [balldevice](../index.md)(name)_ball_enter
+# balldevice_(name)_ball_enter
 
 
 --8<-- "event.md"
 
-A ball (or balls) have just entered the ball device called "name".
+A ball (or balls) have just entered the ball device called (name).
 
 Note that this is a relay event based on the "unclaimed_balls" arg.
 Any unclaimed balls in the relay will be processed as new balls entering

diff --git a/docs/events/balldevice_ball_device_ball_entered.md b/docs/events/balldevice_ball_device_ball_entered.md
@@ -1,13 +1,13 @@
 ---
-title: [balldevice](../index.md)(name)_ball_entered
+title: balldevice_(name)_ball_entered
 ---
 
-# [balldevice](../index.md)(name)_ball_entered
+# balldevice_(name)_ball_entered
 
 
 --8<-- "event.md"
 
-A ball (or balls) have just entered the ball device called "name".
+A ball (or balls) have just entered the ball device called (name).
 
 The ball was also added to balls and available_balls of the device.
 

diff --git a/docs/events/balldevice_ball_device_ball_missing.md b/docs/events/balldevice_ball_device_ball_missing.md
@@ -1,8 +1,8 @@
 ---
-title: [balldevice](../index.md)(name)_ball_missing
+title: balldevice_(name)_ball_missing
 ---
 
-# [balldevice](../index.md)(name)_ball_missing
+# balldevice_(name)_ball_missing
 
 
 --8<-- "event.md"

diff --git a/docs/events/balldevice_ball_device_broken.md b/docs/events/balldevice_ball_device_broken.md
@@ -1,13 +1,13 @@
 ---
-title: [balldevice](../index.md)(name)_broken
+title: balldevice_(name)_broken
 ---
 
-# [balldevice](../index.md)(name)_broken
+# balldevice_(name)_broken
 
 
 --8<-- "event.md"
 
-The ball device called "name" is broken and will no longer operate.
+The ball device called (name) is broken and will no longer operate.
 
 *This event does not have any keyword arguments*
 

diff --git a/docs/events/balldevice_ball_device_ejecting_ball.md b/docs/events/balldevice_ball_device_ejecting_ball.md
@@ -1,13 +1,13 @@
 ---
-title: [balldevice](../index.md)(name)_ejecting_ball
+title: balldevice_(name)_ejecting_ball
 ---
 
-# [balldevice](../index.md)(name)_ejecting_ball
+# balldevice_(name)_ejecting_ball
 
 
 --8<-- "event.md"
 
-The ball device called "name" is ejecting a ball right now.
+The ball device called (name) is ejecting a ball right now.
 
 ## Keyword arguments
 

diff --git a/docs/events/balldevice_captured_from_captures_from.md b/docs/events/balldevice_captured_from_captures_from.md
@@ -1,8 +1,8 @@
 ---
-title: [balldevice_captured_from](../index.md)(captures_from)
+title: balldevice_captured_from_(captures_from)
 ---
 
-# [balldevice_captured_from](../index.md)(captures_from)
+# balldevice_captured_from_(captures_from)
 
 
 --8<-- "event.md"

diff --git a/docs/events/combo_switch_both.md b/docs/events/combo_switch_both.md
@@ -1,13 +1,13 @@
 ---
-title: (name)_both
+title: (combo_switch_name)_both
 ---
 
-# (name)_both
+# (combo_switch_name)_both
 
 
 --8<-- "event.md"
 
-Combo switch (name) changed to state both.
+Combo switch named (combo_switch_name) changed to state both.
 
 A switch from group 1 and group 2 are both active at the same time,
 having been pressed within the `max_offset_time:` and being active for

diff --git a/docs/events/combo_switch_inactive.md b/docs/events/combo_switch_inactive.md
@@ -1,13 +1,13 @@
 ---
-title: (name)_inactive
+title: (combo_switch_name)_inactive
 ---
 
-# (name)_inactive
+# (combo_switch_name)_inactive
 
 
 --8<-- "event.md"
 
-Combo switch (name) changed to state inactive.
+Combo switch named (combo_switch_name) changed to state inactive.
 
 Both switches are inactive.
 

diff --git a/docs/events/combo_switch_one.md b/docs/events/combo_switch_one.md
@@ -1,13 +1,13 @@
 ---
-title: (name)_one
+title: (combo_switch_name)_one
 ---
 
-# (name)_one
+# (combo_switch_name)_one
 
 
 --8<-- "event.md"
 
-Combo switch (name) changed to state one.
+Combo switch named (combo_switch_name) changed to state one.
 
 Either switch 1 or switch 2 has been released for at least the
 `release_time:` but the other switch is still active.