|
|
| (8 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
| + | #REDIRECT [[Global Command: setSoundProperty]] |
| − | <b>Command History</b>
| |
| − | <div class="mw-collapsible-content">
| |
| − | <div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.8</span></div>
| |
| − | </div></div>
| |
| − | | |
| − | | |
| − | Allows you to set various property values for the linked sound.id!
| |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
| |
| − | <b>Additional Info</b>
| |
| − | <div class="mw-collapsible-content">
| |
| − | <div>Properties currently available:
| |
| − | <pre>volume, balance, offset, loop</pre>
| |
| − | Please note that only mono sounds can be panned using the balance property; all stereo channel sounds will remain centered!</div>
| |
| − | </div></div>
| |
| − | | |
| − | | |
| − | Syntax:
| |
| − | <syntaxhighlight>
| |
| − | setSoundProperty(id, {flags=1, properties}) | |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | Example:
| |
| − | <syntaxhighlight>
| |
| − | -- let's store the sound.id into a variable!
| |
| − | local soundID = getSoundId("sounds/example.ogg")
| |
| − | | |
| − | -- set the linked sound property values to: volume=80%, audio=centered, keep current offset with loop mode on!
| |
| − | setSoundProperty(soundID, {flags=1, volume=100, balance=0, offset=0 loop=true})
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | | |
| − | <b><u>Arguments</u></b>
| |
| − | | |
| − | <b>id</b>: integer (number) <br/>
| |
| − | The id for the currently playing audio file! ("sound.id")
| |
| − | | |
| − | | |
| − | <b><u>Flags</u></b>
| |
| − | | |
| − | <b>properties</b>
| |
| − | * volume: allows you to set volume level via an integer value
| |
| − | * balance: allows you to set the left/right audio balance via an integer value (-1000/0/1000)
| |
| − | * offset: allows you to start audio file from x time via an integer value (in ms)
| |
| − | * loop: allows you to declare if audio file should loop via a boolean value (true/false)
| |
| − | | |
| − | | |
| − | <b><u>Return</u></b>
| |
| − | | |
| − | none
| |
| − | {{i18n|GetSoundProperty}} <br/>
| |
| − | {| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
| |
| − | |-
| |
| − | |<b>Relevant Pages</b>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|GetSoundProperty]] - [[StartSound|startSound]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
| |
| − | |}
| |
