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

Classes
enum	ShieldType

Public Member Functions
void	setType (ShieldType type)
ShieldType	getType ()
float	getFacing ()
float	getArc ()
float	getActiveArc ()
void	setActiveArc (float activeArc)
float	getRadius ()
boolean	isOn ()
boolean	isOff ()
Vector2f	getLocation ()
boolean	isWithinArc (Vector2f point)
void	toggleOff ()
float	getFluxPerPointOfDamage ()
void	setArc (float arc)
void	setInnerColor (Color color)
void	setRingColor (Color ringColor)
Color	getInnerColor ()
Color	getRingColor ()
float	getUpkeep ()
void	forceFacing (float facing)
void	setRadius (float radius)
void	setRadius (float radius, String textureInner, String textureRing)
void	toggleOn ()
float	getUnfoldTime ()
void	setCenter (float x, float y)
float	getInnerRotationRate ()
void	setInnerRotationRate (float innerRotationRate)
float	getRingRotationRate ()
void	setRingRotationRate (float ringRotationRate)
boolean	isSkipRendering ()
void	setSkipRendering (boolean skipRendering)

Detailed Description

Author

Alex Mosolov

Copyright 2012 Fractal Softworks, LLC

Definition at line 13 of file ShieldAPI.java.

Member Function Documentation

forceFacing()

void com.fs.starfarer.api.combat.ShieldAPI.forceFacing

(

float

facing

)

getActiveArc()

float com.fs.starfarer.api.combat.ShieldAPI.getActiveArc

(

)

Returns

currently open arc (0 if not on)

getArc()

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

(

)

Returns

maximum arc.

getFacing()

float com.fs.starfarer.api.combat.ShieldAPI.getFacing

(

)

getFluxPerPointOfDamage()

float com.fs.starfarer.api.combat.ShieldAPI.getFluxPerPointOfDamage

(

)

Does not include shield damage taken mult, but does include absorbption mult.

Returns

getInnerColor()

Color com.fs.starfarer.api.combat.ShieldAPI.getInnerColor

(

)

getInnerRotationRate()

float com.fs.starfarer.api.combat.ShieldAPI.getInnerRotationRate

(

)

For shield textures, visual only.

Returns

getLocation()

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

(

)

Returns

location of the center of the shield, in engine coordinates.

getRadius()

float com.fs.starfarer.api.combat.ShieldAPI.getRadius

(

)

getRingColor()

Color com.fs.starfarer.api.combat.ShieldAPI.getRingColor

(

)

getRingRotationRate()

float com.fs.starfarer.api.combat.ShieldAPI.getRingRotationRate

(

)

For shield textures, visual only.

Returns

getType()

ShieldType com.fs.starfarer.api.combat.ShieldAPI.getType

(

)

getUnfoldTime()

float com.fs.starfarer.api.combat.ShieldAPI.getUnfoldTime

(

)

getUpkeep()

float com.fs.starfarer.api.combat.ShieldAPI.getUpkeep

(

)

Flux/second while shield is on.

Returns

isOff()

boolean com.fs.starfarer.api.combat.ShieldAPI.isOff

(

)

isOn()

boolean com.fs.starfarer.api.combat.ShieldAPI.isOn

(

)

isSkipRendering()

boolean com.fs.starfarer.api.combat.ShieldAPI.isSkipRendering

(

)

isWithinArc()

boolean com.fs.starfarer.api.combat.ShieldAPI.isWithinArc

(

Vector2f

point

)

setActiveArc()

void com.fs.starfarer.api.combat.ShieldAPI.setActiveArc

(

float

activeArc

)

setArc()

void com.fs.starfarer.api.combat.ShieldAPI.setArc

(

float

arc

)

Set the maximum arc.

Parameters

arc

setCenter()

void com.fs.starfarer.api.combat.ShieldAPI.setCenter	(	float	x,
		float	y
	)

setInnerColor()

void com.fs.starfarer.api.combat.ShieldAPI.setInnerColor

(

Color

color

)

setInnerRotationRate()

void com.fs.starfarer.api.combat.ShieldAPI.setInnerRotationRate

(

float

innerRotationRate

)

For shield textures, visual only.

Returns

setRadius() [1/2]

void com.fs.starfarer.api.combat.ShieldAPI.setRadius

(

float

radius

)

setRadius() [2/2]

void com.fs.starfarer.api.combat.ShieldAPI.setRadius	(	float	radius,
		String	textureInner,
		String	textureRing
	)

Textures should be already loaded (i.e. via settings.json).

Parameters

radius
textureInner
textureRing

setRingColor()

void com.fs.starfarer.api.combat.ShieldAPI.setRingColor

(

Color

ringColor

)

setRingRotationRate()

void com.fs.starfarer.api.combat.ShieldAPI.setRingRotationRate

(

float

ringRotationRate

)

For shield textures, visual only.

Returns

setSkipRendering()

void com.fs.starfarer.api.combat.ShieldAPI.setSkipRendering

(

boolean

skipRendering

)

setType()

void com.fs.starfarer.api.combat.ShieldAPI.setType

(

ShieldType

type

)

toggleOff()

void com.fs.starfarer.api.combat.ShieldAPI.toggleOff

(

)

toggleOn()

void com.fs.starfarer.api.combat.ShieldAPI.toggleOn

(

)

---

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

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