-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUserInterface.py
More file actions
866 lines (661 loc) · 33.4 KB
/
Copy pathUserInterface.py
File metadata and controls
866 lines (661 loc) · 33.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
from ConsoleInterface import *
class ConsoleInterface:
def DisplayWelcome(self):
""" (None) -> bool
Function is responsible for displaying the welcome message to the user.
Function gives the user the option to continue or quit.
Returns False if the user quits, or True if the user continues.
>>>DisplayWelcome()
True
False
"""
return ConsoleInputMessages().DisplayWelcomeWithInput() # (True) or (False)
def GetNumPlayers(self):
""" (None) -> int or 'string'
Function returns the number of players (0 - 2) as an integer based on user input.
or
Function returns 'R' or 'Q' (for restart or quit) based on user input
>>>GetNumPlayers()
0
1
2
'R'
'Q'
"""
return ConsoleInputMessages().SetNumPlayers() # (range(int(0 - 2))) or (str('R' or 'Q')) based on user input
def DisplayAndGetPlayerTypes(self, players):
""" (list['string1', 'string2']) -> "string"
Displays to the user what if the players are human players or computer players.
Returns a string showing the "typeOfPlayer vs typeOfPlayer".
['string1', 'string2'] Must be one of the following:
['playerOneComputer', 'playerTwoComputer']
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>DisplayAndGetPlayerTypes(['playerOneComputer', 'playerTwoComputer'])
"Computer vs Computer"
>>>DisplayAndGetPlayerTypes(['playerOneHuman', 'playerTwoComputer'])
"Player vs Computer"
>>>DisplayAndGetPlayerTypes(['playerOneHuman', 'playerTwoHuman'])
"Player vs Player"
"""
return ConsoleInputMessages().PrintandSetPlayerTypes(players) # (str("Computer vs Computer")) or (str("Player vs Computer")) or (str("Player vs Player")
def GetPlayerOneX(self):
""" (None) -> bool
Returns True if and only if the user for player 1 wants to be X.
Returns False if and only if the user for player 1 wants to be O.
>>>GetPlayerOneX()
True
False
"""
return ConsoleInputMessages().SetPlayerOneX() # (True) or (False)
def DisplayPlayersXandO(self, playerOneX, Players):
""" (bool, list['string1', 'string2']) -> None
Displays which typeOfPlayer is X and which typeOfPlayer is O.
['string1', 'string2'] Must be one of the following:
['playerOneComputer', 'playerTwoComputer']
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>DisplayPlayersXandO(True, ['playerOneComputer', 'playerTwoComputer'])
None
"""
return ConsoleInputMessages().PrintPlayersXandO(playerOneX, Players) # (None)
def GetFirstPlayerType(self, players):
""" (list['string1', 'string2']) -> 'string'
Function returns the first player as playerType
based on user input from a list of 2 playerTypes in the arg.
['string1', 'string2'] Must be one of the following:
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>GetFirstPlayerType(['playerOneHuman', 'playerTwoComputer'])
'playerOneHuman'
'playerTwoComputer'
>>>GetFirstPlayerType(['playerOneHuman', 'playerTwoHuman'])
'playerOneHuman'
'playerTwoHuman'
"""
return ConsoleInputMessages().SetFirstPlayerType(players) # (str('playerOneHuman')) or (str('playerTwoComputer')) or (str('playerTwoHuman')) based on user input
def DisplayFirstAndSecondPlayers(self, firstPlayerType, secondPlayerType):
""" ('string1', 'string2') -> None
Function returns displays to the user the which playerType is the first player
and which playerType is the second player
('string1', 'string2') Must be the order of ('firstPlayerType', 'secondPlayerType') of the following:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
>>>DisplayFirstAndSecondPlayers('playerOneComputer', 'playerTwoComputer')
None
>>>DisplayFirstAndSecondPlayers('playerTwoComputer', 'playerOneComputer')
None
"""
return ConsoleInputMessages().PrintFirstAndSecondPlayers(firstPlayerType, secondPlayerType) # (None)
def ConfirmGameSettings(self, playerVsPlayerMatchConfig, firstPlayer, secondPlayer):
""" ('string', list['string', bool], list['string', bool]) -> 'string' or bool(True)
Function displays settings of the game,
then asks user to confirm the settings of the game to start game, restart game, or quit.
(arg1) Must be the one of the following strings:
'Computer vs Computer'
'Player vs Computer'
'Player vs Player'
(arg2) Must resemble the first player with one of the following lists('playerType', playerIsX):
['playerOneComputer', 'True']
['playerOneComputer', 'False']
['playerTwoComputer', 'True']
['playerTwoComputer', 'False']
['playerOneHuman', 'True']
['playerOneHuman', 'False']
['playerTwoHuman', 'True']
['playerTwoHuman', 'False']
(arg3) Must resemble the second player with one of the following lists('playerType', playerIsX):
['playerOneComputer', 'True']
['playerOneComputer', 'False']
['playerTwoComputer', 'True']
['playerTwoComputer', 'False']
['playerOneHuman', 'True']
['playerOneHuman', 'False']
['playerTwoHuman', 'True']
['playerTwoHuman', 'False']
>>>ConfirmGameSettings('Computer vs Computer', ['playerOneComputer', 'True'], ['playerTwoComputer', 'False'])
True
'R'
'Q'
>>>ConfirmGameSettings('Player vs Computer', ['playerOneHuman', 'False'], ['playerTwoComputer', 'True'])
True
'R'
'Q'
"""
return ConsoleInputMessages().ConfirmGameSettings(playerVsPlayerMatchConfig, firstPlayer, secondPlayer) # (str('Q' or 'R')) or (True) based on user input
def DisplayBoard(self, gameBoard):
""" (list[9elements]) -> None
Function displays what the current tic tac toe board looks like to the user.
Each element of list[element, element, element, element, element, element, element, element, element]
must be one of the following:
'True'
'False'
'None'
>>>DisplayBoard([None, None, None, None, None, None, None, None, None])
None
>>>DisplayBoard([None, False, None, False, True, None, None, True, None])
None
"""
return ConsoleOutputMessages().PrintGameBoard(gameBoard) # (None)
def DisplayAskPlayerMove(self, playerTypeMove, otherPlayerType, availablePicks):
""" ('sring1', 'string2', list[elements]) -> None
Function displays to the user who's turn it is to move.
The display is based upon what type of players are playing, and which players turn it is.
Function also displays a list of the available moves left to choose from.
(arg1) Must be one of the following strings of the players turn to move:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
(arg2) Must be one of the following strings of the players turn not to move:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
(arg3) Must be a list of integers resembling None in the list(gameBoard[9elements] + 1)
for example:
if gameboard[None, False, None, False, True, None, None, True, None]:
availablePicks[1, 3, 6, 7, 9]
>>>DisplayAskPlayerMove('playerOneComputer', 'playerTwoComputer', availablePicks[1, 3, 6, 7, 9])
None
>>>DisplayAskPlayerMove('playerTwoComputer', 'playerOneHuman', availablePicks[2, 3, 4, 5, 6, 7, 9])
None
"""
return ConsoleOutputMessages().PrintAskPlayerMove(playerTypeMove, otherPlayerType, availablePicks) # (None)
def GetPlayerToMove(self, gameBoard):
""" (list[9elements]) -> int or 'string'
Function returns input from user.
Function must return a integer between 1-9, or a string of ('R' or 'Q')
GetPlayerToMove(gameBoard[None, False, None, False, True, None, None, True, None])
1
3
6
7
9
'R'
'Q'
"""
return ConsoleInputMessages().SetPlayerMove(gameBoard) # (range(int(1 - 9))) or (str('R' or 'Q')) based on user input
def DisplayInvalidSlotError(self, availablePicks, playerMove):
""" (list[elements], int) -> None
Function displays error message (move out of range(1 - 9)) to the user of the move he/she picked,
and the available slots he/she should have pick from
DisplayInvalidSlotError(availablePicks[1, 3, 6, 7, 9], 10)
None
"""
return ConsoleOutputMessages().PrintInvalidSlotError(availablePicks, playerMove) #None
def DisplaySlotTakenError(self, availablePicks, playerMove):
""" (list[elements], int) -> None
Function displays error message (slot already taken) to the user of the move he/she picked,
and the available slots he/she should have pick from
DisplaySlotTakenError(availablePicks[1, 3, 6, 7, 9], 2)
None
"""
return ConsoleOutputMessages().PrintSlotTakenError(availablePicks, playerMove) #None
def DisplayGameDraw(self):
""" (None) -> None
Function displays a message to the user showing the game has ended in a draw.
DisplayGameDraw()
None
"""
return ConsoleOutputMessages().PrintGameDraw() #None
def DisplayGameWinner(self, winner, loser):
""" ('string1', 'string2') -> None
Function displays a message to the user showing the winner of the game.
(arg1) Must be a string with the playerType who won the game
(arg2) Must be a string with the playerType who lost the game
DisplayGameWinner('playerOneHuman', 'playerTwoComputer')
None
"""
return ConsoleOutputMessages().PrintGameWinner(winner, loser) #None
def AskUserPlayAgain(self):
""" (None) -> None
Function displays a message to the user asking them if they want to play again.
Based on user input, function returns True if the user wants to play again,
or function returns False if the user does not want to play again.
AskUserPlayAgain()
None
"""
return ConsoleInputMessages().MessageUserPlayAgain() # True or False based on user input
class WindowInterface:
def DisplayWelcome(self):
""" (None) -> bool
Function is responsible for displaying the welcome message to the user.
Function gives the user the option to continue or quit.
Returns False if the user quits, or True if the user continues.
>>>DisplayWelcome()
True
False
"""
raise NotImplementedError('This interface has not yet been implemented') # (True) or (False)
def GetNumPlayers(self):
""" (None) -> int or 'string'
Function returns the number of players (0 - 2) as an integer based on user input.
or
Function returns 'R' or 'Q' (for restart or quit) based on user input
>>>GetNumPlayers()
0
1
2
'R'
'Q'
"""
raise NotImplementedError('This interface has not yet been implemented') # (range(int(0 - 2))) or (str('R' or 'Q')) based on user input
def DisplayAndGetPlayerTypes(self, players):
""" (list['string1', 'string2']) -> "string"
Displays to the user what if the players are human players or computer players.
Returns a string showing the "typeOfPlayer vs typeOfPlayer".
['string1', 'string2'] Must be one of the following:
['playerOneComputer', 'playerTwoComputer']
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>DisplayAndGetPlayerTypes(['playerOneComputer', 'playerTwoComputer'])
"Computer vs Computer"
>>>DisplayAndGetPlayerTypes(['playerOneHuman', 'playerTwoComputer'])
"Player vs Computer"
>>>DisplayAndGetPlayerTypes(['playerOneHuman', 'playerTwoHuman'])
"Player vs Player"
"""
raise NotImplementedError('This interface has not yet been implemented') # (str("Computer vs Computer")) or (str("Player vs Computer")) or (str("Player vs Player")
def GetPlayerOneX(self):
""" (None) -> bool
Returns True if and only if the user for player 1 wants to be X.
Returns False if and only if the user for player 1 wants to be O.
>>>GetPlayerOneX()
True
False
"""
raise NotImplementedError('This interface has not yet been implemented') # (True) or (False)
def DisplayPlayersXandO(self, playerOneX, Players):
""" (bool, list['string1', 'string2']) -> None
Displays which typeOfPlayer is X and which typeOfPlayer is O.
['string1', 'string2'] Must be one of the following:
['playerOneComputer', 'playerTwoComputer']
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>DisplayPlayersXandO(True, ['playerOneComputer', 'playerTwoComputer'])
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def GetFirstPlayerType(self, players):
""" (list['string1', 'string2']) -> 'string'
Function returns the first player as playerType
based on user input from a list of 2 playerTypes in the arg.
['string1', 'string2'] Must be one of the following:
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>GetFirstPlayerType(['playerOneHuman', 'playerTwoComputer'])
'playerOneHuman'
'playerTwoComputer'
>>>GetFirstPlayerType(['playerOneHuman', 'playerTwoHuman'])
'playerOneHuman'
'playerTwoHuman'
"""
raise NotImplementedError('This interface has not yet been implemented') # (str('playerOneHuman')) or (str('playerTwoComputer')) or (str('playerTwoHuman')) based on user input
def DisplayFirstAndSecondPlayers(self, firstPlayerType, secondPlayerType):
""" ('string1', 'string2') -> None
Function returns displays to the user the which playerType is the first player
and which playerType is the second player
('string1', 'string2') Must be the order of ('firstPlayerType', 'secondPlayerType') of the following:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
>>>DisplayFirstAndSecondPlayers('playerOneComputer', 'playerTwoComputer')
None
>>>DisplayFirstAndSecondPlayers('playerTwoComputer', 'playerOneComputer')
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def ConfirmGameSettings(self, playerVsPlayerType, firstPlayer, secondPlayer):
""" ('string', list['string', bool], list['string', bool]) -> 'string' or bool(True)
Function displays settings of the game,
then asks user to confirm the settings of the game to start game, restart game, or quit.
(arg1) Must be the one of the following strings:
'Computer vs Computer'
'Player vs Computer'
'Player vs Player'
(arg2) Must resemble the first player with one of the following lists('playerType', playerIsX):
['playerOneComputer', 'True']
['playerOneComputer', 'False']
['playerTwoComputer', 'True']
['playerTwoComputer', 'False']
['playerOneHuman', 'True']
['playerOneHuman', 'False']
['playerTwoHuman', 'True']
['playerTwoHuman', 'False']
(arg3) Must resemble the second player with one of the following lists('playerType', playerIsX):
['playerOneComputer', 'True']
['playerOneComputer', 'False']
['playerTwoComputer', 'True']
['playerTwoComputer', 'False']
['playerOneHuman', 'True']
['playerOneHuman', 'False']
['playerTwoHuman', 'True']
['playerTwoHuman', 'False']
>>>ConfirmGameSettings('Computer vs Computer', ['playerOneComputer', 'True'], ['playerTwoComputer', 'False'])
True
'R'
'Q'
>>>ConfirmGameSettings('Player vs Computer', ['playerOneHuman', 'False'], ['playerTwoComputer', 'True'])
True
'R'
'Q'
"""
raise NotImplementedError('This interface has not yet been implemented') # (str('Q' or 'R')) or (True) based on user input
def DisplayBoard(self, gameBoard):
""" (list[9elements]) -> None
Function displays what the current tic tac toe board looks like to the user.
Each element of list[element, element, element, element, element, element, element, element, element]
must be one of the following:
'True'
'False'
'None'
>>>DisplayBoard([None, None, None, None, None, None, None, None, None])
None
>>>DisplayBoard([None, False, None, False, True, None, None, True, None])
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def DisplayAskPlayerMove(self, playerTypeMove, otherPlayerType, availablePicks):
""" ('sring1', 'string2', list[elements]) -> None
Function displays to the user who's turn it is to move.
The display is based upon what type of players are playing, and which players turn it is.
Function also displays a list of the available moves left to choose from.
(arg1) Must be one of the following strings of the players turn to move:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
(arg2) Must be one of the following strings of the players turn not to move:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
(arg3) Must be a list of integers resembling None in the list(gameBoard[9elements] + 1)
for example:
if gameboard[None, False, None, False, True, None, None, True, None]:
availablePicks[1, 3, 6, 7, 9]
>>>DisplayAskPlayerMove('playerOneComputer', 'playerTwoComputer', availablePicks[1, 3, 6, 7, 9])
None
>>>DisplayAskPlayerMove('playerTwoComputer', 'playerOneHuman', availablePicks[2, 3, 4, 5, 6, 7, 9])
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def GetPlayerToMove(self, gameBoard):
""" (list[9elements]) -> int or 'string'
Function returns input from user.
Function must return a integer between 1-9, or a string of ('R' or 'Q')
GetPlayerToMove(gameBoard[None, False, None, False, True, None, None, True, None])
1
3
6
7
9
'R'
'Q'
"""
raise NotImplementedError('This interface has not yet been implemented') # (range(int(1 - 9))) or (str('R' or 'Q')) based on user input
def DisplayInvalidSlotError(self, availablePicks, playerMove):
""" (list[elements], int) -> None
Function displays error message (move out of range(1 - 9)) to the user of the move he/she picked,
and the available slots he/she should have pick from
DisplayInvalidSlotError(availablePicks[1, 3, 6, 7, 9], 10)
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def DisplaySlotTakenError(self, availablePicks, playerMove):
""" (list[elements], int) -> None
Function displays error message (slot already taken) to the user of the move he/she picked,
and the available slots he/she should have pick from
DisplaySlotTakenError(availablePicks[1, 3, 6, 7, 9], 2)
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def DisplayGameDraw(self):
""" (None) -> None
Function displays a message to the user showing the game has ended in a draw.
DisplayGameDraw()
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def DisplayGameWinner(self, winner, loser):
""" ('string1', 'string2') -> None
Function displays a message to the user showing the winner of the game.
(arg1) Must be a string with the playerType who won the game
(arg2) Must be a string with the playerType who lost the game
DisplayGameWinner('playerOneHuman', 'playerTwoComputer')
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def AskUserPlayAgain(self):
""" (None) -> None
Function displays a message to the user asking them if they want to play again.
Based on user input, function returns True if the user wants to play again,
or function returns False if the user does not want to play again.
AskUserPlayAgain()
None
"""
raise NotImplementedError('This interface has not yet been implemented') # True or False based on user input
class WebInterface:
def DisplayWelcome(self):
""" (None) -> bool
Function is responsible for displaying the welcome message to the user.
Function gives the user the option to continue or quit.
Returns False if the user quits, or True if the user continues.
>>>DisplayWelcome()
True
False
"""
raise NotImplementedError('This interface has not yet been implemented') # (True) or (False)
def GetNumPlayers(self):
""" (None) -> int or 'string'
Function returns the number of players (0 - 2) as an integer based on user input.
or
Function returns 'R' or 'Q' (for restart or quit) based on user input
>>>GetNumPlayers()
0
1
2
'R'
'Q'
"""
raise NotImplementedError('This interface has not yet been implemented') # (range(int(0 - 2))) or (str('R' or 'Q')) based on user input
def DisplayAndGetPlayerTypes(self, players):
""" (list['string1', 'string2']) -> "string"
Displays to the user what if the players are human players or computer players.
Returns a string showing the "typeOfPlayer vs typeOfPlayer".
['string1', 'string2'] Must be one of the following:
['playerOneComputer', 'playerTwoComputer']
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>DisplayAndGetPlayerTypes(['playerOneComputer', 'playerTwoComputer'])
"Computer vs Computer"
>>>DisplayAndGetPlayerTypes(['playerOneHuman', 'playerTwoComputer'])
"Player vs Computer"
>>>DisplayAndGetPlayerTypes(['playerOneHuman', 'playerTwoHuman'])
"Player vs Player"
"""
raise NotImplementedError('This interface has not yet been implemented') # (str("Computer vs Computer")) or (str("Player vs Computer")) or (str("Player vs Player")
def GetPlayerOneX(self):
""" (None) -> bool
Returns True if and only if the user for player 1 wants to be X.
Returns False if and only if the user for player 1 wants to be O.
>>>GetPlayerOneX()
True
False
"""
raise NotImplementedError('This interface has not yet been implemented') # (True) or (False)
def DisplayPlayersXandO(self, playerOneX, Players):
""" (bool, list['string1', 'string2']) -> None
Displays which typeOfPlayer is X and which typeOfPlayer is O.
['string1', 'string2'] Must be one of the following:
['playerOneComputer', 'playerTwoComputer']
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>DisplayPlayersXandO(True, ['playerOneComputer', 'playerTwoComputer'])
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def GetFirstPlayerType(self, players):
""" (list['string1', 'string2']) -> 'string'
Function returns the first player as playerType
based on user input from a list of 2 playerTypes in the arg.
['string1', 'string2'] Must be one of the following:
['playerOneHuman', 'playerTwoComputer']
['playerOneHuman', 'playerTwoHuman']
>>>GetFirstPlayerType(['playerOneHuman', 'playerTwoComputer'])
'playerOneHuman'
'playerTwoComputer'
>>>GetFirstPlayerType(['playerOneHuman', 'playerTwoHuman'])
'playerOneHuman'
'playerTwoHuman'
"""
raise NotImplementedError('This interface has not yet been implemented') # (str('playerOneHuman')) or (str('playerTwoComputer')) or (str('playerTwoHuman')) based on user input
def DisplayFirstAndSecondPlayers(self, firstPlayerType, secondPlayerType):
""" ('string1', 'string2') -> None
Function returns displays to the user the which playerType is the first player
and which playerType is the second player
('string1', 'string2') Must be the order of ('firstPlayerType', 'secondPlayerType') of the following:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
>>>DisplayFirstAndSecondPlayers('playerOneComputer', 'playerTwoComputer')
None
>>>DisplayFirstAndSecondPlayers('playerTwoComputer', 'playerOneComputer')
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def ConfirmGameSettings(self, playerVsPlayerType, firstPlayer, secondPlayer):
""" ('string', list['string', bool], list['string', bool]) -> 'string' or bool(True)
Function displays settings of the game,
then asks user to confirm the settings of the game to start game, restart game, or quit.
(arg1) Must be the one of the following strings:
'Computer vs Computer'
'Player vs Computer'
'Player vs Player'
(arg2) Must resemble the first player with one of the following lists('playerType', playerIsX):
['playerOneComputer', 'True']
['playerOneComputer', 'False']
['playerTwoComputer', 'True']
['playerTwoComputer', 'False']
['playerOneHuman', 'True']
['playerOneHuman', 'False']
['playerTwoHuman', 'True']
['playerTwoHuman', 'False']
(arg3) Must resemble the second player with one of the following lists('playerType', playerIsX):
['playerOneComputer', 'True']
['playerOneComputer', 'False']
['playerTwoComputer', 'True']
['playerTwoComputer', 'False']
['playerOneHuman', 'True']
['playerOneHuman', 'False']
['playerTwoHuman', 'True']
['playerTwoHuman', 'False']
>>>ConfirmGameSettings('Computer vs Computer', ['playerOneComputer', 'True'], ['playerTwoComputer', 'False'])
True
'R'
'Q'
>>>ConfirmGameSettings('Player vs Computer', ['playerOneHuman', 'False'], ['playerTwoComputer', 'True'])
True
'R'
'Q'
"""
raise NotImplementedError('This interface has not yet been implemented') # (str('Q' or 'R')) or (True) based on user input
def DisplayBoard(self, gameBoard):
""" (list[9elements]) -> None
Function displays what the current tic tac toe board looks like to the user.
Each element of list[element, element, element, element, element, element, element, element, element]
must be one of the following:
'True'
'False'
'None'
>>>DisplayBoard([None, None, None, None, None, None, None, None, None])
None
>>>DisplayBoard([None, False, None, False, True, None, None, True, None])
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def DisplayAskPlayerMove(self, playerTypeMove, otherPlayerType, availablePicks):
""" ('sring1', 'string2', list[elements]) -> None
Function displays to the user who's turn it is to move.
The display is based upon what type of players are playing, and which players turn it is.
Function also displays a list of the available moves left to choose from.
(arg1) Must be one of the following strings of the players turn to move:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
(arg2) Must be one of the following strings of the players turn not to move:
'playerOneComputer'
'playerTwoComputer'
'playerOneHuman'
'playerTwoHuman'
(arg3) Must be a list of integers resembling None in the list(gameBoard[9elements] + 1)
for example:
if gameboard[None, False, None, False, True, None, None, True, None]:
availablePicks[1, 3, 6, 7, 9]
>>>DisplayAskPlayerMove('playerOneComputer', 'playerTwoComputer', availablePicks[1, 3, 6, 7, 9])
None
>>>DisplayAskPlayerMove('playerTwoComputer', 'playerOneHuman', availablePicks[2, 3, 4, 5, 6, 7, 9])
None
"""
raise NotImplementedError('This interface has not yet been implemented') # (None)
def GetPlayerToMove(self, gameBoard):
""" (list[9elements]) -> int or 'string'
Function returns input from user.
Function must return a integer between 1-9, or a string of ('R' or 'Q')
GetPlayerToMove(gameBoard[None, False, None, False, True, None, None, True, None])
1
3
6
7
9
'R'
'Q'
"""
raise NotImplementedError('This interface has not yet been implemented') # (range(int(1 - 9))) or (str('R' or 'Q')) based on user input
def DisplayInvalidSlotError(self, availablePicks, playerMove):
""" (list[elements], int) -> None
Function displays error message (move out of range(1 - 9)) to the user of the move he/she picked,
and the available slots he/she should have pick from
DisplayInvalidSlotError(availablePicks[1, 3, 6, 7, 9], 10)
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def DisplaySlotTakenError(self, availablePicks, playerMove):
""" (list[elements], int) -> None
Function displays error message (slot already taken) to the user of the move he/she picked,
and the available slots he/she should have pick from
DisplaySlotTakenError(availablePicks[1, 3, 6, 7, 9], 2)
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def DisplayGameDraw(self):
""" (None) -> None
Function displays a message to the user showing the game has ended in a draw.
DisplayGameDraw()
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def DisplayGameWinner(self, winner, loser):
""" ('string1', 'string2') -> None
Function displays a message to the user showing the winner of the game.
(arg1) Must be a string with the playerType who won the game
(arg2) Must be a string with the playerType who lost the game
DisplayGameWinner('playerOneHuman', 'playerTwoComputer')
None
"""
raise NotImplementedError('This interface has not yet been implemented') #None
def AskUserPlayAgain(self):
""" (None) -> None
Function displays a message to the user asking them if they want to play again.
Based on user input, function returns True if the user wants to play again,
or function returns False if the user does not want to play again.
AskUserPlayAgain()
None
"""
raise NotImplementedError('This interface has not yet been implemented') # True or False based on user input