/usr/share/doc/sludge/SLUDGEDevKitHelp/startMusic.html is in sludge-doc 2.2.1-2build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>startMusic</TITLE>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<BODY>
<HR>
<div align="center"><img id="headerGraphic" src="images/sludge300.png" alt="SLUDGE"/></div>
<h2>startMusic</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">startMusic (<i>musicFile, channel, startPos</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Starts playing a piece of music at the volume set by the <a href="setDefaultMusicVolume.html">setDefaultMusicVolume</a> function. The <i>musicFile</i> parameter must be a file handle - the <i>channel</i> parameter must be a number from 0 to 3 inclusive. Only one piece of music can be played on each channel at once.
</P>
<P>
The <i>startPos</i> defines where in a track-based music file to begin playback. This allows you to start the same piece of music in different places dependant on the game situation... or to store more than one piece of music in the same file.
</P>
<P>
File formats supported by this function are .MOD, .XM, .S3M and .IT files. This function cannot play .WAV or .OGG files - to start playback of one of these, you must use either the <a href="playSound.html">playSound</a> or <a href="loopSound.html">loopSound</a> function.
</P>
<H3>Return value:</H3>
<P>
No return value.
</P>
<H3>See also:</H3>
<P>
<a href="Using_Audio_in_SLUDGE.html">Using Audio in SLUDGE</a>
</P>
<P>
<a href="setMusicVolume.html">setMusicVolume</a>
</P>
<P>
<a href="stopMusic.html">stopMusic</a>
</P>
<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2012
</P>
<HR>
</BODY>
</html>
|