View Javadoc
1   /******************************************************************************
2    * FIBSMessages.java - Define the possible message types from FIBS. 
3    * $Id$
4    * 
5    * BuckoFIBS - Backgammon by BuckoSoft
6    * Copyright(c) 2009,2010 - Dick Balaska - BuckoSoft, Corp.
7    * 
8    * $Log$
9    * Revision 1.11  2013/11/09 06:32:20  dick
10   * Distinguish between "you were banned" vs. "PL was banned".
11   *
12   * Revision 1.10  2013/09/19 07:36:03  dick
13   * Add FIBS_YourEmailChanged.
14   *
15   * Revision 1.9  2011/07/16 02:42:10  dick
16   * Add CantWatchSelf.
17   *
18   * Revision 1.8  2011/07/04 03:35:18  dick
19   * Add DidntDoubleOrResign.
20   *
21   * Revision 1.7  2011/06/22 06:02:31  dick
22   * Define NobodyHeardYou.
23   *
24   * Revision 1.6  2011/05/21 05:06:58  dick
25   * Add FIBS_WantedToResign.
26   *
27   * Revision 1.5  2011/05/16 21:19:47  dick
28   * Add FIBS_StartingNewGameInMatch.
29   *
30   * Revision 1.4  2010/12/29 07:46:35  dick
31   * Add WaitForLastInvitation and WaitForAcceptResign.
32   *
33   * Revision 1.3  2010/03/03 13:12:21  inim
34   * Replaced (c) sign in comment mangled by CVS default encoding back to UTF-8
35   *
36   * Revision 1.2  2010/03/03 12:19:49  inim
37   * Moved source to UTF8 encoding from CP1252 encoding. To this end all source files' (c) message was updated to "Copyright© 2009,2010 - Dick Balaska - BuckoSoft, Corp.". This replaces the (c) sign to UTF8, and adds the new year 2010.
38   *
39   * Revision 1.1  2010/02/04 05:57:53  inim
40   * Mavenized project folder layout
41   *
42   * Revision 1.16  2009/05/09 03:42:27  dick
43   * Add PlayerBannedWatch and Doesn'tWantYouToWatch.
44   *
45   * Revision 1.15  2009/03/04 18:52:26  dick
46   * Add FIBS_HasNoSavedGames.
47   *
48   * Revision 1.14  2009/02/25 09:41:11  dick
49   * Handle ATTENTION messages from FIBS when it is shutting down.
50   *
51   * Revision 1.13  2009/02/14 12:30:21  dick
52   * BuckoFIBS is released under the GNU license.
53   *
54   * Revision 1.12  2009/02/11 09:09:43  dick
55   * Better beginning and ending your turn.
56   *
57   * Revision 1.11  2009/02/09 22:46:21  dick
58   * Add EchoJunk, a message we understand, but don't care about and should be echoed to the system pane.
59   *
60   * Revision 1.10  2009/02/06 07:56:48  dick
61   * Working on doubles.
62   *
63   * Revision 1.9  2009/02/05 05:57:23  dick
64   * Rework the sequence because i had 2 #43s (oops).
65   *
66   * Revision 1.8  2009/02/02 08:37:11  dick
67   * Add FIBS_RollBeforeMove().
68   *
69   * Revision 1.7  2009/01/31 06:04:19  dick
70   * Add YouAlreadyPlaying.
71   *
72   * Revision 1.6  2009/01/28 08:25:42  dick
73   * Add HasSavedGames and Talk to Self.
74   *
75   * Revision 1.5  2009/01/10 05:11:04  dick
76   * Add FIBS_PointsFor, a resuming match message.
77   *
78   * Revision 1.4  2009/01/09 07:33:22  dick
79   * Add FIBS_NotInteresting.
80   *
81   * Revision 1.3  2009/01/07 04:29:16  dick
82   * Javadoc.
83   *
84   * Revision 1.2  2009/01/06 08:05:28  dick
85   * Handle registering a new user.
86   *
87   * Revision 1.1  2008/12/13 06:57:11  dick
88   * Move ClientConnection, CookieMonster, and FIBSMessages to their own network package.
89   *
90   * Revision 1.3  2008/12/11 10:00:00  dick
91   * Add FIBS_BoardstyleSetTo.
92   *
93   * Revision 1.2  2008/12/09 20:02:44  dick
94   * Javadoc cleanup.
95   *
96   * Revision 1.1  2008/10/10 09:02:30  dick
97   * Finish implementing the FIBS CookieMonster.
98   *
99   */
100 
101 /* 
102  * This program is free software: you can redistribute it and/or modify
103  * it under the terms of the GNU General Public License as published by
104  * the Free Software Foundation, either version 3 of the License, or
105  * (at your option) any later version.
106  *
107  * This program is distributed in the hope that it will be useful,
108  * but WITHOUT ANY WARRANTY; without even the implied warranty of
109  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
110  * GNU General Public License for more details.
111  *
112  * You should have received a copy of the GNU General Public License
113  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
114  *
115  * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.
116  * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.
117  * 
118  */
119 package com.buckosoft.fibs.net;
120 
121 /** Define the possible message types from FIBS.
122  * @author cppc
123  * @author Dick Balaska
124  * @author Original author of C version says not to use his name
125  * @since 2008/10/08
126  * @version $Revision$ <br> $Date$
127  * @see <a href="http://www.fibs.com/fcm/">http://www.fibs.com/fcm/</a> <br>
128  * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/net/FIBSMessages.java">cvs FIBSMessages.java</a>
129  */
130 public interface FIBSMessages {
131 
132 	final static int	CLIP_VERSION	= 1008;
133 
134 	final static int	CLIP_WELCOME			= 1;
135 	final static int	CLIP_OWN_INFO			= 2;
136 	final static int	CLIP_MOTD_BEGIN			= 3;
137 	final static int	CLIP_MOTD_END			= 4;
138 	final static int	CLIP_WHO_INFO			= 5;
139 	final static int	CLIP_WHO_END			= 6;
140 	final static int	CLIP_LOGIN				= 7;
141 	final static int	CLIP_LOGOUT				= 8;
142 	final static int	CLIP_MESSAGE			= 9;
143 	final static int	CLIP_MESSAGE_DELIVERED	= 10;
144 	final static int	CLIP_MESSAGE_SAVED		= 11;
145 	final static int	CLIP_SAYS				= 12;
146 	final static int	CLIP_SHOUTS				= 13;
147 	final static int	CLIP_WHISPERS			= 14;
148 	final static int	CLIP_KIBITZES			= 15;
149 	final static int	CLIP_YOU_SAY			= 16;
150 	final static int	CLIP_YOU_SHOUT			= 17;
151 	final static int	CLIP_YOU_WHISPER		= 18;
152 	final static int	CLIP_YOU_KIBITZ			= 19;
153 	
154 	final static int	FIBS_BAD_COOKIE			= -1;
155 	final static int	FIBS_PreLogin			= 20;
156 	final static int	FIBS_LoginPrompt		= 21;
157 	final static int	FIBS_FailedLogin		= 22;
158 	final static int	FIBS_MOTD				= 23;
159 	final static int	FIBS_Goodbye			= 24;
160 	final static int	FIBS_PostGoodbye		= 25;	// "send cookies", etc.
161 	final static int	FIBS_Unknown			= 26;	// don't know the type, probably can ignore
162 	final static int	FIBS_Empty				= 27;	// empty string
163 	final static int	FIBS_Junk				= 28;	// a message we don't care about, but is not unknown
164 	final static int	FIBS_ClearScreen		= 29;
165 	final static int	FIBS_BAD_AcceptDouble	= 30;	// DANGER, WILL ROBINSON!!! See notes in .c file about these two cookies!
166 	final static int	FIBS_BAD_Board			= 31;
167 	final static int	FIBS_Average			= 32;
168 	final static int	FIBS_DiceTest			= 33;
169 	final static int	FIBS_Stat				= 34;
170 	final static int	FIBS_Why				= 35;
171 	final static int	FIBS_NoInfo				= 36;
172 	final static int	FIBS_LastLogout			= 37;
173 	final static int	FIBS_RatingCalcStart	= 38;
174 	final static int	FIBS_RatingCalcInfo		= 39;
175 	final static int	FIBS_SettingsHeader		= 40;
176 	final static int	FIBS_PlayerListHeader	= 41;
177 	final static int	FIBS_AwayListHeader		= 42;
178 	final static int	FIBS_RatingExperience	= 43;
179 
180 	final static int	FIBS_NotLoggedIn		= 44;
181 	final static int	FIBS_StillLoggedIn		= 45;
182 	final static int	FIBS_NoOneIsAway		= 46;
183 	final static int	FIBS_RatingsHeader		= 47;
184 	final static int	FIBS_IsPlayingWith		= 48;
185 	final static int	FIBS_Timeout			= 49;
186 	final static int	FIBS_UnknownCommand		= 50;
187 	final static int	FIBS_Username			= 51;
188 	final static int	FIBS_LastLogin			= 52;
189 	final static int	FIBS_YourLastLogin		= 53;
190 	final static int	FIBS_Registered			= 54;
191 	final static int	FIBS_ONEUSERNAME		= 55;
192 	final static int	FIBS_EnterUsername		= 56;
193 	final static int	FIBS_EnterPassword		= 57;
194 	final static int	FIBS_TypeInNo			= 58;
195 	final static int	FIBS_SavedScoreHeader	= 59;
196 	final static int	FIBS_NoSavedGames		= 60;
197 	final static int	FIBS_UsersHeardYou		= 61;
198 	final static int	FIBS_MessagesForYou		= 62;
199 	final static int	FIBS_IsAway				= 63;
200 	final static int	FIBS_OpponentLogsOut	= 64;
201 	final static int	FIBS_Waves				= 65;
202 	final static int	FIBS_WavesAgain			= 66;
203 	final static int	FIBS_YouGag				= 67;
204 	final static int	FIBS_YouUngag			= 68;
205 	final static int	FIBS_YouBlind			= 69;
206 	final static int	FIBS_YouUnblind			= 70;
207 	final static int	FIBS_WatchResign		= 71;
208 	final static int	FIBS_UseToggleReady		= 72;
209 	final static int	FIBS_WARNINGSavedMatch	= 73;
210 	final static int	FIBS_NoSavedMatch		= 74;
211 	final static int	FIBS_AlreadyPlaying		= 75;
212 	final static int	FIBS_DidntInvite		= 76;
213 	final static int	FIBS_WatchingHeader		= 77;
214 	final static int	FIBS_NotWatching		= 78;
215 	final static int	FIBS_NotWatchingPlaying = 79;
216 	final static int	FIBS_NotPlaying			= 80;
217 	final static int	FIBS_PlayerNotPlaying	= 81;
218 	final static int	FIBS_NoUser				= 82;
219 	final static int	FIBS_CantInviteSelf		= 83;
220 	final static int	FIBS_CantWatch			= 84;
221 	final static int	FIBS_CantTalk			= 85;
222 	final static int	FIBS_CantBlindYourself	= 86;
223 	final static int	FIBS_WontListen			= 87;
224 	final static int	FIBS_TypeBack			= 88;
225 	final static int	FIBS_NoOne				= 89;
226 	final static int	FIBS_BadMove			= 90;
227 	final static int	FIBS_MustMove			= 91;
228 	final static int	FIBS_MustComeIn			= 92;
229 	final static int	FIBS_CantShout			= 93;
230 	final static int	FIBS_DontKnowUser		= 94;
231 	final static int	FIBS_MessageUsage		= 95;
232 	final static int	FIBS_Done				= 96;
233 	final static int	FIBS_SavedMatchesHeader	= 97;
234 	final static int	FIBS_CantGagYourself	= 98;
235 	final static int	FIBS_NotYourTurnToRoll	= 99;
236 	final static int	FIBS_NotYourTurnToMove	= 100;
237 	final static int	FIBS_YourTurnToMove		= 101;
238 	final static int	FIBS_Ratings			= 102;
239 	final static int	FIBS_PlayerInfoStart	= 103;
240 	final static int	FIBS_EmailAddress		= 104;
241 	final static int	FIBS_NoEmail			= 105;
242 	final static int	FIBS_ListOfGames		= 106;
243 	final static int	FIBS_SavedMatch			= 107;
244 	final static int	FIBS_SavedMatchPlaying	= 108;
245 	final static int	FIBS_SavedMatchReady	= 109;
246 	final static int	FIBS_YouAreWatching		= 110;
247 	final static int	FIBS_YouStopWatching	= 111;
248 	final static int	FIBS_PlayerStartsWatching	= 112;
249 	final static int	FIBS_PlayerStopsWatching	= 113;
250 	final static int	FIBS_PlayerIsWatching		= 114;
251 	final static int	FIBS_ReportUnlimitedMatch	= 115;
252 	final static int	FIBS_ReportLimitedMatch	= 116;
253 	final static int	FIBS_RollOrDouble		= 117;
254 	final static int	FIBS_RollBeforeMove		= 118;
255 	final static int	FIBS_YouWinMatch		= 119;
256 	final static int	FIBS_PlayerWinsMatch	= 120;
257 	final static int	FIBS_YouReject			= 121;
258 	final static int	FIBS_YouResign			= 122;
259 	final static int	FIBS_ResumeMatchRequest	= 123;
260 	final static int	FIBS_ResumeMatchAck0	= 124;
261 	final static int	FIBS_ResumeMatchAck5	= 125;
262 	final static int	FIBS_NewMatchRequest	= 126;
263 	final static int	FIBS_UnlimitedInvite	= 127;
264 	final static int	FIBS_YouInvited			= 128;
265 	final static int	FIBS_YouAlreadyPlaying	= 129;
266 	final static int	FIBS_NewMatchAck9		= 130;
267 	final static int	FIBS_NewMatchAck10		= 131;
268 	final static int	FIBS_NewMatchAck2		= 132;
269 	final static int	FIBS_YouTerminated		= 133;
270 	final static int	FIBS_OpponentLeftGame	= 134;
271 	final static int	FIBS_PlayerLeftGame		= 135;
272 	final static int	FIBS_PlayerRefusingGames= 136;
273 	final static int	FIBS_TypeJoin			= 137;
274 	final static int	FIBS_ShowMovesStart		= 138;
275 	final static int	FIBS_ShowMovesWins		= 139;
276 	final static int	FIBS_ShowMovesRoll		= 140;
277 	final static int	FIBS_ShowMovesDoubles	= 141;
278 	final static int	FIBS_ShowMovesAccepts	= 142;
279 	final static int	FIBS_ShowMovesRejects	= 143;
280 	final static int	FIBS_ShowMovesOther		= 144;
281 	final static int	FIBS_Board				= 145;
282 	final static int	FIBS_YouRoll			= 146;
283 	final static int	FIBS_PlayerRolls		= 147;
284 	final static int	FIBS_PlayerMoves		= 148;
285 	final static int	FIBS_Doubles			= 149;
286 	final static int	FIBS_AcceptRejectDouble		= 150;
287 	final static int	FIBS_StartingNewGame		= 151;
288 	final static int	FIBS_StartingNewGameInMatch	= 152;
289 	final static int	FIBS_PlayerAcceptsDouble	= 153;
290 	final static int	FIBS_YouAcceptDouble		= 154;
291 	final static int	FIBS_Settings				= 155;
292 	final static int	FIBS_Turn					= 156;
293 	final static int	FIBS_FirstRoll				= 157;
294 	final static int	FIBS_DoublingCubeNow		= 158;
295 	final static int	FIBS_CantMove				= 159;
296 	final static int	FIBS_CantMoveFirstMove		= 160;
297 	final static int	FIBS_ResignRefused			= 161;
298 	final static int	FIBS_YouWinGame				= 162;
299 	final static int	FIBS_OnlyPossibleMove		= 163;
300 	final static int	FIBS_AcceptWins				= 164;
301 	final static int	FIBS_ResignWins				= 165;
302 	final static int	FIBS_ResignYouWin			= 166;
303 	final static int	FIBS_WatchGameWins			= 167;
304 	final static int	FIBS_ScoreUpdate			= 168;
305 	final static int	FIBS_MatchStart				= 169;
306 	final static int	FIBS_YouAcceptAndWin		= 170;
307 	final static int	FIBS_OnlyMove				= 171;
308 	final static int	FIBS_BearingOff				= 172;
309 	final static int	FIBS_PleaseMove				= 173;
310 	final static int	FIBS_MakesFirstMove			= 174;
311 	final static int	FIBS_YouDouble				= 175;
312 	final static int	FIBS_MatchLength			= 176;
313 	final static int	FIBS_PlayerWantsToResign	= 177;
314 	final static int	FIBS_PlayerWinsGame			= 178;
315 	final static int	FIBS_JoinNextGame			= 179;
316 	final static int	FIBS_ResumingUnlimitedMatch	= 180;
317 	final static int	FIBS_ResumingLimitedMatch	= 181;
318 	final static int	FIBS_PlayersStartingMatch	= 182;
319 	final static int	FIBS_PlayersStartingUnlimitedMatch	= 183;
320 	final static int	FIBS_MatchResult			= 184;
321 	final static int	FIBS_YouGiveUp				= 185;
322 	final static int	FIBS_PlayerIsWaitingForYou	= 186;
323 	final static int	FIBS_Boardstyle				= 187;
324 	final static int	FIBS_Linelength				= 188;
325 	final static int	FIBS_Pagelength				= 189;
326 	final static int	FIBS_Redoubles				= 190;
327 	final static int	FIBS_Sortwho			= 191;
328 	final static int	FIBS_Timezone			= 192;
329 	final static int	FIBS_RedoublesSetTo		= 193;
330 	final static int	FIBS_BoardstyleSetTo	= 194;
331 	final static int	FIBS_AllowpipTrue		= 195;
332 	final static int	FIBS_AllowpipFalse		= 196;
333 	final static int	FIBS_AutoboardTrue		= 197;
334 	final static int	FIBS_AutoboardFalse		= 198;
335 	final static int	FIBS_AutodoubleTrue		= 199;
336 	final static int	FIBS_AutodoubleFalse	= 200;
337 	final static int	FIBS_AutomoveTrue		= 201;
338 	final static int	FIBS_AutomoveFalse		= 202;
339 	final static int	FIBS_BellTrue			= 203;
340 	final static int	FIBS_BellFalse			= 204;
341 	final static int	FIBS_CrawfordTrue		= 205;
342 	final static int	FIBS_CrawfordFalse		= 206;
343 	final static int	FIBS_DoubleTrue			= 207;
344 	final static int	FIBS_DoubleFalse		= 208;
345 	final static int	FIBS_MoreboardsTrue		= 209;
346 	final static int	FIBS_MoreboardsFalse	= 210;
347 	final static int	FIBS_MovesTrue			= 211;
348 	final static int	FIBS_MovesFalse			= 212;
349 	final static int	FIBS_GreedyTrue			= 213;
350 	final static int	FIBS_GreedyFalse		= 214;
351 	final static int	FIBS_NotifyTrue			= 215;
352 	final static int	FIBS_NotifyFalse		= 216;
353 	final static int	FIBS_RatingsTrue		= 217;
354 	final static int	FIBS_RatingsFalse		= 218;
355 	final static int	FIBS_ReadyTrue			= 219;
356 	final static int	FIBS_ReadyFalse			= 220;
357 	final static int	FIBS_ReportTrue			= 221;
358 	final static int	FIBS_ReportFalse		= 222;
359 	final static int	FIBS_SilentTrue			= 223;
360 	final static int	FIBS_SilentFalse		= 224;
361 	final static int	FIBS_TelnetTrue			= 225;
362 	final static int	FIBS_TelnetFalse		= 226;
363 	final static int	FIBS_WrapTrue			= 227;
364 	final static int	FIBS_WrapFalse			= 228;
365 	final static int	FIBS_WelcomeToFibs		= 229;
366 	final static int	FIBS_OneUserPerPerson	= 230;
367 	final static int	FIBS_UseAnotherName		= 231;
368 	final static int	FIBS_GivePassword		= 232;
369 	final static int	FIBS_RetypePassword		= 233;
370 	final static int	FIBS_YouAreRegistered	= 234;
371 	final static int	FIBS_NotInteresting		= 235;
372 	final static int	FIBS_PointsFor			= 236;	// during a resume match
373 	final static int	FIBS_HasSavedGames		= 237;	// during a resume match
374 	final static int	FIBS_HasNoSavedGames	= 238;	// during a resume match
375 	final static int	FIBS_TalkToSelf			= 239;	// during a resume match
376 	final static int	FIBS_ReadyWatchingPlaying=240;
377 	final static int	FIBS_PleaseWaitForJoin	= 241;
378 	final static int	FIBS_YouAlreadyRolled	= 242;
379 	final static int	FIBS_YouCantMove		= 243;
380 	final static int	FIBS_GameWasSaved		= 244;
381 	final static int	FIBS_ATTENTION			= 245;	// system shutting down
382 	final static int	FIBS_ShuttingDown		= 246;	// system shutting down
383 	final static int	FIBS_Rebooting			= 247;	// system shutting down
384 	final static int	FIBS_GamesWillBeSaved	= 248;	// system shutting down
385 	final static int	FIBS_YouBannedWatch		= 249;
386 	final static int	FIBS_PlayerBannedWatch	= 250;
387 	final static int	FIBS_DoesntWantYouToWatch= 251;
388 	final static int	FIBS_WaitForLastInvitation= 252;
389 	final static int	FIBS_WaitForAcceptResign= 253;
390 	final static int	FIBS_WantedToResign		= 254;
391 	final static int	FIBS_NobodyHeardYou		= 255;
392 	final static int	FIBS_DidntDoubleOrResign= 256;
393 	final static int	FIBS_CantWatchSelf		= 257;
394 	final static int	FIBS_YourEmailChanged	= 258;
395 	final static int	FIBS_EchoJunk			= 259;	// just echo this to the System window
396 	
397 
398 		
399 	//final static int	FIBS_LastMessage		= 235;	// NO MORE MESSAGES HERE!
400 }
401