Improve type hierarchy. See #99 and #102.

js/game/model/CountingGameLevel.ts

@@ -71,12 +71,6 @@ class CountingGameLevel extends NumberPlayGameLevel {
     this._isObjectsRepresentationProperty.reset();
   }
 
-  /**
-   * @param dt - in seconds
-   */
-  public step( dt: number ): void {
-  }
-
   /**
    * Sets up a new challenge for this level.
    */

js/game/model/NumberPlayGameLevel.ts

@@ -67,11 +67,16 @@ abstract class NumberPlayGameLevel {
     } );
   }
 
-  protected reset(): void {
+  public reset(): void {
     this.isChallengeSolvedProperty.reset();
     this.scoreProperty.reset();
   }
 
+  /**
+   * @param dt - in seconds. No-op because not all subclasses need a step function.
+   */
+  public step( dt: number ): void {}
+
   /**
    * Sets up a new challenge for this level.
    * TODO-TS: why can't this be protected if i only want sub-class implementations to call it? See https://github.com/phetsims/number-play/issues/81.

js/game/model/NumberPlayGameModel.ts

@@ -14,13 +14,14 @@ import SubitizeGameLevel from './SubitizeGameLevel.js';
 import CountingGameLevel from './CountingGameLevel.js';
 import NumberPlayQueryParameters from '../../common/NumberPlayQueryParameters.js';
 import NumberPlayConstants from '../../common/NumberPlayConstants.js';
+import NumberPlayGameLevel from './NumberPlayGameLevel.js';
 
 class NumberPlayGameModel {
 
   public readonly subitizeLevels: SubitizeGameLevel[];
   public readonly countingLevels: CountingGameLevel[];
-  public readonly levels: Array<SubitizeGameLevel | CountingGameLevel>;
-  public readonly levelProperty: Property<SubitizeGameLevel | CountingGameLevel | null>
+  public readonly levels: Array<NumberPlayGameLevel>;
+  public readonly levelProperty: Property<NumberPlayGameLevel| null>
 
   constructor( tandem: Tandem ) {
 
@@ -36,7 +37,7 @@ class NumberPlayGameModel {
     this.levels = [ ...this.countingLevels, ...this.subitizeLevels ];
 
     // the selected game level - null means 'no selection' so that the view returns to the level-selection UI
-    this.levelProperty = new Property<SubitizeGameLevel | CountingGameLevel | null>( null, {
+    this.levelProperty = new Property<NumberPlayGameLevel | null>( null, {
       validValues: [ null, ...this.levels ]
     } );
   }

js/game/model/SubitizeGameLevel.ts

@@ -38,13 +38,6 @@ class SubitizeGameLevel extends NumberPlayGameLevel {
     this.subitizer.newChallenge();
   }
 
-  /**
-   * Calls reset on super type - no need to reset the subitizer because that happens everytime the user enters the level
-   */
-  public reset(): void {
-    super.reset();
-  }
-
   /**
    * @param dt - in seconds
    */

js/game/view/CountingGameLevelNode.ts

@@ -11,7 +11,6 @@ import Property from '../../../../axon/js/Property.js';
 import Bounds2 from '../../../../dot/js/Bounds2.js';
 import CountingGameLevel from '../model/CountingGameLevel.js';
 import numberPlay from '../../numberPlay.js';
-import SubitizeGameLevel from '../model/SubitizeGameLevel.js';
 import NumberPlayGameAnswerButtons from './NumberPlayGameAnswerButtons.js';
 import NumberPlayConstants from '../../common/NumberPlayConstants.js';
 import OnesPlayAreaNode from '../../common/view/OnesPlayAreaNode.js';
@@ -21,6 +20,7 @@ import EnumerationProperty from '../../../../axon/js/EnumerationProperty.js';
 import GroupingLinkingType from '../../../../counting-common/js/common/model/GroupingLinkingType.js';
 import TenFrameNode from '../../common/view/TenFrameNode.js';
 import NumberPlayColors from '../../common/NumberPlayColors.js';
+import NumberPlayGameLevel from '../model/NumberPlayGameLevel.js';
 
 // constants
 const RECTANGLE_WIDTH = 550;
@@ -33,7 +33,7 @@ class CountingGameLevelNode extends NumberPlayGameLevelNode<CountingGameLevel> {
   protected readonly answerButtons: NumberPlayGameAnswerButtons;
 
   constructor( level: CountingGameLevel,
-               levelProperty: Property<SubitizeGameLevel | CountingGameLevel | null>,
+               levelProperty: Property<NumberPlayGameLevel | null>,
                layoutBounds: Bounds2,
                visibleBoundsProperty: Property<Bounds2> ) {
 
@@ -122,10 +122,6 @@ class CountingGameLevelNode extends NumberPlayGameLevelNode<CountingGameLevel> {
       tenFramePanel.visible = !isObjects;
     } );
   }
-
-  public reset(): void {
-    super.reset();
-  }
 }
 
 numberPlay.register( 'CountingGameLevelNode', CountingGameLevelNode );

js/game/view/NumberPlayGameAnswerButtons.ts

@@ -14,11 +14,10 @@ import PhetFont from '../../../../scenery-phet/js/PhetFont.js';
 import { Color, ColorProperty, HBox, Node, Rectangle, Text } from '../../../../scenery/js/imports.js';
 import RectangularPushButton from '../../../../sun/js/buttons/RectangularPushButton.js';
 import numberPlay from '../../numberPlay.js';
-import SubitizeGameLevel from '../model/SubitizeGameLevel.js';
 import NumberProperty from '../../../../axon/js/NumberProperty.js';
-import CountingGameLevel from '../model/CountingGameLevel.js';
 import merge from '../../../../phet-core/js/merge.js';
 import NumberPlayConstants from '../../common/NumberPlayConstants.js';
+import NumberPlayGameLevel from '../model/NumberPlayGameLevel.js';
 
 // types
 type AnswerButtonsOptions = {
@@ -45,7 +44,7 @@ class NumberPlayGameAnswerButtons extends Node {
   private readonly buttonListener: ( index: number ) => void;
   public static BUTTON_DIMENSION: Dimension2;
 
-  constructor( level: SubitizeGameLevel | CountingGameLevel,
+  constructor( level: NumberPlayGameLevel,
                pointAwardedNodeVisibleProperty: BooleanProperty,
                rightAnswerCallback: () => void,
                wrongAnswerCallback: () => void,

js/game/view/NumberPlayGameLevelNode.ts

@@ -13,15 +13,13 @@ import PhetFont from '../../../../scenery-phet/js/PhetFont.js';
 import { Color, ColorProperty, HBox, Node, Path, RichText, Text } from '../../../../scenery/js/imports.js';
 import InfiniteStatusBar from '../../../../vegas/js/InfiniteStatusBar.js';
 import numberPlay from '../../numberPlay.js';
-import SubitizeGameLevel from '../model/SubitizeGameLevel.js';
 import FaceNode from '../../../../scenery-phet/js/FaceNode.js';
 import BooleanProperty from '../../../../axon/js/BooleanProperty.js';
 import StarNode from '../../../../scenery-phet/js/StarNode.js';
 import ArrowShape from '../../../../scenery-phet/js/ArrowShape.js';
 import RectangularPushButton from '../../../../sun/js/buttons/RectangularPushButton.js';
 import Animation from '../../../../twixt/js/Animation.js';
 import Easing from '../../../../twixt/js/Easing.js';
-import CountingGameLevel from '../model/CountingGameLevel.js';
 import NumberPlayGameLevel from '../model/NumberPlayGameLevel.js';
 import NumberPlayGameAnswerButtons from './NumberPlayGameAnswerButtons.js';
 import StringUtils from '../../../../phetcommon/js/util/StringUtils.js';
@@ -49,7 +47,7 @@ abstract class NumberPlayGameLevelNode<T extends NumberPlayGameLevel> extends No
   public static GAME_AREA_NODE_BOTTOM_MARGIN_Y: number;
 
   protected constructor( level: T,
-                         levelProperty: Property<SubitizeGameLevel | CountingGameLevel | null>,
+                         levelProperty: Property<NumberPlayGameLevel | null>,
                          layoutBounds: Bounds2,
                          visibleBoundsProperty: Property<Bounds2>,
                          providedOptions?: StatusBarOptions ) {
@@ -145,7 +143,7 @@ abstract class NumberPlayGameLevelNode<T extends NumberPlayGameLevel> extends No
     this.addChild( newChallengeButton );
   }
 
-  protected reset(): void {
+  public reset(): void {
     this.pointAwardedNodeVisibleProperty.reset();
     this.answerButtons.reset();
   }

js/game/view/NumberPlayGameLevelSelectionNode.ts

@@ -18,13 +18,12 @@ import numberPlay from '../../numberPlay.js';
 import numberPlayStrings from '../../numberPlayStrings.js';
 import NumberPlayGameModel from '../model/NumberPlayGameModel.js';
 import PhetFont from '../../../../scenery-phet/js/PhetFont.js';
-import SubitizeGameLevel from '../model/SubitizeGameLevel.js';
-import CountingGameLevel from '../model/CountingGameLevel.js';
 import NumberPlayColors from '../../common/NumberPlayColors.js';
 import subitizeGameIcon1 from '../../../images/subitize_game_icon_1_png.js';
 import countingGameIcon1 from '../../../images/counting_game_icon_1_png.js';
 import subitizeGameIcon2 from '../../../images/subitize_game_icon_2_png.js';
 import countingGameIcon2 from '../../../images/counting_game_icon_2_png.js';
+import NumberPlayGameLevel from '../model/NumberPlayGameLevel.js';
 
 // types
 type GameLevelToButtonImageType = {
@@ -60,7 +59,7 @@ class NumberPlayGameLevelSelectionNode extends Node {
     this.addChild( titleText );
 
     // creates a level-selection button for each level
-    const createLevelSelectionButton = ( level: SubitizeGameLevel | CountingGameLevel, baseColor: ColorProperty ) => {
+    const createLevelSelectionButton = ( level: NumberPlayGameLevel, baseColor: ColorProperty ) => {
       return new LevelSelectionButton( new Image( GAME_LEVEL_TO_BUTTON_IMAGE[ level.gameName ][ level.levelNumber ] ),
         level.scoreProperty, {
           iconToScoreDisplayYSpace: 0,

js/game/view/NumberPlayGameScreenView.ts

@@ -16,6 +16,8 @@ import NumberPlayGameModel from '../model/NumberPlayGameModel.js';
 import NumberPlayGameLevelSelectionNode from './NumberPlayGameLevelSelectionNode.js';
 import SubitizeGameLevelNode from './SubitizeGameLevelNode.js';
 import CountingGameLevelNode from './CountingGameLevelNode.js';
+import NumberPlayGameLevelNode from './NumberPlayGameLevelNode.js';
+import NumberPlayGameLevel from '../model/NumberPlayGameLevel.js';
 
 // constants
 const TRANSITION_OPTIONS = {
@@ -27,7 +29,7 @@ const TRANSITION_OPTIONS = {
 
 class NumberPlayGameScreenView extends ScreenView {
 
-  private readonly levelNodes: Array<SubitizeGameLevelNode | CountingGameLevelNode>;
+  private readonly levelNodes: Array<NumberPlayGameLevelNode<NumberPlayGameLevel>>;
 
   constructor( model: NumberPlayGameModel, tandem: Tandem ) {
 

js/game/view/SubitizeGameLevelNode.ts

@@ -13,16 +13,16 @@ import numberPlay from '../../numberPlay.js';
 import SubitizeGameLevel from '../model/SubitizeGameLevel.js';
 import NumberPlayGameLevelNode from './NumberPlayGameLevelNode.js';
 import SubitizerNode from './SubitizerNode.js';
-import CountingGameLevel from '../model/CountingGameLevel.js';
 import NumberPlayGameAnswerButtons from './NumberPlayGameAnswerButtons.js';
 import NumberPlayColors from '../../common/NumberPlayColors.js';
+import NumberPlayGameLevel from '../model/NumberPlayGameLevel.js';
 
 class SubitizeGameLevelNode extends NumberPlayGameLevelNode<SubitizeGameLevel> {
 
   protected readonly answerButtons: NumberPlayGameAnswerButtons;
 
   constructor( level: SubitizeGameLevel,
-               levelProperty: Property<SubitizeGameLevel | CountingGameLevel | null>,
+               levelProperty: Property<NumberPlayGameLevel | null>,
                layoutBounds: Bounds2,
                visibleBoundsProperty: Property<Bounds2> ) {
 
@@ -54,10 +54,6 @@ class SubitizeGameLevelNode extends NumberPlayGameLevelNode<SubitizeGameLevel> {
     subitizerNode.bottom = this.answerButtons.top - NumberPlayGameLevelNode.GAME_AREA_NODE_BOTTOM_MARGIN_Y;
     this.addChild( subitizerNode );
   }
-
-  public reset(): void {
-    super.reset();
-  }
 }
 
 numberPlay.register( 'SubitizeGameLevelNode', SubitizeGameLevelNode );