com.fs.starfarer.api.MusicPlayerPlugin Interface Reference

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

Public Member Functions
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 14 of file MusicPlayerPlugin.java.

Member Function Documentation

getMusicSetIdForCampaignStateToken()

String com.fs.starfarer.api.MusicPlayerPlugin.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

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

getMusicSetIdForCombat()

String com.fs.starfarer.api.MusicPlayerPlugin.getMusicSetIdForCombat

(

CombatEngineAPI

engine

)

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

getMusicSetIdForTitle()

String com.fs.starfarer.api.MusicPlayerPlugin.getMusicSetIdForTitle

(

)

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

getStateTokenForCampaignLocation()

Object com.fs.starfarer.api.MusicPlayerPlugin.getStateTokenForCampaignLocation

(

)

Called when free-flying in the campaign only, i.e. not in any sort of interaction dialog.

Returns

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

---

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

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