com.fs.starfarer.api.impl.combat

Class BaseShipSystemScript

java.lang.Object

com.fs.starfarer.api.impl.combat.BaseShipSystemScript

All Implemented Interfaces:

ShipSystemStatsScript, ShipSystemStatsScriptAdvanced

Direct Known Subclasses:

AcausalDisruptorStats, BaseEnergyLashActivatedSystem, ChiralFigmentStats, ConstructionSwarmSystemScript, ConvulsiveLungeSystemScript, CryofluxTransducerStats, DamperFieldOmegaStats, DamperFieldStats, DarkenedGazeSystemScript, DroneStrikeStats, EnergyLashSystemScript, EntropyAmplifierStats, InterdictorArrayStats, LidarArrayStats, MineStrikeStats, MoteControlScript, OrionDeviceStats, PhaseCloakStats, PlasmaJetsStats, RecallDeviceStats, ReserveWingStats, TargetingFeedStats, TemporalShellStats, TenebrousExpulsionSystemScript, TriadShieldStats, TriadShieldStatsBackup

public class BaseShipSystemScript
extends java.lang.Object
implements ShipSystemStatsScriptAdvanced

Nested Class Summary

Nested classes/interfaces inherited from interface com.fs.starfarer.api.plugins.ShipSystemStatsScript

ShipSystemStatsScript.State, ShipSystemStatsScript.StatusData

Constructor Summary

Constructors

Constructor and Description
BaseShipSystemScript()

Method Summary

Modifier and Type	Method and Description
void	apply(MutableShipStatsAPI stats, java.lang.String id, ShipSystemStatsScript.State state, float effectLevel)
float	getActiveOverride(ShipAPI ship)
java.lang.String	getDisplayNameOverride(ShipSystemStatsScript.State state, float effectLevel)
java.lang.String	getInfoText(ShipSystemAPI system, ShipAPI ship) If null, uses "READY" and "ACTIVE" as appropritate in the ship info widget.
float	getInOverride(ShipAPI ship)
float	getOutOverride(ShipAPI ship)
float	getRegenOverride(ShipAPI ship)
ShipSystemStatsScript.StatusData	getStatusData(int index, ShipSystemStatsScript.State state, float effectLevel)
int	getUsesOverride(ShipAPI ship)
boolean	isUsable(ShipSystemAPI system, ShipAPI ship)
void	unapply(MutableShipStatsAPI stats, java.lang.String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseShipSystemScript

public BaseShipSystemScript()

Method Detail

apply

public void apply(MutableShipStatsAPI stats,
                  java.lang.String id,
                  ShipSystemStatsScript.State state,
                  float effectLevel)

Specified by:

apply in interface ShipSystemStatsScript

getStatusData

public ShipSystemStatsScript.StatusData getStatusData(int index,
                                                      ShipSystemStatsScript.State state,
                                                      float effectLevel)

Specified by:

getStatusData in interface ShipSystemStatsScript

unapply

public void unapply(MutableShipStatsAPI stats,
                    java.lang.String id)

Specified by:

unapply in interface ShipSystemStatsScript

getInfoText

public java.lang.String getInfoText(ShipSystemAPI system,
                                    ShipAPI ship)

Description copied from interface: ShipSystemStatsScriptAdvanced

If null, uses "READY" and "ACTIVE" as appropritate in the ship info widget.

Specified by:

getInfoText in interface ShipSystemStatsScriptAdvanced

Returns:

isUsable

public boolean isUsable(ShipSystemAPI system,
                        ShipAPI ship)

Specified by:

isUsable in interface ShipSystemStatsScriptAdvanced

getActiveOverride

public float getActiveOverride(ShipAPI ship)

Specified by:

getActiveOverride in interface ShipSystemStatsScript

getInOverride

public float getInOverride(ShipAPI ship)

Specified by:

getInOverride in interface ShipSystemStatsScript

getOutOverride

public float getOutOverride(ShipAPI ship)

Specified by:

getOutOverride in interface ShipSystemStatsScript

getRegenOverride

public float getRegenOverride(ShipAPI ship)

Specified by:

getRegenOverride in interface ShipSystemStatsScript

getUsesOverride

public int getUsesOverride(ShipAPI ship)

Specified by:

getUsesOverride in interface ShipSystemStatsScript

getDisplayNameOverride

public java.lang.String getDisplayNameOverride(ShipSystemStatsScript.State state,
                                               float effectLevel)

Specified by:

getDisplayNameOverride in interface ShipSystemStatsScript