Difference between revisions of "StartSound"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Redirected page to Global Command: startSound)
 
(19 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>Currently available properties: <br/>
 
* volume (allows you to set volume level)
 
* balance (allows you to set left/right balance)
 
* offset (allows you to start audio file from x time; in ms)
 
* loop (allows you to loop the audio file)</div>
 
</div></div>
 
 
 
 
 
Syntax:
 
<syntaxhighlight>
 
startSound("filename", {flags=1, properties})
 
</syntaxhighlight>
 
 
 
 
 
Example 1: basic play audio file method
 
<syntaxhighlight>
 
n/a
 
</syntaxhighlight>
 
 
 
Example 2: ...
 
<syntaxhighlight>
 
n/a
 
</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>
 
 
 
<b>visionaireObject</b> <br/>
 
The visionaire object representing the active action!
 
{{i18n|StartSound}}
 

Latest revision as of 12:35, 19 May 2023