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

Class ModSpecItemPlugin

java.lang.Object

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

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

All Implemented Interfaces:

SpecialItemPlugin

public class ModSpecItemPlugin
extends BaseSpecialItemPlugin

Nested Class Summary

Nested classes/interfaces inherited from class com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin

BaseSpecialItemPlugin.BlueprintLister, BaseSpecialItemPlugin.ItemCostLabelData

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

SpecialItemPlugin.RightClickActionHelper, SpecialItemPlugin.SpecialItemRendererAPI

Field Summary

Fields inherited from class com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin

itemId, spec, stack

Constructor Summary

Constructors

Constructor and Description
ModSpecItemPlugin()

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	getModId()
java.lang.String	getName()
int	getPrice(MarketAPI market, SubmarketAPI submarket)
float	getTooltipWidth()
boolean	hasRightClickAction()
void	init(CargoStackAPI stack)
boolean	isTooltipExpandable()
void	performRightClickAction()
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.
boolean	shouldRemoveOnRightClickAction()

Methods inherited from class com.fs.starfarer.api.campaign.impl.items.BaseSpecialItemPlugin

addBlueprintList, addCostLabel, addFighterList, addShipList, addWeaponList, createTooltip, getCostLabelData, getId, getItemPriceMult, getSpec, performRightClickAction, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

ModSpecItemPlugin

public ModSpecItemPlugin()

Method Detail

init

public void init(CargoStackAPI stack)

Specified by:

init in interface SpecialItemPlugin

Overrides:

init in class BaseSpecialItemPlugin

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

Overrides:

render in class BaseSpecialItemPlugin

getPrice

public int getPrice(MarketAPI market,
                    SubmarketAPI submarket)

Specified by:

getPrice in interface SpecialItemPlugin

Overrides:

getPrice in class BaseSpecialItemPlugin

getName

public java.lang.String getName()

Specified by:

getName in interface SpecialItemPlugin

Overrides:

getName in class BaseSpecialItemPlugin

getDesignType

public java.lang.String getDesignType()

Specified by:

getDesignType in interface SpecialItemPlugin

Overrides:

getDesignType in class BaseSpecialItemPlugin

createTooltip

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

Specified by:

createTooltip in interface SpecialItemPlugin

Overrides:

createTooltip in class BaseSpecialItemPlugin

getTooltipWidth

public float getTooltipWidth()

Specified by:

getTooltipWidth in interface SpecialItemPlugin

Overrides:

getTooltipWidth in class BaseSpecialItemPlugin

isTooltipExpandable

public boolean isTooltipExpandable()

Specified by:

isTooltipExpandable in interface SpecialItemPlugin

Overrides:

isTooltipExpandable in class BaseSpecialItemPlugin

hasRightClickAction

public boolean hasRightClickAction()

Specified by:

hasRightClickAction in interface SpecialItemPlugin

Overrides:

hasRightClickAction in class BaseSpecialItemPlugin

shouldRemoveOnRightClickAction

public boolean shouldRemoveOnRightClickAction()

Specified by:

shouldRemoveOnRightClickAction in interface SpecialItemPlugin

Overrides:

shouldRemoveOnRightClickAction in class BaseSpecialItemPlugin

performRightClickAction

public void performRightClickAction()

Specified by:

performRightClickAction in interface SpecialItemPlugin

Overrides:

performRightClickAction in class BaseSpecialItemPlugin

resolveDropParamsToSpecificItemData

public java.lang.String resolveDropParamsToSpecificItemData(java.lang.String params,
                                                            java.util.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

Overrides:

resolveDropParamsToSpecificItemData in class BaseSpecialItemPlugin

Returns:

Throws:

org.json.JSONException

getModId

public java.lang.String getModId()