diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..15ed82b --- /dev/null +++ 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/Assets/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Developer's Guide.pdf b/Assets/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Developer's Guide.pdf new file mode 100644 index 0000000..5f9711e Binary files /dev/null and b/Assets/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Developer's Guide.pdf differ 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 deleted file mode 100644 index b086bb7..0000000 Binary files a/Assets/BCP/Docs/Backbox Communication Protocol (BCP) Server for Unity - Deveoper's Guide.pdf and /dev/null differ diff --git a/Assets/BCP/Docs/html/annotated.html b/Assets/BCP/Docs/html/annotated.html index 1af83f9..746952c 100644 --- a/Assets/BCP/Docs/html/annotated.html +++ b/Assets/BCP/Docs/html/annotated.html @@ -26,7 +26,7 @@
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
@@ -86,9 +86,10 @@  CPlayerTurnStartMessageEventArgsEvent arguments for the "player_turn_start" BCP message.  CPlayerVariableMessageEventArgsEvent arguments for the "player_variable" BCP message.  CResetMessageEventArgsEvent arguments for the "reset" BCP message. - CSwitchMessageEventArgsEvent arguments for the "switch" BCP message. - CTimerMessageEventArgsEvent arguments for the "timer" BCP message. - CTriggerMessageEventArgsEvent arguments for the "trigger" BCP message. + CShotMessageEventArgsEvent arguments for the "shot" BCP message. + CSwitchMessageEventArgsEvent arguments for the "switch" BCP message. + CTimerMessageEventArgsEvent arguments for the "timer" BCP message. + CTriggerMessageEventArgsEvent arguments for the "trigger" BCP message. @@ -96,7 +97,7 @@ - +
@@ -186,7 +186,7 @@

Property Documentation

@@ -210,7 +210,7 @@

Property Documentation

@@ -82,7 +82,7 @@ @@ -221,7 +221,7 @@

Property Documentation

@@ -90,7 +90,7 @@ @@ -504,7 +504,7 @@

Member Data Documentation

@@ -79,7 +79,7 @@ @@ -92,9 +92,10 @@ PlayerTurnStartMessageEventArgsPlayerVariableMessageEventArgsResetMessageEventArgs -SwitchMessageEventArgs -TimerMessageEventArgs -TriggerMessageEventArgs +ShotMessageEventArgs +SwitchMessageEventArgs +TimerMessageEventArgs +TriggerMessageEventArgs
- +
int BallStartMessageEventArgs.Playerint BallStartMessageEventArgs.PlayerNum
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
@@ -170,7 +171,7 @@

Property Documentation

@@ -74,8 +74,6 @@
Backbox Communication Protocol (BCP) Server for Unity -  1.00 +  1.01
- - @@ -86,8 +84,6 @@ - - @@ -99,14 +95,10 @@ - - - - @@ -119,36 +111,39 @@ - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + +
AddMessageToQueue(BcpMessage message)BcpMessageManager
AllMessageHandler(BcpMessage message)BcpMessageManagerprotected
AttractStartMessageHandler(BcpMessage message)BcpMessageManagerprotected
AttractStopMessageHandler(BcpMessage message)BcpMessageManagerprotected
BallEndMessageHandler(BcpMessage message)BcpMessageManagerprotected
BallStartMessageEventHandler(object sender, BallStartMessageEventArgs e)BcpMessageManager
BallStartMessageHandler(BcpMessage message)BcpMessageManagerprotected
ConfigMessageHandler(BcpMessage message)BcpMessageManagerprotected
ErrorMessageEventHandler(object sender, ErrorMessageEventArgs e)BcpMessageManager
ErrorMessageHandler(BcpMessage message)BcpMessageManagerprotected
GameEndMessageHandler(BcpMessage message)BcpMessageManagerprotected
GameStartMessageHandler(BcpMessage message)BcpMessageManagerprotected
GetMessageHandler(BcpMessage message)BcpMessageManagerprotected
GoodbyeMessageHandler(BcpMessage message)BcpMessageManagerprotected
HelloMessageEventHandler(object sender, HelloMessageEventArgs e)BcpMessageManager
ModeStartMessageHandler(BcpMessage message)BcpMessageManagerprotected
ModeStopMessageEventHandler(object sender, ModeStopMessageEventArgs e)BcpMessageManager
ModeStopMessageHandler(BcpMessage message)BcpMessageManagerprotected
OnAttractStartBcpMessageManagerstatic
OnAttractStopBcpMessageManagerstatic
OnBallEndBcpMessageManagerstatic
OnBallStartBcpMessageManagerstatic
OnConfigBcpMessageManagerstatic
OnErrorBcpMessageManagerstatic
OnGameEndBcpMessageManagerstatic
OnGameStartBcpMessageManagerstatic
OnGetBcpMessageManagerstatic
OnGoodbyeBcpMessageManagerstatic
OnHelloBcpMessageManagerstatic
OnPlayerVariableBcpMessageManagerstatic
OnResetBcpMessageManagerstatic
OnSetBcpMessageManagerstatic
OnSwitchBcpMessageManagerstatic
OnTimerBcpMessageManagerstatic
OnTriggerBcpMessageManagerstatic
PacketToBcpMessage(byte[] buffer, int length)BcpMessageManagerstatic
PlayerAddedMessageEventHandler(object sender, PlayerAddedMessageEventArgs e)BcpMessageManager
PlayerAddedMessageHandler(BcpMessage message)BcpMessageManagerprotected
PlayerScoreMessageEventHandler(object sender, PlayerScoreMessageEventArgs e)BcpMessageManager
PlayerScoreMessageHandler(BcpMessage message)BcpMessageManagerprotected
PlayerTurnStartMessageEventHandler(object sender, PlayerTurnStartMessageEventArgs e)BcpMessageManager
PlayerTurnStartMessageHandler(BcpMessage message)BcpMessageManagerprotected
PlayerVariableMessageEventHandler(object sender, PlayerVariableMessageEventArgs e)BcpMessageManager
PlayerVariableMessageHandler(BcpMessage message)BcpMessageManagerprotected
ResetMessageEventHandler(object sender, ResetMessageEventArgs e)BcpMessageManager
ResetMessageHandler(BcpMessage message)BcpMessageManagerprotected
SetAllMessageCallback(BcpMessageCallback messageCallback)BcpMessageManagerprotected
SetMessageCallback(string key, BcpMessageCallback messageCallback)BcpMessageManagerprotected
SetMessageHandler(BcpMessage message)BcpMessageManagerprotected
StringToBcpMessage(string rawMessageBuffer)BcpMessageManagerstatic
SwitchMessageEventHandler(object sender, SwitchMessageEventArgs e)BcpMessageManager
SwitchMessageHandler(BcpMessage message)BcpMessageManagerprotected
TimerMessageEventHandler(object sender, TimerMessageEventArgs e)BcpMessageManager
TimerMessageHandler(BcpMessage message)BcpMessageManagerprotected
TriggerMessageEventHandler(object sender, TriggerMessageEventArgs e)BcpMessageManager
TriggerMessageHandler(BcpMessage message)BcpMessageManagerprotected
OnShotBcpMessageManagerstatic
OnSwitchBcpMessageManagerstatic
OnTimerBcpMessageManagerstatic
OnTriggerBcpMessageManagerstatic
PacketToBcpMessage(byte[] buffer, int length)BcpMessageManagerstatic
PlayerAddedMessageEventHandler(object sender, PlayerAddedMessageEventArgs e)BcpMessageManager
PlayerAddedMessageHandler(BcpMessage message)BcpMessageManagerprotected
PlayerScoreMessageEventHandler(object sender, PlayerScoreMessageEventArgs e)BcpMessageManager
PlayerScoreMessageHandler(BcpMessage message)BcpMessageManagerprotected
PlayerTurnStartMessageEventHandler(object sender, PlayerTurnStartMessageEventArgs e)BcpMessageManager
PlayerTurnStartMessageHandler(BcpMessage message)BcpMessageManagerprotected
PlayerVariableMessageEventHandler(object sender, PlayerVariableMessageEventArgs e)BcpMessageManager
PlayerVariableMessageHandler(BcpMessage message)BcpMessageManagerprotected
ResetMessageEventHandler(object sender, ResetMessageEventArgs e)BcpMessageManager
ResetMessageHandler(BcpMessage message)BcpMessageManagerprotected
SetAllMessageCallback(BcpMessageCallback messageCallback)BcpMessageManagerprotected
SetMessageCallback(string key, BcpMessageCallback messageCallback)BcpMessageManagerprotected
SetMessageHandler(BcpMessage message)BcpMessageManagerprotected
ShotMessageEventHandler(object sender, ShotMessageEventArgs e)BcpMessageManager
ShotMessageHandler(BcpMessage message)BcpMessageManagerprotected
StringToBcpMessage(string rawMessageBuffer)BcpMessageManagerstatic
SwitchMessageEventHandler(object sender, SwitchMessageEventArgs e)BcpMessageManager
SwitchMessageHandler(BcpMessage message)BcpMessageManagerprotected
TimerMessageEventHandler(object sender, TimerMessageEventArgs e)BcpMessageManager
TimerMessageHandler(BcpMessage message)BcpMessageManagerprotected
TriggerMessageEventHandler(object sender, TriggerMessageEventArgs e)BcpMessageManager
TriggerMessageHandler(BcpMessage message)BcpMessageManagerprotected
- - -
-
- - - - - -
- - - - - - - - -
void BcpMessageManager.AttractStartMessageHandler (BcpMessage message)
-
-protected
-
- -

Internal message handler for all "attract_start" messages. Raises the OnAttractStart event.

-
Parameters
- - -
messageThe "attract_start" BCP message.
-
-
- -
-
- -
-
- - - - - -
- - - - - - - - -
void BcpMessageManager.AttractStopMessageHandler (BcpMessage message)
-
-protected
-
- -

Internal message handler for all "attract_stop" messages. Raises the OnAttractStop event.

-
Parameters
- - -
messageThe "attract_stop" BCP message.
-
-
-
@@ -780,70 +701,6 @@ - - - -
-
- - - - - -
- - - - - - - - -
void BcpMessageManager.GameEndMessageHandler (BcpMessage message)
-
-protected
-
- -

Internal message handler for all "game_end" messages. Raises the OnGameEnd event.

-
Parameters
- - -
messageThe "game_end" BCP message.
-
-
- -
-
- -
-
- - - - - -
- - - - - - - - -
void BcpMessageManager.GameStartMessageHandler (BcpMessage message)
-
-protected
-
- -

Internal message handler for all "game_start" messages. Raises the OnGameStart event.

-
Parameters
- - -
messageThe "game_start" BCP message.
-
-
-
@@ -1595,6 +1452,73 @@ + + + +
+
+ + + + + + + + + + + + + + + + + + +
delegate void BcpMessageManager.ShotMessageEventHandler (object sender,
ShotMessageEventArgs e 
)
+
+ +

Represents the method that will handle a 'shot' BCP message event.

+
Parameters
+ + + +
senderThe sender.
eThe SwitchMessageEventArgs instance containing the event message data.
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void BcpMessageManager.ShotMessageHandler (BcpMessage message)
+
+protected
+
+ +

Internal message handler for all "shot" messages. Raises the OnShot event.

+
Parameters
+ + +
messageThe "shot" BCP message.
+
+
+
@@ -1899,50 +1823,6 @@

Property Documentation

Event Documentation

- -
-
- - - - - -
- - - - -
BcpMessageEventHandler BcpMessageManager.OnAttractStart
-
-static
-
- -

Occurs when an "attract_start" BCP message is received (notification that attract mode has started).

- -
-
- -
-
- - - - - -
- - - - -
BcpMessageEventHandler BcpMessageManager.OnAttractStop
-
-static
-
- -

Occurs when an "attract_stop" BCP message is received (notification that attract mode has stopped). Typically this will be followed by a "game_start" message, though it could also be followed by service mode starting.

- -
-
@@ -2029,50 +1909,6 @@

Event Documentation

Occurs when an "error" BCP message is received. Indicates that a recent BCP message sent to BCP Triggered an error.

-
-
- -
-
- - - - - -
- - - - -
BcpMessageEventHandler BcpMessageManager.OnGameEnd
-
-static
-
- -

Occurs when a "game_end" BCP message is received. Indicates that a game has ended.

- -
-
- -
-
- - - - - -
- - - - -
BcpMessageEventHandler BcpMessageManager.OnGameStart
-
-static
-
- -

Occurs when a "game_start" BCP message is received. Indicates that a game has started.

-
@@ -2338,6 +2174,28 @@

Event Documentation

Occurs when a "set" BCP message is received. Tells the other side to set the value of one or more variables. For sanity reasons, all variable are to be lower case, must start with a letter, and may contain only lower case letters, numbers, and underscores. Variable names should be lowercased on arrival. Variable names can be no more than 32 characters. Variable values are of unbounded length. A value can be blank.

Setting a variable should have an immediate effect. For example if the system audio volume is set, it is expected that audio will immediate take on that volume value. Or if the high score is currently being displayed and its variable it set, it should immediately update the display.

+ + + +
+
+ + + + + +
+ + + + +
ShotMessageEventHandler BcpMessageManager.OnShot
+
+static
+
+ +

Occurs when a "shot" BCP message is received. This message indicates that a shot was just hit.

+
@@ -2415,7 +2273,7 @@

Event Documentation

+ +

The BCP Specification document version implemented

+ +
+ + +
+
+ + +
const string BcpServer.VERSION = "1.01"
@@ -302,7 +319,7 @@

Property Documentation