com.fs.starfarer.api.combat.ShipVariantAPI Interface Reference

Public Member Functions
ShipVariantAPI	clone ()
ShipHullSpecAPI	getHullSpec ()
String	getDisplayName ()
String	getDesignation ()
Collection< String >	getHullMods ()
void	clearHullMods ()
EnumSet< ShipTypeHints >	getHints ()
void	addMod (String modId)
void	removeMod (String modId)
void	addWeapon (String slotId, String weaponId)
int	getNumFluxVents ()
int	getNumFluxCapacitors ()
List< String >	getNonBuiltInWeaponSlots ()
String	getWeaponId (String slotId)
void	setNumFluxCapacitors (int capacitors)
void	setNumFluxVents (int vents)
void	setSource (VariantSource source)
void	clearSlot (String slotId)
WeaponSpecAPI	getWeaponSpec (String slotId)
Collection< String >	getFittedWeaponSlots ()
void	autoGenerateWeaponGroups ()
boolean	hasUnassignedWeapons ()
void	assignUnassignedWeapons ()
WeaponGroupSpec	getGroup (int index)
int	computeOPCost (MutableCharacterStatsAPI stats)
int	computeWeaponOPCost (MutableCharacterStatsAPI stats)
int	computeHullModOPCost ()
int	computeHullModOPCost (MutableCharacterStatsAPI stats)
VariantSource	getSource ()
boolean	isStockVariant ()
boolean	isEmptyHullVariant ()
void	setHullVariantId (String hullVariantId)
String	getHullVariantId ()
List< WeaponGroupSpec >	getWeaponGroups ()
void	addWeaponGroup (WeaponGroupSpec group)
void	setVariantDisplayName (String variantName)
ShipAPI.HullSize	getHullSize ()
boolean	isFighter ()
String	getFullDesignationWithHullName ()
boolean	hasHullMod (String id)
WeaponSlotAPI	getSlot (String slotId)
boolean	isCombat ()
boolean	isStation ()
String	getWingId (int index)
void	setWingId (int index, String wingId)
List< String >	getWings ()
List< String >	getLaunchBaysSlotIds ()
List< String >	getFittedWings ()
void	setHullSpecAPI (ShipHullSpecAPI hullSpec)
Set< String >	getPermaMods ()
void	clearPermaMods ()
void	removePermaMod (String modId)
void	addPermaMod (String modId)
void	addPermaMod (String modId, boolean isSMod)
boolean	isCarrier ()
List< String >	getSortedMods ()
Set< String >	getSuppressedMods ()
void	addSuppressedMod (String modId)
void	removeSuppressedMod (String modId)
void	clearSuppressedMods ()
boolean	isGoalVariant ()
void	setGoalVariant (boolean goalVariant)
Collection< String >	getNonBuiltInHullmods ()
FighterWingSpecAPI	getWing (int index)
int	getUnusedOP (MutableCharacterStatsAPI stats)
boolean	isCivilian ()
List< String >	getModuleSlots ()
MutableShipStatsAPI	getStatsForOpCosts ()
boolean	isLiner ()
boolean	isFreighter ()
boolean	isTanker ()
boolean	isDHull ()
Map< String, String >	getStationModules ()
List< String >	getNonBuiltInWings ()
boolean	hasTag (String tag)
void	addTag (String tag)
void	removeTag (String tag)
Collection< String >	getTags ()
void	clearTags ()
void	clear ()
String	getOriginalVariant ()
void	setOriginalVariant (String targetVariant)
ShipVariantAPI	getModuleVariant (String slotId)
void	setModuleVariant (String slotId, ShipVariantAPI variant)
boolean	isTransport ()
String	getVariantFilePath ()
LinkedHashSet< String >	getSMods ()
String	getFullDesignationWithHullNameForShip ()
void	refreshBuiltInWings ()
boolean	hasDMods ()
LinkedHashSet< String >	getSModdedBuiltIns ()
boolean	isMayAutoAssignWeapons ()
void	setMayAutoAssignWeapons (boolean mayAutoAssign)
String	getFullDesignationForShip ()
JSONObject	toJSONObject () throws JSONException

Detailed Description

Definition at line 21 of file ShipVariantAPI.java.

Member Function Documentation

addMod()

void com.fs.starfarer.api.combat.ShipVariantAPI.addMod

(

String

modId

)

addPermaMod() [1/2]

void com.fs.starfarer.api.combat.ShipVariantAPI.addPermaMod

(

String

modId

)

addPermaMod() [2/2]

void com.fs.starfarer.api.combat.ShipVariantAPI.addPermaMod	(	String	modId,
		boolean	isSMod )

addSuppressedMod()

void com.fs.starfarer.api.combat.ShipVariantAPI.addSuppressedMod

(

String

modId

)

addTag()

void com.fs.starfarer.api.combat.ShipVariantAPI.addTag

(

String

tag

)

addWeapon()

void com.fs.starfarer.api.combat.ShipVariantAPI.addWeapon	(	String	slotId,
		String	weaponId )

addWeaponGroup()

void com.fs.starfarer.api.combat.ShipVariantAPI.addWeaponGroup

(

WeaponGroupSpec

group

)

assignUnassignedWeapons()

void com.fs.starfarer.api.combat.ShipVariantAPI.assignUnassignedWeapons

(

)

autoGenerateWeaponGroups()

void com.fs.starfarer.api.combat.ShipVariantAPI.autoGenerateWeaponGroups

(

)

clear()

void com.fs.starfarer.api.combat.ShipVariantAPI.clear

(

)

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

clearHullMods()

void com.fs.starfarer.api.combat.ShipVariantAPI.clearHullMods

(

)

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

clearPermaMods()

void com.fs.starfarer.api.combat.ShipVariantAPI.clearPermaMods

(

)

clearSlot()

void com.fs.starfarer.api.combat.ShipVariantAPI.clearSlot

(

String

slotId

)

clearSuppressedMods()

void com.fs.starfarer.api.combat.ShipVariantAPI.clearSuppressedMods

(

)

clearTags()

void com.fs.starfarer.api.combat.ShipVariantAPI.clearTags

(

)

clone()

ShipVariantAPI com.fs.starfarer.api.combat.ShipVariantAPI.clone

(

)

computeHullModOPCost() [1/2]

int com.fs.starfarer.api.combat.ShipVariantAPI.computeHullModOPCost

(

)

computeHullModOPCost() [2/2]

int com.fs.starfarer.api.combat.ShipVariantAPI.computeHullModOPCost

(

MutableCharacterStatsAPI

stats

)

computeOPCost()

int com.fs.starfarer.api.combat.ShipVariantAPI.computeOPCost

(

MutableCharacterStatsAPI

stats

)

computeWeaponOPCost()

int com.fs.starfarer.api.combat.ShipVariantAPI.computeWeaponOPCost

(

MutableCharacterStatsAPI

stats

)

getDesignation()

String com.fs.starfarer.api.combat.ShipVariantAPI.getDesignation

(

)

getDisplayName()

String com.fs.starfarer.api.combat.ShipVariantAPI.getDisplayName

(

)

getFittedWeaponSlots()

Collection< String > com.fs.starfarer.api.combat.ShipVariantAPI.getFittedWeaponSlots

(

)

getFittedWings()

List< String > com.fs.starfarer.api.combat.ShipVariantAPI.getFittedWings

(

)

getFullDesignationForShip()

String com.fs.starfarer.api.combat.ShipVariantAPI.getFullDesignationForShip

(

)

getFullDesignationWithHullName()

String com.fs.starfarer.api.combat.ShipVariantAPI.getFullDesignationWithHullName

(

)

getFullDesignationWithHullNameForShip()

String com.fs.starfarer.api.combat.ShipVariantAPI.getFullDesignationWithHullNameForShip

(

)

getGroup()

WeaponGroupSpec com.fs.starfarer.api.combat.ShipVariantAPI.getGroup

(

int

index

)

getHints()

EnumSet< ShipTypeHints > com.fs.starfarer.api.combat.ShipVariantAPI.getHints

(

)

getHullMods()

Collection< String > com.fs.starfarer.api.combat.ShipVariantAPI.getHullMods

(

)

getHullSize()

ShipAPI.HullSize com.fs.starfarer.api.combat.ShipVariantAPI.getHullSize

(

)

getHullSpec()

ShipHullSpecAPI com.fs.starfarer.api.combat.ShipVariantAPI.getHullSpec

(

)

getHullVariantId()

String com.fs.starfarer.api.combat.ShipVariantAPI.getHullVariantId

(

)

getLaunchBaysSlotIds()

List< String > com.fs.starfarer.api.combat.ShipVariantAPI.getLaunchBaysSlotIds

(

)

getModuleSlots()

List< String > com.fs.starfarer.api.combat.ShipVariantAPI.getModuleSlots

(

)

getModuleVariant()

ShipVariantAPI com.fs.starfarer.api.combat.ShipVariantAPI.getModuleVariant

(

String

slotId

)

getNonBuiltInHullmods()

Collection< String > com.fs.starfarer.api.combat.ShipVariantAPI.getNonBuiltInHullmods

(

)

getNonBuiltInWeaponSlots()

List< String > com.fs.starfarer.api.combat.ShipVariantAPI.getNonBuiltInWeaponSlots

(

)

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

Returns

getNonBuiltInWings()

List< String > com.fs.starfarer.api.combat.ShipVariantAPI.getNonBuiltInWings

(

)

getNumFluxCapacitors()

int com.fs.starfarer.api.combat.ShipVariantAPI.getNumFluxCapacitors

(

)

getNumFluxVents()

int com.fs.starfarer.api.combat.ShipVariantAPI.getNumFluxVents

(

)

getOriginalVariant()

String com.fs.starfarer.api.combat.ShipVariantAPI.getOriginalVariant

(

)

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

Returns

getPermaMods()

Set< String > com.fs.starfarer.api.combat.ShipVariantAPI.getPermaMods

(

)

getSlot()

WeaponSlotAPI com.fs.starfarer.api.combat.ShipVariantAPI.getSlot

(

String

slotId

)

getSModdedBuiltIns()

LinkedHashSet< String > com.fs.starfarer.api.combat.ShipVariantAPI.getSModdedBuiltIns

(

)

getSMods()

LinkedHashSet< String > com.fs.starfarer.api.combat.ShipVariantAPI.getSMods

(

)

getSortedMods()

List< String > com.fs.starfarer.api.combat.ShipVariantAPI.getSortedMods

(

)

getSource()

VariantSource com.fs.starfarer.api.combat.ShipVariantAPI.getSource

(

)

getStationModules()

Map< String, String > com.fs.starfarer.api.combat.ShipVariantAPI.getStationModules

(

)

getStatsForOpCosts()

MutableShipStatsAPI com.fs.starfarer.api.combat.ShipVariantAPI.getStatsForOpCosts

(

)

getSuppressedMods()

Set< String > com.fs.starfarer.api.combat.ShipVariantAPI.getSuppressedMods

(

)

getTags()

Collection< String > com.fs.starfarer.api.combat.ShipVariantAPI.getTags

(

)

getUnusedOP()

int com.fs.starfarer.api.combat.ShipVariantAPI.getUnusedOP

(

MutableCharacterStatsAPI

stats

)

getVariantFilePath()

String com.fs.starfarer.api.combat.ShipVariantAPI.getVariantFilePath

(

)

getWeaponGroups()

List< WeaponGroupSpec > com.fs.starfarer.api.combat.ShipVariantAPI.getWeaponGroups

(

)

getWeaponId()

String com.fs.starfarer.api.combat.ShipVariantAPI.getWeaponId

(

String

slotId

)

getWeaponSpec()

WeaponSpecAPI com.fs.starfarer.api.combat.ShipVariantAPI.getWeaponSpec

(

String

slotId

)

getWing()

FighterWingSpecAPI com.fs.starfarer.api.combat.ShipVariantAPI.getWing

(

int

index

)

getWingId()

String com.fs.starfarer.api.combat.ShipVariantAPI.getWingId

(

int

index

)

getWings()

List< String > com.fs.starfarer.api.combat.ShipVariantAPI.getWings

(

)

hasDMods()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.hasDMods

(

)

hasHullMod()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.hasHullMod

(

String

id

)

hasTag()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.hasTag

(

String

tag

)

hasUnassignedWeapons()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.hasUnassignedWeapons

(

)

isCarrier()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isCarrier

(

)

isCivilian()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isCivilian

(

)

isCombat()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isCombat

(

)

isDHull()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isDHull

(

)

Whether variant has any unsuppressed dmods.

Returns

isEmptyHullVariant()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isEmptyHullVariant

(

)

isFighter()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isFighter

(

)

isFreighter()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isFreighter

(

)

isGoalVariant()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isGoalVariant

(

)

isLiner()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isLiner

(

)

isMayAutoAssignWeapons()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isMayAutoAssignWeapons

(

)

isStation()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isStation

(

)

isStockVariant()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isStockVariant

(

)

isTanker()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isTanker

(

)

isTransport()

boolean com.fs.starfarer.api.combat.ShipVariantAPI.isTransport

(

)

refreshBuiltInWings()

void com.fs.starfarer.api.combat.ShipVariantAPI.refreshBuiltInWings

(

)

removeMod()

void com.fs.starfarer.api.combat.ShipVariantAPI.removeMod

(

String

modId

)

removePermaMod()

void com.fs.starfarer.api.combat.ShipVariantAPI.removePermaMod

(

String

modId

)

removeSuppressedMod()

void com.fs.starfarer.api.combat.ShipVariantAPI.removeSuppressedMod

(

String

modId

)

removeTag()

void com.fs.starfarer.api.combat.ShipVariantAPI.removeTag

(

String

tag

)

setGoalVariant()

void com.fs.starfarer.api.combat.ShipVariantAPI.setGoalVariant

(

boolean

goalVariant

)

setHullSpecAPI()

void com.fs.starfarer.api.combat.ShipVariantAPI.setHullSpecAPI

(

ShipHullSpecAPI

hullSpec

)

setHullVariantId()

void com.fs.starfarer.api.combat.ShipVariantAPI.setHullVariantId

(

String

hullVariantId

)

setMayAutoAssignWeapons()

void com.fs.starfarer.api.combat.ShipVariantAPI.setMayAutoAssignWeapons

(

boolean

mayAutoAssign

)

setModuleVariant()

void com.fs.starfarer.api.combat.ShipVariantAPI.setModuleVariant	(	String	slotId,
		ShipVariantAPI	variant )

setNumFluxCapacitors()

void com.fs.starfarer.api.combat.ShipVariantAPI.setNumFluxCapacitors

(

int

capacitors

)

setNumFluxVents()

void com.fs.starfarer.api.combat.ShipVariantAPI.setNumFluxVents

(

int

vents

)

setOriginalVariant()

void com.fs.starfarer.api.combat.ShipVariantAPI.setOriginalVariant

(

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.

setSource()

void com.fs.starfarer.api.combat.ShipVariantAPI.setSource

(

VariantSource

source

)

setVariantDisplayName()

void com.fs.starfarer.api.combat.ShipVariantAPI.setVariantDisplayName

(

String

variantName

)

setWingId()

void com.fs.starfarer.api.combat.ShipVariantAPI.setWingId	(	int	index,
		String	wingId )

toJSONObject()

JSONObject com.fs.starfarer.api.combat.ShipVariantAPI.toJSONObject

(

)

throws JSONException

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/combat/ShipVariantAPI.java