Merge pull request #560 from bosh/patch15

Reorganize Events Reference section of the site to group events by type

docs/config/achievement_groups.md

@@ -54,7 +54,7 @@ achievement_groups:
 More examples:
 
 * [Recipe: The Addams Family Mansion Awards](../cookbook/TAF_mansion_awards.md)
-* [/game_logic/achievements/index](../examples/index.md)
+* [Achievements](../../game_logic/achievements)
 
 ## Required settings
 

docs/events/achievement_achievement_state_state.md

@@ -2,7 +2,7 @@
 title: achievement_(name)_state_(state)
 ---
 
-# achievement_(name)_state_(state)
+# achievement_(name)\_state_(state)
 
 
 --8<-- "event.md"

docs/events/ball_will_start.md

@@ -8,7 +8,7 @@ title: ball_will_start
 --8<-- "event.md"
 
 The ball is about to start. This event is posted just before
-[/events/overview/conditional](ball_starting.md).
+[ball_starting](ball_starting.md).
 
 ## Keyword arguments
 

docs/events/index_achievements.md

@@ -7,5 +7,5 @@ title: achievement event index
 
 See: [achievements:](../config/achievements.md)
 
-* [achievement_(name)_changed_state](achievement_achievement_changed_state.md)
-* [achievement_(name)_state_(state)](achievement_achievement_state_state.md)
+* [achievement_(name)\_changed_state](achievement_achievement_changed_state.md)
+* [achievement_(name)\_state_(state)](achievement_achievement_state_state.md)

docs/events/index_ball_devices.md

@@ -7,15 +7,15 @@ title: ball_device event index
 
 See: [ball_devices:](../config/ball_devices.md)
 
-* [balldevice_(name)_ball_eject_failed](balldevice_ball_device_ball_eject_failed.md)
-* [balldevice_(name)_ball_eject_attempt](balldevice_ball_device_ball_eject_attempt.md)
-* [balldevice_(name)_ejecting_ball](balldevice_ball_device_ejecting_ball.md)
-* [balldevice_(name)_ball_eject_success](balldevice_ball_device_ball_eject_success.md)
-* [balldevice_(name)_broken](balldevice_ball_device_broken.md)
-* [balldevice_(name)_ball_count_changed](balldevice_ball_device_ball_count_changed.md)
-* [balldevice_(name)_captured_from_(captures_from)](balldevice_captured_from_captures_from.md)
-* [balldevice_(name)_ball_enter](balldevice_ball_device_ball_enter.md)
-* [balldevice_(name)_ball_entered](balldevice_ball_device_ball_entered.md)
-* [balldevice_(name)_ball_missing](balldevice_ball_device_ball_missing.md)
+* [balldevice_(name)\_ball_eject_failed](balldevice_ball_device_ball_eject_failed.md)
+* [balldevice_(name)\_ball_eject_attempt](balldevice_ball_device_ball_eject_attempt.md)
+* [balldevice_(name)\_ejecting_ball](balldevice_ball_device_ejecting_ball.md)
+* [balldevice_(name)\_ball_eject_success](balldevice_ball_device_ball_eject_success.md)
+* [balldevice_(name)\_broken](balldevice_ball_device_broken.md)
+* [balldevice_(name)\_ball_count_changed](balldevice_ball_device_ball_count_changed.md)
+* [balldevice_(name)\_captured_from_(captures_from)](balldevice_captured_from_captures_from.md)
+* [balldevice_(name)\_ball_enter](balldevice_ball_device_ball_enter.md)
+* [balldevice_(name)\_ball_entered](balldevice_ball_device_ball_entered.md)
+* [balldevice_(name)\_ball_missing](balldevice_ball_device_ball_missing.md)
 * [balldevice_ball_missing](balldevice_ball_missing.md)
 * [balldevice_balls_available](balldevice_balls_available.md)

docs/events/index_ball_holds.md

@@ -7,6 +7,6 @@ title: ball_hold event index
 
 See: [ball_holds:](../config/ball_holds.md)
 
-* [ball_hold_(name)_held_ball](ball_hold_ball_hold_held_ball.md)
-* [ball_hold_(name)_full](ball_hold_ball_hold_full.md)
-* [ball_hold_(name)_balls_released](ball_hold_ball_hold_balls_released.md)
+* [ball_hold_(name)\_held_ball](ball_hold_ball_hold_held_ball.md)
+* [ball_hold_(name)\_full](ball_hold_ball_hold_full.md)
+* [ball_hold_(name)\_balls_released](ball_hold_ball_hold_balls_released.md)

docs/events/index_ball_saves.md

@@ -9,7 +9,7 @@ See: [ball_saves:](../config/ball_saves.md)
 
 * [ball_save_(name)_enabled](ball_save_ball_save_enabled.md)
 * [ball_save_(name)_disabled](ball_save_ball_save_disabled.md)
-* [ball_save_(name)_timer_start](ball_save_ball_save_timer_start.md)
-* [ball_save_(name)_hurry_up](ball_save_ball_save_hurry_up.md)
-* [ball_save_(name)_grace_period](ball_save_ball_save_grace_period.md)
-* [ball_save_(name)_saving_ball](ball_save_ball_save_saving_ball.md)
+* [ball_save_(name)\_timer_start](ball_save_ball_save_timer_start.md)
+* [ball_save_(name)\_hurry_up](ball_save_ball_save_hurry_up.md)
+* [ball_save_(name)\_grace_period](ball_save_ball_save_grace_period.md)
+* [ball_save_(name)\_saving_ball](ball_save_ball_save_saving_ball.md)

docs/events/index_combo_switches.md

@@ -10,5 +10,5 @@ See: [combo_switches:](../config/combo_switches.md)
 * [(combo_switch_name)_one](combo_switch_one.md)
 * [(combo_switch_name)_both](combo_switch_both.md)
 * [(combo_switch_name)_inactive](combo_switch_inactive.md)
-* [(combo_switch_name)_switches_2](combo_switch_switches_1.md)
-* [(combo_switch_name)_switches_2](combo_switch_switches_2.md)
+* [(combo_switch_name)\_switches_2](combo_switch_switches_1.md)
+* [(combo_switch_name)\_switches_2](combo_switch_switches_2.md)

docs/events/index_extra_ball_groups.md

@@ -10,5 +10,5 @@ See: [extra_ball_groups:](../config/extra_ball_groups.md)
 * [extra_ball_group_(name)_awarded](extra_ball_group_extra_ball_group_awarded.md)
 * [extra_ball_group_(name)_lit](extra_ball_group_extra_ball_group_lit.md)
 * [extra_ball_group_(name)_unlit](extra_ball_group_extra_ball_group_unlit.md)
-* [extra_ball_group_(name)_award_disabled](extra_ball_group_extra_ball_group_award_disabled.md)
-* [extra_ball_group_(name)_lit_awarded](extra_ball_group_extra_ball_group_lit_awarded.md)
+* [extra_ball_group_(name)\_award_disabled](extra_ball_group_extra_ball_group_award_disabled.md)
+* [extra_ball_group_(name)\_lit_awarded](extra_ball_group_extra_ball_group_lit_awarded.md)

docs/events/index_extra_balls.md

@@ -8,7 +8,7 @@ title: extra_ball event index
 See: [extra_balls:](../config/extra_balls.md)
 
 * [extra_ball_award_disabled](extra_ball_award_disabled.md)
-* [extra_ball_(name)_award_disabled](extra_ball_extra_ball_award_disabled.md)
+* [extra_ball_(name)\_award_disabled](extra_ball_extra_ball_award_disabled.md)
 * [extra_ball_(name)_lit](extra_ball_extra_ball_lit.md)
 * [extra_ball_(name)_awarded](extra_ball_extra_ball_awarded.md)
 * [extra_ball_awarded](extra_ball_awarded.md)

docs/events/index_motors.md

@@ -7,4 +7,4 @@ title: motor event index
 
 See: [motors](../config/motors.md)
 
-* [motor_(name)_reached_(position)](motor_motor_reached_position.md)
+* [motor_(name)\_reached_(position)](motor_motor_reached_position.md)

docs/events/index_multiball_locks.md

@@ -7,5 +7,5 @@ title: multiball_lock event index
 
 See: [multiball_locks:](../config/multiball_locks.md)
 
-* [multiball_lock_(name)_locked_ball](multiball_lock_multiball_lock_locked_ball.md)
 * [multiball_lock_(name)_full](multiball_lock_multiball_lock_full.md)
+* [multiball_lock_(name)\_locked_ball](multiball_lock_multiball_lock_locked_ball.md)

docs/events/index_multiballs.md

@@ -8,11 +8,11 @@ title: multiball event index
 See: [multiballs:](../config/multiballs.md)
 
 * [multiball_(name)_started](multiball_multiball_started.md)
-* [multiball_(name)_hurry_up](multiball_multiball_hurry_up.md)
-* [multiball_(name)_grace_period](multiball_multiball_grace_period.md)
-* [multiball_(name)_shoot_again](multiball_multiball_shoot_again.md)
-* [multiball_(name)_lost_ball](multiball_multiball_lost_ball.md)
-* [multiball_(name)_shoot_again_ended](multiball_multiball_shoot_again_ended.md)
+* [multiball_(name)\_hurry_up](multiball_multiball_hurry_up.md)
+* [multiball_(name)\_grace_period](multiball_multiball_grace_period.md)
+* [multiball_(name)\_shoot_again](multiball_multiball_shoot_again.md)
+* [multiball_(name)\_lost_ball](multiball_multiball_lost_ball.md)
+* [multiball_(name)\_shoot_again_ended](multiball_multiball_shoot_again_ended.md)
 * [multiball_(name)_ended](multiball_multiball_ended.md)
 * [ball_save_(multiball_name)_start](ball_save_multiball_timer_start.md)
-* [ball_save_(multiball_name)_add_a_ball_timer_start](ball_save_multiball_add_a_ball_timer_start.md)
+* [ball_save_(multiball_name)\_add_a_ball_timer_start](ball_save_multiball_add_a_ball_timer_start.md)

docs/events/index_player_vars.md

@@ -8,3 +8,4 @@ title: player_var event index
 See: [player_vars:](../config/player_vars.md)
 
 * [player_(var_name)](player_player_var.md)
+* [player_score](player_score.md)

docs/events/index_playfield_transfers.md

@@ -7,4 +7,4 @@ title: playfield_transfer event index
 
 See: [playfield_transfers:](../config/playfield_transfers.md)
 
-* [playfield_transfer_(name)_ball_transferred](playfield_transfer_playfield_transfer_ball_transferred)
+* [playfield_transfer_(name)\_ball_transferred](playfield_transfer_playfield_transfer_ball_transferred)

docs/events/index_playfields.md

@@ -7,7 +7,7 @@ title: playfield event index
 
 See: [playfields:](../config/playfields.md)
 
-* [(playfield)_ball_count_change](playfield_ball_count_change.md)
+* [(playfield)\_ball_count_change](playfield_ball_count_change.md)
 * [(playfield)_active](playfield_active.md)
-* [sw_(playfield)_active](sw_playfield_active.md)
+* [sw_(playfield_name)_active](sw_playfield_active.md)
 * [unexpected_ball_on_(playfield)](unexpected_ball_on_playfield.md)

docs/events/index_shot_groups.md

@@ -8,6 +8,6 @@ title: shot_group event index
 See: [shot_groups:](../config/shot_groups.md)
 
 * [(shot_group)_complete](shot_group_complete.md)
-* [(shot_group)_(state)_complete](shot_group_state_complete.md)
+* [(shot_group)\_(state)_complete](shot_group_state_complete.md)
 * [(shot_group)_hit](shot_group_hit.md)
-* [(shot_group)_(state)_hit](shot_group_state_hit.md)
+* [(shot_group)\_(state)_hit](shot_group_state_hit.md)

docs/events/index_shots.md

@@ -8,6 +8,6 @@ title: shot event index
 See: [shots:](../config/shots.md)
 
 * [(shot)_hit](shot_hit.md)
-* [(shot)_(profile)_hit](shot_profile_hit.md)
-* [(shot)_(profile)_(state)_hit](shot_profile_state_hit.md)
-* [(shot)_(state)_hit](shot_state_hit.md)
+* [(shot)\_(profile)_hit](shot_profile_hit.md)
+* [(shot)\_(profile)\_(state)_hit](shot_profile_state_hit.md)
+* [(shot)\_(state)_hit](shot_state_hit.md)

docs/events/index_spinners.md

@@ -11,5 +11,5 @@ See: [spinners:](../config/spinners.md)
 * [spinner_(name)_inactive](spinner_spinner_inactive.md)
 * [spinner_(name)_idle](spinner_spinner_idle.md)
 * [spinner_(name)_active](spinner_spinner_active.md)
-* [spinner_(name)_(label)_hit](spinner_spinner_label_hit.md)
-* [spinner_(name)_(label)_active](spinner_spinner_label_active.md)
+* [spinner_(name)\_(label)_hit](spinner_spinner_label_hit.md)
+* [spinner_(name)\_(label)_active](spinner_spinner_label_active.md)

docs/events/index_timed_switches.md

@@ -9,3 +9,5 @@ See: [timed_switches:](../config/timed_switches.md)
 
 * [(timed_switch)_active](timed_switch_active.md)
 * [(timed_switch)_released](timed_switch_released.md)
+* [flipper_cradle](flipper_cradle.md)
+* [flipper_cradle_released](flipper_cradle_released.md)

docs/events/index_timers.md

@@ -11,6 +11,6 @@ See: [timers:](../config/timers.md)
 * [timer_(name)_stopped](timer_timer_stopped.md)
 * [timer_(name)_paused](timer_timer_paused.md)
 * [timer_(name)_complete](timer_timer_complete.md)
-* [timer_(name)_time_added](timer_timer_time_added.md)
-* [timer_(name)_time_subtracted](timer_timer_time_subtracted.md)
+* [timer_(name)\_time_added](timer_timer_time_added.md)
+* [timer_(name)\_time_subtracted](timer_timer_time_subtracted.md)
 * [timer_(name)_tick](timer_timer_tick.md)

docs/events/motor_motor_reached_position.md

@@ -2,7 +2,7 @@
 title: motor_(name)_reached_(position)
 ---
 
-# motor_(name)_reached_(position)
+# motor_(name)\_reached_(position)
 
 
 --8<-- "event.md"

docs/events/player_score.md

@@ -7,7 +7,7 @@ title: player_score
 
 --8<-- "event.md"
 
-The player has scored.
+The player has scored. This is a built-in example version of the [player_(var_name)](player_player_var.md) event used when score changes.
 
 ## Keyword arguments
 

docs/events/shot_profile_state_hit.md

@@ -2,7 +2,7 @@
 title: (shot_name)_(profile)_(state)_hit
 ---
 
-# (shot_name)_(profile)_(state)_hit
+# (shot_name)\_(profile)\_(state)_hit
 
 
 --8<-- "event.md"