Add documentation - see phetsims/center-and-variability#328

phetsims · Jul 11, 2023 · ddf2748 · ddf2748
1 parent 3811bc3
commit ddf2748
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/js/soccer-common/model/SoccerSceneModel.ts b/js/soccer-common/model/SoccerSceneModel.ts
@@ -264,6 +264,8 @@ export default class SoccerSceneModel<T extends SoccerBall = SoccerBall> extends
 
     Multilink.multilink( [ this.activeKickerIndexProperty, this.maxKicksProperty ], ( activeKickerIndex, maxKicks ) => {
       this.soccerPlayers.forEach( ( soccerPlayer, index ) => {
+
+        // If activeKickerIndex is greater than the number of kickers, but we want showing the last  kicker, show the last available player
         const showAsLastKicker = showPlayersWhenDoneKicking && ( activeKickerIndex === this.maxKicksLimit && index === activeKickerIndex - 1 );
         soccerPlayer.soccerPlayerPhaseProperty.value = ( ( index === activeKickerIndex && ( index < maxKicks || showPlayersWhenDoneKicking ) ) || showAsLastKicker ) ? SoccerPlayerPhase.READY : SoccerPlayerPhase.INACTIVE;
       } );