com.fs.starfarer.api.combat

Interface ShipVariantAPI

public interface ShipVariantAPI

Method Summary

Methods

Modifier and Type	Method and Description
void	addMod(java.lang.String modId)
void	addPermaMod(java.lang.String modId)
void	addPermaMod(java.lang.String modId, boolean isSMod)
void	addSuppressedMod(java.lang.String modId)
void	addTag(java.lang.String tag)
void	addWeapon(java.lang.String slotId, java.lang.String weaponId)
void	addWeaponGroup(WeaponGroupSpec group)
void	assignUnassignedWeapons()
void	autoGenerateWeaponGroups()
void	clear() Removes everything non-built-in - weapons, fighters, hullmods - and sets vents/capacitors to 0.
void	clearHullMods() Doesn't clear out built-in hullmods (or permamods), as opposed to getHullMods().clear().
void	clearPermaMods()
void	clearSlot(java.lang.String slotId)
void	clearSuppressedMods()
void	clearTags()
ShipVariantAPI	clone()
int	computeHullModOPCost()
int	computeHullModOPCost(MutableCharacterStatsAPI stats)
int	computeOPCost(MutableCharacterStatsAPI stats)
int	computeWeaponOPCost(MutableCharacterStatsAPI stats)
java.lang.String	getDesignation()
java.lang.String	getDisplayName()
java.util.Collection<java.lang.String>	getFittedWeaponSlots()
java.util.List<java.lang.String>	getFittedWings()
java.lang.String	getFullDesignationWithHullName()
java.lang.String	getFullDesignationWithHullNameForShip()
WeaponGroupSpec	getGroup(int index)
java.util.EnumSet<ShipHullSpecAPI.ShipTypeHints>	getHints()
java.util.Collection<java.lang.String>	getHullMods()
ShipAPI.HullSize	getHullSize()
ShipHullSpecAPI	getHullSpec()
java.lang.String	getHullVariantId()
java.util.List<java.lang.String>	getLaunchBaysSlotIds()
java.util.List<java.lang.String>	getModuleSlots()
ShipVariantAPI	getModuleVariant(java.lang.String slotId)
java.util.Collection<java.lang.String>	getNonBuiltInHullmods()
java.util.List<java.lang.String>	getNonBuiltInWeaponSlots() Only returns slots that have actual weapons in them, not empty slots.
java.util.List<java.lang.String>	getNonBuiltInWings()
int	getNumFluxCapacitors()
int	getNumFluxVents()
java.lang.String	getOriginalVariant() If autofitted, what the goal variant was.
java.util.Set<java.lang.String>	getPermaMods()
WeaponSlotAPI	getSlot(java.lang.String slotId)
java.util.LinkedHashSet<java.lang.String>	getSModdedBuiltIns()
java.util.LinkedHashSet<java.lang.String>	getSMods()
java.util.List<java.lang.String>	getSortedMods()
VariantSource	getSource()
java.util.Map<java.lang.String,java.lang.String>	getStationModules()
MutableShipStatsAPI	getStatsForOpCosts()
java.util.Set<java.lang.String>	getSuppressedMods()
java.util.Collection<java.lang.String>	getTags()
int	getUnusedOP(MutableCharacterStatsAPI stats)
java.lang.String	getVariantFilePath()
java.util.List<WeaponGroupSpec>	getWeaponGroups()
java.lang.String	getWeaponId(java.lang.String slotId)
WeaponSpecAPI	getWeaponSpec(java.lang.String slotId)
FighterWingSpecAPI	getWing(int index)
java.lang.String	getWingId(int index)
java.util.List<java.lang.String>	getWings()
boolean	hasDMods()
boolean	hasHullMod(java.lang.String id)
boolean	hasTag(java.lang.String tag)
boolean	hasUnassignedWeapons()
boolean	isCarrier()
boolean	isCivilian()
boolean	isCombat()
boolean	isDHull() Whether variant has any unsuppressed dmods.
boolean	isEmptyHullVariant()
boolean	isFighter()
boolean	isFreighter()
boolean	isGoalVariant()
boolean	isLiner()
boolean	isMayAutoAssignWeapons()
boolean	isStation()
boolean	isStockVariant()
boolean	isTanker()
boolean	isTransport()
void	refreshBuiltInWings()
void	removeMod(java.lang.String modId)
void	removePermaMod(java.lang.String modId)
void	removeSuppressedMod(java.lang.String modId)
void	removeTag(java.lang.String tag)
void	setGoalVariant(boolean goalVariant)
void	setHullSpecAPI(ShipHullSpecAPI hullSpec)
void	setHullVariantId(java.lang.String hullVariantId)
void	setMayAutoAssignWeapons(boolean mayAutoAssign)
void	setModuleVariant(java.lang.String slotId, ShipVariantAPI variant)
void	setNumFluxCapacitors(int capacitors)
void	setNumFluxVents(int vents)
void	setOriginalVariant(java.lang.String targetVariant) If autofitted by a FleetInflater, what the goal variant was.
void	setSource(VariantSource source)
void	setVariantDisplayName(java.lang.String variantName)
void	setWingId(int index, java.lang.String wingId)

Method Detail

clone

ShipVariantAPI clone()

getHullSpec

ShipHullSpecAPI getHullSpec()

getDisplayName

java.lang.String getDisplayName()

getDesignation

java.lang.String getDesignation()

getHullMods

java.util.Collection<java.lang.String> getHullMods()

clearHullMods

void clearHullMods()

Doesn't clear out built-in hullmods (or permamods), as opposed to getHullMods().clear().

getHints

java.util.EnumSet<ShipHullSpecAPI.ShipTypeHints> getHints()

addMod

void addMod(java.lang.String modId)

removeMod

void removeMod(java.lang.String modId)

addWeapon

void addWeapon(java.lang.String slotId,
             java.lang.String weaponId)

getNumFluxVents

int getNumFluxVents()

getNumFluxCapacitors

int getNumFluxCapacitors()

getNonBuiltInWeaponSlots

java.util.List<java.lang.String> getNonBuiltInWeaponSlots()

Only returns slots that have actual weapons in them, not empty slots.

Returns:

getWeaponId

java.lang.String getWeaponId(java.lang.String slotId)

setNumFluxCapacitors

void setNumFluxCapacitors(int capacitors)

setNumFluxVents

void setNumFluxVents(int vents)

setSource

void setSource(VariantSource source)

clearSlot

void clearSlot(java.lang.String slotId)

getWeaponSpec

WeaponSpecAPI getWeaponSpec(java.lang.String slotId)

getFittedWeaponSlots

java.util.Collection<java.lang.String> getFittedWeaponSlots()

autoGenerateWeaponGroups

void autoGenerateWeaponGroups()

hasUnassignedWeapons

boolean hasUnassignedWeapons()

assignUnassignedWeapons

void assignUnassignedWeapons()

getGroup

WeaponGroupSpec getGroup(int index)

computeOPCost

int computeOPCost(MutableCharacterStatsAPI stats)

computeWeaponOPCost

int computeWeaponOPCost(MutableCharacterStatsAPI stats)

computeHullModOPCost

int computeHullModOPCost()

computeHullModOPCost

int computeHullModOPCost(MutableCharacterStatsAPI stats)

getSource

VariantSource getSource()

isStockVariant

boolean isStockVariant()

isEmptyHullVariant

boolean isEmptyHullVariant()

setHullVariantId

void setHullVariantId(java.lang.String hullVariantId)

getHullVariantId

java.lang.String getHullVariantId()

getWeaponGroups

java.util.List<WeaponGroupSpec> getWeaponGroups()

addWeaponGroup

void addWeaponGroup(WeaponGroupSpec group)

setVariantDisplayName

void setVariantDisplayName(java.lang.String variantName)

getHullSize

ShipAPI.HullSize getHullSize()

isFighter

boolean isFighter()

getFullDesignationWithHullName

java.lang.String getFullDesignationWithHullName()

hasHullMod

boolean hasHullMod(java.lang.String id)

getSlot

WeaponSlotAPI getSlot(java.lang.String slotId)

isCombat

boolean isCombat()

isStation

boolean isStation()

getWingId

java.lang.String getWingId(int index)

setWingId

void setWingId(int index,
             java.lang.String wingId)

getWings

java.util.List<java.lang.String> getWings()

getLaunchBaysSlotIds

java.util.List<java.lang.String> getLaunchBaysSlotIds()

getFittedWings

java.util.List<java.lang.String> getFittedWings()

setHullSpecAPI

void setHullSpecAPI(ShipHullSpecAPI hullSpec)

getPermaMods

java.util.Set<java.lang.String> getPermaMods()

clearPermaMods

void clearPermaMods()

removePermaMod

void removePermaMod(java.lang.String modId)

addPermaMod

void addPermaMod(java.lang.String modId)

addPermaMod

void addPermaMod(java.lang.String modId,
               boolean isSMod)

isCarrier

boolean isCarrier()

getSortedMods

java.util.List<java.lang.String> getSortedMods()

getSuppressedMods

java.util.Set<java.lang.String> getSuppressedMods()

addSuppressedMod

void addSuppressedMod(java.lang.String modId)

removeSuppressedMod

void removeSuppressedMod(java.lang.String modId)

clearSuppressedMods

void clearSuppressedMods()

isGoalVariant

boolean isGoalVariant()

setGoalVariant

void setGoalVariant(boolean goalVariant)

getNonBuiltInHullmods

java.util.Collection<java.lang.String> getNonBuiltInHullmods()

getWing

FighterWingSpecAPI getWing(int index)

getUnusedOP

int getUnusedOP(MutableCharacterStatsAPI stats)

isCivilian

boolean isCivilian()

getModuleSlots

java.util.List<java.lang.String> getModuleSlots()

getStatsForOpCosts

MutableShipStatsAPI getStatsForOpCosts()

isLiner

boolean isLiner()

isFreighter

boolean isFreighter()

isTanker

boolean isTanker()

isDHull

boolean isDHull()

Whether variant has any unsuppressed dmods.

Returns:

getStationModules

java.util.Map<java.lang.String,java.lang.String> getStationModules()

getNonBuiltInWings

java.util.List<java.lang.String> getNonBuiltInWings()

hasTag

boolean hasTag(java.lang.String tag)

addTag

void addTag(java.lang.String tag)

removeTag

void removeTag(java.lang.String tag)

getTags

java.util.Collection<java.lang.String> getTags()

clearTags

void clearTags()

clear

void clear()

Removes everything non-built-in - weapons, fighters, hullmods - and sets vents/capacitors to 0.

getOriginalVariant

java.lang.String getOriginalVariant()

If autofitted, what the goal variant was. May or may not be set. Must be set for fleet.deflate() to work.

Returns:

setOriginalVariant

void setOriginalVariant(java.lang.String targetVariant)

If autofitted by a FleetInflater, what the goal variant was. May or may not be set. Must be set for fleet.deflate() to work.

getModuleVariant

ShipVariantAPI getModuleVariant(java.lang.String slotId)

setModuleVariant

void setModuleVariant(java.lang.String slotId,
                    ShipVariantAPI variant)

isTransport

boolean isTransport()

getVariantFilePath

java.lang.String getVariantFilePath()

getSMods

java.util.LinkedHashSet<java.lang.String> getSMods()

getFullDesignationWithHullNameForShip

java.lang.String getFullDesignationWithHullNameForShip()

refreshBuiltInWings

void refreshBuiltInWings()

hasDMods

boolean hasDMods()

getSModdedBuiltIns

java.util.LinkedHashSet<java.lang.String> getSModdedBuiltIns()

isMayAutoAssignWeapons

boolean isMayAutoAssignWeapons()

setMayAutoAssignWeapons

void setMayAutoAssignWeapons(boolean mayAutoAssign)