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

Public Member Functions
float	getTimeToVent ()
float	getOverloadTimeRemaining ()
boolean	isOverloaded ()
boolean	isVenting ()
boolean	isOverloadedOrVenting ()
boolean	isEngineBoostActive ()
float	getFluxLevel ()
float	getCurrFlux ()
float	getHardFlux ()
float	getMaxFlux ()
void	setHardFlux (float minFlux)
void	setCurrFlux (float currFlux)
boolean	increaseFlux (float fluxAmount, boolean hardFlux)
void	decreaseFlux (float fluxAmount)
void	forceOverload (float extraOverloadTime)
void	stopOverload ()
void	stopVenting ()
void	beginOverloadWithTotalBaseDuration (float totalDur)
boolean	showFloaty ()
float	getFloatySize ()
void	playOverloadSound ()
void	showOverloadFloatyIfNeeded ()
void	showOverloadFloatyIfNeeded (String text, Color color, float fontSizeBonus, boolean alwaysShow)
float	getEngineBoostLevel ()
void	setOverloadProgress (float empProgress)
void	setOverloadDuration (float empDuration)
void	ventFlux ()
void	setOverloadColor (Color overloadColor)
Color	getOverloadColor ()
void	setOverloadText (String overloadText)
String	getOverloadText ()

Detailed Description

Definition at line 5 of file FluxTrackerAPI.java.

Member Function Documentation

beginOverloadWithTotalBaseDuration()

void com.fs.starfarer.api.combat.FluxTrackerAPI.beginOverloadWithTotalBaseDuration

(

float

totalDur

)

decreaseFlux()

void com.fs.starfarer.api.combat.FluxTrackerAPI.decreaseFlux

(

float

fluxAmount

)

forceOverload()

void com.fs.starfarer.api.combat.FluxTrackerAPI.forceOverload

(

float

extraOverloadTime

)

getCurrFlux()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getCurrFlux

(

)

getEngineBoostLevel()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getEngineBoostLevel

(

)

getFloatySize()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getFloatySize

(

)

"Overload" floaty font size.

Returns

getFluxLevel()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getFluxLevel

(

)

Returns

flux level, from 0 to 1

getHardFlux()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getHardFlux

(

)

getMaxFlux()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getMaxFlux

(

)

getOverloadColor()

Color com.fs.starfarer.api.combat.FluxTrackerAPI.getOverloadColor

(

)

getOverloadText()

String com.fs.starfarer.api.combat.FluxTrackerAPI.getOverloadText

(

)

getOverloadTimeRemaining()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getOverloadTimeRemaining

(

)

getTimeToVent()

float com.fs.starfarer.api.combat.FluxTrackerAPI.getTimeToVent

(

)

increaseFlux()

boolean com.fs.starfarer.api.combat.FluxTrackerAPI.increaseFlux	(	float	fluxAmount,
		boolean	hardFlux )

Parameters

fluxAmount
hardFlux

Returns

false if flux couldn't be raised successfully. Hard flux increases always return true and can overload the ship.

isEngineBoostActive()

boolean com.fs.starfarer.api.combat.FluxTrackerAPI.isEngineBoostActive

(

)

isOverloaded()

boolean com.fs.starfarer.api.combat.FluxTrackerAPI.isOverloaded

(

)

isOverloadedOrVenting()

boolean com.fs.starfarer.api.combat.FluxTrackerAPI.isOverloadedOrVenting

(

)

isVenting()

boolean com.fs.starfarer.api.combat.FluxTrackerAPI.isVenting

(

)

playOverloadSound()

void com.fs.starfarer.api.combat.FluxTrackerAPI.playOverloadSound

(

)

setCurrFlux()

void com.fs.starfarer.api.combat.FluxTrackerAPI.setCurrFlux

(

float

currFlux

)

setHardFlux()

void com.fs.starfarer.api.combat.FluxTrackerAPI.setHardFlux

(

float

minFlux

)

setOverloadColor()

void com.fs.starfarer.api.combat.FluxTrackerAPI.setOverloadColor

(

Color

overloadColor

)

setOverloadDuration()

void com.fs.starfarer.api.combat.FluxTrackerAPI.setOverloadDuration

(

float

empDuration

)

setOverloadProgress()

void com.fs.starfarer.api.combat.FluxTrackerAPI.setOverloadProgress

(

float

empProgress

)

setOverloadText()

void com.fs.starfarer.api.combat.FluxTrackerAPI.setOverloadText

(

String

overloadText

)

showFloaty()

boolean com.fs.starfarer.api.combat.FluxTrackerAPI.showFloaty

(

)

Whether the "Overload!" floaty should be shown.

Returns

showOverloadFloatyIfNeeded() [1/2]

void com.fs.starfarer.api.combat.FluxTrackerAPI.showOverloadFloatyIfNeeded

(

)

showOverloadFloatyIfNeeded() [2/2]

void com.fs.starfarer.api.combat.FluxTrackerAPI.showOverloadFloatyIfNeeded	(	String	text,
		Color	color,
		float	fontSizeBonus,
		boolean	alwaysShow )

stopOverload()

void com.fs.starfarer.api.combat.FluxTrackerAPI.stopOverload

(

)

stopVenting()

void com.fs.starfarer.api.combat.FluxTrackerAPI.stopVenting

(

)

ventFlux()

void com.fs.starfarer.api.combat.FluxTrackerAPI.ventFlux

(

)

---

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

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