|
|
| (7 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: startSound]] |
| − | <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 play sound files; with optional property values!
| |
| − | <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 be centered!</div>
| |
| − | </div></div>
| |
| − | | |
| − | | |
| − | Syntax:
| |
| − | <syntaxhighlight>
| |
| − | startSound("filename", {flags=1, properties})
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | Example 1: basic play audio file method!
| |
| − | <syntaxhighlight>
| |
| − | startSound("sounds/example.ogg")
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | Example 2: again with properties!
| |
| − | <syntaxhighlight>
| |
| − | -- play example.ogg at 100% volume level, audio centered, from 1 second mark with loop mode on!
| |
| − | startSound("sounds/example.ogg", {flags=1, volume=100, balance=0, offset=1000 loop=true}) | |
| − | | |
| − | --[[
| |
| − | let's say you have an audio file with a duration of 00:03:24 & you want to start the audio file at: 2 minutes & 44 seconds;
| |
| − | so what we need to do is convert minutes/seconds into ms like so: (2*60)*1000 + (44*1000) = 164000ms
| |
| − | | |
| − | math explanation:
| |
| − | 2m*60s = 120 seconds * 1000ms = 120,000ms | 44s*1000ms = 44,000ms
| |
| − | 120,000 + 44,000 = 164,000ms
| |
| − | --]]
| |
| − | </syntaxhighlight>
| |
| − | | |
| − | | |
| − | | |
| − | <b><u>Arguments</u></b>
| |
| − | | |
| − | <b>filename</b>: path <br/>
| |
| − | The path to the audio file to be played! ("path/filename.type")
| |
| − | | |
| − | | |
| − | <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|StartSound}} <br/>
| |
| − | {| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
| |
| − | |-
| |
| − | |<b>Relevant Pages</b>: [[GetSoundId|getSoundId]] - [[GetSoundProperty|getSoundProperty]] - [[SetSoundProperty|setSoundProperty]] - [[StopSound|stopSound]] - [[ToggleSoundPause|toggleSoundPause]]
| |
| − | |}
| |
