Files
sfall/audio/index.html
T

6 lines
21 KiB
HTML
Raw Normal View History

2026-01-09 12:10:58 +00:00
<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/sfall/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/sfall/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav > ul.nav-list:first-child > li:not(:nth-child(11)) > a, .site-nav > ul.nav-list:first-child > li > ul > li a { background-image: none; } .site-nav > ul.nav-list:not(:first-child) a, .site-nav li.external a { background-image: none; } .site-nav > ul.nav-list:first-child > li:nth-child(11) > a { font-weight: 600; text-decoration: none; }.site-nav > ul.nav-list:first-child > li:nth-child(11) > button svg { transform: rotate(-90deg); }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(11) > ul.nav-list { display: block; } </style> <script src="/sfall/assets/js/vendor/lunr.min.js"></script> <script src="/sfall/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="icon" href="/sfall/favicon.ico" type="image/x-icon"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>Audio | sfall</title> <meta name="generator" content="Jekyll v3.9.0" /> <meta property="og:title" content="Audio" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Sfall documentation" /> <meta property="og:description" content="Sfall documentation" /> <link rel="canonical" href="/sfall/audio/" /> <meta property="og:url" content="/sfall/audio/" /> <meta property="og:site_name" content="sfall" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="Audio" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","description":"Sfall documentation","headline":"Audio","url":"/sfall/audio/"}</script> <!-- End Jekyll SEO tag --> <link rel="apple-touch-icon" sizes="180x180" href="/assets/favicon/apple-touch-icon.png"> <link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon/favicon-32x32.png"> <link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon/favicon-16x16.png"> <link rel="manifest" href="/assets/favicon/site.webmanifest"> <link rel="mask-icon" href="/assets/favicon/safari-pinned-tab.svg" color="#5bbad5"> <meta name="msapplication-TileColor" content="#da532c"> <meta name="msapplication-config" content="/assets/favicon/browserconfig.xml"> <meta name="theme-color" content="#ffffff"> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="non
2022-05-30 13:00:21 +00:00
</code></pre></div></div> <p>Obsolete since sfall 2.1a. Always returns 0.</p><hr /> <h3 id="play_sfall_sound"> <a href="#play_sfall_sound" class="anchor-heading" aria-labelledby="play_sfall_sound"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>play_sfall_sound</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">int</span> <span class="n">play_sfall_sound</span><span class="p">(</span><span class="n">string</span> <span class="n">file</span><span class="p">,</span> <span class="kt">int</span> <span class="n">mode</span><span class="p">)</span>
2025-03-02 03:33:18 +00:00
</code></pre></div></div> <p>Used to play <code class="language-plaintext highlighter-rouge">mp3/wav/wma</code> files. The path given is relative to the Fallout folder. Specify mode as 1 to loop the file continuously, 2 to replace the current background game music with playing the specified file in loop mode, or 0 to play the file once. If you dont wish to loop, <code class="language-plaintext highlighter-rouge">play_sfall_sound</code> returns 0. If you do loop, it returns an ID which can be passed back to <code class="language-plaintext highlighter-rouge">stop_sfall_sound</code> when you want to stop the effect. All sounds effects will be stopped on game reload, looping or not. Does not require <code class="language-plaintext highlighter-rouge">AllowDShowSound</code> to be set to 1 in <code class="language-plaintext highlighter-rouge">ddraw.ini</code>.</p> <p>Starting from sfall 4.2.8/3.8.28, you can pass a value in the <code class="language-plaintext highlighter-rouge">mode</code> argument for a reduced sound volume. To set the volume, you need to convert the number to hexadecimal and use the argument format <code class="language-plaintext highlighter-rouge">0xZZZZ000Y</code>, where <code class="language-plaintext highlighter-rouge">ZZZZ</code> is the volume reduction value in range from 0 to 32767 (the value 32767 is mute), and <code class="language-plaintext highlighter-rouge">Y</code> is the playback mode.</p><hr /> <h3 id="set_eax_environment"> <a href="#set_eax_environment" class="anchor-heading" aria-labelledby="set_eax_environment"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>set_eax_environment</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">set_eax_environment</span><span class="p">(</span><span class="kt">int</span> <span class="n">environment</span><span class="p">)</span>
2022-05-30 13:00:21 +00:00
</code></pre></div></div> <p>Obsolete since sfall 2.1a. Has no effect.</p><hr /> <h3 id="stop_sfall_sound"> <a href="#stop_sfall_sound" class="anchor-heading" aria-labelledby="stop_sfall_sound"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> <strong>stop_sfall_sound</strong> </h3> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="n">stop_sfall_sound</span><span class="p">(</span><span class="kt">int</span> <span class="n">soundID</span><span class="p">)</span>
2026-01-09 12:10:58 +00:00
</code></pre></div></div> <p>Stops looping <code class="language-plaintext highlighter-rouge">mp3/wav/wma</code> files previously launched by <code class="language-plaintext highlighter-rouge">play_sfall_sound</code>. All sounds effects will be stopped on game reload, looping or not. Does not require <code class="language-plaintext highlighter-rouge">AllowDShowSound</code> to be set to 1 in <code class="language-plaintext highlighter-rouge">ddraw.ini</code>.</p> </main> <hr> <footer> <div class="d-md-none"> <div class="mt-4 fs-2"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </div> </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>