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

Inheritance diagram for com.fs.starfarer.api.combat.MissileAPI:

Collaboration diagram for com.fs.starfarer.api.combat.MissileAPI:

Public Member Functions
boolean	isFizzling ()
void	flameOut ()
ShipEngineControllerAPI	getEngineController ()
void	setMissileAI (MissileAIPlugin ai)
MissileAIPlugin	getMissileAI ()
void	giveCommand (ShipCommand command)
boolean	isFlare ()
SpriteAPI	getSpriteAPI ()
float	getAcceleration ()
float	getMaxSpeed ()
float	getMaxTurnRate ()
float	getTurnAcceleration ()
float	getMaxFlightTime ()
float	getFlightTime ()
void	setFlightTime (float flightTime)
boolean	isGuided ()
boolean	isArmed ()
float	getArmingTime ()
void	setArmingTime (float armingTime)
void	setArmedWhileFizzling (boolean armedWhileFizzling)
boolean	isArmedWhileFizzling ()
void	setEmpResistance (int empResistance)
int	getEmpResistance ()
void	decrEMPResistance ()
void	interruptContrail ()
void	fadeOutThenIn (float inDur)
float	getTimeSinceFizzling ()
void	setTimeSinceFizzling (float timeSinceFizzling)
boolean	isMine ()
void	setMine (boolean isMine)
void	setMineExplosionRange (float mineExplosionRange)
boolean	isMinePrimed ()
float	getMineExplosionRange ()
void	setMinePrimed (boolean isMinePrimed)
float	getUntilMineExplosion ()
void	setUntilMineExplosion (float untilMineExplosion)
void	setJitter (Object source, Color color, float intensity, int copies, float range)
void	setJitter (Object source, Color color, float intensity, int copies, float minRange, float range)
float	getCurrentBaseAlpha ()
float	getGlowRadius ()
void	setGlowRadius (float glowRadius)
boolean	isRenderGlowAbove ()
void	setRenderGlowAbove (boolean renderGlowAbove)
void	setShineBrightness (float brightness)
boolean	isMirv ()
float	getMirvWarheadDamage ()
float	getMirvWarheadEMPDamage ()
int	getMirvNumWarheads ()
DamageType	getMirvWarheadDamageType ()
JSONObject	getBehaviorSpecParams ()
boolean	isDecoyFlare ()
void	resetEngineGlowBrightness ()
float	getECCMChance ()
WeaponSpecAPI	getWeaponSpec ()
void	setWeaponSpec (String weaponId)
MissileAIPlugin	getUnwrappedMissileAI ()
Object	getParamAboutToApplyDamage ()
void	setParamAboutToApplyDamage (Object param)
MissileSpecAPI	getSpec ()
EnumSet< CombatEngineLayers >	getActiveLayers ()
boolean	isForceAlwaysArmed ()
void	setForceAlwaysArmed (boolean forceAlwaysArmed)
boolean	didDamage ()
boolean	isNoMineFFConcerns ()
void	setNoMineFFConcerns (boolean noFFConcerns)
float	getEccmChanceOverride ()
void	setEccmChanceOverride (float eccmChanceOverride)
float	getEccmChanceBonus ()
void	setEccmChanceBonus (float eccmChanceBonus)
void	setSource (ShipAPI source)
ShipAPI	getSourceAPI ()
boolean	isNoFlameoutOnFizzling ()
void	setNoFlameoutOnFizzling (boolean noFlameoutOnFizzling)
DamagingProjectileAPI	explode ()
float	getMaxRange ()
void	setMaxRange (float maxRange)
void	setMaxFlightTime (float maxFlightTime)
float	getSpriteAlphaOverride ()
void	setSpriteAlphaOverride (float spriteAlphaOverride)
Vector2f	getStart ()
void	setStart (Vector2f start)
MutableShipStatsAPI	getEngineStats ()
void	setFizzleTime (float fizzleTime)
void	setFadeTime (float fadeTime)
void	setNoGlowTime (float noGlowTime)
Color	getDestroyedExplosionColorOverride ()
void	setDestroyedExplosionColorOverride (Color destroyedExplosionColorOverride)
float	getEtaModifier ()
void	setEtaModifier (float etaModifier)
float	getGuidanceBonus ()
boolean	isDoNotFlareEnginesWhenStrafingOrDecelerating ()
void	setDoNotFlareEnginesWhenStrafingOrDecelerating (boolean doNotFlare)
void	setDidDamage (boolean didDamage)
void	updateMaxSpeed ()
Set< String >	getTags ()
void	addTag (String tag)
boolean	hasTag (String tag)
void	removeTag (String tag)
Public Member Functions inherited from com.fs.starfarer.api.combat.DamagingProjectileAPI
DamageType	getDamageType ()
float	getDamageAmount ()
float	getBaseDamageAmount ()
float	getEmpAmount ()
void	setDamageAmount (float damage)
WeaponAPI	getWeapon ()
CombatEntityAPI	getDamageTarget ()
String	getProjectileSpecId ()
ShipAPI	getSource ()
boolean	isFading ()
ProjectileSpawnType	getSpawnType ()
float	getElapsed ()
DamageAPI	getDamage ()
boolean	isFromMissile ()
void	setFromMissile (boolean fromMissile)
void	removeDamagedAlready (CombatEntityAPI c)
void	addDamagedAlready (CombatEntityAPI c)
float	getMoveSpeed ()
Vector2f	getSpawnLocation ()
ProjectileSpecAPI	getProjectileSpec ()
float	getBrightness ()
Vector2f	getTailEnd ()
List< CombatEntityAPI >	getDamagedAlready ()
default DamagingExplosionSpec	getExplosionSpecIfExplosion ()
Public Member Functions inherited from com.fs.starfarer.api.combat.CombatEntityAPI
Vector2f	getLocation ()
Vector2f	getVelocity ()
float	getFacing ()
void	setFacing (float facing)
float	getAngularVelocity ()
void	setAngularVelocity (float angVel)
int	getOwner ()
void	setOwner (int owner)
float	getCollisionRadius ()
CollisionClass	getCollisionClass ()
void	setCollisionClass (CollisionClass collisionClass)
float	getMass ()
void	setMass (float mass)
BoundsAPI	getExactBounds ()
ShieldAPI	getShield ()
float	getHullLevel ()
float	getHitpoints ()
float	getMaxHitpoints ()
void	setCollisionRadius (float radius)
Object	getAI ()
boolean	isExpired ()
void	setCustomData (String key, Object data)
void	removeCustomData (String key)
Map< String, Object >	getCustomData ()
void	setHitpoints (float hitpoints)
boolean	isPointInBounds (Vector2f p)
boolean	wasRemoved ()

Detailed Description

Definition at line 16 of file MissileAPI.java.

Member Function Documentation

addTag()

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

(

String

tag

)

decrEMPResistance()

void com.fs.starfarer.api.combat.MissileAPI.decrEMPResistance

(

)

didDamage()

boolean com.fs.starfarer.api.combat.MissileAPI.didDamage

(

)

Whether the projectile already did its damage and is now fading out.

Returns

Implements com.fs.starfarer.api.combat.DamagingProjectileAPI.

explode()

DamagingProjectileAPI com.fs.starfarer.api.combat.MissileAPI.explode

(

)

fadeOutThenIn()

void com.fs.starfarer.api.combat.MissileAPI.fadeOutThenIn

(

float

inDur

)

flameOut()

void com.fs.starfarer.api.combat.MissileAPI.flameOut

(

)

getAcceleration()

float com.fs.starfarer.api.combat.MissileAPI.getAcceleration

(

)

getActiveLayers()

EnumSet< CombatEngineLayers > com.fs.starfarer.api.combat.MissileAPI.getActiveLayers

(

)

getArmingTime()

float com.fs.starfarer.api.combat.MissileAPI.getArmingTime

(

)

getBehaviorSpecParams()

JSONObject com.fs.starfarer.api.combat.MissileAPI.getBehaviorSpecParams

(

)

getCurrentBaseAlpha()

float com.fs.starfarer.api.combat.MissileAPI.getCurrentBaseAlpha

(

)

getDestroyedExplosionColorOverride()

Color com.fs.starfarer.api.combat.MissileAPI.getDestroyedExplosionColorOverride

(

)

getECCMChance()

float com.fs.starfarer.api.combat.MissileAPI.getECCMChance

(

)

getEccmChanceBonus()

float com.fs.starfarer.api.combat.MissileAPI.getEccmChanceBonus

(

)

getEccmChanceOverride()

float com.fs.starfarer.api.combat.MissileAPI.getEccmChanceOverride

(

)

getEmpResistance()

int com.fs.starfarer.api.combat.MissileAPI.getEmpResistance

(

)

getEngineController()

ShipEngineControllerAPI com.fs.starfarer.api.combat.MissileAPI.getEngineController

(

)

getEngineStats()

MutableShipStatsAPI com.fs.starfarer.api.combat.MissileAPI.getEngineStats

(

)

getEtaModifier()

float com.fs.starfarer.api.combat.MissileAPI.getEtaModifier

(

)

getFlightTime()

float com.fs.starfarer.api.combat.MissileAPI.getFlightTime

(

)

getGlowRadius()

float com.fs.starfarer.api.combat.MissileAPI.getGlowRadius

(

)

getGuidanceBonus()

float com.fs.starfarer.api.combat.MissileAPI.getGuidanceBonus

(

)

getMaxFlightTime()

float com.fs.starfarer.api.combat.MissileAPI.getMaxFlightTime

(

)

getMaxRange()

float com.fs.starfarer.api.combat.MissileAPI.getMaxRange

(

)

getMaxSpeed()

float com.fs.starfarer.api.combat.MissileAPI.getMaxSpeed

(

)

getMaxTurnRate()

float com.fs.starfarer.api.combat.MissileAPI.getMaxTurnRate

(

)

getMineExplosionRange()

float com.fs.starfarer.api.combat.MissileAPI.getMineExplosionRange

(

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

getMirvNumWarheads()

int com.fs.starfarer.api.combat.MissileAPI.getMirvNumWarheads

(

)

getMirvWarheadDamage()

float com.fs.starfarer.api.combat.MissileAPI.getMirvWarheadDamage

(

)

getMirvWarheadDamageType()

DamageType com.fs.starfarer.api.combat.MissileAPI.getMirvWarheadDamageType

(

)

getMirvWarheadEMPDamage()

float com.fs.starfarer.api.combat.MissileAPI.getMirvWarheadEMPDamage

(

)

getMissileAI()

MissileAIPlugin com.fs.starfarer.api.combat.MissileAPI.getMissileAI

(

)

Does NOT return the same ai passed in to setShipAI(), but a wrapper around it. Can be used to save/restore the AI.

Returns

getParamAboutToApplyDamage()

Object com.fs.starfarer.api.combat.MissileAPI.getParamAboutToApplyDamage

(

)

getSourceAPI()

ShipAPI com.fs.starfarer.api.combat.MissileAPI.getSourceAPI

(

)

getSpec()

MissileSpecAPI com.fs.starfarer.api.combat.MissileAPI.getSpec

(

)

getSpriteAlphaOverride()

float com.fs.starfarer.api.combat.MissileAPI.getSpriteAlphaOverride

(

)

getSpriteAPI()

SpriteAPI com.fs.starfarer.api.combat.MissileAPI.getSpriteAPI

(

)

getStart()

Vector2f com.fs.starfarer.api.combat.MissileAPI.getStart

(

)

Location it spawned at, used to fizzle out if fizzling is range-based.

Returns

getTags()

Set< String > com.fs.starfarer.api.combat.MissileAPI.getTags

(

)

getTimeSinceFizzling()

float com.fs.starfarer.api.combat.MissileAPI.getTimeSinceFizzling

(

)

getTurnAcceleration()

float com.fs.starfarer.api.combat.MissileAPI.getTurnAcceleration

(

)

getUntilMineExplosion()

float com.fs.starfarer.api.combat.MissileAPI.getUntilMineExplosion

(

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

getUnwrappedMissileAI()

MissileAIPlugin com.fs.starfarer.api.combat.MissileAPI.getUnwrappedMissileAI

(

)

Returns the AI that was passed in to setMissileAI(). getMissileAI() returns an internal wrapper around that.

Returns

getWeaponSpec()

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

(

)

giveCommand()

void com.fs.starfarer.api.combat.MissileAPI.giveCommand

(

ShipCommand

command

)

Should only be used by a MissileAIPlugin.

Parameters

command

type of the command. Only movement-related ShipCommands have any effect.

hasTag()

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

(

String

tag

)

interruptContrail()

void com.fs.starfarer.api.combat.MissileAPI.interruptContrail

(

)

Useful for missiles that change position using a script. Call twice - once before the missile is moved, and once when it has moved to its new location.

isArmed()

boolean com.fs.starfarer.api.combat.MissileAPI.isArmed

(

)

isArmedWhileFizzling()

boolean com.fs.starfarer.api.combat.MissileAPI.isArmedWhileFizzling

(

)

isDecoyFlare()

boolean com.fs.starfarer.api.combat.MissileAPI.isDecoyFlare

(

)

isDoNotFlareEnginesWhenStrafingOrDecelerating()

boolean com.fs.starfarer.api.combat.MissileAPI.isDoNotFlareEnginesWhenStrafingOrDecelerating

(

)

isFizzling()

boolean com.fs.starfarer.api.combat.MissileAPI.isFizzling

(

)

isFlare()

boolean com.fs.starfarer.api.combat.MissileAPI.isFlare

(

)

isForceAlwaysArmed()

boolean com.fs.starfarer.api.combat.MissileAPI.isForceAlwaysArmed

(

)

isGuided()

boolean com.fs.starfarer.api.combat.MissileAPI.isGuided

(

)

isMine()

boolean com.fs.starfarer.api.combat.MissileAPI.isMine

(

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

isMinePrimed()

boolean com.fs.starfarer.api.combat.MissileAPI.isMinePrimed

(

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

isMirv()

boolean com.fs.starfarer.api.combat.MissileAPI.isMirv

(

)

isNoFlameoutOnFizzling()

boolean com.fs.starfarer.api.combat.MissileAPI.isNoFlameoutOnFizzling

(

)

isNoMineFFConcerns()

boolean com.fs.starfarer.api.combat.MissileAPI.isNoMineFFConcerns

(

)

isRenderGlowAbove()

boolean com.fs.starfarer.api.combat.MissileAPI.isRenderGlowAbove

(

)

removeTag()

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

(

String

tag

)

resetEngineGlowBrightness()

void com.fs.starfarer.api.combat.MissileAPI.resetEngineGlowBrightness

(

)

setArmedWhileFizzling()

void com.fs.starfarer.api.combat.MissileAPI.setArmedWhileFizzling

(

boolean

armedWhileFizzling

)

Setting to false has no effect on missiles whose dudProbabilityOnFlameout is false, as those are considered conceptually incapable of being duds/disarmed.

Parameters

armedWhileFizzling

setArmingTime()

void com.fs.starfarer.api.combat.MissileAPI.setArmingTime

(

float

armingTime

)

setDestroyedExplosionColorOverride()

void com.fs.starfarer.api.combat.MissileAPI.setDestroyedExplosionColorOverride

(

Color

destroyedExplosionColorOverride

)

setDidDamage()

void com.fs.starfarer.api.combat.MissileAPI.setDidDamage

(

boolean

didDamage

)

setDoNotFlareEnginesWhenStrafingOrDecelerating()

void com.fs.starfarer.api.combat.MissileAPI.setDoNotFlareEnginesWhenStrafingOrDecelerating

(

boolean

doNotFlare

)

setEccmChanceBonus()

void com.fs.starfarer.api.combat.MissileAPI.setEccmChanceBonus

(

float

eccmChanceBonus

)

setEccmChanceOverride()

void com.fs.starfarer.api.combat.MissileAPI.setEccmChanceOverride

(

float

eccmChanceOverride

)

setEmpResistance()

void com.fs.starfarer.api.combat.MissileAPI.setEmpResistance

(

int

empResistance

)

Number of times a missile will ignore being hit by an system EMP arc (not emp damage) instead of flaming out.

Parameters

empResistance

setEtaModifier()

void com.fs.starfarer.api.combat.MissileAPI.setEtaModifier

(

float

etaModifier

)

setFadeTime()

void com.fs.starfarer.api.combat.MissileAPI.setFadeTime

(

float

fadeTime

)

setFizzleTime()

void com.fs.starfarer.api.combat.MissileAPI.setFizzleTime

(

float

fizzleTime

)

setFlightTime()

void com.fs.starfarer.api.combat.MissileAPI.setFlightTime

(

float

flightTime

)

setForceAlwaysArmed()

void com.fs.starfarer.api.combat.MissileAPI.setForceAlwaysArmed

(

boolean

forceAlwaysArmed

)

setGlowRadius()

void com.fs.starfarer.api.combat.MissileAPI.setGlowRadius

(

float

glowRadius

)

setJitter() [1/2]

void com.fs.starfarer.api.combat.MissileAPI.setJitter	(	Object	source,
		Color	color,
		float	intensity,
		int	copies,
		float	minRange,
		float	range )

setJitter() [2/2]

void com.fs.starfarer.api.combat.MissileAPI.setJitter	(	Object	source,
		Color	color,
		float	intensity,
		int	copies,
		float	range )

setMaxFlightTime()

void com.fs.starfarer.api.combat.MissileAPI.setMaxFlightTime

(

float

maxFlightTime

)

setMaxRange()

void com.fs.starfarer.api.combat.MissileAPI.setMaxRange

(

float

maxRange

)

setMine()

void com.fs.starfarer.api.combat.MissileAPI.setMine

(

boolean

isMine

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

setMineExplosionRange()

void com.fs.starfarer.api.combat.MissileAPI.setMineExplosionRange

(

float

mineExplosionRange

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

setMinePrimed()

void com.fs.starfarer.api.combat.MissileAPI.setMinePrimed

(

boolean

isMinePrimed

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

setMissileAI()

void com.fs.starfarer.api.combat.MissileAPI.setMissileAI

(

MissileAIPlugin

ai

)

Only should be called if the AI needs to be changed dynamically. Otherwise, use ModPlugin.pickMissileAI() instead.

Parameters

ai

setNoFlameoutOnFizzling()

void com.fs.starfarer.api.combat.MissileAPI.setNoFlameoutOnFizzling

(

boolean

noFlameoutOnFizzling

)

setNoGlowTime()

void com.fs.starfarer.api.combat.MissileAPI.setNoGlowTime

(

float

noGlowTime

)

setNoMineFFConcerns()

void com.fs.starfarer.api.combat.MissileAPI.setNoMineFFConcerns

(

boolean

noFFConcerns

)

setParamAboutToApplyDamage()

void com.fs.starfarer.api.combat.MissileAPI.setParamAboutToApplyDamage

(

Object

param

)

setRenderGlowAbove()

void com.fs.starfarer.api.combat.MissileAPI.setRenderGlowAbove

(

boolean

renderGlowAbove

)

setShineBrightness()

void com.fs.starfarer.api.combat.MissileAPI.setShineBrightness

(

float

brightness

)

setSource()

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

(

ShipAPI

source

)

Implements com.fs.starfarer.api.combat.DamagingProjectileAPI.

setSpriteAlphaOverride()

void com.fs.starfarer.api.combat.MissileAPI.setSpriteAlphaOverride

(

float

spriteAlphaOverride

)

setStart()

void com.fs.starfarer.api.combat.MissileAPI.setStart

(

Vector2f

start

)

setTimeSinceFizzling()

void com.fs.starfarer.api.combat.MissileAPI.setTimeSinceFizzling

(

float

timeSinceFizzling

)

setUntilMineExplosion()

void com.fs.starfarer.api.combat.MissileAPI.setUntilMineExplosion

(

float

untilMineExplosion

)

Just data flags, WILL NOT actually make the missile a mine/adjust mine properties/etc.

Returns

setWeaponSpec()

void com.fs.starfarer.api.combat.MissileAPI.setWeaponSpec

(

String

weaponId

)

updateMaxSpeed()

void com.fs.starfarer.api.combat.MissileAPI.updateMaxSpeed

(

)

---

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

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