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 java.lang.Object
implements MusicPlayerPluginWithVolumeControl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	CAMPAIGN_HYPERSPACE
static java.lang.Object	CAMPAIGN_SYSTEM
static java.lang.Object	COMBAT
static java.lang.Object	CUSTOM
static java.lang.Object	ENCOUNTER
static java.lang.String	KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY
static java.lang.Object	MARKET
static java.lang.String	MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO
static java.lang.String	MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE
static java.lang.String	MUSIC_ENCOUNTER_NEUTRAL
static java.lang.String	MUSIC_SET_MEM_KEY
static java.lang.Object	NO_MUSIC
static java.lang.Object	PLANET_SURVEY
static java.util.Map<java.lang.String,java.lang.String>	stringTokens
static java.lang.String	SYSTEM_MUSIC_PREFIX
static java.lang.Object	TITLE

Constructor Summary

Constructors

Constructor and Description
MusicPlayerPluginImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	getEncounterMusicSetId(java.lang.Object param)
protected java.lang.String	getHyperspaceMusicSetId()
protected java.lang.String	getMarketMusicSetId(java.lang.Object param)
java.lang.String	getMusicSetIdForCampaignStateToken(java.lang.Object token, java.lang.Object param) Called for the following states: MusicPlayerPluginImpl.MARKET MusicPlayerPluginImpl.ENCOUNTER MusicPlayerPluginImpl.PLANET_SURVEY MusicPlayerPluginImpl.CAMPAIGN_SYSTEM MusicPlayerPluginImpl.CAMPAIGN_HYPERSPACE ...
java.lang.String	getMusicSetIdForCombat(CombatEngineAPI engine)
java.lang.String	getMusicSetIdForTitle()
float	getMusicSetVolumeForCampaignStateToken(java.lang.Object token, java.lang.Object param)
protected java.lang.String	getPlanetSurveyMusicSetId(java.lang.Object param)
protected java.lang.String	getStarSystemMusicSetId()
java.lang.Object	getStateTokenForCampaignLocation() Called when free-flying in the campaign only, i.e.
static java.lang.Object	getToken(java.lang.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 Detail

KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY

public static java.lang.String KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY

MUSIC_SET_MEM_KEY

public static java.lang.String MUSIC_SET_MEM_KEY

MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO

public static java.lang.String MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO

MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE

public static java.lang.String MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE

MUSIC_ENCOUNTER_NEUTRAL

public static java.lang.String MUSIC_ENCOUNTER_NEUTRAL

CAMPAIGN_SYSTEM

public static java.lang.Object CAMPAIGN_SYSTEM

CAMPAIGN_HYPERSPACE

public static java.lang.Object CAMPAIGN_HYPERSPACE

NO_MUSIC

public static java.lang.Object NO_MUSIC

COMBAT

public static java.lang.Object COMBAT

TITLE

public static java.lang.Object TITLE

MARKET

public static java.lang.Object MARKET

ENCOUNTER

public static java.lang.Object ENCOUNTER

PLANET_SURVEY

public static java.lang.Object PLANET_SURVEY

CUSTOM

public static java.lang.Object CUSTOM

stringTokens

public static java.util.Map<java.lang.String,java.lang.String> stringTokens

SYSTEM_MUSIC_PREFIX

public static java.lang.String SYSTEM_MUSIC_PREFIX

Constructor Detail

MusicPlayerPluginImpl

public MusicPlayerPluginImpl()

Method Detail

getToken

public static java.lang.Object getToken(java.lang.String str)

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

Parameters:

str -

Returns:

getStateTokenForCampaignLocation

public java.lang.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 java.lang.String getMusicSetIdForCombat(CombatEngineAPI engine)

Specified by:

getMusicSetIdForCombat in interface MusicPlayerPlugin

getMusicSetIdForTitle

public java.lang.String getMusicSetIdForTitle()

Specified by:

getMusicSetIdForTitle in interface MusicPlayerPlugin

getMusicSetVolumeForCampaignStateToken

public float getMusicSetVolumeForCampaignStateToken(java.lang.Object token,
                                           java.lang.Object param)

Specified by:

getMusicSetVolumeForCampaignStateToken in interface MusicPlayerPluginWithVolumeControl

getMusicSetIdForCampaignStateToken

public java.lang.String getMusicSetIdForCampaignStateToken(java.lang.Object token,
                                                  java.lang.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 java.lang.String getPlanetSurveyMusicSetId(java.lang.Object param)

Parameters:

param - is a MarketAPI.

Returns:

getHyperspaceMusicSetId

protected java.lang.String getHyperspaceMusicSetId()

getStarSystemMusicSetId

protected java.lang.String getStarSystemMusicSetId()

getEncounterMusicSetId

protected java.lang.String getEncounterMusicSetId(java.lang.Object param)

getMarketMusicSetId

protected java.lang.String getMarketMusicSetId(java.lang.Object param)