/usr/share/doc/sludge/SLUDGEDevKitHelp/freeSound.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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>freeSound</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>freeSound</h2>
<HR>
<H3>Syntax:</H3>
<P>
<pre class="syntax">freeSound (<i>soundFile</i>);</pre>
</P>
<H3>Purpose:</H3>
<P>
Removes the <i>soundFile</i> file from the SLUDGE sound cache. Why? Because the more sounds you have in the cache - especially big ones - the more memory is taken up, and the slower your game may run on some older computers. So, if you've just finished using a huge great sound that you don't need again for a while, use this function to reclaim some memory.
</P>
<P>
Please note that the cache can only hold 8 sounds at once, so older sounds will be unloaded once they're not needed automatically anyway - you don't <i>need</i> to use freeSound to make your game work, and freeing up memory used by tiny little sounds (up to a few seconds long) won't make much of a difference.
</P>
<H3>Return value:</H3>
<P>
No return value.
</P>
<H3>Example:</H3>
<P>
<pre># Start a sound playing
playSound ('bigLongSound.wav');
# Wait 10 frames and then stop it
pause (10);
stopSound ('bigLongSound.wav');
# We don't need the sound in the cache any more...
freeSound ('bigLongSound.wav');</pre>
</P>
<H3>See also:</H3>
<P>
<a href="Using_Audio_in_SLUDGE.html">Using Audio in SLUDGE</a>
</P>
<P>
<a href="loopSound.html">loopSound</a>
</P>
<P>
<a href="playSound.html">playSound</a>
</P>
<P>
<a href="stopSound.html">stopSound</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>
|