From c51953490279f91dcbf0ff511020c28d922dcbc3 Mon Sep 17 00:00:00 2001 From: Luisav1 Date: Tue, 14 Dec 2021 12:15:35 -0700 Subject: [PATCH] Add Game Screen info for implementation-notes.md and move face node feedback from model.md to implementation-notes.md. See https://github.com/phetsims/number-play/issues/83. --- doc/implementation-notes.md | 17 ++++++++++++++++- doc/model.md | 4 +--- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/doc/implementation-notes.md b/doc/implementation-notes.md index 77158379..c0d9dc56 100644 --- a/doc/implementation-notes.md +++ b/doc/implementation-notes.md @@ -1 +1,16 @@ -TODO implementation overview \ No newline at end of file +# Number Play - implementation notes + +## Game screen + +Both games rely on the abstract classes +[NumberPlayGameLevel](https://github.com/phetsims/number-play/blob/master/js/game/model/NumberPlayGameLevel.ts) and +[NumberPlayGameLevelNode](https://github.com/phetsims/number-play/blob/master/js/game/view/NumberPlayGameLevelNode.ts). + +The 'Counting' game builds upon the play areas that are used in the _Ten_, _Twenty_, and _Compare_ screens, but doesn't +include the controls for changing the object type or adding/removing objects. +[Subitizer](https://github.com/phetsims/number-play/blob/master/js/game/model/Subitizer.ts) controls the game sequence +and determines the shapes to show in the 'Subitize' game. + +[NumberPlayGameAnswerButtons](https://github.com/phetsims/number-play/blob/master/js/game/view/NumberPlayGameAnswerButtons.ts) +are used in both games for the user to input their answer. A smiley face is shown when the correct answer is selected. +When a wrong answer button is pressed, the button is disabled, and a frowny face is briefly shown. \ No newline at end of file diff --git a/doc/model.md b/doc/model.md index cdc8475f..0b5b4eec 100644 --- a/doc/model.md +++ b/doc/model.md @@ -55,7 +55,5 @@ Subitize | 2 | 6 | 10 | Since the challenges in both levels of each game are randomly generated, all levels can be played endlessly. One star is awarded per challenge that is successfully completed on the first try. On the 'Subitize' game, -pressing the 'Reveal' button does not disqualify the user from getting a first-try star. Regardless of the -attempt number, the user always gets a smiley face when the correct answer is selected. When a wrong answer -button is pressed, the button is disabled, and a frowny face is briefly shown. +pressing the 'Reveal' button does not disqualify the user from getting a first-try star.