com.fs.starfarer.api.MusicPlayerPluginWithVolumeControl Interface Reference

Inheritance diagram for com.fs.starfarer.api.MusicPlayerPluginWithVolumeControl:

Collaboration diagram for com.fs.starfarer.api.MusicPlayerPluginWithVolumeControl:

Public Member Functions
float	getMusicSetVolumeForCampaignStateToken (Object token, Object param)
Public Member Functions inherited from com.fs.starfarer.api.MusicPlayerPlugin
Object	getStateTokenForCampaignLocation ()
String	getMusicSetIdForCampaignStateToken (Object token, Object param)
String	getMusicSetIdForCombat (CombatEngineAPI engine)
String	getMusicSetIdForTitle ()

Detailed Description

WARNING Do not store campaign data in data members of an implementation of this interface. There is only one instance of it per application session and references to campaign data will likely cause memory leaks.

If data storage is required, use SectorAPI.getMemory() or other such.

Definition at line 12 of file MusicPlayerPluginWithVolumeControl.java.

Member Function Documentation

getMusicSetVolumeForCampaignStateToken()

float com.fs.starfarer.api.MusicPlayerPluginWithVolumeControl.getMusicSetVolumeForCampaignStateToken	(	Object	token,
		Object	param
	)

Implemented in com.fs.starfarer.api.impl.MusicPlayerPluginImpl.

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/MusicPlayerPluginWithVolumeControl.java