com.fs.starfarer.api.campaign

Interface SpecialItemPlugin

All Known Implementing Classes:

BaseSpecialItemPlugin, FighterBlueprintItemPlugin, GenericSpecialItemPlugin, IndustryBlueprintItemPlugin, JanusDevicePlugin, ModSpecItemPlugin, MultiBlueprintItemPlugin, ShipBlueprintItemPlugin, ShroudedHullmodItemPlugin, ShroudedSubstratePlugin, WeaponBlueprintItemPlugin, WormholeAnchorPlugin, WormholeScannerPlugin

public interface SpecialItemPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SpecialItemPlugin.RightClickActionHelper
static interface	SpecialItemPlugin.SpecialItemRendererAPI

Method Summary

Modifier and Type	Method and Description
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded, CargoTransferHandlerAPI transferHandler, java.lang.Object stackSource)
java.lang.String	getDesignType()
java.lang.String	getName()
int	getPrice(MarketAPI market, SubmarketAPI submarket)
SpecialItemSpecAPI	getSpec()
float	getTooltipWidth()
boolean	hasRightClickAction()
void	init(CargoStackAPI stack)
boolean	isTooltipExpandable()
void	performRightClickAction()
void	performRightClickAction(SpecialItemPlugin.RightClickActionHelper helper)
void	render(float x, float y, float w, float h, float alphaMult, float glowMult, SpecialItemPlugin.SpecialItemRendererAPI renderer)
java.lang.String	resolveDropParamsToSpecificItemData(java.lang.String params, java.util.Random random) Return null to have this item turn into nothing, or an empty string if it has no parameters.
void	setId(java.lang.String id) Called before init().
boolean	shouldRemoveOnRightClickAction()

Method Detail

setId

void setId(java.lang.String id)

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

Parameters:

id -

init

void init(CargoStackAPI stack)

getName

java.lang.String getName()

getPrice

int getPrice(MarketAPI market,
             SubmarketAPI submarket)

hasRightClickAction

boolean hasRightClickAction()

performRightClickAction

void performRightClickAction()

performRightClickAction

void performRightClickAction(SpecialItemPlugin.RightClickActionHelper helper)

shouldRemoveOnRightClickAction

boolean shouldRemoveOnRightClickAction()

isTooltipExpandable

boolean isTooltipExpandable()

getTooltipWidth

float getTooltipWidth()

createTooltip

void createTooltip(TooltipMakerAPI tooltip,
                   boolean expanded,
                   CargoTransferHandlerAPI transferHandler,
                   java.lang.Object stackSource)

render

void render(float x,
            float y,
            float w,
            float h,
            float alphaMult,
            float glowMult,
            SpecialItemPlugin.SpecialItemRendererAPI renderer)

resolveDropParamsToSpecificItemData

java.lang.String resolveDropParamsToSpecificItemData(java.lang.String params,
                                                     java.util.Random random)
                                              throws org.json.JSONException

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

Parameters:

params -

Returns:

Throws:

org.json.JSONException

getDesignType

java.lang.String getDesignType()

getSpec

SpecialItemSpecAPI getSpec()