101 lines
6.3 KiB (Stored with Git LFS)
HTML
101 lines
6.3 KiB (Stored with Git LFS)
HTML
<html>
|
|
<head>
|
|
<title>Blueprint Reference | Enums</title>
|
|
<link rel="stylesheet" href="style/docs.css">
|
|
<link rel="stylesheet" href="style/code_highlight.css">
|
|
<script type="text/javascript" src="scripts/language-selector.js"></script></head>
|
|
<body>
|
|
<div class="docs-body">
|
|
<div class="manual-toc">
|
|
<p>Unreal Integration 2.02</p>
|
|
<ul>
|
|
<li><a href="welcome.html">Welcome to FMOD for Unreal</a></li>
|
|
<li><a href="user-guide.html">User Guide</a></li>
|
|
<li><a href="settings.html">Settings</a></li>
|
|
<li><a href="plugins.html">Plugins</a></li>
|
|
<li><a href="niagara.html">Niagara Integration</a></li>
|
|
<li><a href="api-reference.html">API Reference</a></li>
|
|
<li class="manual-current-chapter manual-inactive-chapter"><a href="blueprint-reference.html">Blueprint Reference</a><ul class="subchapters"><li><a href="blueprint-reference-bus.html">Bus</a></li><li><a href="blueprint-reference-common.html">Common</a></li><li><a href="blueprint-reference-component.html">Component</a></li><li><a href="blueprint-reference-eventinstance.html">Event Instance</a></li><li><a href="blueprint-reference-asynchronous-loading.html">Asynchronous Loading</a></li><li class="manual-current-chapter manual-active-chapter"><a href="blueprint-reference-enums.html">Enums</a></li><li><a href="blueprint-reference-structs.html">Structs</a></li><li><a href="blueprint-reference-utilities.html">Utilities</a></li></ul></li>
|
|
<li><a href="platform-specifics.html">Platform Specifics</a></li>
|
|
<li><a href="troubleshooting.html">Troubleshooting</a></li>
|
|
<li><a href="audiolink.html">AudioLink</a></li>
|
|
<li><a href="glossary.html">Glossary</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="manual-content api">
|
|
<h1>7. Blueprint Reference | Enums</h1>
|
|
<p>Automatically generated methods for working with FMOD and Unreal Enums.</p>
|
|
<p><strong>Methods:</strong></p>
|
|
<ul>
|
|
<li><span><a class="apilink" href="blueprint-reference-enums.html#byte-to-enum-efmod_studio_stop_mode" title="Converts a byte to an EFMOD_STUDIO_STOP_MODE.">Byte to Enum EFMOD_STUDIO_STOP_MODE</a> Converts a byte to an EFMOD_STUDIO_STOP_MODE.</span></li>
|
|
<li><span><a class="apilink" href="blueprint-reference-enums.html#foreach-efmod_studio_stop_mode" title="Returns every value in the EFMOD_STUDIO_STOP_MODE enum.">ForEach EFMOD_STUDIO_STOP_MODE</a> Returns every value in the EFMOD_STUDIO_STOP_MODE enum.</span></li>
|
|
<li><span><a class="apilink" href="blueprint-reference-enums.html#get-number-of-entries-in-efmod_studio_stop_mode" title="Returns the total number of entries in the EFMOD_STUDIO_STOP_MODE enum.">Get Number of Entries in EFMOD_STUDIO_STOP_MODE</a> Returns the total number of entries in the EFMOD_STUDIO_STOP_MODE enum.</span></li>
|
|
<li><span><a class="apilink" href="blueprint-reference-enums.html#literal-enum-efmod_studio_stop_mode" title="Returns the value of an EFMOD_STUDIO_STOP_MODE member.">Literal Enum EFMOD_STUDIO_STOP_MODE</a> Returns the value of an EFMOD_STUDIO_STOP_MODE member.</span></li>
|
|
</ul>
|
|
<h2 api="function" id="byte-to-enum-efmod_studio_stop_mode"><a href="#byte-to-enum-efmod_studio_stop_mode">Byte to Enum EFMOD_STUDIO_STOP_MODE</a></h2>
|
|
<p>Converts a byte to an EFMOD_STUDIO_STOP_MODE.</p>
|
|
<p><img alt="Byte to Enum" src="images/byte-to-enum.png" /></p>
|
|
<p>
|
|
<div class="language-selector">
|
|
<div class="language-tab" data-language="language-cpp">C++</div>
|
|
</div>
|
|
</p>
|
|
<div class="highlight language-cpp"><pre><span></span><span class="n">EFMOD_STUDIO_STOP_MODE</span> <span class="nf">ByteToEnum</span><span class="p">(</span>
|
|
<span class="n">byte</span> <span class="n">Byte</span>
|
|
<span class="p">);</span>
|
|
</pre></div>
|
|
|
|
<dl>
|
|
<dt>Byte</dt>
|
|
<dd>Byte to convert to an EFMOD_STUDIO_STOP_MODE.</dd>
|
|
</dl>
|
|
<p><strong>See Also:</strong> <a href="https://fmod.com/docs/2.02/api/studio-api-eventinstance.html#fmod_studio_stop_mode">EFMOD_STUDIO_STOP_MODE</a>.</p>
|
|
<h2 api="function" id="foreach-efmod_studio_stop_mode"><a href="#foreach-efmod_studio_stop_mode">ForEach EFMOD_STUDIO_STOP_MODE</a></h2>
|
|
<p>Returns every value in the EFMOD_STUDIO_STOP_MODE enum.</p>
|
|
<p><img alt="ForEach EFMOD_STUDIO_STOP_MODE" src="images/for-each.png" /></p>
|
|
<p>
|
|
<div class="language-selector">
|
|
<div class="language-tab" data-language="language-cpp">C++</div>
|
|
</div>
|
|
</p>
|
|
<div class="highlight language-cpp"><pre><span></span><span class="n">EFMOD_STUDIO_STOP_MODE</span> <span class="nf">ForEachEFMOD_STUDIO_STOP_MODE</span><span class="p">();</span>
|
|
</pre></div>
|
|
|
|
<p><strong>See Also:</strong> <a href="https://fmod.com/docs/2.02/api/studio-api-eventinstance.html#fmod_studio_stop_mode">EFMOD_STUDIO_STOP_MODE</a>.</p>
|
|
<h2 api="function" id="get-number-of-entries-in-efmod_studio_stop_mode"><a href="#get-number-of-entries-in-efmod_studio_stop_mode">Get Number of Entries in EFMOD_STUDIO_STOP_MODE</a></h2>
|
|
<p>Returns the total number of entries in the EFMOD_STUDIO_STOP_MODE enum.</p>
|
|
<p><img alt="Get Number of Entries in EFMOD_STUDIO_STOP_MODE" src="images/get-number-of-entreis-in.png" /></p>
|
|
<p>
|
|
<div class="language-selector">
|
|
<div class="language-tab" data-language="language-cpp">C++</div>
|
|
</div>
|
|
</p>
|
|
<div class="highlight language-cpp"><pre><span></span><span class="kt">int</span> <span class="nf">GetNumberOfEntriesInEFMOD_STUDIO_STOP_MODE</span><span class="p">();</span>
|
|
</pre></div>
|
|
|
|
<p><strong>See Also:</strong> <a href="https://fmod.com/docs/2.02/api/studio-api-eventinstance.html#fmod_studio_stop_mode">EFMOD_STUDIO_STOP_MODE</a>.</p>
|
|
<h2 api="function" id="literal-enum-efmod_studio_stop_mode"><a href="#literal-enum-efmod_studio_stop_mode">Literal Enum EFMOD_STUDIO_STOP_MODE</a></h2>
|
|
<p>Returns the value of an EFMOD_STUDIO_STOP_MODE member.</p>
|
|
<p><img alt="Literal Enum EFMOD_STUDIO_STOP_MODE" src="images/literal-enum.png" /></p>
|
|
<p>
|
|
<div class="language-selector">
|
|
<div class="language-tab" data-language="language-cpp">C++</div>
|
|
</div>
|
|
</p>
|
|
<div class="highlight language-cpp"><pre><span></span><span class="n">EFMOD_STUDIO_STOP_MODE</span> <span class="nf">LiteralEnumEFMOD_STUDIO_STOP_MODE</span><span class="p">(</span>
|
|
<span class="n">EFMOD_STUDIO_STOP_MODE</span> <span class="n">Enum</span>
|
|
<span class="p">);</span>
|
|
</pre></div>
|
|
|
|
<dl>
|
|
<dt>Enum</dt>
|
|
<dd>The EFMOD_STUDIO_STOP_MODE member value to retrieve.</dd>
|
|
</dl>
|
|
<p><strong>See Also:</strong> <a href="https://fmod.com/docs/2.02/api/studio-api-eventinstance.html#fmod_studio_stop_mode">EFMOD_STUDIO_STOP_MODE</a>.</p></div>
|
|
|
|
<p class="manual-footer">Unreal Integration 2.02.23 (2024-07-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
|
</body>
|
|
</html>
|
|
|
|
</div>
|