Package com.fs.starfarer.api.impl

Class MusicPlayerPluginImpl

java.lang.Object

com.fs.starfarer.api.impl.MusicPlayerPluginImpl

All Implemented Interfaces:

MusicPlayerPlugin, MusicPlayerPluginWithVolumeControl

public class MusicPlayerPluginImpl
extends Object
implements MusicPlayerPluginWithVolumeControl

Field Summary

Fields

Modifier and Type	Field	Description
static Object	CAMPAIGN_HYPERSPACE
static Object	CAMPAIGN_SYSTEM
static Object	COMBAT
static String	COMBAT_MUSIC_SET_FACTION_KEY
static String	COMBAT_MUSIC_SET_MEM_KEY
static Object	CUSTOM
static Object	ENCOUNTER
static String	KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY
static Object	MARKET
static String	MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO
static String	MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE
static String	MUSIC_ENCOUNTER_NEUTRAL
static String	MUSIC_GALATIA_ACADEMY
static String	MUSIC_SET_MEM_KEY
static String	MUSIC_SET_MEM_KEY_MISSION
static Object	NO_MUSIC
static Object	PLANET_SURVEY
static Map<String,String>	stringTokens
static String	SYSTEM_MUSIC_PREFIX
static Object	TITLE

Constructor Summary

Constructors

Constructor	Description
MusicPlayerPluginImpl()

Method Summary

Modifier and Type	Method	Description
protected String	getEncounterMusicSetId(Object param)
protected String	getHyperspaceMusicSetId()
protected String	getMarketMusicSetId(Object param)
String	getMusicSetIdForCampaignStateToken(Object token, Object param)	Called for the following states: MusicPlayerPluginImpl.MARKET MusicPlayerPluginImpl.ENCOUNTER MusicPlayerPluginImpl.PLANET_SURVEY MusicPlayerPluginImpl.CAMPAIGN_SYSTEM MusicPlayerPluginImpl.CAMPAIGN_HYPERSPACE ...
String	getMusicSetIdForCombat(CombatEngineAPI engine)
String	getMusicSetIdForTitle()
float	getMusicSetVolumeForCampaignStateToken(Object token, Object param)
protected String	getPlanetSurveyMusicSetId(Object param)
protected String	getStarSystemMusicSetId()
Object	getStateTokenForCampaignLocation()	Called when free-flying in the campaign only, i.e.
static Object	getToken(String str)	Goal here is to return tokens for which an == comparison works.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY

public static String KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY

COMBAT_MUSIC_SET_MEM_KEY

public static String COMBAT_MUSIC_SET_MEM_KEY

COMBAT_MUSIC_SET_FACTION_KEY

public static String COMBAT_MUSIC_SET_FACTION_KEY

MUSIC_SET_MEM_KEY

public static String MUSIC_SET_MEM_KEY

MUSIC_SET_MEM_KEY_MISSION

public static String MUSIC_SET_MEM_KEY_MISSION

MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO

public static String MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO

MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE

public static String MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE

MUSIC_ENCOUNTER_NEUTRAL

public static String MUSIC_ENCOUNTER_NEUTRAL

MUSIC_GALATIA_ACADEMY

public static String MUSIC_GALATIA_ACADEMY

CAMPAIGN_SYSTEM

public static Object CAMPAIGN_SYSTEM

CAMPAIGN_HYPERSPACE

public static Object CAMPAIGN_HYPERSPACE

NO_MUSIC

public static Object NO_MUSIC

COMBAT

public static Object COMBAT

TITLE

public static Object TITLE

MARKET

public static Object MARKET

ENCOUNTER

public static Object ENCOUNTER

PLANET_SURVEY

public static Object PLANET_SURVEY

CUSTOM

public static Object CUSTOM

stringTokens

public static Map<String,String> stringTokens

SYSTEM_MUSIC_PREFIX

public static String SYSTEM_MUSIC_PREFIX

Constructor Details

MusicPlayerPluginImpl

public MusicPlayerPluginImpl()

Method Details

getToken

public static Object getToken(String str)

Goal here is to return tokens for which an == comparison works.

Parameters:

str -

Returns:

getStateTokenForCampaignLocation

public Object getStateTokenForCampaignLocation()

Description copied from interface: MusicPlayerPlugin

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

Specified by:

getStateTokenForCampaignLocation in interface MusicPlayerPlugin

Returns:

getMusicSetIdForCombat

public String getMusicSetIdForCombat(CombatEngineAPI engine)

Specified by:

getMusicSetIdForCombat in interface MusicPlayerPlugin

getMusicSetIdForTitle

public String getMusicSetIdForTitle()

Specified by:

getMusicSetIdForTitle in interface MusicPlayerPlugin

getMusicSetVolumeForCampaignStateToken

public float getMusicSetVolumeForCampaignStateToken(Object token,
 Object param)

Specified by:

getMusicSetVolumeForCampaignStateToken in interface MusicPlayerPluginWithVolumeControl

getMusicSetIdForCampaignStateToken

public String getMusicSetIdForCampaignStateToken(Object token,
 Object param)

Description copied from interface: MusicPlayerPlugin

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()

Specified by:

getMusicSetIdForCampaignStateToken in interface MusicPlayerPlugin

Returns:

getPlanetSurveyMusicSetId

protected String getPlanetSurveyMusicSetId(Object param)

Parameters:

param - is a MarketAPI.

Returns:

getHyperspaceMusicSetId

protected String getHyperspaceMusicSetId()

getStarSystemMusicSetId

protected String getStarSystemMusicSetId()

getEncounterMusicSetId

protected String getEncounterMusicSetId(Object param)

getMarketMusicSetId

protected String getMarketMusicSetId(Object param)