FiniteStatusBar¶

Overview¶

FiniteStatusBar is the status bar for games that have a finite number of challenges per level. This was adapted from and replaces ScoreboardBar. See https://github.com/phetsims/vegas/issues/66.

@author Chris Malley (PixelZoom, Inc.)

Class FiniteStatusBar¶

import { FiniteStatusBar } from 'scenerystack/vegas';

Constructor¶

new FiniteStatusBar( layoutBounds : Bounds2, visibleBoundsProperty : TReadOnlyProperty<Bounds2>, scoreProperty : TProperty<number>, providedOptions? : FiniteStatusBarOptions )¶

Instance Methods¶

dispose()¶

Type FiniteStatusBarOptions¶

import type { FiniteStatusBarOptions } from 'scenerystack/vegas';

• challengeIndexProperty?: TReadOnlyProperty<number> | null
  optional Properties
• numberOfChallengesProperty?: TReadOnlyProperty<number> | null
• levelProperty?: TReadOnlyProperty<number> | null
• elapsedTimeProperty?: TReadOnlyProperty<number> | null
• timerEnabledProperty?: TReadOnlyProperty<boolean> | null
• levelVisible?: boolean
  things that can be hidden
• challengeNumberVisible?: boolean
• font?: Font
  all text
• textFill?: TColor
• createScoreDisplay?: ( scoreProperty: TProperty<number> ) => Node
  score display
• startOverButtonOptions?: TextPushButtonOptions
  nested options for 'Start Over' button, filled in below
• startOverButtonText?: string | TReadOnlyProperty<string>
• clockIconRadius?: number
  options for the timer node
• xSpacing?: number
  spacing and margin for things in the bar
• xMargin?: number
• yMargin?: number
• levelTextOptions?: TextOptions
• challengeTextOptions?: TextOptions
• barFill?: TColor
• barStroke?: TColor
• & StrictOmit<StatusBarOptions, "children" | "barHeight">

Source Code¶

See the source for FiniteStatusBar.ts in the vegas repository.