newly updated FMODStudio plugin for UE5.3 migration
This commit is contained in:
Ji Yoon Rhee
parent
6ec77258e3
commit
547689631f
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,5 +1,5 @@
|
||||
{
|
||||
"BuildId": "23058290",
|
||||
"BuildId": "27405482",
|
||||
"Modules":
|
||||
{
|
||||
"FMODStudio": "UnrealEditor-FMODStudio.dll",
|
||||
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | AFMODAmbientSound</h1>
|
||||
<h1>6. API Reference | AFMODAmbientSound</h1>
|
||||
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/Engine/GameFramework/AActor/index.html">AActor</a></p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
<ul>
|
||||
@ -39,7 +41,7 @@
|
||||
|
||||
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></p></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,22 +13,24 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | Common</h1>
|
||||
<h1>6. API Reference | Common</h1>
|
||||
<p><strong>Types:</strong></p>
|
||||
<ul>
|
||||
<li><span><a class="apilink" href="api-reference-common.html#ffmodattenuationdetails" title="Override the attenuation values from FMOD Studio.">FFMODAttenuationDetails</a> Override the attenuation values from FMOD Studio.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-common.html#efmodeventproperty" title="These definitions describe built-in event properties.">EFMODEventProperty</a> These definitions describe built-in event properties.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-common.html#efmodsystemcontext" title="Which FMOD Studio system to use.">EFMODSystemContext</a> Which FMOD Studio system to use.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-common.html#ffmodocclusiondetails" title="Occlusion details.">FFMODOcclusionDetails</a> Occlusion details.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-common.html#fmod_vector_scale_default" title="Unreal defines 1 unit == 1cm, so convert to metres for Studio automatically.">FMOD_VECTOR_SCALE_DEFAULT</a> Unreal defines 1 unit == 1cm, so convert to metres for Studio automatically.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-common.html#fmod_vector_scale_default" title="This constant is used to convert unreal units to meters for FMOD Studio. The default value is appropriate for games that follow the Unreal Engine's convention of 1 unreal unit == 1cm; if your game world's scale uses a different length for unreal units, you can alter this value in FMODUtils.h.">FMOD_VECTOR_SCALE_DEFAULT</a> This constant is used to convert unreal units to meters for FMOD Studio. The default value is appropriate for games that follow the Unreal Engine's convention of 1 unreal unit == 1cm; if your game world's scale uses a different length for unreal units, you can alter this value in FMODUtils.h.</span></li>
|
||||
</ul>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -179,7 +181,7 @@
|
||||
<dd>Whether or not to enable complex geometry occlusion checks.</dd>
|
||||
</dl>
|
||||
<h2 api="type" id="fmod_vector_scale_default"><a href="#fmod_vector_scale_default">FMOD_VECTOR_SCALE_DEFAULT</a></h2>
|
||||
<p>Unreal defines 1 unit == 1cm, so convert to metres for Studio automatically.</p>
|
||||
<p>This constant is used to convert unreal units to meters for FMOD Studio. The default value is appropriate for games that follow the Unreal Engine's convention of 1 unreal unit == 1cm; if your game world's scale uses a different length for unreal units, you can alter this value in FMODUtils.h.</p>
|
||||
<p>
|
||||
<div class="language-selector">
|
||||
<div class="language-tab" data-language="language-cpp">C++</div>
|
||||
@ -385,7 +387,7 @@
|
||||
<dd>Helper function to return a parameter type as a string.</dd>
|
||||
</dl></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | IFMODStudioModule</h1>
|
||||
<h1>6. API Reference | IFMODStudioModule</h1>
|
||||
<p>This class inherits from <a href="">IModuleInterface</a>.</p>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -29,15 +31,11 @@
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_isavailable" title="Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.">IFMODStudioModule::IsAvailable</a> Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getstudiosystem" title="Get a pointer to the runtime studio system (only valid in-game or in PIE).">IFMODStudioModule::GetStudioSystem</a> Get a pointer to the runtime studio system (only valid in-game or in PIE).</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_setsystempaused" title="Set system paused.">IFMODStudioModule::SetSystemPaused</a> Set system paused.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_refreshsettings" title="Called when user changes any studio settings.">IFMODStudioModule::RefreshSettings</a> Called when user changes any studio settings.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_setinpie" title="Called when we enter or leave PIE mode.">IFMODStudioModule::SetInPIE</a> Called when we enter or leave PIE mode.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_findassetbyname" title="Look up an asset given its name.">IFMODStudioModule::FindAssetByName</a> Look up an asset given its name.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_findeventbyname" title="Look up an event given its name.">IFMODStudioModule::FindEventByName</a> Look up an event given its name.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getbankpath" title="Get the disk path for a bank asset.">IFMODStudioModule::GetBankPath</a> Get the disk path for a bank asset.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getallbankpaths" title="Get the disk paths for all Banks.">IFMODStudioModule::GetAllBankPaths</a> Get the disk paths for all Banks.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_reloadbanks" title="Called by the editor module when banks have been modified on disk.">IFMODStudioModule::ReloadBanks</a> Called by the editor module when banks have been modified on disk.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getlocale" title="Get current locale.">IFMODStudioModule::GetLocale</a> Get current locale.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_setlocale" title="Set active locale. Locale must be the locale name of one of the configured project locales.">IFMODStudioModule::SetLocale</a> Set active locale. Locale must be the locale name of one of the configured project locales.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_geteventdescription" title="Get an event description. The system type can control which Studio system to use, or leave it as System_Max for it to choose automatically.">IFMODStudioModule::GetEventDescription</a> Get an event description. The system type can control which Studio system to use, or leave it as System_Max for it to choose automatically.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_createauditioninginstance" title="Create a single auditioning instance using the auditioning system.">IFMODStudioModule::CreateAuditioningInstance</a> Create a single auditioning instance using the auditioning system.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_stopauditioninginstance" title="Stop any auditioning instance.">IFMODStudioModule::StopAuditioningInstance</a> Stop any auditioning instance.</span></li>
|
||||
@ -46,78 +44,47 @@
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_finishsetlistenerposition" title="Used to update the listener positions.">IFMODStudioModule::FinishSetListenerPosition</a> Used to update the listener positions.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getnearestlistener" title="Return the audio settings for the listener nearest the given location.">IFMODStudioModule::GetNearestListener</a> Return the audio settings for the listener nearest the given location.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getfailedbankloads" title="Return a list of banks that failed to load due to an error.">IFMODStudioModule::GetFailedBankLoads</a> Return a list of banks that failed to load due to an error.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_banksreloadedevent" title="This event is fired after all banks were reloaded.">IFMODStudioModule::BanksReloadedEvent</a> This event is fired after all banks were reloaded.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getrequiredplugins" title="Return a list of plugins that appear to be needed.">IFMODStudioModule::GetRequiredPlugins</a> Return a list of plugins that appear to be needed.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_addrequiredplugin" title="Register a plugin that is required.">IFMODStudioModule::AddRequiredPlugin</a> Register a plugin that is required.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_usesound" title="Returns whether sound is enabled for the game.">IFMODStudioModule::UseSound</a> Returns whether sound is enabled for the game.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_loadplugin" title="Attempts to load a plugin by name.">IFMODStudioModule::LoadPlugin</a> Attempts to load a plugin by name.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_logerror" title="Log an FMOD error.">IFMODStudioModule::LogError</a> Log an FMOD error.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudioeditormodule_arebanksloaded" title="This returns true if the plugin has loaded all required banks on startup. Depending if bLoadAllBanks is checked, this could be all banks or just the Master and Strings Bank.">IFMODStudioEditorModule::AreBanksLoaded</a> This returns true if the plugin has loaded all required banks on startup. Depending if <a href="api-reference-ufmodsettings#bloadallbanks.html">bLoadAllBanks</a> is checked, this could be all banks or just the <a href="studio-guide#loading-banks.html">Master</a> and <a href="studio-guide#loading-banks.html">Strings Bank</a>.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_arebanksloaded" title="This returns true if the plugin has loaded all required banks on startup. Depending if bLoadAllBanks is checked, this could be all banks or just the Master and Strings Bank.">IFMODStudioModule::AreBanksLoaded</a> This returns true if the plugin has loaded all required banks on startup. Depending if <a href="api-reference-ufmodsettings#bloadallbanks.html">bLoadAllBanks</a> is checked, this could be all banks or just the <a href="studio-guide#loading-banks.html">Master</a> and <a href="studio-guide#loading-banks.html">Strings Bank</a>.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_setlocale" title="Set active locale. Locale must be the locale name of one of the configured project locales.">IFMODStudioModule::SetLocale</a> Set active locale. Locale must be the locale name of one of the configured project locales.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getlocale" title="Get current locale.">IFMODStudioModule::GetLocale</a> Get current locale.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getdefaultlocale" title="Get the current default locale.">IFMODStudioModule::GetDefaultLocale</a> Get the current default locale.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_preendpie" title="A function called by FFMODStudioEditorModule as the PIE is ending so that the FMODStudioModule can clean up.">IFMODStudioModule::PreEndPIE</a> A function called by FFMODStudioEditorModule as the PIE is ending so that the FMODStudioModule can clean up.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_preendpieevent" title="Returns a delegate that gets triggered as the Play-In-Editor session is stopped but before the FMOD System is shutdown.">IFMODStudioModule::PreEndPIEEvent</a> Returns a delegate that gets triggered as the Play-In-Editor session is stopped but before the FMOD System is shutdown.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_reloadbanks" title="Called by the editor module when banks have been modified on disk.">IFMODStudioModule::ReloadBanks</a> Called by the editor module when banks have been modified on disk.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_loadeditorbanks" title="Load banks using the Editor System Context.">IFMODStudioModule::LoadEditorBanks</a> Load banks using the Editor System Context.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_unloadeditorbanks" title="Unload banks using the Editor System Context.">IFMODStudioModule::UnloadEditorBanks</a> Unload banks using the Editor System Context.</span></li>
|
||||
</ul>
|
||||
<h2 api="method" id="ifmodstudiomodule_get"><a href="#ifmodstudiomodule_get">IFMODStudioModule::Get</a></h2>
|
||||
<p>Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.</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">IFMODStudioModule</span> <span class="o">&</span><span class="n">Get</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>return</dt>
|
||||
<dd>Returns singleton instance, loading the module on demand if needed.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_isavailable"><a href="#ifmodstudiomodule_isavailable">IFMODStudioModule::IsAvailable</a></h2>
|
||||
<p>Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="n">IsAvailable</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>return</dt>
|
||||
<dd>Returns true if the module is loaded and ready to use.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_getstudiosystem"><a href="#ifmodstudiomodule_getstudiosystem">IFMODStudioModule::GetStudioSystem</a></h2>
|
||||
<p>Get a pointer to the runtime studio system (only valid in-game or in PIE).</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">System</span> <span class="o">*</span><span class="n">GetStudioSystem</span><span class="p">(</span>
|
||||
<span class="n">EFMODSystemContext</span><span class="o">::</span><span class="n">Type</span> <span class="n">Context</span>
|
||||
<h2 api="method" id="ifmodstudiomodule_addrequiredplugin"><a href="#ifmodstudiomodule_addrequiredplugin">IFMODStudioModule::AddRequiredPlugin</a></h2>
|
||||
<p>Register a plugin that is required.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">AddRequiredPlugin</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">FString</span> <span class="o">&</span><span class="n">Plugin</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Context</dt>
|
||||
<dd>System context to use.</dd>
|
||||
<dt>Plugin</dt>
|
||||
<dd>The plugin to be registered.</dd>
|
||||
</dl>
|
||||
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-common.html#efmodsystemcontext">EFMODSystemContext</a>.</p>
|
||||
<h2 api="method" id="ifmodstudiomodule_setsystempaused"><a href="#ifmodstudiomodule_setsystempaused">IFMODStudioModule::SetSystemPaused</a></h2>
|
||||
<p>Set system paused.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">SetSystemPaused</span><span class="p">(</span>
|
||||
<span class="kt">bool</span> <span class="n">paused</span>
|
||||
<h2 api="method" id="ifmodstudiomodule_arebanksloaded"><a href="#ifmodstudiomodule_arebanksloaded">IFMODStudioModule::AreBanksLoaded</a></h2>
|
||||
<p>This returns true if the plugin has loaded all required banks on startup. Depending if <a href="api-reference-ufmodsettings#bloadallbanks.html">bLoadAllBanks</a> is checked, this could be all banks or just the <a href="studio-guide#loading-banks.html">Master</a> and <a href="studio-guide#loading-banks.html">Strings Bank</a>.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">AreBanksLoaded</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_createauditioninginstance"><a href="#ifmodstudiomodule_createauditioninginstance">IFMODStudioModule::CreateAuditioningInstance</a></h2>
|
||||
<p>Create a single auditioning instance using the auditioning system.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">EventInstance</span> <span class="o">*</span><span class="n">CreateAuditioningInstance</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>paused</dt>
|
||||
<dd>Should the system be paused.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_refreshsettings"><a href="#ifmodstudiomodule_refreshsettings">IFMODStudioModule::RefreshSettings</a></h2>
|
||||
<p>Called when user changes any studio settings.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">RefreshSettings</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_setinpie"><a href="#ifmodstudiomodule_setinpie">IFMODStudioModule::SetInPIE</a></h2>
|
||||
<p>Called when we enter or leave PIE mode.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">SetInPIE</span><span class="p">(</span>
|
||||
<span class="kt">bool</span> <span class="n">bInPIE</span><span class="p">,</span>
|
||||
<span class="kt">bool</span> <span class="n">bSimulating</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>bInPIE</dt>
|
||||
<dd>Currently in PIE.</dd>
|
||||
<dt>bSimulating</dt>
|
||||
<dd>Currently simulating.</dd>
|
||||
<dt>Event</dt>
|
||||
<dd>The event to audition.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_findassetbyname"><a href="#ifmodstudiomodule_findassetbyname">IFMODStudioModule::FindAssetByName</a></h2>
|
||||
<p>Look up an asset given its name.</p>
|
||||
@ -141,16 +108,30 @@
|
||||
<dt>Name</dt>
|
||||
<dd>The name of the event.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_getbankpath"><a href="#ifmodstudiomodule_getbankpath">IFMODStudioModule::GetBankPath</a></h2>
|
||||
<p>Get the disk path for a bank asset.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FString</span> <span class="nf">GetBankPath</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">UFMODBank</span> <span class="o">&</span><span class="n">Bank</span>
|
||||
<h2 api="method" id="ifmodstudiomodule_finishsetlistenerposition"><a href="#ifmodstudiomodule_finishsetlistenerposition">IFMODStudioModule::FinishSetListenerPosition</a></h2>
|
||||
<p>Used to update the listener positions.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">FinishSetListenerPosition</span><span class="p">(</span>
|
||||
<span class="kt">int</span> <span class="n">NumListeners</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Bank</dt>
|
||||
<dd>The bank to retrieve the disk path for.</dd>
|
||||
<dt>NumListeners</dt>
|
||||
<dd>The number of listeners to change the positions of.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_get"><a href="#ifmodstudiomodule_get">IFMODStudioModule::Get</a></h2>
|
||||
<p>Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.</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">IFMODStudioModule</span> <span class="o">&</span><span class="n">Get</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>return</dt>
|
||||
<dd>Returns singleton instance, loading the module on demand if needed.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_getallbankpaths"><a href="#ifmodstudiomodule_getallbankpaths">IFMODStudioModule::GetAllBankPaths</a></h2>
|
||||
<p>Get the disk paths for all Banks.</p>
|
||||
@ -166,25 +147,20 @@
|
||||
<dt>IncludeMasterBank</dt>
|
||||
<dd>Should the Master Bank path be included.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_reloadbanks"><a href="#ifmodstudiomodule_reloadbanks">IFMODStudioModule::ReloadBanks</a></h2>
|
||||
<p>Called by the editor module when banks have been modified on disk.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">ReloadBanks</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_setlocale"><a href="#ifmodstudiomodule_setlocale">IFMODStudioModule::SetLocale</a></h2>
|
||||
<p>Set active locale. Locale must be the locale name of one of the configured project locales.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">SetLocale</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">FString</span><span class="o">&</span> <span class="n">Locale</span>
|
||||
<h2 api="method" id="ifmodstudiomodule_getbankpath"><a href="#ifmodstudiomodule_getbankpath">IFMODStudioModule::GetBankPath</a></h2>
|
||||
<p>Get the disk path for a bank asset.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FString</span> <span class="nf">GetBankPath</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">UFMODBank</span> <span class="o">&</span><span class="n">Bank</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Locale</dt>
|
||||
<dd>The language to use.</dd>
|
||||
<dt>Bank</dt>
|
||||
<dd>The bank to retrieve the disk path for.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_getlocale"><a href="#ifmodstudiomodule_getlocale">IFMODStudioModule::GetLocale</a></h2>
|
||||
<p>Get current locale.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FString</span> <span class="nf">GetLocale</span><span class="p">();</span>
|
||||
<h2 api="method" id="ifmodstudiomodule_getdefaultlocale"><a href="#ifmodstudiomodule_getdefaultlocale">IFMODStudioModule::GetDefaultLocale</a></h2>
|
||||
<p>Get the current default locale.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FString</span> <span class="nf">GetDefaultLocale</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_geteventdescription"><a href="#ifmodstudiomodule_geteventdescription">IFMODStudioModule::GetEventDescription</a></h2>
|
||||
@ -202,69 +178,6 @@
|
||||
<dd>System context to use.</dd>
|
||||
</dl>
|
||||
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-common.html#efmodsystemcontext">EFMODSystemContext</a>.</p>
|
||||
<h2 api="method" id="ifmodstudiomodule_createauditioninginstance"><a href="#ifmodstudiomodule_createauditioninginstance">IFMODStudioModule::CreateAuditioningInstance</a></h2>
|
||||
<p>Create a single auditioning instance using the auditioning system.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">EventInstance</span> <span class="o">*</span><span class="n">CreateAuditioningInstance</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">UFMODEvent</span> <span class="o">*</span><span class="n">Event</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Event</dt>
|
||||
<dd>The event to audition.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_stopauditioninginstance"><a href="#ifmodstudiomodule_stopauditioninginstance">IFMODStudioModule::StopAuditioningInstance</a></h2>
|
||||
<p>Stop any auditioning instance.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">StopAuditioningInstance</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_haslistenermoved"><a href="#ifmodstudiomodule_haslistenermoved">IFMODStudioModule::HasListenerMoved</a></h2>
|
||||
<p>Return whether the listener(s) have moved.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">HasListenerMoved</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_setlistenerposition"><a href="#ifmodstudiomodule_setlistenerposition">IFMODStudioModule::SetListenerPosition</a></h2>
|
||||
<p>Used to update a listener's position.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">SetListenerPosition</span><span class="p">(</span>
|
||||
<span class="kt">int</span> <span class="n">ListenerIndex</span><span class="p">,</span>
|
||||
<span class="n">UWorld</span> <span class="o">*</span><span class="n">World</span><span class="p">,</span>
|
||||
<span class="n">FTransform</span> <span class="o">&</span><span class="n">ListenerTransform</span><span class="p">,</span>
|
||||
<span class="kt">float</span> <span class="n">DeltaSeconds</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>ListenerIndex</dt>
|
||||
<dd>Which listener position to change.</dd>
|
||||
<dt>World</dt>
|
||||
<dd>The current map.</dd>
|
||||
<dt>ListenerTransform</dt>
|
||||
<dd>New transform of the listener.</dd>
|
||||
<dt>DeltaSeconds</dt>
|
||||
<dd>How many seconds it should take to get there.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_finishsetlistenerposition"><a href="#ifmodstudiomodule_finishsetlistenerposition">IFMODStudioModule::FinishSetListenerPosition</a></h2>
|
||||
<p>Used to update the listener positions.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">FinishSetListenerPosition</span><span class="p">(</span>
|
||||
<span class="kt">int</span> <span class="n">NumListeners</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>NumListeners</dt>
|
||||
<dd>The number of listeners to change the positions of.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_getnearestlistener"><a href="#ifmodstudiomodule_getnearestlistener">IFMODStudioModule::GetNearestListener</a></h2>
|
||||
<p>Return the audio settings for the listener nearest the given location.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="k">const</span> <span class="n">FFMODListener</span> <span class="o">&</span><span class="n">GetNearestListener</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">FVector</span> <span class="o">&</span><span class="n">Location</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Location</dt>
|
||||
<dd>Unreal Vector position.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_getfailedbankloads"><a href="#ifmodstudiomodule_getfailedbankloads">IFMODStudioModule::GetFailedBankLoads</a></h2>
|
||||
<p>Return a list of banks that failed to load due to an error.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">TArray</span><span class="o"><</span><span class="n">FString</span><span class="o">></span> <span class="n">GetFailedBankLoads</span><span class="p">(</span>
|
||||
@ -277,32 +190,59 @@
|
||||
<dd>System context to use.</dd>
|
||||
</dl>
|
||||
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-common.html#efmodsystemcontext">EFMODSystemContext</a>.</p>
|
||||
<h2 api="method" id="ifmodstudiomodule_banksreloadedevent"><a href="#ifmodstudiomodule_banksreloadedevent">IFMODStudioModule::BanksReloadedEvent</a></h2>
|
||||
<p>This event is fired after all banks were reloaded.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FSimpleMulticastDelegate</span> <span class="o">&</span><span class="n">BanksReloadedEvent</span><span class="p">();</span>
|
||||
<h2 api="method" id="ifmodstudiomodule_getlocale"><a href="#ifmodstudiomodule_getlocale">IFMODStudioModule::GetLocale</a></h2>
|
||||
<p>Get current locale.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FString</span> <span class="nf">GetLocale</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_getnearestlistener"><a href="#ifmodstudiomodule_getnearestlistener">IFMODStudioModule::GetNearestListener</a></h2>
|
||||
<p>Return the audio settings for the listener nearest the given location.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="k">const</span> <span class="n">FFMODListener</span> <span class="o">&</span><span class="n">GetNearestListener</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">FVector</span> <span class="o">&</span><span class="n">Location</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Location</dt>
|
||||
<dd>Unreal Vector position.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_getrequiredplugins"><a href="#ifmodstudiomodule_getrequiredplugins">IFMODStudioModule::GetRequiredPlugins</a></h2>
|
||||
<p>Return a list of plugins that appear to be needed.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">TArray</span><span class="o"><</span><span class="n">FString</span><span class="o">></span> <span class="n">GetRequiredPlugins</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_addrequiredplugin"><a href="#ifmodstudiomodule_addrequiredplugin">IFMODStudioModule::AddRequiredPlugin</a></h2>
|
||||
<p>Register a plugin that is required.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">AddRequiredPlugin</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">FString</span> <span class="o">&</span><span class="n">Plugin</span>
|
||||
<h2 api="method" id="ifmodstudiomodule_getstudiosystem"><a href="#ifmodstudiomodule_getstudiosystem">IFMODStudioModule::GetStudioSystem</a></h2>
|
||||
<p>Get a pointer to the runtime studio system (only valid in-game or in PIE).</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">System</span> <span class="o">*</span><span class="n">GetStudioSystem</span><span class="p">(</span>
|
||||
<span class="n">EFMODSystemContext</span><span class="o">::</span><span class="n">Type</span> <span class="n">Context</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Plugin</dt>
|
||||
<dd>The plugin to be registered.</dd>
|
||||
<dt>Context</dt>
|
||||
<dd>System context to use.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_usesound"><a href="#ifmodstudiomodule_usesound">IFMODStudioModule::UseSound</a></h2>
|
||||
<p>Returns whether sound is enabled for the game.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">UseSound</span><span class="p">();</span>
|
||||
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-common.html#efmodsystemcontext">EFMODSystemContext</a>.</p>
|
||||
<h2 api="method" id="ifmodstudiomodule_haslistenermoved"><a href="#ifmodstudiomodule_haslistenermoved">IFMODStudioModule::HasListenerMoved</a></h2>
|
||||
<p>Return whether the listener(s) have moved.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">HasListenerMoved</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_isavailable"><a href="#ifmodstudiomodule_isavailable">IFMODStudioModule::IsAvailable</a></h2>
|
||||
<p>Checks to see if this module is loaded and ready. It is only valid to call Get() if IsAvailable() returns true.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="n">IsAvailable</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>return</dt>
|
||||
<dd>Returns true if the module is loaded and ready to use.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_loadeditorbanks"><a href="#ifmodstudiomodule_loadeditorbanks">IFMODStudioModule::LoadEditorBanks</a></h2>
|
||||
<p>Load banks using the Editor System Context.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">LoadEditorBanks</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-common.html#efmodsystemcontext">EFMODSystemContext</a>.</p>
|
||||
<h2 api="method" id="ifmodstudiomodule_loadplugin"><a href="#ifmodstudiomodule_loadplugin">IFMODStudioModule::LoadPlugin</a></h2>
|
||||
<p>Attempts to load a plugin by name.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">LoadPlugin</span><span class="p">(</span>
|
||||
@ -332,12 +272,94 @@
|
||||
<dt>function</dt>
|
||||
<dd>The name of the function.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudioeditormodule_arebanksloaded"><a href="#ifmodstudioeditormodule_arebanksloaded">IFMODStudioEditorModule::AreBanksLoaded</a></h2>
|
||||
<p>This returns true if the plugin has loaded all required banks on startup. Depending if <a href="api-reference-ufmodsettings#bloadallbanks.html">bLoadAllBanks</a> is checked, this could be all banks or just the <a href="studio-guide#loading-banks.html">Master</a> and <a href="studio-guide#loading-banks.html">Strings Bank</a>.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">AreBanksLoaded</span><span class="p">();</span>
|
||||
<h2 api="function" id="ifmodstudiomodule_preendpie"><a href="#ifmodstudiomodule_preendpie">IFMODStudioModule::PreEndPIE</a></h2>
|
||||
<p>A function called by FFMODStudioEditorModule as the PIE is ending so that the FMODStudioModule can clean up.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="n">PreEndPIE</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="function" id="ifmodstudiomodule_preendpieevent"><a href="#ifmodstudiomodule_preendpieevent">IFMODStudioModule::PreEndPIEEvent</a></h2>
|
||||
<p>Returns a delegate that gets triggered as the Play-In-Editor session is stopped but before the FMOD System is shutdown.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FSimpleMulticastDelegate</span> <span class="o">&</span><span class="n">PreEndPIEEvent</span><span class="p">()</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_reloadbanks"><a href="#ifmodstudiomodule_reloadbanks">IFMODStudioModule::ReloadBanks</a></h2>
|
||||
<p>Called by the editor module when banks have been modified on disk.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">ReloadBanks</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_setinpie"><a href="#ifmodstudiomodule_setinpie">IFMODStudioModule::SetInPIE</a></h2>
|
||||
<p>Called when we enter or leave PIE mode.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">SetInPIE</span><span class="p">(</span>
|
||||
<span class="kt">bool</span> <span class="n">bInPIE</span><span class="p">,</span>
|
||||
<span class="kt">bool</span> <span class="n">bSimulating</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>bInPIE</dt>
|
||||
<dd>Currently in PIE.</dd>
|
||||
<dt>bSimulating</dt>
|
||||
<dd>Currently simulating.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_setlistenerposition"><a href="#ifmodstudiomodule_setlistenerposition">IFMODStudioModule::SetListenerPosition</a></h2>
|
||||
<p>Used to update a listener's position.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">SetListenerPosition</span><span class="p">(</span>
|
||||
<span class="kt">int</span> <span class="n">ListenerIndex</span><span class="p">,</span>
|
||||
<span class="n">UWorld</span> <span class="o">*</span><span class="n">World</span><span class="p">,</span>
|
||||
<span class="n">FTransform</span> <span class="o">&</span><span class="n">ListenerTransform</span><span class="p">,</span>
|
||||
<span class="kt">float</span> <span class="n">DeltaSeconds</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>ListenerIndex</dt>
|
||||
<dd>Which listener position to change.</dd>
|
||||
<dt>World</dt>
|
||||
<dd>The current map.</dd>
|
||||
<dt>ListenerTransform</dt>
|
||||
<dd>New transform of the listener.</dd>
|
||||
<dt>DeltaSeconds</dt>
|
||||
<dd>How many seconds it should take to get there.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_setlocale"><a href="#ifmodstudiomodule_setlocale">IFMODStudioModule::SetLocale</a></h2>
|
||||
<p>Set active locale. Locale must be the locale name of one of the configured project locales.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">SetLocale</span><span class="p">(</span>
|
||||
<span class="k">const</span> <span class="n">FString</span><span class="o">&</span> <span class="n">Locale</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>Locale</dt>
|
||||
<dd>The language to use.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_setsystempaused"><a href="#ifmodstudiomodule_setsystempaused">IFMODStudioModule::SetSystemPaused</a></h2>
|
||||
<p>Set system paused.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">SetSystemPaused</span><span class="p">(</span>
|
||||
<span class="kt">bool</span> <span class="n">paused</span>
|
||||
<span class="p">);</span>
|
||||
</pre></div>
|
||||
|
||||
<dl>
|
||||
<dt>paused</dt>
|
||||
<dd>Should the system be paused.</dd>
|
||||
</dl>
|
||||
<h2 api="method" id="ifmodstudiomodule_stopauditioninginstance"><a href="#ifmodstudiomodule_stopauditioninginstance">IFMODStudioModule::StopAuditioningInstance</a></h2>
|
||||
<p>Stop any auditioning instance.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">StopAuditioningInstance</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="method" id="ifmodstudiomodule_unloadeditorbanks"><a href="#ifmodstudiomodule_unloadeditorbanks">IFMODStudioModule::UnloadEditorBanks</a></h2>
|
||||
<p>Unload banks using the Editor System Context.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">UnloadEditorBanks</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<p><strong>See Also:</strong> <a class="apilink" href="api-reference-common.html#efmodsystemcontext">EFMODSystemContext</a>.</p>
|
||||
<h2 api="method" id="ifmodstudiomodule_usesound"><a href="#ifmodstudiomodule_usesound">IFMODStudioModule::UseSound</a></h2>
|
||||
<p>Returns whether sound is enabled for the game.</p>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">bool</span> <span class="nf">UseSound</span><span class="p">();</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODAnimNotifyPlay</h1>
|
||||
<h1>6. API Reference | UFMODAnimNotifyPlay</h1>
|
||||
<p>Used for triggering Events in Animation timelines.</p>
|
||||
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/Engine/Animation/AnimNotifies/UAnimNotify/index.html">UAnimNotify</a></p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
@ -84,7 +86,7 @@
|
||||
<p>If <a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_bfollow">UFMODAnimNotifyPlay::bFollow</a> is true <a class="apilink" href="blueprint-reference-common.html#play-event-attached">Play Event Attached</a> is called using the current <a class="apilink" href="api-reference-ufmodanimnotifyplay.html#ufmodanimnotifyplay_attachname">UFMODAnimNotifyPlay::AttachName</a>.<br />
|
||||
Otherwise <a class="apilink" href="blueprint-reference-common.html#play-event-at-location">Play Event At Location</a> is called using the <code>MeshComp</code> for the positional information.</p></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODAsset</h1>
|
||||
<h1>6. API Reference | UFMODAsset</h1>
|
||||
<p>Base asset used for creating FMOD object assets in Unreal.</p>
|
||||
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/CoreUObject/UObject/UObject/index.html">UObject</a></p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
@ -38,7 +40,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FGuid</span> <span class="n">AssetGuid</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODAudioComponent</h1>
|
||||
<h1>6. API Reference | UFMODAudioComponent</h1>
|
||||
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/Engine/Components/USceneComponent/index.html">USceneComponent</a></p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
<ul>
|
||||
@ -34,11 +36,12 @@
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_event" title="The event asset to use for this sound.">UFMODAudioComponent::Event</a> The event asset to use for this sound.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_eventcallback" title="Generic callback used for the Studio Instance.">UFMODAudioComponent_EventCallback</a> Generic callback used for the Studio Instance.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_occlusiondetails" title="FMOD Custom Occlusion Details.">UFMODAudioComponent::OcclusionDetails</a> FMOD Custom Occlusion Details.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_oneventstopped" title="Called when an event stops, either because it played to completion or because a Stop() call turned it off early.">UFMODAudioComponent::OnEventStopped</a> Called when an event stops, either because it played to completion or because a Stop() call turned it off early.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_onsoundstopped" title="Called when a sound stops.">UFMODAudioComponent::OnSoundStopped</a> Called when a sound stops.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_ontimelinebeat" title="Called when we reach a beat of a tempo (if bEnableTimelineCallbacks is true).">UFMODAudioComponent::OnTimelineBeat</a> Called when we reach a beat of a tempo (if bEnableTimelineCallbacks is true).</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_ontimelinemarker" title="Called when we reach a named marker (if bEnableTimelineCallbacks is true).">UFMODAudioComponent::OnTimelineMarker</a> Called when we reach a named marker (if bEnableTimelineCallbacks is true).</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_parametercache" title="Cache of the current Events parameters.">UFMODAudioComponent::ParameterCache</a> Cache of the current Events parameters.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_programmersoundname" title="Sound name used for programmer sound.">UFMODAudioComponent::ProgrammerSoundName</a> Sound name used for programmer sound.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_oneventstopped" title="Called when an event stops, either because it played to completion or because a Stop() call turned it off early.">UFMODAudioComponent::OnEventStopped</a> Called when an event stops, either because it played to completion or because a Stop() call turned it off early.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_ontimelinebeat" title="Called when we reach a beat of a tempo (if bEnableTimelineCallbacks is true).">UFMODAudioComponent::OnTimelineBeat</a> Called when we reach a beat of a tempo (if bEnableTimelineCallbacks is true).</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodaudiocomponent.html#ufmodaudiocomponent_studioinstance" title="Actual Studio instance handle.">UFMODAudioComponent::StudioInstance</a> Actual Studio instance handle.</span></li>
|
||||
</ul>
|
||||
<p><strong>Methods:</strong></p>
|
||||
@ -50,6 +53,7 @@
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-length" title="Get the event length in milliseconds.">Get Length</a> Get the event length in milliseconds.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-parameter" title="Get parameter value from the Event.">Get Parameter</a> Get parameter value from the Event.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-parameter-value" title="Get parameter value from the Event.">Get Parameter Value</a> Get parameter value from the Event.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-paused" title="Get the paused state of the audio component.">Get Paused</a> Get the paused state of the audio component.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-property" title="Get a property of the Event.">Get Property</a> Get a property of the Event.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-timeline-position" title="Get the timeline position in milliseconds.">Get Timeline Position</a> Get the timeline position in milliseconds.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#is-playing" title="Return true if this component is currently playing an event.">Is Playing</a> Return true if this component is currently playing an event.</span></li>
|
||||
@ -184,6 +188,16 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FOnEventStopped</span> <span class="n">OnEventStopped</span><span class="p">;</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="struct" id="ufmodaudiocomponent_onsoundstopped"><a href="#ufmodaudiocomponent_onsoundstopped">UFMODAudioComponent::OnSoundStopped</a></h2>
|
||||
<p>Called when a sound stops.</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">FOnSoundStopped</span> <span class="n">OnSoundStopped</span><span class="p">;</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="struct" id="ufmodaudiocomponent_ontimelinebeat"><a href="#ufmodaudiocomponent_ontimelinebeat">UFMODAudioComponent::OnTimelineBeat</a></h2>
|
||||
<p>Called when we reach a beat of a tempo (if bEnableTimelineCallbacks is true).</p>
|
||||
<p>
|
||||
@ -254,7 +268,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FMOD</span><span class="o">::</span><span class="n">Studio</span><span class="o">::</span><span class="n">EventInstance</span> <span class="o">*</span><span class="n">StudioInstance</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODBank</h1>
|
||||
<h1>6. API Reference | UFMODBank</h1>
|
||||
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html">UFMODAsset</a>.</p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
<ul>
|
||||
@ -37,7 +39,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FGuid</span> <span class="n">AssetGuid</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODBlueprintStatics</h1>
|
||||
<h1>6. API Reference | UFMODBlueprintStatics</h1>
|
||||
<p>This class inherits from <a href="https://api.unrealengine.com/INT/API/Runtime/Engine/Kismet/UBlueprintFunctionLibrary/index.html">UBlueprintFunctionLibrary</a></p>
|
||||
<p>Refer to <a href="blueprint-reference.html">Blueprint Reference</a>.</p>
|
||||
<p><strong>Defines:</strong></p>
|
||||
@ -66,7 +68,7 @@
|
||||
<dd><a href="https://fmod.com/docs/2.02/api/studio-api-eventinstance.html">FMOD::Studio::EventInstance</a> to use.</dd>
|
||||
</dl></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODBus</h1>
|
||||
<h1>6. API Reference | UFMODBus</h1>
|
||||
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html">UFMODAsset</a>.</p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
<ul>
|
||||
@ -37,7 +39,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FGuid</span> <span class="n">AssetGuid</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODEvent</h1>
|
||||
<h1>6. API Reference | UFMODEvent</h1>
|
||||
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html">UFMODAsset</a></p>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -55,7 +57,7 @@
|
||||
<dd>Parameters to retrieve.</dd>
|
||||
</dl></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODPort</h1>
|
||||
<h1>6. API Reference | UFMODPort</h1>
|
||||
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html">UFMODAsset</a>.</p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
<ul>
|
||||
@ -37,7 +39,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FGuid</span> <span class="n">AssetGuid</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODSettings</h1>
|
||||
<h1>6. API Reference | UFMODSettings</h1>
|
||||
<p>This class inherits from <a href="">UObject</a>.</p>
|
||||
<p><strong>Defines:</strong></p>
|
||||
<ul>
|
||||
@ -46,8 +48,7 @@
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_outputformat" title="Project output format, should match the mode set up for the Studio project.">UFMODSettings::OutputFormat</a> Project output format, should match the mode set up for the Studio project.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_outputtype" title="Built-in output types that can be used to run the mixer.">UFMODSettings::OutputType</a> Built-in output types that can be used to run the mixer.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_locales" title="Locales for localized banks. These should match the project locales configured in the FMOD Studio project.">UFMODSettings::Locales</a> Locales for localized banks. These should match the project locales configured in the FMOD Studio project.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_bvol0virtual" title="Enable vol0virtual, which means voices with low volume will automatically go virtual to save CPU.">UFMODSettings::bVol0Virtual</a> Enable vol0virtual, which means voices with low volume will automatically go virtual to save CPU.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_vol0virtuallevel" title="If vol0virtual is enabled, the signal level at which to make channels virtual.">UFMODSettings::Vol0VirtualLevel</a> If vol0virtual is enabled, the signal level at which to make channels virtual.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_vol0virtuallevel" title="The signal level at which to make channels virtual.">UFMODSettings::Vol0VirtualLevel</a> The signal level at which to make channels virtual.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_samplerate" title="Sample rate to use, or 0 to match system rate.eg. 0, 22050, 24000, 32000, 44100, 48000.">UFMODSettings::SampleRate</a> Sample rate to use, or 0 to match system rate.eg. 0, 22050, 24000, 32000, 44100, 48000.</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_bmatchhardwaresamplerate" title="Match hardware sample rate where reasonable (44.1kHz to 48kHz).">UFMODSettings::bMatchHardwareSampleRate</a> Match hardware sample rate where reasonable (44.1kHz to 48kHz).</span></li>
|
||||
<li><span><a class="apilink" href="api-reference-ufmodsettings.html#ufmodsettings_realchannelcount" title="Number of actual software voices that can be used at once.">UFMODSettings::RealChannelCount</a> Number of actual software voices that can be used at once.</span></li>
|
||||
@ -463,18 +464,8 @@ FMOD may become unstable if the limit is exceeded!</dd>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">TArray</span><span class="o"><</span><span class="n">FFMODProjectLocale</span><span class="o">></span> <span class="n">Locales</span><span class="p">;</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="property" id="ufmodsettings_bvol0virtual"><a href="#ufmodsettings_bvol0virtual">UFMODSettings::bVol0Virtual</a></h2>
|
||||
<p>Enable vol0virtual, which means voices with low volume will automatically go virtual to save CPU.</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">bool</span> <span class="n">bVol0Virtual</span><span class="p">;</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="property" id="ufmodsettings_vol0virtuallevel"><a href="#ufmodsettings_vol0virtuallevel">UFMODSettings::Vol0VirtualLevel</a></h2>
|
||||
<p>If vol0virtual is enabled, the signal level at which to make channels virtual.</p>
|
||||
<p>The signal level at which to make channels virtual.</p>
|
||||
<p>
|
||||
<div class="language-selector">
|
||||
<div class="language-tab" data-language="language-cpp">C++</div>
|
||||
@ -757,7 +748,7 @@ FMOD may become unstable if the limit is exceeded!</dd>
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">TMap</span><span class="o"><</span><span class="n">TEnumAsByte</span><span class="o"><</span><span class="n">EFMODPlatforms</span><span class="o">::</span><span class="n">Type</span><span class="o">></span><span class="p">,</span> <span class="n">FFMODPlatformSettings</span><span class="o">></span> <span class="n">Platforms</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODSnapshot</h1>
|
||||
<h1>6. API Reference | UFMODSnapshot</h1>
|
||||
<p>This class inherits from <a class="apilink" href="api-reference-ufmodevent.html">UFMODEvent</a>.</p>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -55,7 +57,7 @@
|
||||
<dd>Parameters to retrieve.</dd>
|
||||
</dl></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODSnapshotReverb</h1>
|
||||
<h1>6. API Reference | UFMODSnapshotReverb</h1>
|
||||
<p>This class inherits from <a href="">UReverbEffect</a>.</p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
<ul>
|
||||
@ -37,7 +39,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FGuid</span> <span class="n">AssetGuid</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-inactive-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li class="manual-current-chapter manual-active-chapter"><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference | UFMODVCA</h1>
|
||||
<h1>6. API Reference | UFMODVCA</h1>
|
||||
<p>This class inherits from <a class="apilink" href="api-reference-ufmodasset.html">UFMODAsset</a>.</p>
|
||||
<p><strong>Properties:</strong></p>
|
||||
<ul>
|
||||
@ -37,7 +39,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="n">FGuid</span> <span class="n">AssetGuid</span><span class="p">;</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-active-chapter"><a href="api-reference.html">API Reference</a><ul class="subchapters"><li><a href="api-reference-common.html">Common</a></li><li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li><li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li><li><a href="api-reference-ufmodaudiocomponent.html">UFMODAudioComponent</a></li><li><a href="api-reference-afmodambientsound.html">AFMODAmbientSound</a></li><li><a href="api-reference-ufmodanimnotifyplay.html">UFMODAnimNotifyPlay</a></li><li><a href="api-reference-ufmodbank.html">UFMODBank</a></li><li><a href="api-reference-ufmodbus.html">UFMODBus</a></li><li><a href="api-reference-ufmodvca.html">UFMODVCA</a></li><li><a href="api-reference-ufmodevent.html">UFMODEvent</a></li><li><a href="api-reference-ufmodport.html">UFMODPort</a></li><li><a href="api-reference-ufmodsnapshot.html">UFMODSnapshot</a></li><li><a href="api-reference-ufmodsnapshotreverb.html">UFMODSnapshotReverb</a></li><li><a href="api-reference-ufmodasset.html">UFMODAsset</a></li><li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li></ul></li>
|
||||
<li><a href="blueprint-reference.html">Blueprint Reference</a></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>5. API Reference</h1>
|
||||
<h1>6. API Reference</h1>
|
||||
<ul class="docs-body-subchapters"><li><a href="api-reference-common.html">Common</a></li>
|
||||
<li><a href="api-reference-ifmodstudiomodule.html">IFMODStudioModule</a></li>
|
||||
<li><a href="api-reference-ufmodblueprintstatics.html">UFMODBlueprintStatics</a></li>
|
||||
@ -39,7 +41,7 @@
|
||||
<li><a href="api-reference-ufmodsettings.html">UFMODSettings</a></li>
|
||||
</ul></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-active-chapter"><a href="blueprint-reference-asynchronous-loading.html">Asynchronous Loading</a></li></ul></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 class="manual-current-chapter manual-active-chapter"><a href="blueprint-reference-asynchronous-loading.html">Asynchronous Loading</a></li><li><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>6. Blueprint Reference | Asynchronous Loading</h1>
|
||||
<h1>7. Blueprint Reference | Asynchronous Loading</h1>
|
||||
<p>This is an Unreal Level Blueprint that demonstrates how to build a loading screen that can be used at the start of a game to load both FMOD Studio data and Unreal data without blocking the main thread. To make this work properly "Load All Banks" needs to be turned off in the FMOD Settings.</p>
|
||||
<p><img alt="Level Blueprint" src="images/blueprint-async-levelbp.png" /></p>
|
||||
<p><strong>Topics:</strong></p>
|
||||
@ -57,7 +59,7 @@
|
||||
<img alt="Check if Loaded" src="images/blueprint-async-checkifloaded.png" /></dd>
|
||||
</dl></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-active-chapter"><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></ul></li>
|
||||
<li class="manual-current-chapter manual-inactive-chapter"><a href="blueprint-reference.html">Blueprint Reference</a><ul class="subchapters"><li class="manual-current-chapter manual-active-chapter"><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><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>6. Blueprint Reference | Bus</h1>
|
||||
<h1>7. Blueprint Reference | Bus</h1>
|
||||
<p>Used for controlling mixer buses.</p>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -118,7 +120,7 @@
|
||||
</dl>
|
||||
<p><strong>See Also:</strong> <a href="https://fmod.com/docs/2.02/api/studio-api-eventinstance.html#fmod_studio_stop_mode">FMOD_STUDIO_STOP_MODE</a></p></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-active-chapter"><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></ul></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 class="manual-current-chapter manual-active-chapter"><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><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>6. Blueprint Reference | Common</h1>
|
||||
<h1>7. Blueprint Reference | Common</h1>
|
||||
<p>The common section contains methods for controlling the FMOD system.</p>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -517,7 +519,7 @@ The sound does not travel with any actor.</p>
|
||||
<dd>Volume value.</dd>
|
||||
</dl></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-active-chapter"><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></ul></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 class="manual-current-chapter manual-active-chapter"><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><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>6. Blueprint Reference | Component</h1>
|
||||
<h1>7. Blueprint Reference | Component</h1>
|
||||
<p>These methods are used to control the state of Audio Components.</p>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -29,6 +31,7 @@
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-length" title="Get the event length in milliseconds.">Get Length</a> Get the event length in milliseconds.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-parameter" title="Get parameter value from the Event.">Get Parameter</a> Get parameter value from the Event.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-parameter-value" title="Get parameter value from the Event.">Get Parameter Value</a> Get parameter value from the Event.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-paused" title="Get the paused state of the audio component.">Get Paused</a> Get the paused state of the audio component.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-property" title="Get a property of the Event.">Get Property</a> Get a property of the Event.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#get-timeline-position" title="Get the timeline position in milliseconds.">Get Timeline Position</a> Get the timeline position in milliseconds.</span></li>
|
||||
<li><span><a class="apilink" href="blueprint-reference-component.html#is-playing" title="Return true if this component is currently playing an event.">Is Playing</a> Return true if this component is currently playing an event.</span></li>
|
||||
@ -101,6 +104,17 @@
|
||||
<dt>FinalValue</dt>
|
||||
<dd>Final combined parameter value.</dd>
|
||||
</dl>
|
||||
<h2 api="struct" id="get-paused"><a href="#get-paused">Get Paused</a></h2>
|
||||
<p>Get the paused state of the audio component.</p>
|
||||
<p><img alt="Set Paused" src="images/get-paused.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">bool</span> <span class="nf">GetPaused</span><span class="p">();</span>
|
||||
</pre></div>
|
||||
|
||||
<h2 api="function" id="get-property"><a href="#get-property">Get Property</a></h2>
|
||||
<p>Get a property of the Event.</p>
|
||||
<p><img alt="Get Property" src="images/get-property.png" /></p>
|
||||
@ -334,7 +348,7 @@
|
||||
<div class="highlight language-cpp"><pre><span></span><span class="kt">void</span> <span class="nf">Stop</span><span class="p">();</span>
|
||||
</pre></div></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,15 +13,17 @@
|
||||
<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 class="manual-current-chapter manual-active-chapter"><a href="blueprint-reference-eventinstance.html">Event Instance</a></li><li><a href="blueprint-reference-asynchronous-loading.html">Asynchronous Loading</a></li></ul></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 class="manual-current-chapter manual-active-chapter"><a href="blueprint-reference-eventinstance.html">Event Instance</a></li><li><a href="blueprint-reference-asynchronous-loading.html">Asynchronous Loading</a></li><li><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>6. Blueprint Reference | Event Instance</h1>
|
||||
<h1>7. Blueprint Reference | Event Instance</h1>
|
||||
<p>These methods are used to control individual Event Instances.</p>
|
||||
<p><strong>Methods:</strong></p>
|
||||
<ul>
|
||||
@ -295,7 +297,7 @@
|
||||
<dd>Whether to release the Event Instance</dd>
|
||||
</dl></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,23 +13,28 @@
|
||||
<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-active-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></ul></li>
|
||||
<li class="manual-current-chapter manual-active-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><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>6. Blueprint Reference</h1>
|
||||
<h1>7. Blueprint Reference</h1>
|
||||
<ul class="docs-body-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><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></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
@ -13,10 +13,12 @@
|
||||
<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><a href="blueprint-reference.html">Blueprint Reference</a></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 class="manual-current-chapter manual-active-chapter"><a href="glossary.html">Glossary</a><ul>
|
||||
<li><a href="#documentation-conventions">Documentation Conventions</a><ul>
|
||||
<li><a href="#parameter-tokens">Parameter Tokens</a></li>
|
||||
@ -28,10 +30,10 @@
|
||||
</ul>
|
||||
</div>
|
||||
<div class="manual-content api">
|
||||
<h1>9. Glossary</h1>
|
||||
<h1>11. Glossary</h1>
|
||||
<p>This page includes definitions for various common FMOD Studio terms, along with references to related terms and documentation.</p>
|
||||
<h2 id="documentation-conventions"><a href="#documentation-conventions">9.1 Documentation Conventions</a></h2>
|
||||
<h3 id="parameter-tokens"><a href="#parameter-tokens">9.1.1 Parameter Tokens</a></h3>
|
||||
<h2 id="documentation-conventions"><a href="#documentation-conventions">11.1 Documentation Conventions</a></h2>
|
||||
<h3 id="parameter-tokens"><a href="#parameter-tokens">11.1.1 Parameter Tokens</a></h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@ -62,12 +64,12 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="version"><a href="#version">9.2 Version</a></h2>
|
||||
<h2 id="version"><a href="#version">11.2 Version</a></h2>
|
||||
<p>The version number of FMOD Studio. Version numbers are split into three parts, in the format: productVersion.majorVersion.minorVersion. For example, the version 1.23.45 would indicate product version 1, major version 23, and minor version 45 of that major version.</p>
|
||||
<p>Major versions contain significant changes, add new features, and may affect bank compatibility. Updating to a new major version usually requires project migration. New major versions may change playback behavior in some cases.</p>
|
||||
<p>Minor versions, also known as patch versions, contain bug fixes and smaller workflow improvements.</p></div>
|
||||
|
||||
<p class="manual-footer">Unreal Integration 2.02.14 (2023-05-03). © 2023 Firelight Technologies Pty Ltd.</p>
|
||||
<p class="manual-footer">Unreal Integration 2.02.26 (2024-12-11). © 2024 Firelight Technologies Pty Ltd.</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 953 B After Width: | Height: | Size: 128 B |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 734 B After Width: | Height: | Size: 128 B |
Binary file not shown.
|
Before Width: | Height: | Size: 587 B After Width: | Height: | Size: 128 B |
Binary file not shown.
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 73 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 131 B |
Binary file not shown.
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 7.3 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 8.4 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 512 KiB After Width: | Height: | Size: 131 B |
Binary file not shown.
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 6.6 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 9.9 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 6.5 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 9.4 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 6.6 KiB After Width: | Height: | Size: 129 B |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 130 B |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 130 B |
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user