Package com.fs.starfarer.api.campaign.impl.items

Class BaseSpecialItemPlugin

java.lang.Object

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

All Implemented Interfaces:

SpecialItemPlugin

Direct Known Subclasses:

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

public class BaseSpecialItemPlugin
extends Object
implements SpecialItemPlugin

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	BaseSpecialItemPlugin.BlueprintLister
static class	BaseSpecialItemPlugin.ItemCostLabelData

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.SpecialItemPlugin

SpecialItemPlugin.RightClickActionHelper, SpecialItemPlugin.SpecialItemRendererAPI

Field Summary

Fields

Modifier and Type	Field	Description
protected String	itemId
protected SpecialItemSpecAPI	spec
protected CargoStackAPI	stack

Constructor Summary

Constructors

Constructor	Description
BaseSpecialItemPlugin()

Method Summary

Modifier and Type	Method	Description
protected void	addBlueprintList(TooltipMakerAPI tooltip, String title, List<String> ids, int max, float opad, BaseSpecialItemPlugin.BlueprintLister lister)
protected void	addCostLabel(TooltipMakerAPI tooltip, float pad, CargoTransferHandlerAPI transferHandler, Object stackSource)
protected void	addFighterList(TooltipMakerAPI tooltip, String title, List<String> wings, int max, float opad)
protected void	addShipList(TooltipMakerAPI tooltip, String title, List<String> hulls, int max, float opad)
protected void	addWeaponList(TooltipMakerAPI tooltip, String title, List<String> weapons, int max, float opad)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded, CargoTransferHandlerAPI transferHandler, Object stackSource)
void	createTooltip(TooltipMakerAPI tooltip, boolean expanded, CargoTransferHandlerAPI transferHandler, Object stackSource, boolean useGray)
protected BaseSpecialItemPlugin.ItemCostLabelData	getCostLabelData(CargoStackAPI stack, CargoTransferHandlerAPI transferHandler, Object stackSource)
String	getDesignType()
String	getId()
protected float	getItemPriceMult()
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)
String	resolveDropParamsToSpecificItemData(String params, Random random)	Return null to have this item turn into nothing, or an empty string if it has no parameters.
void	setId(String id)	Called before init().
boolean	shouldRemoveOnRightClickAction()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

spec

protected SpecialItemSpecAPI spec

stack

protected CargoStackAPI stack

itemId

protected String itemId

Constructor Details

BaseSpecialItemPlugin

public BaseSpecialItemPlugin()

Method Details

getId

public String getId()

setId

public void setId(String id)

Description copied from interface: SpecialItemPlugin

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

Specified by:

setId in interface SpecialItemPlugin

init

public void init(CargoStackAPI stack)

Specified by:

init in interface SpecialItemPlugin

performRightClickAction

public void performRightClickAction(SpecialItemPlugin.RightClickActionHelper helper)

Specified by:

performRightClickAction in interface SpecialItemPlugin

performRightClickAction

public void performRightClickAction()

Specified by:

performRightClickAction in interface SpecialItemPlugin

hasRightClickAction

public boolean hasRightClickAction()

Specified by:

hasRightClickAction in interface SpecialItemPlugin

shouldRemoveOnRightClickAction

public boolean shouldRemoveOnRightClickAction()

Specified by:

shouldRemoveOnRightClickAction in interface SpecialItemPlugin

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
 boolean expanded,
 CargoTransferHandlerAPI transferHandler,
 Object stackSource)

Specified by:

createTooltip in interface SpecialItemPlugin

createTooltip

public void createTooltip(TooltipMakerAPI tooltip,
 boolean expanded,
 CargoTransferHandlerAPI transferHandler,
 Object stackSource,
 boolean useGray)

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface SpecialItemPlugin

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface SpecialItemPlugin

getName

public String getName()

Specified by:

getName in interface SpecialItemPlugin

getPrice

public int getPrice(MarketAPI market,
 SubmarketAPI submarket)

Specified by:

getPrice in interface SpecialItemPlugin

getItemPriceMult

protected float getItemPriceMult()

render

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

Specified by:

render in interface SpecialItemPlugin

addCostLabel

protected void addCostLabel(TooltipMakerAPI tooltip,
 float pad,
 CargoTransferHandlerAPI transferHandler,
 Object stackSource)

getCostLabelData

protected BaseSpecialItemPlugin.ItemCostLabelData getCostLabelData(CargoStackAPI stack,
 CargoTransferHandlerAPI transferHandler,
 Object stackSource)

resolveDropParamsToSpecificItemData

public String resolveDropParamsToSpecificItemData(String params,
 Random random)
                                           throws org.json.JSONException

Description copied from interface: SpecialItemPlugin

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

Specified by:

resolveDropParamsToSpecificItemData in interface SpecialItemPlugin

Returns:

Throws:

org.json.JSONException

addShipList

protected void addShipList(TooltipMakerAPI tooltip,
 String title,
 List<String> hulls,
 int max,
 float opad)

addWeaponList

protected void addWeaponList(TooltipMakerAPI tooltip,
 String title,
 List<String> weapons,
 int max,
 float opad)

addFighterList

protected void addFighterList(TooltipMakerAPI tooltip,
 String title,
 List<String> wings,
 int max,
 float opad)

addBlueprintList

protected void addBlueprintList(TooltipMakerAPI tooltip,
 String title,
 List<String> ids,
 int max,
 float opad,
 BaseSpecialItemPlugin.BlueprintLister lister)

getDesignType

public String getDesignType()

Specified by:

getDesignType in interface SpecialItemPlugin

getSpec

public SpecialItemSpecAPI getSpec()

Specified by:

getSpec in interface SpecialItemPlugin