com.fs.starfarer.api.fleet

Interface RepairTrackerAPI

public interface RepairTrackerAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RepairTrackerAPI.CREvent

Method Summary

Modifier and Type	Method and Description
void	applyCREvent(float crChange, java.lang.String description)
void	applyCREvent(float crChange, java.lang.String id, java.lang.String description) Uses id to apply subsequent CR changes to the same "recent event".
float	computeRepairednessFraction() Including both hull and armor.
float	getBaseCR() Current CR without the crew understrength multiplier, if any.
float	getCR() Returned value is modified by crew fraction.
float	getCRPriorToMothballing()
float	getDecreaseRate()
float	getFuelFromScuttling()
float	getHeavyMachineryFromScuttling()
float	getMaxCR()
RepairTrackerAPI.CREvent	getNoSupplyCRLossEvent() The "event" for gradual supply loss over the last week is not included in the return value of getRecentEvents().
java.util.List<RepairTrackerAPI.CREvent>	getRecentEvents()
float	getRecoveryRate()
float	getRemainingRepairTime()
float	getRepairRatePerDay()
float	getSuppliesFromScuttling()
boolean	isCrashMothballed()
boolean	isMothballed()
boolean	isSuspendRepairs()
void	performRepairsFraction(float fraction)
void	setCR(float cr) getCR() will return this value, modified by the crew fraction
void	setCrashMothballed(boolean crashMothballed)
void	setCRPriorToMothballing(float crPriorToMothballing)
void	setMothballed(boolean mothballed)
void	setSuspendRepairs(boolean suspendRepairs)

Method Detail

applyCREvent

void applyCREvent(float crChange,
                  java.lang.String description)

Parameters:

crChange - from -1 to 1

description - shows up in the CR tooltip

getCR

float getCR()

Returned value is modified by crew fraction.

Returns:

from 0 to 1.

setCR

void setCR(float cr)

getCR() will return this value, modified by the crew fraction

Parameters:

cr - from 0 to 1.

getSuppliesFromScuttling

float getSuppliesFromScuttling()

getFuelFromScuttling

float getFuelFromScuttling()

getRecoveryRate

float getRecoveryRate()

getDecreaseRate

float getDecreaseRate()

getMaxCR

float getMaxCR()

Returns:

0 to 1

getBaseCR

float getBaseCR()

Current CR without the crew understrength multiplier, if any.

Returns:

getRecentEvents

java.util.List<RepairTrackerAPI.CREvent> getRecentEvents()

getNoSupplyCRLossEvent

RepairTrackerAPI.CREvent getNoSupplyCRLossEvent()

The "event" for gradual supply loss over the last week is not included in the return value of getRecentEvents().

Returns:

isSuspendRepairs

boolean isSuspendRepairs()

setSuspendRepairs

void setSuspendRepairs(boolean suspendRepairs)

performRepairsFraction

void performRepairsFraction(float fraction)

getRemainingRepairTime

float getRemainingRepairTime()

computeRepairednessFraction

float computeRepairednessFraction()

Including both hull and armor.

Returns:

0 to 1

isMothballed

boolean isMothballed()

setMothballed

void setMothballed(boolean mothballed)

isCrashMothballed

boolean isCrashMothballed()

setCrashMothballed

void setCrashMothballed(boolean crashMothballed)

getRepairRatePerDay

float getRepairRatePerDay()

applyCREvent

void applyCREvent(float crChange,
                  java.lang.String id,
                  java.lang.String description)

Uses id to apply subsequent CR changes to the same "recent event". Useful for gradual CR loss, i.e. from star corona.

Parameters:

crChange -

id -

description -

getHeavyMachineryFromScuttling

float getHeavyMachineryFromScuttling()

getCRPriorToMothballing

float getCRPriorToMothballing()

setCRPriorToMothballing

void setCRPriorToMothballing(float crPriorToMothballing)