Uses of Interface
com.fs.starfarer.api.graphics.SpriteAPI

Packages that use SpriteAPI

Package	Description
com.fs.starfarer.api
com.fs.starfarer.api.campaign
com.fs.starfarer.api.combat
com.fs.starfarer.api.impl.campaign
com.fs.starfarer.api.impl.campaign.abilities
com.fs.starfarer.api.impl.campaign.eventide
com.fs.starfarer.api.impl.campaign.terrain
com.fs.starfarer.api.impl.campaign.velfield
com.fs.starfarer.api.impl.combat
com.fs.starfarer.api.impl.combat.dweller
com.fs.starfarer.api.impl.combat.threat
com.fs.starfarer.api.impl.hullmods
com.fs.starfarer.api.util

Uses of SpriteAPI in com.fs.starfarer.api

Methods in com.fs.starfarer.api that return SpriteAPI

Modifier and Type	Method	Description
SpriteAPI	SettingsAPI.getSprite(SpriteId id)	Same as the method that takes (String category, String key).
SpriteAPI	SettingsAPI.getSprite(String filename)	File must already have been loaded.
SpriteAPI	SettingsAPI.getSprite(String category, String key)	Gets a sprite loaded using the "graphics" section in data/config/settings.json.
SpriteAPI	SettingsAPI.getSprite(String category, String id, boolean emptySpriteOnNotFound)

Uses of SpriteAPI in com.fs.starfarer.api.campaign

Methods in com.fs.starfarer.api.campaign with parameters of type SpriteAPI

Modifier and Type	Method	Description
void	SpecialItemPlugin.SpecialItemRendererAPI.renderScanlines(SpriteAPI sprite, float cx, float cy, float alphaMult)
void	SpecialItemPlugin.SpecialItemRendererAPI.renderSchematic(SpriteAPI sprite, float cx, float cy, float alphaMult)
void	SpecialItemPlugin.SpecialItemRendererAPI.renderSchematicWithCorners(SpriteAPI sprite, Color color, float blX, float blY, float tlX, float tlY, float trX, float trY, float brX, float brY, float alphaMult)

Uses of SpriteAPI in com.fs.starfarer.api.combat

Methods in com.fs.starfarer.api.combat that return SpriteAPI

Modifier and Type	Method	Description
SpriteAPI	WeaponAPI.getBarrelSpriteAPI()	Sprite with the weapon barrels, or null if the weapon doesn't use recoil/separate barrel graphics.
SpriteAPI	WeaponAPI.getGlowSpriteAPI()
SpriteAPI	BeamAPI.getHitGlow()
SpriteAPI	ShipAPI.getLargeHardpointCover()
SpriteAPI	ShipAPI.getLargeTurretCover()
SpriteAPI	ShipAPI.getMediumHardpointCover()
SpriteAPI	ShipAPI.getMediumTurretCover()
SpriteAPI	ShipAPI.getSmallHardpointCover()
SpriteAPI	ShipAPI.getSmallTurretCover()
SpriteAPI	BattleObjectiveAPI.getSprite()
SpriteAPI	MissileRenderDataAPI.getSprite()
SpriteAPI	WeaponAPI.getSprite()	Note: setAlphaMult() and setAngle() will be called on the sprite returned here just prior to rendering.
SpriteAPI	CombatAsteroidAPI.getSpriteAPI()
SpriteAPI	MissileAPI.getSpriteAPI()
SpriteAPI	ShipAPI.getSpriteAPI()	A wrapper around the internal implementation of a sprite.
SpriteAPI	WeaponAPI.getUnderSpriteAPI()	"Base" sprite for the weapon (see: mjolnir.wpn), or null.

Methods in com.fs.starfarer.api.combat with parameters of type SpriteAPI

Modifier and Type	Method	Description
void	WeaponAPI.renderBarrel(SpriteAPI sprite, org.lwjgl.util.vector.Vector2f loc, float alphaMult)	Renders the barrel.
void	BeamAPI.setHitGlow(SpriteAPI sprite)
void	BattleObjectiveAPI.setSprite(SpriteAPI sprite)
void	ShipAPI.setSprite(SpriteAPI sprite)

Uses of SpriteAPI in com.fs.starfarer.api.impl.campaign

Fields in com.fs.starfarer.api.impl.campaign declared as SpriteAPI

Modifier and Type	Field	Description
protected SpriteAPI	GateEntityPlugin.activeGlow
protected SpriteAPI	GateEntityPlugin.baseSprite
protected SpriteAPI	GateEntityPlugin.concentric
protected SpriteAPI	GenericCampaignEntitySprite.glow
protected SpriteAPI	GenericFieldItemSprite.glow
protected SpriteAPI	GenericCampaignEntitySprite.overlay
protected SpriteAPI	GateEntityPlugin.rays
protected SpriteAPI	GateEntityPlugin.scannedGlow
protected SpriteAPI	GenericCampaignEntitySprite.shadowMask
protected SpriteAPI	GenericFieldItemSprite.shadowMask
protected SpriteAPI	ExplosionEntityPlugin.sprite
protected SpriteAPI	GenericCampaignEntitySprite.sprite
protected SpriteAPI	GenericFieldItemSprite.sprite
protected SpriteAPI	GateEntityPlugin.starfield
protected SpriteAPI	GateEntityPlugin.whirl1
protected SpriteAPI	GateEntityPlugin.whirl2

Methods in com.fs.starfarer.api.impl.campaign that return SpriteAPI

Modifier and Type	Method	Description
SpriteAPI	GenericCampaignEntitySprite.getGlow()
SpriteAPI	GenericCampaignEntitySprite.getOverlay()

Methods in com.fs.starfarer.api.impl.campaign with parameters of type SpriteAPI

Modifier and Type	Method	Description
void	GenericCampaignEntitySprite.setGlow(SpriteAPI glow)
void	GenericCampaignEntitySprite.setOverlay(SpriteAPI overlay)

Uses of SpriteAPI in com.fs.starfarer.api.impl.campaign.abilities

Fields in com.fs.starfarer.api.impl.campaign.abilities declared as SpriteAPI

Modifier and Type	Field	Description
protected SpriteAPI	GraviticScanAbility.texture

Uses of SpriteAPI in com.fs.starfarer.api.impl.campaign.eventide

Fields in com.fs.starfarer.api.impl.campaign.eventide declared as SpriteAPI

Modifier and Type	Field	Description
protected SpriteAPI	EventideDuelBackground.bg
protected SpriteAPI	EventideDuelBackground.column
protected SpriteAPI	EventideDuelBackground.conduits
protected SpriteAPI	EventideDuelBackground.foreground_side
protected SpriteAPI	EventideDuelBackground.platform
SpriteAPI	AnimAction.sprite
SpriteAPI	CharAnim.sprite
protected SpriteAPI	EventideDuelBackground.tower

Methods in com.fs.starfarer.api.impl.campaign.eventide that return SpriteAPI

Modifier and Type	Method	Description
protected SpriteAPI	BaseDuelBackground.loadTex(String tex)

Uses of SpriteAPI in com.fs.starfarer.api.impl.campaign.terrain

Fields in com.fs.starfarer.api.impl.campaign.terrain declared as SpriteAPI

Modifier and Type	Field	Description
protected SpriteAPI	PulsarBeamTerrainPlugin.flareTexture
protected SpriteAPI	HyperspaceTerrainPlugin.flickerTexture
protected SpriteAPI	DebrisPiece.glow
protected SpriteAPI	BaseTiledTerrain.mapTexture
protected SpriteAPI	DebrisPiece.shadowMask
protected SpriteAPI	DebrisPiece.sprite
protected SpriteAPI	BaseTiledTerrain.texture
protected SpriteAPI	MagneticFieldTerrainPlugin.texture
protected SpriteAPI	SpatialAnomalyTerrainPlugin.texture
protected SpriteAPI	StarCoronaTerrainPlugin.texture
protected SpriteAPI	WavefrontTerrainPlugin.texture

Methods in com.fs.starfarer.api.impl.campaign.terrain that return SpriteAPI

Modifier and Type	Method	Description
SpriteAPI	AuroraRenderer.AuroraRendererDelegate.getAuroraTexture()
SpriteAPI	MagneticFieldTerrainPlugin.getAuroraTexture()
SpriteAPI	SpatialAnomalyTerrainPlugin.getAuroraTexture()
SpriteAPI	StarCoronaTerrainPlugin.getAuroraTexture()
SpriteAPI	PulsarBeamTerrainPlugin.getPulsarTexture()
SpriteAPI	PulsarRenderer.PulsarRendererDelegate.getPulsarTexture()

Uses of SpriteAPI in com.fs.starfarer.api.impl.campaign.velfield

Fields in com.fs.starfarer.api.impl.campaign.velfield declared as SpriteAPI

Modifier and Type	Field	Description
SpriteAPI	TurbulenceEntityPlugin.ParticleData.sprite

Methods in com.fs.starfarer.api.impl.campaign.velfield with parameters of type SpriteAPI

Modifier and Type	Method	Description
void	SlipstreamEntityPlugin.renderLayer(SpriteAPI sprite, float texProgress, float alpha)
void	SlipstreamEntityPlugin2.renderSegments(SpriteAPI sprite, SpriteAPI edge, float alpha, List<SlipstreamEntityPlugin2.SlipstreamSegment> segments)
void	SlipstreamTerrainPlugin2.renderSegments(SpriteAPI sprite0, SpriteAPI sprite1, SpriteAPI sprite2, SpriteAPI edge, float alpha, List<SlipstreamTerrainPlugin2.SlipstreamSegment> segments, float extraTX, boolean forMap)

Uses of SpriteAPI in com.fs.starfarer.api.impl.combat

Fields in com.fs.starfarer.api.impl.combat declared as SpriteAPI

Modifier and Type	Field	Description
protected SpriteAPI	NegativeExplosionVisual.atmosphereTex
SpriteAPI	CombatEntityPluginWithParticles.ParticleData.sprite
SpriteAPI	CryoblasterEffect.ParticleData.sprite
SpriteAPI	CryofluxTransducerEffect.ParticleData.sprite
SpriteAPI	DisintegratorEffect.ParticleData.sprite
protected SpriteAPI	NeuralTransferVisual.sprite
protected SpriteAPI	ShipExplosionFlareVisual.sprite
SpriteAPI	TriadShieldStatsBackup.ShieldPiece.sprite

Uses of SpriteAPI in com.fs.starfarer.api.impl.combat.dweller

Fields in com.fs.starfarer.api.impl.combat.dweller declared as SpriteAPI

Modifier and Type	Field	Description
protected SpriteAPI	WarpingSpriteRendererUtilV2.sprite

Methods in com.fs.starfarer.api.impl.combat.dweller that return SpriteAPI

Modifier and Type	Method	Description
SpriteAPI	WarpingSpriteRendererUtilV2.getSprite()

Constructors in com.fs.starfarer.api.impl.combat.dweller with parameters of type SpriteAPI

Modifier	Constructor	Description
	WarpingSpriteRendererUtilV2(SpriteAPI sprite, int verticesWide, int verticesTall, float minWarpRadius, float maxWarpRadius, float warpRateMult)

Uses of SpriteAPI in com.fs.starfarer.api.impl.combat.threat

Fields in com.fs.starfarer.api.impl.combat.threat declared as SpriteAPI

Modifier and Type	Field	Description
SpriteAPI	RoilingSwarmEffect.SwarmMember.sprite

Uses of SpriteAPI in com.fs.starfarer.api.impl.hullmods

Methods in com.fs.starfarer.api.impl.hullmods that return SpriteAPI

Modifier and Type	Method	Description
static SpriteAPI	ConvertedHangar.getFighterSkin(ShipAPI fighter, ShipAPI carrier)
static SpriteAPI	ConvertedHangar.getFighterSkin(String cat, ShipAPI fighter, ShipAPI carrier)

Uses of SpriteAPI in com.fs.starfarer.api.util

Fields in com.fs.starfarer.api.util declared as SpriteAPI

Modifier and Type	Field	Description
protected SpriteAPI	CampaignEngineGlowIndividualEngine.flame
protected SpriteAPI	CampaignEngineGlowIndividualEngine.glow

Methods in com.fs.starfarer.api.util that return SpriteAPI

Modifier and Type	Method	Description
SpriteAPI	CampaignEngineGlowIndividualEngine.getGlow()
static SpriteAPI	Misc.getWeaponSkin(ShipAPI ship, String weaponId, Misc.WeaponSkinType type)
static SpriteAPI	Misc.getWeaponSkin(String cat, String weaponId, ShipAPI ship, Misc.WeaponSkinType type)

Methods in com.fs.starfarer.api.util with parameters of type SpriteAPI

Modifier and Type	Method	Description
void	JitterUtil.render(SpriteAPI s, float x, float y, float minJitter, float maxJitter, int numCopies)
void	JitterUtil.render(SpriteAPI s, float x, float y, float maxJitter, int numCopies)
void	WarpingSpriteRendererUtil.renderNoBlendOrRotate(SpriteAPI sprite, float x, float y)
void	WarpingSpriteRendererUtil.renderNoBlendOrRotate(SpriteAPI sprite, float xOff, float yOff, boolean disableBlend)
static void	JitterUtil.renderWithJitter(SpriteAPI s, float x, float y, float maxJitter, int numCopies)
void	CampaignEngineGlowIndividualEngine.setGlow(SpriteAPI glow)