Package com.fs.starfarer.api

Interface MusicPlayerPlugin

All Known Subinterfaces:
MusicPlayerPluginWithVolumeControl
All Known Implementing Classes:
MusicPlayerPluginImpl
public interface MusicPlayerPlugin
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.

  • Method Details

    • getStateTokenForCampaignLocation

      Object getStateTokenForCampaignLocation()
      Called when free-flying in the campaign only, i.e. not in any sort of interaction dialog.
      Returns:

    • getMusicSetIdForCampaignStateToken

      String getMusicSetIdForCampaignStateToken(Object token, Object param)
      Called for the following states: MusicPlayerPluginImpl.MARKET MusicPlayerPluginImpl.ENCOUNTER MusicPlayerPluginImpl.PLANET_SURVEY MusicPlayerPluginImpl.CAMPAIGN_SYSTEM MusicPlayerPluginImpl.CAMPAIGN_HYPERSPACE ... and any other states returned by getStateTokenForCampaignLocation()
      Parameters:
      token -
      Returns:

    • getMusicSetIdForCombat

      String getMusicSetIdForCombat(CombatEngineAPI engine)

    • getMusicSetIdForTitle

      String getMusicSetIdForTitle()