<p>This class inherits from <ahref="">IModuleInterface</a>.</p>
<p><strong>Methods:</strong></p>
<ul>
<li><span><aclass="apilink"href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_get"title="Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.">IFMODStudioModule::Get</a> Singleton-like access to this module's interface. Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.</span></li>
<li><span><aclass="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><aclass="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><aclass="apilink"href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_setsystempaused"title="Set system paused.">IFMODStudioModule::SetSystemPaused</a> Set system paused.</span></li>
<li><span><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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><aclass="apilink"href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_stopauditioninginstance"title="Stop any auditioning instance.">IFMODStudioModule::StopAuditioningInstance</a> Stop any auditioning instance.</span></li>
<li><span><aclass="apilink"href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_haslistenermoved"title="Return whether the listener(s) have moved.">IFMODStudioModule::HasListenerMoved</a> Return whether the listener(s) have moved.</span></li>
<li><span><aclass="apilink"href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_setlistenerposition"title="Used to update a listener's position.">IFMODStudioModule::SetListenerPosition</a> Used to update a listener's position.</span></li>
<li><span><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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><aclass="apilink"href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_logerror"title="Log an FMOD error.">IFMODStudioModule::LogError</a> Log an FMOD error.</span></li>
<li><span><aclass="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 <ahref="api-reference-ufmodsettings#bloadallbanks.html">bLoadAllBanks</a> is checked, this could be all banks or just the <ahref="studio-guide#loading-banks.html">Master</a> and <ahref="studio-guide#loading-banks.html">Strings Bank</a>.</span></li>
<li><span><aclass="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><aclass="apilink"href="api-reference-ifmodstudiomodule.html#ifmodstudiomodule_getlocale"title="Get current locale.">IFMODStudioModule::GetLocale</a> Get current locale.</span></li>
<li><span><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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><aclass="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>
<p>This returns true if the plugin has loaded all required banks on startup. Depending if <ahref="api-reference-ufmodsettings#bloadallbanks.html">bLoadAllBanks</a> is checked, this could be all banks or just the <ahref="studio-guide#loading-banks.html">Master</a> and <ahref="studio-guide#loading-banks.html">Strings Bank</a>.</p>
<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>
