-
Notifications
You must be signed in to change notification settings - Fork 594
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add reference pages for the built-in melody accessors (#5880)
* add reference pages for built-in melody accessors * update help paths
- Loading branch information
Showing
3 changed files
with
103 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# built In Melody | ||
|
||
Get a melody string for a built-in melody. | ||
|
||
```sig | ||
music.builtInMelody(Melodies.Dadadadum) | ||
``` | ||
|
||
A collection of built-in melodies are available. You choose one by selecting the name of the melody. | ||
|
||
## Parameters | ||
|
||
* **melody**: A melody name. The available melodies are: | ||
|
||
>* `dadadum` | ||
>* `entertainer` | ||
>* `prelude` | ||
>* `ode` | ||
>* `nyan` | ||
>* `ringtone` | ||
>* `funk` | ||
>* `blues` | ||
>* `birthday` | ||
>* `wedding` | ||
>* `funeral` | ||
>* `punchline` | ||
>* `baddy` | ||
>* `chase` | ||
>* `ba ding` | ||
>* `wawawawaa` | ||
>* `jump up` | ||
>* `jump down` | ||
>* `power up` | ||
>* `power down` | ||
## Returns | ||
|
||
* a [string](/types/string) that contains the melody. | ||
|
||
## Example | ||
|
||
Play the built-in melody for **blues**. | ||
|
||
```blocks | ||
music.startMelody(music.builtInMelody(Melodies.Blues), MelodyOptions.Once) | ||
``` | ||
|
||
## See also | ||
|
||
[start melody](/reference/music/start-melody), | ||
[built-in sound effect](/reference/music/builtin-sound-effect) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# built In Playable Melody | ||
|
||
Get a playable sound object for a built-in melody. | ||
|
||
```sig | ||
music.builtInPlayableMelody(Melodies.Dadadadum) | ||
``` | ||
|
||
A collection of built-in melodies are available as [playable](/types/playable) sound objects. You choose one by selecting the name of the melody. | ||
|
||
## Parameters | ||
|
||
* **melody**: A melody name. The available melodies are: | ||
|
||
>* `dadadum` | ||
>* `entertainer` | ||
>* `prelude` | ||
>* `ode` | ||
>* `nyan` | ||
>* `ringtone` | ||
>* `funk` | ||
>* `blues` | ||
>* `birthday` | ||
>* `wedding` | ||
>* `funeral` | ||
>* `punchline` | ||
>* `baddy` | ||
>* `chase` | ||
>* `ba ding` | ||
>* `wawawawaa` | ||
>* `jump up` | ||
>* `jump down` | ||
>* `power up` | ||
>* `power down` | ||
## Returns | ||
|
||
* a [playable](/types/playable) object that contains the melody. | ||
|
||
## Example | ||
|
||
Play the built-in melody for **blues**. | ||
|
||
```blocks | ||
music.play(music.builtInPlayableMelody(Melodies.Blues), music.PlaybackMode.InBackground) | ||
``` | ||
|
||
## See also | ||
|
||
[built-in sound effect](/reference/music/builtin-sound-effect) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters