Support the BCP modifications in MPF 0.20.

Removal of attract_start, attract_stop, game_start, game_stop commands. Renaming of all player variable names to player_num. Added player_num to player_variable command. Updated documentation. Updated BCP Server version to 1.01.
missionpinball · Sep 15, 2015 · b0769bb · b0769bb
1 parent fe66f95
commit b0769bb
Show file tree

Hide file tree

Showing 83 changed files with 1,396 additions and 1,286 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,20 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain
+
+Assets/BCP/Docs/* linguist-documentation
+
diff --git a/...ts/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Developer's Guide.pdf b/...ts/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Developer's Guide.pdf
diff --git a/Assets/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Deveoper's Guide.pdf b/Assets/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Deveoper's Guide.pdf
diff --git a/Assets/BCP/Docs/html/annotated.html b/Assets/BCP/Docs/html/annotated.html
@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Backbox Communication Protocol (BCP) Server for Unity
-   &#160;<span id="projectnumber">1.00</span>
+   &#160;<span id="projectnumber">1.01</span>
    </div>
   </td>
  </tr>
@@ -86,17 +86,18 @@
 <tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_player_turn_start_message_event_args.html" target="_self">PlayerTurnStartMessageEventArgs</a></td><td class="desc">Event arguments for the "player_turn_start" BCP message. </td></tr>
 <tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_player_variable_message_event_args.html" target="_self">PlayerVariableMessageEventArgs</a></td><td class="desc">Event arguments for the "player_variable" BCP message. </td></tr>
 <tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_reset_message_event_args.html" target="_self">ResetMessageEventArgs</a></td><td class="desc">Event arguments for the "reset" BCP message. </td></tr>
-<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_switch_message_event_args.html" target="_self">SwitchMessageEventArgs</a></td><td class="desc">Event arguments for the "switch" BCP message. </td></tr>
-<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_timer_message_event_args.html" target="_self">TimerMessageEventArgs</a></td><td class="desc">Event arguments for the "timer" BCP message. </td></tr>
-<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_trigger_message_event_args.html" target="_self">TriggerMessageEventArgs</a></td><td class="desc">Event arguments for the "trigger" BCP message. </td></tr>
+<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_shot_message_event_args.html" target="_self">ShotMessageEventArgs</a></td><td class="desc">Event arguments for the "shot" BCP message. </td></tr>
+<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_switch_message_event_args.html" target="_self">SwitchMessageEventArgs</a></td><td class="desc">Event arguments for the "switch" BCP message. </td></tr>
+<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_timer_message_event_args.html" target="_self">TimerMessageEventArgs</a></td><td class="desc">Event arguments for the "timer" BCP message. </td></tr>
+<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_trigger_message_event_args.html" target="_self">TriggerMessageEventArgs</a></td><td class="desc">Event arguments for the "trigger" BCP message. </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Sat Jun 27 2015 11:35:53 for Backbox Communication Protocol (BCP) Server for Unity by
+    <li class="footer">Generated on Tue Sep 15 2015 08:45:33 for Backbox Communication Protocol (BCP) Server for Unity by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
   </ul>

diff --git a/Assets/BCP/Docs/html/annotated.js b/Assets/BCP/Docs/html/annotated.js
@@ -15,6 +15,7 @@ var annotated =
     [ "PlayerTurnStartMessageEventArgs", "class_player_turn_start_message_event_args.html", "class_player_turn_start_message_event_args" ],
     [ "PlayerVariableMessageEventArgs", "class_player_variable_message_event_args.html", "class_player_variable_message_event_args" ],
     [ "ResetMessageEventArgs", "class_reset_message_event_args.html", "class_reset_message_event_args" ],
+    [ "ShotMessageEventArgs", "class_shot_message_event_args.html", "class_shot_message_event_args" ],
     [ "SwitchMessageEventArgs", "class_switch_message_event_args.html", "class_switch_message_event_args" ],
     [ "TimerMessageEventArgs", "class_timer_message_event_args.html", "class_timer_message_event_args" ],
     [ "TriggerMessageEventArgs", "class_trigger_message_event_args.html", "class_trigger_message_event_args" ]

diff --git a/Assets/BCP/Docs/html/class_ball_start_message_event_args-members.html b/Assets/BCP/Docs/html/class_ball_start_message_event_args-members.html
@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Backbox Communication Protocol (BCP) Server for Unity
-   &#160;<span id="projectnumber">1.00</span>
+   &#160;<span id="projectnumber">1.01</span>
    </div>
   </td>
  </tr>
@@ -73,16 +73,16 @@
 <p>This is the complete list of members for <a class="el" href="class_ball_start_message_event_args.html">BallStartMessageEventArgs</a>, including all inherited members.</p>
 <table class="directory">
   <tr class="even"><td class="entry"><a class="el" href="class_ball_start_message_event_args.html#a99ce8517b34c1465f4c2cc7be724e138">Ball</a></td><td class="entry"><a class="el" href="class_ball_start_message_event_args.html">BallStartMessageEventArgs</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="class_ball_start_message_event_args.html#acda0acbb139b05626e3833bc523e7273">BallStartMessageEventArgs</a>(BcpMessage bcpMessage, int player, int ball)</td><td class="entry"><a class="el" href="class_ball_start_message_event_args.html">BallStartMessageEventArgs</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_ball_start_message_event_args.html#aaafaf6d9137cfba7fd663d30a65b4ae9">BallStartMessageEventArgs</a>(BcpMessage bcpMessage, int playerNum, int ball)</td><td class="entry"><a class="el" href="class_ball_start_message_event_args.html">BallStartMessageEventArgs</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_bcp_message_event_args.html#a49fb554851a147519da36d836bd224e1">BcpMessage</a></td><td class="entry"><a class="el" href="class_bcp_message_event_args.html">BcpMessageEventArgs</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_bcp_message_event_args.html#a032cf097dd63bae14aefb2a379fd478c">BcpMessageEventArgs</a>(BcpMessage bcpMessage)</td><td class="entry"><a class="el" href="class_bcp_message_event_args.html">BcpMessageEventArgs</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_ball_start_message_event_args.html#a81fac40280b740d718765cbd38209e58">Player</a></td><td class="entry"><a class="el" href="class_ball_start_message_event_args.html">BallStartMessageEventArgs</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_ball_start_message_event_args.html#a1945a77d084234af695405aad9dccd06">PlayerNum</a></td><td class="entry"><a class="el" href="class_ball_start_message_event_args.html">BallStartMessageEventArgs</a></td><td class="entry"></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Sat Jun 27 2015 11:35:53 for Backbox Communication Protocol (BCP) Server for Unity by
+    <li class="footer">Generated on Tue Sep 15 2015 08:45:33 for Backbox Communication Protocol (BCP) Server for Unity by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
   </ul>

diff --git a/Assets/BCP/Docs/html/class_ball_start_message_event_args.html b/Assets/BCP/Docs/html/class_ball_start_message_event_args.html
@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Backbox Communication Protocol (BCP) Server for Unity
-   &#160;<span id="projectnumber">1.00</span>
+   &#160;<span id="projectnumber">1.01</span>
    </div>
   </td>
  </tr>
@@ -88,19 +88,19 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
-<tr class="memitem:acda0acbb139b05626e3833bc523e7273"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ball_start_message_event_args.html#acda0acbb139b05626e3833bc523e7273">BallStartMessageEventArgs</a> (<a class="el" href="class_bcp_message.html">BcpMessage</a> bcpMessage, int player, int ball)</td></tr>
-<tr class="memdesc:acda0acbb139b05626e3833bc523e7273"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new instance of the <a class="el" href="class_ball_start_message_event_args.html" title="Event arguments for the &quot;ball_start&quot; BCP message. ">BallStartMessageEventArgs</a> class.  <a href="#acda0acbb139b05626e3833bc523e7273">More...</a><br /></td></tr>
-<tr class="separator:acda0acbb139b05626e3833bc523e7273"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aaafaf6d9137cfba7fd663d30a65b4ae9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ball_start_message_event_args.html#aaafaf6d9137cfba7fd663d30a65b4ae9">BallStartMessageEventArgs</a> (<a class="el" href="class_bcp_message.html">BcpMessage</a> bcpMessage, int playerNum, int ball)</td></tr>
+<tr class="memdesc:aaafaf6d9137cfba7fd663d30a65b4ae9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new instance of the <a class="el" href="class_ball_start_message_event_args.html" title="Event arguments for the &quot;ball_start&quot; BCP message. ">BallStartMessageEventArgs</a> class.  <a href="#aaafaf6d9137cfba7fd663d30a65b4ae9">More...</a><br /></td></tr>
+<tr class="separator:aaafaf6d9137cfba7fd663d30a65b4ae9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_methods_class_bcp_message_event_args"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_bcp_message_event_args')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_bcp_message_event_args.html">BcpMessageEventArgs</a></td></tr>
 <tr class="memitem:a032cf097dd63bae14aefb2a379fd478c inherit pub_methods_class_bcp_message_event_args"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_bcp_message_event_args.html#a032cf097dd63bae14aefb2a379fd478c">BcpMessageEventArgs</a> (<a class="el" href="class_bcp_message.html">BcpMessage</a> bcpMessage)</td></tr>
 <tr class="memdesc:a032cf097dd63bae14aefb2a379fd478c inherit pub_methods_class_bcp_message_event_args"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new instance of the <a class="el" href="class_bcp_message_event_args.html" title="Base class for all BCP message event arguments classes. Contains the BcpMessage for the event...">BcpMessageEventArgs</a> class.  <a href="#a032cf097dd63bae14aefb2a379fd478c">More...</a><br /></td></tr>
 <tr class="separator:a032cf097dd63bae14aefb2a379fd478c inherit pub_methods_class_bcp_message_event_args"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
 Properties</h2></td></tr>
-<tr class="memitem:a81fac40280b740d718765cbd38209e58"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ball_start_message_event_args.html#a81fac40280b740d718765cbd38209e58">Player</a><code> [get, set]</code></td></tr>
-<tr class="memdesc:a81fac40280b740d718765cbd38209e58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the player number.  <a href="#a81fac40280b740d718765cbd38209e58">More...</a><br /></td></tr>
-<tr class="separator:a81fac40280b740d718765cbd38209e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1945a77d084234af695405aad9dccd06"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ball_start_message_event_args.html#a1945a77d084234af695405aad9dccd06">PlayerNum</a><code> [get, set]</code></td></tr>
+<tr class="memdesc:a1945a77d084234af695405aad9dccd06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the player number.  <a href="#a1945a77d084234af695405aad9dccd06">More...</a><br /></td></tr>
+<tr class="separator:a1945a77d084234af695405aad9dccd06"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a99ce8517b34c1465f4c2cc7be724e138"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ball_start_message_event_args.html#a99ce8517b34c1465f4c2cc7be724e138">Ball</a><code> [get, set]</code></td></tr>
 <tr class="memdesc:a99ce8517b34c1465f4c2cc7be724e138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the ball number.  <a href="#a99ce8517b34c1465f4c2cc7be724e138">More...</a><br /></td></tr>
 <tr class="separator:a99ce8517b34c1465f4c2cc7be724e138"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -112,7 +112,7 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Event arguments for the "ball_start" BCP message. </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
-<a class="anchor" id="acda0acbb139b05626e3833bc523e7273"></a>
+<a class="anchor" id="aaafaf6d9137cfba7fd663d30a65b4ae9"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -126,7 +126,7 @@
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">int&#160;</td>
-          <td class="paramname"><em>player</em>, </td>
+          <td class="paramname"><em>playerNum</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
@@ -146,7 +146,7 @@
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">bcpMessage</td><td>The BCP message.</td></tr>
-    <tr><td class="paramname">player</td><td>The player number.</td></tr>
+    <tr><td class="paramname">playerNum</td><td>The player number.</td></tr>
     <tr><td class="paramname">ball</td><td>The ball number.</td></tr>
   </table>
   </dd>
@@ -178,15 +178,15 @@ <h2 class="groupheader">Property Documentation</h2>
 
 </div>
 </div>
-<a class="anchor" id="a81fac40280b740d718765cbd38209e58"></a>
+<a class="anchor" id="a1945a77d084234af695405aad9dccd06"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">int BallStartMessageEventArgs.Player</td>
+          <td class="memname">int BallStartMessageEventArgs.PlayerNum</td>
         </tr>
       </table>
   </td>
@@ -210,7 +210,7 @@ <h2 class="groupheader">Property Documentation</h2>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="class_ball_start_message_event_args.html">BallStartMessageEventArgs</a></li>
-    <li class="footer">Generated on Sat Jun 27 2015 11:35:53 for Backbox Communication Protocol (BCP) Server for Unity by
+    <li class="footer">Generated on Tue Sep 15 2015 08:45:33 for Backbox Communication Protocol (BCP) Server for Unity by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
   </ul>

diff --git a/Assets/BCP/Docs/html/class_ball_start_message_event_args.js b/Assets/BCP/Docs/html/class_ball_start_message_event_args.js
@@ -1,6 +1,6 @@
 var class_ball_start_message_event_args =
 [
-    [ "BallStartMessageEventArgs", "class_ball_start_message_event_args.html#acda0acbb139b05626e3833bc523e7273", null ],
+    [ "BallStartMessageEventArgs", "class_ball_start_message_event_args.html#aaafaf6d9137cfba7fd663d30a65b4ae9", null ],
     [ "Ball", "class_ball_start_message_event_args.html#a99ce8517b34c1465f4c2cc7be724e138", null ],
-    [ "Player", "class_ball_start_message_event_args.html#a81fac40280b740d718765cbd38209e58", null ]
+    [ "PlayerNum", "class_ball_start_message_event_args.html#a1945a77d084234af695405aad9dccd06", null ]
 ];
diff --git a/Assets/BCP/Docs/html/class_bcp_logger-members.html b/Assets/BCP/Docs/html/class_bcp_logger-members.html
@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Backbox Communication Protocol (BCP) Server for Unity
-   &#160;<span id="projectnumber">1.00</span>
+   &#160;<span id="projectnumber">1.01</span>
    </div>
   </td>
  </tr>
@@ -82,7 +82,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Sat Jun 27 2015 11:35:53 for Backbox Communication Protocol (BCP) Server for Unity by
+    <li class="footer">Generated on Tue Sep 15 2015 08:45:33 for Backbox Communication Protocol (BCP) Server for Unity by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
   </ul>

diff --git a/Assets/BCP/Docs/html/class_bcp_logger.html b/Assets/BCP/Docs/html/class_bcp_logger.html
@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Backbox Communication Protocol (BCP) Server for Unity
-   &#160;<span id="projectnumber">1.00</span>
+   &#160;<span id="projectnumber">1.01</span>
    </div>
   </td>
  </tr>
@@ -221,7 +221,7 @@ <h2 class="groupheader">Property Documentation</h2>
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="class_bcp_logger.html">BcpLogger</a></li>
-    <li class="footer">Generated on Sat Jun 27 2015 11:35:53 for Backbox Communication Protocol (BCP) Server for Unity by
+    <li class="footer">Generated on Tue Sep 15 2015 08:45:33 for Backbox Communication Protocol (BCP) Server for Unity by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
   </ul>

diff --git a/Assets/BCP/Docs/html/class_bcp_message-members.html b/Assets/BCP/Docs/html/class_bcp_message-members.html
@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Backbox Communication Protocol (BCP) Server for Unity
-   &#160;<span id="projectnumber">1.00</span>
+   &#160;<span id="projectnumber">1.01</span>
    </div>
   </td>
  </tr>
@@ -90,7 +90,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Sat Jun 27 2015 11:35:53 for Backbox Communication Protocol (BCP) Server for Unity by
+    <li class="footer">Generated on Tue Sep 15 2015 08:45:33 for Backbox Communication Protocol (BCP) Server for Unity by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
   </ul>