com.fs.starfarer.api.impl.MusicPlayerPluginImpl Class Reference

Inheritance diagram for com.fs.starfarer.api.impl.MusicPlayerPluginImpl:

Collaboration diagram for com.fs.starfarer.api.impl.MusicPlayerPluginImpl:

Public Member Functions
Object	getStateTokenForCampaignLocation ()
String	getMusicSetIdForCombat (CombatEngineAPI engine)
String	getMusicSetIdForTitle ()
float	getMusicSetVolumeForCampaignStateToken (Object token, Object param)
String	getMusicSetIdForCampaignStateToken (Object token, Object param)

Static Public Member Functions
static Object	getToken (String str)

Static Public Attributes
static String	KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY = "$playLocationMusicDuringEnc"
static String	MUSIC_SET_MEM_KEY = "$musicSetId"
static String	MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO = "music_encounter_mysterious"
static String	MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE = "music_encounter_mysterious_non_aggressive"
static String	MUSIC_ENCOUNTER_NEUTRAL = "music_encounter_neutral"
static Object	CAMPAIGN_SYSTEM = new Object()
static Object	CAMPAIGN_HYPERSPACE = new Object()
static Object	NO_MUSIC = new Object()
static Object	COMBAT = new Object()
static Object	TITLE = new Object()
static Object	MARKET = new Object()
static Object	ENCOUNTER = new Object()
static Object	PLANET_SURVEY = new Object()
static Object	CUSTOM = new Object()
static Map< String, String >	stringTokens = new HashMap<String, String>()
static String	SYSTEM_MUSIC_PREFIX = "core_sys_music_"

Protected Member Functions
String	getPlanetSurveyMusicSetId (Object param)
String	getHyperspaceMusicSetId ()
String	getStarSystemMusicSetId ()
String	getEncounterMusicSetId (Object param)
String	getMarketMusicSetId (Object param)

Detailed Description

Definition at line 21 of file MusicPlayerPluginImpl.java.

Member Function Documentation

getEncounterMusicSetId()

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getEncounterMusicSetId ( Object  param )

protected

Definition at line 163 of file MusicPlayerPluginImpl.java.

getHyperspaceMusicSetId()

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getHyperspaceMusicSetId ( )

protected

Definition at line 143 of file MusicPlayerPluginImpl.java.

getMarketMusicSetId()

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getMarketMusicSetId ( Object  param )

protected

Definition at line 249 of file MusicPlayerPluginImpl.java.

getMusicSetIdForCampaignStateToken()

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

Implements com.fs.starfarer.api.MusicPlayerPlugin.

Definition at line 112 of file MusicPlayerPluginImpl.java.

getMusicSetIdForCombat()

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getMusicSetIdForCombat

(

CombatEngineAPI

engine

)

Implements com.fs.starfarer.api.MusicPlayerPlugin.

Definition at line 87 of file MusicPlayerPluginImpl.java.

getMusicSetIdForTitle()

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getMusicSetIdForTitle

(

)

Implements com.fs.starfarer.api.MusicPlayerPlugin.

Definition at line 91 of file MusicPlayerPluginImpl.java.

getMusicSetVolumeForCampaignStateToken()

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

Implements com.fs.starfarer.api.MusicPlayerPluginWithVolumeControl.

Definition at line 96 of file MusicPlayerPluginImpl.java.

getPlanetSurveyMusicSetId()

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getPlanetSurveyMusicSetId ( Object  param )

protected

Parameters

param

is a MarketAPI.

Returns

Definition at line 139 of file MusicPlayerPluginImpl.java.

getStarSystemMusicSetId()

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getStarSystemMusicSetId ( )

protected

Definition at line 147 of file MusicPlayerPluginImpl.java.

getStateTokenForCampaignLocation()

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getStateTokenForCampaignLocation

(

)

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

Returns

Implements com.fs.starfarer.api.MusicPlayerPlugin.

Definition at line 59 of file MusicPlayerPluginImpl.java.

getToken()

static Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.getToken ( String  str )

static

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

Parameters

str

Returns

Definition at line 50 of file MusicPlayerPluginImpl.java.

Member Data Documentation

CAMPAIGN_HYPERSPACE

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.CAMPAIGN_HYPERSPACE = new Object()

static

Definition at line 33 of file MusicPlayerPluginImpl.java.

CAMPAIGN_SYSTEM

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.CAMPAIGN_SYSTEM = new Object()

static

Definition at line 32 of file MusicPlayerPluginImpl.java.

COMBAT

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.COMBAT = new Object()

static

Definition at line 35 of file MusicPlayerPluginImpl.java.

CUSTOM

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.CUSTOM = new Object()

static

Definition at line 41 of file MusicPlayerPluginImpl.java.

ENCOUNTER

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.ENCOUNTER = new Object()

static

Definition at line 38 of file MusicPlayerPluginImpl.java.

KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.KEEP_PLAYING_LOCATION_MUSIC_DURING_ENCOUNTER_MEM_KEY = "$playLocationMusicDuringEnc"

static

Definition at line 23 of file MusicPlayerPluginImpl.java.

MARKET

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.MARKET = new Object()

static

Definition at line 37 of file MusicPlayerPluginImpl.java.

MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.MUSIC_ENCOUNTER_MYSTERIOUS_AGGRO = "music_encounter_mysterious"

static

Definition at line 27 of file MusicPlayerPluginImpl.java.

MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.MUSIC_ENCOUNTER_MYSTERIOUS_NON_AGGRESSIVE = "music_encounter_mysterious_non_aggressive"

static

Definition at line 28 of file MusicPlayerPluginImpl.java.

MUSIC_ENCOUNTER_NEUTRAL

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.MUSIC_ENCOUNTER_NEUTRAL = "music_encounter_neutral"

static

Definition at line 29 of file MusicPlayerPluginImpl.java.

MUSIC_SET_MEM_KEY

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.MUSIC_SET_MEM_KEY = "$musicSetId"

static

Definition at line 24 of file MusicPlayerPluginImpl.java.

NO_MUSIC

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.NO_MUSIC = new Object()

static

Definition at line 34 of file MusicPlayerPluginImpl.java.

PLANET_SURVEY

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.PLANET_SURVEY = new Object()

static

Definition at line 39 of file MusicPlayerPluginImpl.java.

stringTokens

Map<String, String> com.fs.starfarer.api.impl.MusicPlayerPluginImpl.stringTokens = new HashMap<String, String>()

static

Definition at line 43 of file MusicPlayerPluginImpl.java.

SYSTEM_MUSIC_PREFIX

String com.fs.starfarer.api.impl.MusicPlayerPluginImpl.SYSTEM_MUSIC_PREFIX = "core_sys_music_"

static

Definition at line 57 of file MusicPlayerPluginImpl.java.

TITLE

Object com.fs.starfarer.api.impl.MusicPlayerPluginImpl.TITLE = new Object()

static

Definition at line 36 of file MusicPlayerPluginImpl.java.

---

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

• src/com/fs/starfarer/api/impl/MusicPlayerPluginImpl.java