Updates for V4 (#197)
* update yotta defaults for 16kb devices * refactor deprecated blocks * updates for button events * update button events * update refference * update docs * update docs * update button event blocks * update docs * update block id
This commit is contained in:
40
docs/reference/music/builtin-sound-effect.md
Normal file
40
docs/reference/music/builtin-sound-effect.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# builtin Sound Effect
|
||||
|
||||
Get a sound expression string for a built-in sound effect.
|
||||
|
||||
```sig
|
||||
music.builtinSoundEffect(soundExpression.giggle)
|
||||
```
|
||||
|
||||
A collection of built-in sound effects are available as sound expressions. You choose one by selecting the name of the effect
|
||||
|
||||
## Parameters
|
||||
|
||||
* **soundExpression**: A sound expression name. The available effects are:
|
||||
>* `giggle`
|
||||
>* `happy`
|
||||
>* `hello`
|
||||
>* `mysterious`
|
||||
>* `sad`
|
||||
>* `slide`
|
||||
>* `soaring`
|
||||
>* `spring`
|
||||
>* `twinkle`
|
||||
>* `yawn`
|
||||
|
||||
## Returns
|
||||
|
||||
* a [sound](/types/sound) expression [string](/types/string) with the the named sound effect.
|
||||
|
||||
## Example
|
||||
|
||||
Play the built-in sound effect for `giggle`.
|
||||
|
||||
```blocks
|
||||
music.playSoundEffect(music.builtinSoundEffect(soundExpression.giggle), SoundExpressionPlayMode.UntilDone)
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
[play sound effect](/reference/music/play-sound-effect),
|
||||
[create sound effect](/reference/music/create-sound-effect)
|
||||
Reference in New Issue
Block a user