Skip to content

Commit

Permalink
improved docs for sound generation options
Browse files Browse the repository at this point in the history
  • Loading branch information
jbphet committed Jun 14, 2021
1 parent b80f8e4 commit 6eecb7a
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions js/LevelSelectionButton.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,17 @@ class LevelSelectionButton extends RectangularPushButton {
bestTimeYSpacing: 10, // vertical space between drop shadow and best time

// sound generation
soundPlayer: null, // will be created if null using the index
soundPlayerIndex: 0, // a value that is used to configure the sound player, ignored if a sound player is specified

// Tandem
// {number} - A value that is used to configure the default sound player. This is used to alter the sound when
// the button is in a group, which it usually is. Note that this assumes zero-based indexing, which is often not
// the norm for the game levels. This is ignored if a custom sound player is defined.
soundPlayerIndex: 0,

// {Playable} - Sound player for this button. If null, a default will be created. Use Playable.NO_SOUND to
// turn off sound generation.
soundPlayer: null,

// phet-io
tandem: Tandem.REQUIRED
}, options );

Expand Down

1 comment on commit 6eecb7a

@jbphet
Copy link
Contributor Author

@jbphet jbphet commented on 6eecb7a Jun 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see #89

Please sign in to comment.