com.fs.starfarer.api.impl

Class PlayerFleetPersonnelTracker

java.lang.Object

com.fs.starfarer.api.impl.PlayerFleetPersonnelTracker

All Implemented Interfaces:

GenericPluginManagerAPI.GenericPlugin, CargoScreenListener, ColonyInteractionListener, CommodityIconProvider, CommodityTooltipModifier, GroundRaidObjectivesListener

public class PlayerFleetPersonnelTracker
extends java.lang.Object
implements ColonyInteractionListener, GroundRaidObjectivesListener, CommodityTooltipModifier, CommodityIconProvider, CargoScreenListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlayerFleetPersonnelTracker.CommodityDescriptionProviderWrapper
static class	PlayerFleetPersonnelTracker.CommodityIconProviderWrapper
static class	PlayerFleetPersonnelTracker.PersonnelAtEntity
static class	PlayerFleetPersonnelTracker.PersonnelData
static class	PlayerFleetPersonnelTracker.PersonnelRank

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.listeners.GroundRaidObjectivesListener

GroundRaidObjectivesListener.RaidResultData

Field Summary

Fields

Modifier and Type	Field and Description
protected SubmarketAPI	currSubmarket
protected java.util.List<PlayerFleetPersonnelTracker.PersonnelAtEntity>	droppedOff
static boolean	KEEP_XP_DURING_TRANSFERS
static java.lang.String	KEY
protected PlayerFleetPersonnelTracker.PersonnelData	marineData
static float	MAX_EFFECTIVENESS_PERCENT
static float	MAX_LOSS_REDUCTION_PERCENT
protected SectorEntityToken	pods
protected PlayerFleetPersonnelTracker.PersonnelData	savedMarineData
protected java.util.List<PlayerFleetPersonnelTracker.PersonnelAtEntity>	savedPersonnelData
static float	XP_PER_RAID_MULT

Constructor Summary

Constructors

Constructor and Description
PlayerFleetPersonnelTracker()

Method Summary

Modifier and Type	Method and Description
void	addSectionAfterPrice(TooltipMakerAPI info, float width, boolean expanded, CargoStackAPI stack)
protected void	doCleanup(boolean withDroppedOff)
java.util.List<PlayerFleetPersonnelTracker.PersonnelAtEntity>	getDroppedOff()
PlayerFleetPersonnelTracker.PersonnelAtEntity	getDroppedOffAt(java.lang.String commodityId, SectorEntityToken entity, SubmarketAPI sub, boolean createIfNull)
int	getHandlingPriority(java.lang.Object params) Negative priority means plugin doesn't want to handle whatever the parameters indicate the action is.
java.lang.String	getIconName()
java.lang.String	getIconName(CargoStackAPI stack)
static PlayerFleetPersonnelTracker	getInstance()
SectorEntityToken	getInteractionEntity()
PlayerFleetPersonnelTracker.PersonnelData	getMarineData()
static float	getMarineEffectBonus(PlayerFleetPersonnelTracker.PersonnelData data)
static float	getMarineLossesReductionPercent(PlayerFleetPersonnelTracker.PersonnelData data)
PlayerFleetPersonnelTracker.PersonnelAtEntity	getPersonnelAtLocation(java.lang.String commodityId, SubmarketAPI sub)
java.lang.String	getRankIconName(CargoStackAPI stack)
SubmarketAPI	getSubmarketFor(CargoStackAPI stack) Assumes stack is not in player cargo.
void	modifyRaidObjectives(MarketAPI market, SectorEntityToken entity, java.util.List<GroundRaidObjectivePlugin> objectives, MarketCMD.RaidType type, int marineTokens, int priority) Called 10 times with priority from 0 to 9.
void	processTransaction(PlayerMarketTransaction transaction, SectorEntityToken entity)
void	reportCargoScreenOpened()
void	reportPlayerClosedMarket(MarketAPI market)
void	reportPlayerLeftCargoPods(SectorEntityToken entity)
void	reportPlayerMarketTransaction(PlayerMarketTransaction transaction)
void	reportPlayerNonMarketTransaction(PlayerMarketTransaction transaction, InteractionDialogAPI dialog)
void	reportPlayerOpenedMarket(MarketAPI market)
void	reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)
void	reportRaidObjectivesAchieved(GroundRaidObjectivesListener.RaidResultData data, InteractionDialogAPI dialog, java.util.Map<java.lang.String,MemoryAPI> memoryMap)
void	reportSubmarketOpened(SubmarketAPI submarket)
void	restoreData()
void	saveData()
static void	transferPersonnel(PlayerFleetPersonnelTracker.PersonnelData from, PlayerFleetPersonnelTracker.PersonnelData to, int num, PlayerFleetPersonnelTracker.PersonnelData keepsXP)
void	update()
void	update(boolean withIntegrationFromCurrentLocation, boolean keepXP, CargoStackAPI stack)

Methods inherited from class java.lang.Object

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

Field Detail

XP_PER_RAID_MULT

public static float XP_PER_RAID_MULT

MAX_EFFECTIVENESS_PERCENT

public static float MAX_EFFECTIVENESS_PERCENT

MAX_LOSS_REDUCTION_PERCENT

public static float MAX_LOSS_REDUCTION_PERCENT

KEEP_XP_DURING_TRANSFERS

public static boolean KEEP_XP_DURING_TRANSFERS

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

marineData

protected PlayerFleetPersonnelTracker.PersonnelData marineData

droppedOff

protected java.util.List<PlayerFleetPersonnelTracker.PersonnelAtEntity> droppedOff

pods

protected transient SectorEntityToken pods

currSubmarket

protected transient SubmarketAPI currSubmarket

savedMarineData

protected transient PlayerFleetPersonnelTracker.PersonnelData savedMarineData

savedPersonnelData

protected transient java.util.List<PlayerFleetPersonnelTracker.PersonnelAtEntity> savedPersonnelData

Constructor Detail

PlayerFleetPersonnelTracker

public PlayerFleetPersonnelTracker()

Method Detail

getInstance

public static PlayerFleetPersonnelTracker getInstance()

reportCargoScreenOpened

public void reportCargoScreenOpened()

Specified by:

reportCargoScreenOpened in interface CargoScreenListener

reportSubmarketOpened

public void reportSubmarketOpened(SubmarketAPI submarket)

Specified by:

reportSubmarketOpened in interface CargoScreenListener

reportPlayerLeftCargoPods

public void reportPlayerLeftCargoPods(SectorEntityToken entity)

Specified by:

reportPlayerLeftCargoPods in interface CargoScreenListener

reportPlayerNonMarketTransaction

public void reportPlayerNonMarketTransaction(PlayerMarketTransaction transaction,
                                             InteractionDialogAPI dialog)

Specified by:

reportPlayerNonMarketTransaction in interface CargoScreenListener

reportPlayerMarketTransaction

public void reportPlayerMarketTransaction(PlayerMarketTransaction transaction)

Specified by:

reportPlayerMarketTransaction in interface ColonyInteractionListener

processTransaction

public void processTransaction(PlayerMarketTransaction transaction,
                               SectorEntityToken entity)

transferPersonnel

public static void transferPersonnel(PlayerFleetPersonnelTracker.PersonnelData from,
                                     PlayerFleetPersonnelTracker.PersonnelData to,
                                     int num,
                                     PlayerFleetPersonnelTracker.PersonnelData keepsXP)

reportRaidObjectivesAchieved

public void reportRaidObjectivesAchieved(GroundRaidObjectivesListener.RaidResultData data,
                                         InteractionDialogAPI dialog,
                                         java.util.Map<java.lang.String,MemoryAPI> memoryMap)

Specified by:

reportRaidObjectivesAchieved in interface GroundRaidObjectivesListener

update

public void update()

update

public void update(boolean withIntegrationFromCurrentLocation,
                   boolean keepXP,
                   CargoStackAPI stack)

getMarineEffectBonus

public static float getMarineEffectBonus(PlayerFleetPersonnelTracker.PersonnelData data)

getMarineLossesReductionPercent

public static float getMarineLossesReductionPercent(PlayerFleetPersonnelTracker.PersonnelData data)

addSectionAfterPrice

public void addSectionAfterPrice(TooltipMakerAPI info,
                                 float width,
                                 boolean expanded,
                                 CargoStackAPI stack)

Specified by:

addSectionAfterPrice in interface CommodityTooltipModifier

reportPlayerClosedMarket

public void reportPlayerClosedMarket(MarketAPI market)

Specified by:

reportPlayerClosedMarket in interface ColonyInteractionListener

reportPlayerOpenedMarket

public void reportPlayerOpenedMarket(MarketAPI market)

Specified by:

reportPlayerOpenedMarket in interface ColonyInteractionListener

getIconName

public java.lang.String getIconName()

getHandlingPriority

public int getHandlingPriority(java.lang.Object params)

Description copied from interface: GenericPluginManagerAPI.GenericPlugin

Negative priority means plugin doesn't want to handle whatever the parameters indicate the action is.

Specified by:

getHandlingPriority in interface GenericPluginManagerAPI.GenericPlugin

Returns:

getRankIconName

public java.lang.String getRankIconName(CargoStackAPI stack)

Specified by:

getRankIconName in interface CommodityIconProvider

getIconName

public java.lang.String getIconName(CargoStackAPI stack)

Specified by:

getIconName in interface CommodityIconProvider

saveData

public void saveData()

restoreData

public void restoreData()

reportPlayerOpenedMarketAndCargoUpdated

public void reportPlayerOpenedMarketAndCargoUpdated(MarketAPI market)

Specified by:

reportPlayerOpenedMarketAndCargoUpdated in interface ColonyInteractionListener

modifyRaidObjectives

public void modifyRaidObjectives(MarketAPI market,
                                 SectorEntityToken entity,
                                 java.util.List<GroundRaidObjectivePlugin> objectives,
                                 MarketCMD.RaidType type,
                                 int marineTokens,
                                 int priority)

Description copied from interface: GroundRaidObjectivesListener

Called 10 times with priority from 0 to 9. An implementation should generally only modify objectives in one of those callse.

Specified by:

modifyRaidObjectives in interface GroundRaidObjectivesListener

doCleanup

protected void doCleanup(boolean withDroppedOff)

getInteractionEntity

public SectorEntityToken getInteractionEntity()

getSubmarketFor

public SubmarketAPI getSubmarketFor(CargoStackAPI stack)

Assumes stack is not in player cargo.

Parameters:

stack -

Returns:

getDroppedOffAt

public PlayerFleetPersonnelTracker.PersonnelAtEntity getDroppedOffAt(java.lang.String commodityId,
                                                                     SectorEntityToken entity,
                                                                     SubmarketAPI sub,
                                                                     boolean createIfNull)

getPersonnelAtLocation

public PlayerFleetPersonnelTracker.PersonnelAtEntity getPersonnelAtLocation(java.lang.String commodityId,
                                                                            SubmarketAPI sub)

getMarineData

public PlayerFleetPersonnelTracker.PersonnelData getMarineData()

getDroppedOff

public java.util.List<PlayerFleetPersonnelTracker.PersonnelAtEntity> getDroppedOff()