com.fs.starfarer.api.campaign.SpecialItemPlugin Interface Reference

Inheritance diagram for com.fs.starfarer.api.campaign.SpecialItemPlugin:

Classes
interface	RightClickActionHelper
interface	SpecialItemRendererAPI

Public Member Functions
void	setId (String id)
void	init (CargoStackAPI stack)
String	getName ()
int	getPrice (MarketAPI market, SubmarketAPI submarket)
boolean	hasRightClickAction ()
void	performRightClickAction ()
void	performRightClickAction (RightClickActionHelper helper)
boolean	shouldRemoveOnRightClickAction ()
boolean	isTooltipExpandable ()
float	getTooltipWidth ()
void	createTooltip (TooltipMakerAPI tooltip, boolean expanded, CargoTransferHandlerAPI transferHandler, Object stackSource)
void	render (float x, float y, float w, float h, float alphaMult, float glowMult, SpecialItemRendererAPI renderer)
String	resolveDropParamsToSpecificItemData (String params, Random random) throws JSONException
String	getDesignType ()
SpecialItemSpecAPI	getSpec ()

Detailed Description

Definition at line 15 of file SpecialItemPlugin.java.

Member Function Documentation

createTooltip()

void com.fs.starfarer.api.campaign.SpecialItemPlugin.createTooltip	(	TooltipMakerAPI	tooltip,
		boolean	expanded,
		CargoTransferHandlerAPI	transferHandler,
		Object	stackSource )

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.GenericSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedHullmodItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedSubstratePlugin, com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.WormholeAnchorPlugin, and com.fs.starfarer.api.campaign.impl.items.WormholeScannerPlugin.

getDesignType()

String com.fs.starfarer.api.campaign.SpecialItemPlugin.getDesignType

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin.

getName()

String com.fs.starfarer.api.campaign.SpecialItemPlugin.getName

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WormholeAnchorPlugin.

getPrice()

int com.fs.starfarer.api.campaign.SpecialItemPlugin.getPrice	(	MarketAPI	market,
		SubmarketAPI	submarket )

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin.

getSpec()

SpecialItemSpecAPI com.fs.starfarer.api.campaign.SpecialItemPlugin.getSpec

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin.

getTooltipWidth()

float com.fs.starfarer.api.campaign.SpecialItemPlugin.getTooltipWidth

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedSubstratePlugin, com.fs.starfarer.api.campaign.impl.items.WormholeAnchorPlugin, and com.fs.starfarer.api.campaign.impl.items.WormholeScannerPlugin.

hasRightClickAction()

boolean com.fs.starfarer.api.campaign.SpecialItemPlugin.hasRightClickAction

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedHullmodItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedSubstratePlugin, com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WormholeScannerPlugin.

init()

void com.fs.starfarer.api.campaign.SpecialItemPlugin.init

(

CargoStackAPI

stack

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin.

isTooltipExpandable()

boolean com.fs.starfarer.api.campaign.SpecialItemPlugin.isTooltipExpandable

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedSubstratePlugin, com.fs.starfarer.api.campaign.impl.items.WormholeAnchorPlugin, and com.fs.starfarer.api.campaign.impl.items.WormholeScannerPlugin.

performRightClickAction() [1/2]

void com.fs.starfarer.api.campaign.SpecialItemPlugin.performRightClickAction

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WormholeScannerPlugin.

performRightClickAction() [2/2]

void com.fs.starfarer.api.campaign.SpecialItemPlugin.performRightClickAction

(

RightClickActionHelper

helper

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedHullmodItemPlugin, and com.fs.starfarer.api.campaign.impl.items.ShroudedSubstratePlugin.

render()

void com.fs.starfarer.api.campaign.SpecialItemPlugin.render	(	float	x,
		float	y,
		float	w,
		float	h,
		float	alphaMult,
		float	glowMult,
		SpecialItemRendererAPI	renderer )

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin.

resolveDropParamsToSpecificItemData()

String com.fs.starfarer.api.campaign.SpecialItemPlugin.resolveDropParamsToSpecificItemData	(	String	params,
		Random	random ) throws JSONException

Return null to have this item turn into nothing, or an empty string if it has no parameters.

Parameters

params

Returns

Exceptions

JSONException

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin.

setId()

void com.fs.starfarer.api.campaign.SpecialItemPlugin.setId

(

String

id

)

Called before init(). init() may not be called if there's no stack.

Parameters

id

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin.

shouldRemoveOnRightClickAction()

boolean com.fs.starfarer.api.campaign.SpecialItemPlugin.shouldRemoveOnRightClickAction

(

)

Implemented in com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin, com.fs.starfarer.api.campaign.impl.items.FighterBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.IndustryBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.JanusDevicePlugin, com.fs.starfarer.api.campaign.impl.items.ModSpecItemPlugin, com.fs.starfarer.api.campaign.impl.items.MultiBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShipBlueprintItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedHullmodItemPlugin, com.fs.starfarer.api.campaign.impl.items.ShroudedSubstratePlugin, com.fs.starfarer.api.campaign.impl.items.WeaponBlueprintItemPlugin, and com.fs.starfarer.api.campaign.impl.items.WormholeScannerPlugin.

---

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

• src/com/fs/starfarer/api/campaign/SpecialItemPlugin.java