stop melody block (#1633)

* docs

* updated strings
This commit is contained in:
Peli de Halleux
2018-12-02 07:56:47 -08:00
committed by GitHub
parent 946aa82217
commit 61c06ad969
5 changed files with 61 additions and 2 deletions

View File

@ -7,6 +7,7 @@ music.playTone(0, 0);
music.ringTone(0);
music.rest(0);
music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Once);
music.stopMelody(MelodyStopOptions.All);
music.onEvent(MusicEvent.MelodyNotePlayed, () => {});
music.beat(BeatFraction.Whole);
music.tempo();
@ -17,5 +18,7 @@ music.setTempo(120);
## See Also
[playTone](/reference/music/play-tone), [ringTone](/reference/music/ring-tone), [rest](/reference/music/rest),
[beginMelody](/reference/music/begin-melody), [onEvent](/reference/music/on-event),
[beginMelody](/reference/music/begin-melody),
[stop melody](/reference/music/stop-melody),
[onEvent](/reference/music/on-event),
[beat](/reference/music/beat), [tempo](/reference/music/tempo), [changeTempoBy](/reference/music/change-tempo-by), [setTempo](/reference/music/set-tempo),

View File

@ -0,0 +1,27 @@
# Stop Melody
Stops playing a musical melody.
## Simulator
```sig
music.stopMelody(MelodyStopOptions.All)
```
## Parameters
* ``options`` specifies which melodies (foreground, background or both) need to be stopped
## Example
This example plays the ``Entertainer`` built-in melody.
```blocks
music.beginMelody(music.builtInMelody(Melodies.Entertainer), MelodyOptions.Forever)
basic.pause(5000)
music.stopMelody(MelodyStopOptions.All)
```
## See also
[start melody](/reference/music/begin-melody)