Package com.fs.starfarer.api.impl.campaign.skills

Class BaseSkillEffectDescription

java.lang.Object

com.fs.starfarer.api.impl.campaign.skills.BaseSkillEffectDescription

All Implemented Interfaces:

CustomSkillDescription, LevelBasedEffect

Direct Known Subclasses:

AutomatedShips.Level1, AutomatedShips.Level2, AuxiliarySupport.Level1, BulkTransport.BaseCapacityModifierEffect, BulkTransport.Level4, CarrierGroup.Level1, CombatEndurance.Level4, ContainmentProcedures.Level1, ContainmentProcedures.Level4, ContainmentProcedures.Level5, CoordinatedManeuvers.Level1A, CoordinatedManeuvers.Level1B, CoordinatedManeuvers.Level1C, CrewTraining.Level1, CrewTraining.Level2, CyberneticAugmentation.Level2, CyberneticAugmentation.Level3, DamageControl.Level6, DerelictContingent.Level1, EnergyWeaponMastery.Level1, FieldRepairs.Level1, FieldRepairs.Level2, FighterUplink.Level1, FighterUplink.Level2, FluxRegulation.Level1, ForceConcentration.Level4, HullRestoration.Level5, IndustrialPlanning.Level2, MakeshiftEquipment.Level3, Navigation.Level4, NeuralLink.Level1, PhaseCorps.Level3, PlanetaryOperations.Level3, RangedSpecialization.Level1, Salvaging.Level4, SupportDoctrine.Level3, TacticalDrills.Level1, TacticalDrills.Level2, WeaponDrills.Level1, WolfpackTactics.Level1C

public class BaseSkillEffectDescription
extends Object
implements CustomSkillDescription

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseSkillEffectDescription.FleetMemberPointContrib
static enum	BaseSkillEffectDescription.ThresholdBonusType
static interface	BaseSkillEffectDescription.TooltipCreatorSkillEffectPlugin

Nested classes/interfaces inherited from interface com.fs.starfarer.api.characters.LevelBasedEffect

LevelBasedEffect.ScopeDescription

Field Summary

Fields

Modifier and Type	Field	Description
protected int	alpha
static float	AUTOMATED_POINTS_THRESHOLD
protected Color	dhc
protected Color	dtc
static float	FIGHTER_BAYS_THRESHOLD
protected Color	hc
protected String	indent
static float	MILITARIZED_OP_THRESHOLD
static float	OP_ALL_LOW_THRESHOLD
static float	OP_ALL_THRESHOLD
static float	OP_LOW_THRESHOLD
static float	OP_THRESHOLD
static float	PHASE_OP_THRESHOLD
static String	RECOVERY_COST
protected Color	tc
static float	TOOLTIP_WIDTH
static boolean	USE_RECOVERY_COST

Constructor Summary

Constructors

Constructor	Description
BaseSkillEffectDescription()

Method Summary

Modifier and Type	Method	Description
void	addAutomatedThresholdInfo(TooltipMakerAPI info, FleetDataAPI data, MutableCharacterStatsAPI cStats)
void	addFighterBayThresholdInfo(TooltipMakerAPI info, FleetDataAPI data)
void	addMilitarizedOPThresholdInfo(TooltipMakerAPI info, FleetDataAPI data, MutableCharacterStatsAPI cStats)
void	addOPThresholdAll(TooltipMakerAPI info, FleetDataAPI data, MutableCharacterStatsAPI cStats, float threshold)
void	addOPThresholdInfo(TooltipMakerAPI info, FleetDataAPI data, MutableCharacterStatsAPI cStats)
void	addOPThresholdInfo(TooltipMakerAPI info, FleetDataAPI data, MutableCharacterStatsAPI cStats, float threshold)
void	addPhaseOPThresholdInfo(TooltipMakerAPI info, FleetDataAPI data, MutableCharacterStatsAPI cStats)
protected float	computeAndCacheThresholdBonus(FleetDataAPI data, MutableCharacterStatsAPI cStats, String key, float maxBonus, BaseSkillEffectDescription.ThresholdBonusType type)
protected float	computeAndCacheThresholdBonus(MutableShipStatsAPI stats, String key, float maxBonus, BaseSkillEffectDescription.ThresholdBonusType type)
void	createCustomDescription(MutableCharacterStatsAPI stats, SkillSpecAPI skill, TooltipMakerAPI info, float width)
static float	getAutomatedPoints(FleetDataAPI data, MutableCharacterStatsAPI stats)
static List<BaseSkillEffectDescription.FleetMemberPointContrib>	getAutomatedPointsDetail(FleetDataAPI data, MutableCharacterStatsAPI stats)
FleetTotalItem	getAutomatedPointsTotal()
FleetTotalItem	getCombatOPTotal()
static MutableCharacterStatsAPI	getCommanderStats(MutableShipStatsAPI stats)
String	getEffectDescription(float level)
String	getEffectPerLevelDescription()
FleetTotalItem	getFighterBaysTotal()
static FleetDataAPI	getFleetData(MutableShipStatsAPI stats)
static float	getMilitarizedOP(FleetDataAPI data, MutableCharacterStatsAPI stats)
static List<BaseSkillEffectDescription.FleetMemberPointContrib>	getMilitarizedOPDetail(FleetDataAPI data, MutableCharacterStatsAPI stats)
FleetTotalItem	getMilitarizedOPTotal()
static float	getNumBaysIncludingModules(FleetMemberAPI member)
static float	getNumFighterBays(FleetDataAPI data)
static List<BaseSkillEffectDescription.FleetMemberPointContrib>	getNumFighterBaysDetail(FleetDataAPI data)
FleetTotalItem	getOPTotal()
static float	getPhaseOP(FleetDataAPI data, MutableCharacterStatsAPI stats)
static List<BaseSkillEffectDescription.FleetMemberPointContrib>	getPhaseOPDetail(FleetDataAPI data, MutableCharacterStatsAPI stats)
FleetTotalItem	getPhaseOPTotal()
protected static float	getPoints(FleetMemberAPI member, MutableCharacterStatsAPI stats)
LevelBasedEffect.ScopeDescription	getScopeDescription()
float	getThresholdBasedBonus(float maxBonus, float value, float threshold)
float	getThresholdBasedRoundedBonus(float maxBonus, float value, float threshold)
TooltipMakerAPI.TooltipCreator	getTooltipCreator(BaseSkillEffectDescription.TooltipCreatorSkillEffectPlugin plugin)
static float	getTotalCombatOP(FleetDataAPI data, MutableCharacterStatsAPI stats)
static List<BaseSkillEffectDescription.FleetMemberPointContrib>	getTotalCombatOPDetail(FleetDataAPI data, MutableCharacterStatsAPI stats)
static float	getTotalOP(FleetDataAPI data, MutableCharacterStatsAPI stats)
static List<BaseSkillEffectDescription.FleetMemberPointContrib>	getTotalOPDetail(FleetDataAPI data, MutableCharacterStatsAPI stats)
static String	getValueLabelForMember(FleetMemberAPI member)
boolean	hasCustomDescription()
static boolean	hasFighterBays(MutableShipStatsAPI stats)
static boolean	hasFighterBays(FleetMemberAPI member)
void	init(MutableCharacterStatsAPI stats, SkillSpecAPI skill)
void	initElite(MutableCharacterStatsAPI stats, SkillSpecAPI skill)
static boolean	isCivilian(MutableShipStatsAPI stats)
static boolean	isCivilian(FleetMemberAPI member)
static boolean	isInCampaign()
static boolean	isMilitarized(MutableShipStatsAPI stats)
static boolean	isMilitarized(FleetMemberAPI member)

Methods inherited from class java.lang.Object

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

Field Details

TOOLTIP_WIDTH

public static float TOOLTIP_WIDTH

FIGHTER_BAYS_THRESHOLD

public static float FIGHTER_BAYS_THRESHOLD

OP_THRESHOLD

public static float OP_THRESHOLD

OP_LOW_THRESHOLD

public static float OP_LOW_THRESHOLD

OP_ALL_LOW_THRESHOLD

public static float OP_ALL_LOW_THRESHOLD

OP_ALL_THRESHOLD

public static float OP_ALL_THRESHOLD

PHASE_OP_THRESHOLD

public static float PHASE_OP_THRESHOLD

MILITARIZED_OP_THRESHOLD

public static float MILITARIZED_OP_THRESHOLD

AUTOMATED_POINTS_THRESHOLD

public static float AUTOMATED_POINTS_THRESHOLD

USE_RECOVERY_COST

public static boolean USE_RECOVERY_COST

RECOVERY_COST

public static String RECOVERY_COST

tc

protected Color tc

dtc

protected Color dtc

hc

protected Color hc

dhc

protected Color dhc

indent

protected String indent

alpha

protected int alpha

Constructor Details

BaseSkillEffectDescription

public BaseSkillEffectDescription()

Method Details

init

public void init(MutableCharacterStatsAPI stats,
 SkillSpecAPI skill)

initElite

public void initElite(MutableCharacterStatsAPI stats,
 SkillSpecAPI skill)

addFighterBayThresholdInfo

public void addFighterBayThresholdInfo(TooltipMakerAPI info,
 FleetDataAPI data)

addOPThresholdInfo

public void addOPThresholdInfo(TooltipMakerAPI info,
 FleetDataAPI data,
 MutableCharacterStatsAPI cStats)

addOPThresholdInfo

public void addOPThresholdInfo(TooltipMakerAPI info,
 FleetDataAPI data,
 MutableCharacterStatsAPI cStats,
 float threshold)

addOPThresholdAll

public void addOPThresholdAll(TooltipMakerAPI info,
 FleetDataAPI data,
 MutableCharacterStatsAPI cStats,
 float threshold)

addPhaseOPThresholdInfo

public void addPhaseOPThresholdInfo(TooltipMakerAPI info,
 FleetDataAPI data,
 MutableCharacterStatsAPI cStats)

addAutomatedThresholdInfo

public void addAutomatedThresholdInfo(TooltipMakerAPI info,
 FleetDataAPI data,
 MutableCharacterStatsAPI cStats)

addMilitarizedOPThresholdInfo

public void addMilitarizedOPThresholdInfo(TooltipMakerAPI info,
 FleetDataAPI data,
 MutableCharacterStatsAPI cStats)

computeAndCacheThresholdBonus

protected float computeAndCacheThresholdBonus(MutableShipStatsAPI stats,
 String key,
 float maxBonus,
 BaseSkillEffectDescription.ThresholdBonusType type)

computeAndCacheThresholdBonus

protected float computeAndCacheThresholdBonus(FleetDataAPI data,
 MutableCharacterStatsAPI cStats,
 String key,
 float maxBonus,
 BaseSkillEffectDescription.ThresholdBonusType type)

getOPTotal

public FleetTotalItem getOPTotal()

getCombatOPTotal

public FleetTotalItem getCombatOPTotal()

getAutomatedPointsTotal

public FleetTotalItem getAutomatedPointsTotal()

getPhaseOPTotal

public FleetTotalItem getPhaseOPTotal()

getMilitarizedOPTotal

public FleetTotalItem getMilitarizedOPTotal()

getFighterBaysTotal

public FleetTotalItem getFighterBaysTotal()

getTooltipCreator

public TooltipMakerAPI.TooltipCreator getTooltipCreator(BaseSkillEffectDescription.TooltipCreatorSkillEffectPlugin plugin)

getValueLabelForMember

public static String getValueLabelForMember(FleetMemberAPI member)

getThresholdBasedBonus

public float getThresholdBasedBonus(float maxBonus,
 float value,
 float threshold)

getThresholdBasedRoundedBonus

public float getThresholdBasedRoundedBonus(float maxBonus,
 float value,
 float threshold)

isMilitarized

public static boolean isMilitarized(MutableShipStatsAPI stats)

isMilitarized

public static boolean isMilitarized(FleetMemberAPI member)

isCivilian

public static boolean isCivilian(MutableShipStatsAPI stats)

isCivilian

public static boolean isCivilian(FleetMemberAPI member)

hasFighterBays

public static boolean hasFighterBays(MutableShipStatsAPI stats)

hasFighterBays

public static boolean hasFighterBays(FleetMemberAPI member)

getPoints

protected static float getPoints(FleetMemberAPI member,
 MutableCharacterStatsAPI stats)

getTotalOP

public static float getTotalOP(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getTotalOPDetail

public static List<BaseSkillEffectDescription.FleetMemberPointContrib> getTotalOPDetail(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getTotalCombatOP

public static float getTotalCombatOP(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getTotalCombatOPDetail

public static List<BaseSkillEffectDescription.FleetMemberPointContrib> getTotalCombatOPDetail(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getPhaseOP

public static float getPhaseOP(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getPhaseOPDetail

public static List<BaseSkillEffectDescription.FleetMemberPointContrib> getPhaseOPDetail(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getMilitarizedOP

public static float getMilitarizedOP(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getMilitarizedOPDetail

public static List<BaseSkillEffectDescription.FleetMemberPointContrib> getMilitarizedOPDetail(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getNumFighterBays

public static float getNumFighterBays(FleetDataAPI data)

getNumBaysIncludingModules

public static float getNumBaysIncludingModules(FleetMemberAPI member)

getNumFighterBaysDetail

public static List<BaseSkillEffectDescription.FleetMemberPointContrib> getNumFighterBaysDetail(FleetDataAPI data)

getAutomatedPoints

public static float getAutomatedPoints(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

getAutomatedPointsDetail

public static List<BaseSkillEffectDescription.FleetMemberPointContrib> getAutomatedPointsDetail(FleetDataAPI data,
 MutableCharacterStatsAPI stats)

isInCampaign

public static boolean isInCampaign()

getCommanderStats

public static MutableCharacterStatsAPI getCommanderStats(MutableShipStatsAPI stats)

getFleetData

public static FleetDataAPI getFleetData(MutableShipStatsAPI stats)

hasCustomDescription

public boolean hasCustomDescription()

Specified by:

hasCustomDescription in interface CustomSkillDescription

createCustomDescription

public void createCustomDescription(MutableCharacterStatsAPI stats,
 SkillSpecAPI skill,
 TooltipMakerAPI info,
 float width)

Specified by:

createCustomDescription in interface CustomSkillDescription

getEffectDescription

public String getEffectDescription(float level)

Specified by:

getEffectDescription in interface LevelBasedEffect

getEffectPerLevelDescription

public String getEffectPerLevelDescription()

Specified by:

getEffectPerLevelDescription in interface LevelBasedEffect

getScopeDescription

public LevelBasedEffect.ScopeDescription getScopeDescription()

Specified by:

getScopeDescription in interface LevelBasedEffect