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

Classes
enum	AIHints
interface	DerivedWeaponStatsAPI
enum	WeaponSize
enum	WeaponType

Public Member Functions
String	getId ()
WeaponType	getType ()
WeaponSize	getSize ()
void	setPD (boolean pd)
float	distanceFromArc (Vector2f target)
boolean	isAlwaysFire ()
float	getCurrSpread ()
float	getCurrAngle ()
float	getArcFacing ()
float	getArc ()
void	setCurrAngle (float angle)
float	getRange ()
float	getDisplayArcRadius ()
float	getChargeLevel ()
float	getTurnRate ()
float	getProjectileSpeed ()
String	getDisplayName ()
int	getAmmo ()
int	getMaxAmmo ()
void	setMaxAmmo (int maxAmmo)
void	resetAmmo ()
float	getCooldownRemaining ()
float	getCooldown ()
void	setRemainingCooldownTo (float value)
boolean	isBeam ()
boolean	isBurstBeam ()
boolean	isPulse ()
boolean	requiresFullCharge ()
Vector2f	getLocation ()
boolean	isFiring ()
boolean	usesAmmo ()
boolean	usesEnergy ()
boolean	hasAIHint (AIHints hint)
CollisionClass	getProjectileCollisionClass ()
void	beginSelectionFlash ()
float	getFluxCostToFire ()
float	getMaxHealth ()
float	getCurrHealth ()
boolean	isDisabled ()
float	getDisabledDuration ()
boolean	isPermanentlyDisabled ()
DamageType	getDamageType ()
ShipAPI	getShip ()
DerivedWeaponStatsAPI	getDerivedStats ()
void	setAmmo (int ammo)
AnimationAPI	getAnimation ()
SpriteAPI	getSprite ()
SpriteAPI	getUnderSpriteAPI ()
SpriteAPI	getBarrelSpriteAPI ()
void	renderBarrel (SpriteAPI sprite, Vector2f loc, float alphaMult)
boolean	isRenderBarrelBelow ()
void	disable ()
void	disable (boolean permanent)
void	repair ()
WeaponSpecAPI	getSpec ()
WeaponSlotAPI	getSlot ()
EveryFrameWeaponEffectPlugin	getEffectPlugin ()
List< MissileRenderDataAPI >	getMissileRenderData ()
DamageAPI	getDamage ()
float	getProjectileFadeRange ()
boolean	isDecorative ()
void	ensureClonedSpec ()
float	getAmmoPerSecond ()
void	setPDAlso (boolean pdAlso)
void	setCurrHealth (float currHealth)
MuzzleFlashSpec	getMuzzleFlashSpec ()
List< BeamAPI >	getBeams ()
Vector2f	getFirePoint (int barrel)
void	setTurnRateOverride (Float turnRateOverride)
SpriteAPI	getGlowSpriteAPI ()
AmmoTrackerAPI	getAmmoTracker ()
void	setRefireDelay (float delay)
void	setFacing (float facing)
void	updateBeamFromPoints ()
boolean	isKeepBeamTargetWhileChargingDown ()
void	setKeepBeamTargetWhileChargingDown (boolean keepTargetWhileChargingDown)
void	setScaleBeamGlowBasedOnDamageEffectiveness (boolean scaleGlowBasedOnDamageEffectiveness)
void	setForceFireOneFrame (boolean forceFire)
void	setGlowAmount (float glow, Color glowColor)
void	setForceNoFireOneFrame (boolean forceNoFireOneFrame)
void	setSuspendAutomaticTurning (boolean suspendAutomaticTurning)
float	getBurstFireTimeRemaining ()
Vector2f	getRenderOffsetForDecorativeBeamWeaponsOnly ()
void	setRenderOffsetForDecorativeBeamWeaponsOnly (Vector2f renderOffsetForDecorativeBeamWeaponsOnly)
float	getRefireDelay ()
void	forceShowBeamGlow ()
boolean	isInBurst ()
WeaponSpecAPI	getOriginalSpec ()
void	setWeaponGlowWidthMult (float weaponGlowWidthMult)
void	setWeaponGlowHeightMult (float weaponGlowHeightMult)
void	stopFiring ()
boolean	isForceDisabled ()
void	setForceDisabled (boolean forceDisabled)
Object	getCustom ()
void	setCustom (Object custom)
boolean	isForceNoFireOneFrame ()

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 20 of file WeaponAPI.java.

Member Function Documentation

beginSelectionFlash()

void com.fs.starfarer.api.combat.WeaponAPI.beginSelectionFlash

(

)

disable() [1/2]

void com.fs.starfarer.api.combat.WeaponAPI.disable

(

)

disable() [2/2]

void com.fs.starfarer.api.combat.WeaponAPI.disable

(

boolean

permanent

)

distanceFromArc()

float com.fs.starfarer.api.combat.WeaponAPI.distanceFromArc

(

Vector2f

target

)

Returns 0 if the target is in arc, angular distance to edge of arc otherwise.

Parameters

target

Returns

ensureClonedSpec()

void com.fs.starfarer.api.combat.WeaponAPI.ensureClonedSpec

(

)

forceShowBeamGlow()

void com.fs.starfarer.api.combat.WeaponAPI.forceShowBeamGlow

(

)

getAmmo()

int com.fs.starfarer.api.combat.WeaponAPI.getAmmo

(

)

getAmmoPerSecond()

float com.fs.starfarer.api.combat.WeaponAPI.getAmmoPerSecond

(

)

getAmmoTracker()

AmmoTrackerAPI com.fs.starfarer.api.combat.WeaponAPI.getAmmoTracker

(

)

getAnimation()

AnimationAPI com.fs.starfarer.api.combat.WeaponAPI.getAnimation

(

)

Returns

null for non-animated weapons.

getArc()

float com.fs.starfarer.api.combat.WeaponAPI.getArc

(

)

getArcFacing()

float com.fs.starfarer.api.combat.WeaponAPI.getArcFacing

(

)

getBarrelSpriteAPI()

SpriteAPI com.fs.starfarer.api.combat.WeaponAPI.getBarrelSpriteAPI

(

)

Sprite with the weapon barrels, or null if the weapon doesn't use recoil/separate barrel graphics.

Returns

getBeams()

List< BeamAPI > com.fs.starfarer.api.combat.WeaponAPI.getBeams

(

)

getBurstFireTimeRemaining()

float com.fs.starfarer.api.combat.WeaponAPI.getBurstFireTimeRemaining

(

)

getChargeLevel()

float com.fs.starfarer.api.combat.WeaponAPI.getChargeLevel

(

)

getCooldown()

float com.fs.starfarer.api.combat.WeaponAPI.getCooldown

(

)

getCooldownRemaining()

float com.fs.starfarer.api.combat.WeaponAPI.getCooldownRemaining

(

)

getCurrAngle()

float com.fs.starfarer.api.combat.WeaponAPI.getCurrAngle

(

)

getCurrHealth()

float com.fs.starfarer.api.combat.WeaponAPI.getCurrHealth

(

)

getCurrSpread()

float com.fs.starfarer.api.combat.WeaponAPI.getCurrSpread

(

)

getCustom()

Object com.fs.starfarer.api.combat.WeaponAPI.getCustom

(

)

getDamage()

DamageAPI com.fs.starfarer.api.combat.WeaponAPI.getDamage

(

)

getDamageType()

DamageType com.fs.starfarer.api.combat.WeaponAPI.getDamageType

(

)

getDerivedStats()

DerivedWeaponStatsAPI com.fs.starfarer.api.combat.WeaponAPI.getDerivedStats

(

)

Base stats, does not include character skill bonuses/hull mods/etc.

Returns

getDisabledDuration()

float com.fs.starfarer.api.combat.WeaponAPI.getDisabledDuration

(

)

getDisplayArcRadius()

float com.fs.starfarer.api.combat.WeaponAPI.getDisplayArcRadius

(

)

getDisplayName()

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

(

)

getEffectPlugin()

EveryFrameWeaponEffectPlugin com.fs.starfarer.api.combat.WeaponAPI.getEffectPlugin

(

)

getFirePoint()

Vector2f com.fs.starfarer.api.combat.WeaponAPI.getFirePoint

(

int

barrel

)

getFluxCostToFire()

float com.fs.starfarer.api.combat.WeaponAPI.getFluxCostToFire

(

)

getGlowSpriteAPI()

SpriteAPI com.fs.starfarer.api.combat.WeaponAPI.getGlowSpriteAPI

(

)

getId()

String com.fs.starfarer.api.combat.WeaponAPI.getId

(

)

getLocation()

Vector2f com.fs.starfarer.api.combat.WeaponAPI.getLocation

(

)

Returns

location, in absolute engine coordinates.

getMaxAmmo()

int com.fs.starfarer.api.combat.WeaponAPI.getMaxAmmo

(

)

getMaxHealth()

float com.fs.starfarer.api.combat.WeaponAPI.getMaxHealth

(

)

getMissileRenderData()

List< MissileRenderDataAPI > com.fs.starfarer.api.combat.WeaponAPI.getMissileRenderData

(

)

getMuzzleFlashSpec()

MuzzleFlashSpec com.fs.starfarer.api.combat.WeaponAPI.getMuzzleFlashSpec

(

)

getOriginalSpec()

WeaponSpecAPI com.fs.starfarer.api.combat.WeaponAPI.getOriginalSpec

(

)

getProjectileCollisionClass()

CollisionClass com.fs.starfarer.api.combat.WeaponAPI.getProjectileCollisionClass

(

)

getProjectileFadeRange()

float com.fs.starfarer.api.combat.WeaponAPI.getProjectileFadeRange

(

)

getProjectileSpeed()

float com.fs.starfarer.api.combat.WeaponAPI.getProjectileSpeed

(

)

getRange()

float com.fs.starfarer.api.combat.WeaponAPI.getRange

(

)

getRefireDelay()

float com.fs.starfarer.api.combat.WeaponAPI.getRefireDelay

(

)

getRenderOffsetForDecorativeBeamWeaponsOnly()

Vector2f com.fs.starfarer.api.combat.WeaponAPI.getRenderOffsetForDecorativeBeamWeaponsOnly

(

)

getShip()

ShipAPI com.fs.starfarer.api.combat.WeaponAPI.getShip

(

)

getSize()

WeaponSize com.fs.starfarer.api.combat.WeaponAPI.getSize

(

)

getSlot()

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

(

)

getSpec()

WeaponSpecAPI com.fs.starfarer.api.combat.WeaponAPI.getSpec

(

)

getSprite()

SpriteAPI com.fs.starfarer.api.combat.WeaponAPI.getSprite

(

)

Note: setAlphaMult() and setAngle() will be called on the sprite returned here just prior to rendering. Thus, setting these is pointless - the values will be overridden. Uses the alpha channel in SpriteAPI.setColor() and WeaponAPI.setCurrAngle() instead.

Returns

either the base sprite, or, for animated weapons, the sprite for the current frame.

getTurnRate()

float com.fs.starfarer.api.combat.WeaponAPI.getTurnRate

(

)

getType()

WeaponType com.fs.starfarer.api.combat.WeaponAPI.getType

(

)

getUnderSpriteAPI()

SpriteAPI com.fs.starfarer.api.combat.WeaponAPI.getUnderSpriteAPI

(

)

"Base" sprite for the weapon (see: mjolnir.wpn), or null.

Returns

hasAIHint()

boolean com.fs.starfarer.api.combat.WeaponAPI.hasAIHint

(

AIHints

hint

)

isAlwaysFire()

boolean com.fs.starfarer.api.combat.WeaponAPI.isAlwaysFire

(

)

isBeam()

boolean com.fs.starfarer.api.combat.WeaponAPI.isBeam

(

)

isBurstBeam()

boolean com.fs.starfarer.api.combat.WeaponAPI.isBurstBeam

(

)

isDecorative()

boolean com.fs.starfarer.api.combat.WeaponAPI.isDecorative

(

)

isDisabled()

boolean com.fs.starfarer.api.combat.WeaponAPI.isDisabled

(

)

isFiring()

boolean com.fs.starfarer.api.combat.WeaponAPI.isFiring

(

)

isForceDisabled()

boolean com.fs.starfarer.api.combat.WeaponAPI.isForceDisabled

(

)

isForceNoFireOneFrame()

boolean com.fs.starfarer.api.combat.WeaponAPI.isForceNoFireOneFrame

(

)

isInBurst()

boolean com.fs.starfarer.api.combat.WeaponAPI.isInBurst

(

)

isKeepBeamTargetWhileChargingDown()

boolean com.fs.starfarer.api.combat.WeaponAPI.isKeepBeamTargetWhileChargingDown

(

)

isPermanentlyDisabled()

boolean com.fs.starfarer.api.combat.WeaponAPI.isPermanentlyDisabled

(

)

isPulse()

boolean com.fs.starfarer.api.combat.WeaponAPI.isPulse

(

)

isRenderBarrelBelow()

boolean com.fs.starfarer.api.combat.WeaponAPI.isRenderBarrelBelow

(

)

Whether the barrel goes below or above the weapon sprite.

Returns

renderBarrel()

void com.fs.starfarer.api.combat.WeaponAPI.renderBarrel	(	SpriteAPI	sprite,
		Vector2f	loc,
		float	alphaMult )

Renders the barrel. Shouldn't need to do this unless for shaders etc.

Parameters

alphaMult

repair()

void com.fs.starfarer.api.combat.WeaponAPI.repair

(

)

requiresFullCharge()

boolean com.fs.starfarer.api.combat.WeaponAPI.requiresFullCharge

(

)

resetAmmo()

void com.fs.starfarer.api.combat.WeaponAPI.resetAmmo

(

)

setAmmo()

void com.fs.starfarer.api.combat.WeaponAPI.setAmmo

(

int

ammo

)

setCurrAngle()

void com.fs.starfarer.api.combat.WeaponAPI.setCurrAngle

(

float

angle

)

setCurrHealth()

void com.fs.starfarer.api.combat.WeaponAPI.setCurrHealth

(

float

currHealth

)

setCustom()

void com.fs.starfarer.api.combat.WeaponAPI.setCustom

(

Object

custom

)

setFacing()

void com.fs.starfarer.api.combat.WeaponAPI.setFacing

(

float

facing

)

setForceDisabled()

void com.fs.starfarer.api.combat.WeaponAPI.setForceDisabled

(

boolean

forceDisabled

)

setForceFireOneFrame()

void com.fs.starfarer.api.combat.WeaponAPI.setForceFireOneFrame

(

boolean

forceFire

)

setForceNoFireOneFrame()

void com.fs.starfarer.api.combat.WeaponAPI.setForceNoFireOneFrame

(

boolean

forceNoFireOneFrame

)

setGlowAmount()

void com.fs.starfarer.api.combat.WeaponAPI.setGlowAmount	(	float	glow,
		Color	glowColor )

setKeepBeamTargetWhileChargingDown()

void com.fs.starfarer.api.combat.WeaponAPI.setKeepBeamTargetWhileChargingDown

(

boolean

keepTargetWhileChargingDown

)

setMaxAmmo()

void com.fs.starfarer.api.combat.WeaponAPI.setMaxAmmo

(

int

maxAmmo

)

setPD()

void com.fs.starfarer.api.combat.WeaponAPI.setPD

(

boolean

pd

)

setPDAlso()

void com.fs.starfarer.api.combat.WeaponAPI.setPDAlso

(

boolean

pdAlso

)

setRefireDelay()

void com.fs.starfarer.api.combat.WeaponAPI.setRefireDelay

(

float

delay

)

setRemainingCooldownTo()

void com.fs.starfarer.api.combat.WeaponAPI.setRemainingCooldownTo

(

float

value

)

setRenderOffsetForDecorativeBeamWeaponsOnly()

void com.fs.starfarer.api.combat.WeaponAPI.setRenderOffsetForDecorativeBeamWeaponsOnly

(

Vector2f

renderOffsetForDecorativeBeamWeaponsOnly

)

setScaleBeamGlowBasedOnDamageEffectiveness()

void com.fs.starfarer.api.combat.WeaponAPI.setScaleBeamGlowBasedOnDamageEffectiveness

(

boolean

scaleGlowBasedOnDamageEffectiveness

)

setSuspendAutomaticTurning()

void com.fs.starfarer.api.combat.WeaponAPI.setSuspendAutomaticTurning

(

boolean

suspendAutomaticTurning

)

setTurnRateOverride()

void com.fs.starfarer.api.combat.WeaponAPI.setTurnRateOverride

(

Float

turnRateOverride

)

setWeaponGlowHeightMult()

void com.fs.starfarer.api.combat.WeaponAPI.setWeaponGlowHeightMult

(

float

weaponGlowHeightMult

)

setWeaponGlowWidthMult()

void com.fs.starfarer.api.combat.WeaponAPI.setWeaponGlowWidthMult

(

float

weaponGlowWidthMult

)

stopFiring()

void com.fs.starfarer.api.combat.WeaponAPI.stopFiring

(

)

updateBeamFromPoints()

void com.fs.starfarer.api.combat.WeaponAPI.updateBeamFromPoints

(

)

usesAmmo()

boolean com.fs.starfarer.api.combat.WeaponAPI.usesAmmo

(

)

usesEnergy()

boolean com.fs.starfarer.api.combat.WeaponAPI.usesEnergy

(

)

---

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

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