Merge pull request #605 from bosh/high_score_events

High score events

Author: bosh

docs/config/shots.md

@@ -19,7 +19,7 @@ be hit in order, or an event or series of events.
 Shots are used for things like standup targets, rollover lanes, drop
 targets, ramps, loops, orbits, etc.
 
-Each shot can have a [*shot profile*](shot_profile.md) applied to it which defines what
+Each shot can have a [*shot profile*](shot_profiles.md) applied to it which defines what
 happens when its hit. For example the shot profile might specify that
 the shot starts unlit, then when it's hit it becomes complete. Or a
 shot profile might specify that it's flashing slowly, and each hit

docs/events/award_name_award_display.md

@@ -0,0 +1,34 @@
+---
+title: (award_name)\_award_display
+---
+
+# (award_name)\_award_display
+
+
+--8<-- "event.md"
+
+Event is posted by [high_score](../config/high_score.md) built-in mode
+when a player has entered their name for an award.
+
+This event will be posted along with [(category_name)\_award_display](category_name_award_display.md)
+and [high_score_award_display](high_score_award_display.md),
+so you can pick whichever name and level of specificity you prefer to hook
+on to, and do not need to check for all three.
+
+## Keyword arguments
+
+(See the [Conditional Events](overview/conditional.md)
+guide for details for how to create entries in your config file that
+only respond to certain combinations of the arguments below.)
+
+#### `player_name`:
+
+The letters that the player has entered as their name.
+
+#### `award`:
+
+The name of the award the player earned.
+
+#### `value`:
+
+The number value of the record. This may be score or the custom value used to rank the performance.

docs/events/category_name_award_display.md

@@ -0,0 +1,42 @@
+---
+title: (category_name)\_award_display
+---
+
+# (category_name)\_award_display
+
+
+--8<-- "event.md"
+
+Event is posted by [high_score](../config/high_score.md) built-in mode
+when a player has entered their name for an award.
+
+This event will be posted along with [(award_name)\_award_display](award_name_award_display.md)
+and [high_score_award_display](high_score_award_display.md),
+so you can pick whichever name and level of specificity you prefer to hook
+on to, and do not need to check for all three.
+
+## Keyword arguments
+
+(See the [Conditional Events](overview/conditional.md)
+guide for details for how to create entries in your config file that
+only respond to certain combinations of the arguments below.)
+
+#### `category_name`:
+
+The name of the category for the event. This is included both in the event name and as the keyword argument "category_name".
+
+#### `player_num`:
+
+The number (1-4) of the player.
+
+#### `player_name`:
+
+The letters that the player has entered as their name.
+
+#### `award`:
+
+The name of the award the player earned.
+
+#### `value`:
+
+The number value of the record. This may be score or the custom value used to rank the performance.

docs/events/high_score/index.md

@@ -0,0 +1,15 @@
+---
+title: High Score event index
+---
+
+# High Score events
+
+
+See: [high_score:](../../config/high_score.md)
+
+  * [high_score_enter_initials](../high_score_enter_initials.md)
+  * [high_score_award_display](../high_score_award_display.md)
+  * [text_input_high_score_complete](../text_input_high_score_complete.md)
+  * [score_award_display](../score_award_display.md)
+  * [(award_name)\_award_display](../award_name_award_display.md)
+  * [(category_name)\_award_display](../category_name_award_display.md)

docs/events/high_score_award_display.md

@@ -0,0 +1,34 @@
+---
+title: high_score_award_display
+---
+
+# high_score_award_display
+
+
+--8<-- "event.md"
+
+Event is posted by [high_score](../config/high_score.md) built-in mode
+when a player has entered their name for an award.
+
+This event will be posted along with [(award_name)\_award_display](award_name_award_display.md)
+and [(category_name)\_award_display](category_name_award_display.md),
+so you can pick whichever name and level of specificity you prefer to hook
+on to, and do not need to check for all three.
+
+## Keyword arguments
+
+(See the [Conditional Events](overview/conditional.md)
+guide for details for how to create entries in your config file that
+only respond to certain combinations of the arguments below.)
+
+#### `player_name`:
+
+The letters that the player has entered as their name.
+
+#### `award`:
+
+The name of the award the player earned.
+
+#### `value`:
+
+The number value of the record. This may be score or the custom value used to rank the performance.

docs/events/high_score_enter_initials.md

@@ -0,0 +1,29 @@
+---
+title: high_score_enter_initials
+---
+
+# high_score_enter_initials
+
+
+--8<-- "event.md"
+
+Event is posted by [high_score](../config/high_score.md) built-in mode
+when requesting that a player enters their name for a record.
+
+## Keyword arguments
+
+(See the [Conditional Events](overview/conditional.md)
+guide for details for how to create entries in your config file that
+only respond to certain combinations of the arguments below.)
+
+#### `player_num`:
+
+The number (1-4) of the player.
+
+#### `award`:
+
+The name of the award the player earned.
+
+#### `value`:
+
+The number value of the record. This may be score or the custom value used to rank the performance.

docs/events/index.md

@@ -114,6 +114,14 @@ will posted an event called *switch_s_left_slingshot_active*.
     * [extra_ball_group_(name)\_lit_awarded](extra_ball_group_extra_ball_group_lit_awarded.md)
     * [extra_ball_group_(name)_unlit](extra_ball_group_extra_ball_group_unlit.md)
 
+* [High Score Events](high_score/index.md)
+    * [high_score_enter_initials](high_score_enter_initials.md)
+    * [high_score_award_display](high_score_award_display.md)
+    * [text_input_high_score_complete](text_input_high_score_complete.md)
+    * [score_award_display](score_award_display.md)
+    * [(award_name)\_award_display](award_name_award_display.md)
+    * [(category_name)\_award_display](category_name_award_display.md)
+
 * [Kickback Events](kickbacks/index.md)
     * [kickback_(name)_fired](kickback_kickback_fired.md)
 

docs/events/score_award_display.md

@@ -0,0 +1,31 @@
+---
+title: score_award_display
+---
+
+# score_award_display
+
+
+--8<-- "event.md"
+
+Event is posted by [high_score](../config/high_score.md) built-in mode
+when a player has entered their name for a score award. This is the standard
+record type that is included with the mode, and is actually just the "score"
+version of the event [(award_name)\_award_display](award_name_award_display.md).
+
+## Keyword arguments
+
+(See the [Conditional Events](overview/conditional.md)
+guide for details for how to create entries in your config file that
+only respond to certain combinations of the arguments below.)
+
+#### `player_name`:
+
+The letters that the player has entered as their name.
+
+#### `award`:
+
+The name of the award the player earned.
+
+#### `value`:
+
+The number value of the record. This may be score or the custom value used to rank the performance.

docs/events/text_input_high_score_complete.md

@@ -0,0 +1,26 @@
+---
+title: text_input_high_score_complete
+---
+
+# text_input_high_score_complete
+
+
+--8<-- "event.md"
+
+Event is posted by the BCP integration for the [high_score](../config/high_score.md) built-in mode.
+When using the high_score built-in behaviors, 
+
+## Keyword arguments
+
+(See the [Conditional Events](overview/conditional.md)
+guide for details for how to create entries in your config file that
+only respond to certain combinations of the arguments below.)
+
+#### text:
+
+The text value submitted for the current record. This value will be saved
+with the record and transmitted through the events
+[(award_name)\_award_display](award_name_award_display.md),
+[(category_name)\_award_display](category_name_award_display.md),
+and [high_score_award_display](high_score_award_display.md)
+so that any following slides may display the name back to the user.

docs/game_logic/high_scores/index.md

@@ -7,7 +7,7 @@ title: High Scores
 
 Related Config File Sections:
 
-* [high_scores_in_ems](../../config/high_score.md)
+* [high_score:](../../config/high_score.md)
 
 MPF includes support for high scores which is where players can enter
 their names (or initials) when they've achieved a high score. Features
@@ -379,12 +379,12 @@ Generically, these machine variables are:
 
 ## Related How To guides:
 
-* [high_scores_in_ems](../scoring/index.md)
-* [high_scores_in_ems](../../game_design/index.md)
-* [High Scores in EM Machines](high_scores_in_ems.md)--
+* [Scoring](../scoring/index.md)
+* [How to design a game in MPF using Modes](../../game_design/index.md)
+* [High Scores in EM Machines](high_scores_in_ems.md)
 
 ## Related Events
 
+* [High Score Events](../../events/high_score/index.md)
 * [mode_high_score_started](../../events/mode_name_started.md)
-* [mode_high_score_stopped](../../events/mode_name_stopped.md)--
-* [High Scores in EM Machines](high_scores_in_ems.md)
+* [mode_high_score_stopped](../../events/mode_name_stopped.md)