com.fs.starfarer.api.ui.TooltipMakerAPI Interface Reference

Inheritance diagram for com.fs.starfarer.api.ui.TooltipMakerAPI:

Collaboration diagram for com.fs.starfarer.api.ui.TooltipMakerAPI:

Classes
interface	ActionListenerDelegate
interface	FleetMemberValueGetter
class	PlanetInfoParams
interface	StatModValueGetter
interface	TooltipCreator
enum	TooltipLocation

Public Member Functions
LabelAPI	addTitle (String text)
void	setTitleFont (String titleFont)
void	setTitleSmallOrbitron ()
void	setTitleFontColor (Color titleFontColor)
void	setParaFont (String paraFont)
void	setParaFontColor (Color paraFontColor)
void	setParaSmallInsignia ()
LabelAPI	addPara (String format, float pad, Color hl, String... highlights)
LabelAPI	addPara (String str, float pad)
LabelAPI	addPara (String str, Color color, float pad)
LabelAPI	addSectionHeading (String str, Alignment align, float pad)
LabelAPI	addSectionHeading (String str, Color textColor, Color bgColor, Alignment align, float pad)
void	beginGrid (float itemWidth, int cols)
void	beginGrid (float itemWidth, int cols, Color labelColor)
Object	addToGrid (int x, int y, String label, String value)
Object	addToGrid (int x, int y, String label, String value, Color valueColor)
void	setGridLabelColor (Color nameColor)
void	addGrid (float pad)
void	beginGridFlipped (float itemWidth, int cols, float valueWidth, float valuePad)
void	beginGridFlipped (float itemWidth, int cols, Color labelColor, float valueWidth, float valuePad)
void	addStatModGrid (float width, float valueWidth, float valuePad, float pad, MutableStat stat)
void	addStatModGrid (float width, float valueWidth, float valuePad, float pad, StatBonus stat)
void	addStatGridForShips (float width, float valueWidth, float valuePad, float pad, CampaignFleetAPI fleet, int maxNum, boolean ascending, FleetMemberValueGetter getter)
void	setGridFontDefault ()
void	setGridFont (String gridFont)
void	addStatModGrid (float width, float valueWidth, float valuePad, float pad, MutableStat stat, StatModValueGetter getter)
void	addStatModGrid (float width, float valueWidth, float valuePad, float pad, StatBonus stat, StatModValueGetter getter)
void	setParaSmallOrbitron ()
LabelAPI	addTitle (String text, Color color)
void	setParaFontVictor14 ()
void	addImage (String spriteName, float pad)
void	addImage (String spriteName, float width, float pad)
void	setParaFontDefault ()
void	setParaOrbitronLarge ()
void	setParaOrbitronVeryLarge ()
void	setParaInsigniaLarge ()
void	setParaInsigniaVeryLarge ()
void	setTitleOrbitronLarge ()
void	setTitleOrbitronVeryLarge ()
void	beginIconGroup ()
void	setIconSpacingMedium ()
void	setIconSpacingWide ()
void	addIcons (CommodityOnMarketAPI com, int num, IconRenderMode mode)
void	addIcons (CommoditySpecAPI com, int num, IconRenderMode mode)
void	addIconGroup (float pad)
void	addIconGroup (float rowHeight, float pad)
void	cancelGrid ()
void	addIconGroupAndCenter (float pad)
void	addStatModGrid (float width, float valueWidth, float valuePad, float pad, StatBonus stat, boolean showNonMods, StatModValueGetter getter)
void	showCargo (CargoAPI cargo, int max, boolean sort, float pad)
void	showShips (List< FleetMemberAPI > ships, int max, boolean sort, float pad)
UIPanelAPI	beginTable (FactionAPI faction, float itemHeight, Object ... columns)
UIPanelAPI	beginTable2 (FactionAPI faction, float itemHeight, boolean withBorder, boolean withHeader, Object ... columns)
UIPanelAPI	beginTable (Color base, Color dark, Color bright, float itemHeight, Object ... columns)
UIPanelAPI	beginTable (Color base, Color dark, Color bright, float itemHeight, boolean withBorder, boolean withHeader, Object ... columns)
Object	addRow (Object ... data)
Object	addRowWithGlow (Object ... data)
void	addTooltipToAddedRow (TooltipCreator tc, TooltipLocation loc)
void	addTooltipToAddedRow (TooltipCreator tc, TooltipLocation loc, boolean recreateEveryFrame)
void	addTable (String emptyText, int andMore, float pad)
void	setGridValueColor (Color valueColor)
TooltipMakerAPI	beginImageWithText (String spriteName, float imageHeight)
UIPanelAPI	addImageWithText (float pad)
void	addIconGroup (float rowHeight, int rows, float pad)
LabelAPI	addPara (String format, float pad, Color color, Color hl, String ... highlights)
void	setButtonFontDefault ()
void	setButtonFontVictor10 ()
void	setButtonFontVictor14 ()
ButtonAPI	addButton (String text, Object data, float width, float height, float pad)
ButtonAPI	addButton (String text, Object data, Color base, Color bg, float width, float height, float pad)
ButtonAPI	addButton (String text, Object data, Color base, Color bg, Alignment align, CutStyle style, float width, float height, float pad)
void	setBulletedListMode (String itemPrefix)
void	setBulletWidth (Float bulletWidth)
UIComponentAPI	addCustom (UIComponentAPI comp, float pad)
String	getBulletedListPrefix ()
void	addImage (String spriteName, float width, float height, float pad)
float	getTextWidthOverride ()
void	setTextWidthOverride (float textWidthOverride)
void	addImages (float width, float height, float pad, float imagePad, String ... spriteNames)
void	resetGridRowHeight ()
void	setLowGridRowHeight ()
void	setGridRowHeight (float gridSize)
String	shortenString (String in, float maxWidth)
void	addStatModGrid (float width, float valueWidth, float valuePad, float pad, MutableStat stat, boolean showNonMods, StatModValueGetter getter)
void	addShipList (int cols, int rows, float iconSize, Color baseColor, List< FleetMemberAPI > ships, float pad)
void	setParaFontOrbitron ()
LabelAPI	addPara (String format, float pad, Color[] hl, String ... highlights)
UIComponentAPI	addSpacer (float height)
void	addStoryPointUseInfo (float pad, float bonusXPFraction, boolean withNoSPNotification)
void	addStoryPointUseInfo (float pad, int numPoints, float bonusXPFraction, boolean withNoSPNotification)
void	setForceProcessInput (boolean forceProcessInput)
void	addPlaythroughDataPanel (float width, float height)
void	setBulletColor (Color bulletColor)
void	addRelationshipBar (PersonAPI person, float pad)
void	addRelationshipBar (PersonAPI person, float width, float pad)
void	addRelationshipBar (FactionAPI faction, float pad)
void	addRelationshipBar (FactionAPI faction, float width, float pad)
void	addRelationshipBar (float value, float pad)
void	addRelationshipBar (float value, float width, float pad)
void	addImportanceIndicator (PersonImportance importance, float width, float pad)
void	addTooltipToPrevious (TooltipCreator tc, TooltipLocation loc)
ButtonAPI	addAreaCheckbox (String text, Object data, Color base, Color bg, Color bright, float width, float height, float pad)
void	showShips (List< FleetMemberAPI > ships, int max, boolean sort, boolean showBaseHullForDHulls, float pad)
void	setGridFontSmallInsignia ()
void	showFullSurveyReqs (PlanetAPI planet, boolean withText, float pad)
void	showCost (String title, boolean withAvailable, float widthOverride, Color color, Color dark, float pad, String[] res, int[] quantities, boolean[] consumed)
void	showCost (String title, boolean withAvailable, Color color, Color dark, float pad, String[] res, int[] quantities)
void	showCost (Color color, Color dark, float pad, String[] res, int[] quantities)
void	showCost (String title, boolean withAvailable, float widthOverride, float heightOverride, Color color, Color dark, float pad, String[] res, int[] quantities, boolean[] consumed)
UIComponentAPI	getPrev ()
ButtonAPI	addAreaCheckbox (String text, Object data, Color base, Color bg, Color bright, float width, float height, float pad, boolean leftAlign)
UIComponentAPI	addSkillPanel (PersonAPI person, float pad)
UIComponentAPI	addSkillPanelOneColumn (PersonAPI person, float pad)
float	computeStringWidth (String in)
TextFieldAPI	addTextField (float width, float pad)
TextFieldAPI	addTextField (float width, String font, float pad)
TextFieldAPI	addTextField (float width, float height, String font, float pad)
ButtonAPI	addCheckbox (float width, float height, String text, UICheckboxSize size, float pad)
ButtonAPI	addCheckbox (float width, float height, String text, String font, Color textColor, UICheckboxSize size, float pad)
void	setAreaCheckboxFont (String areaCheckboxFont)
void	setAreaCheckboxFontDefault ()
UIComponentAPI	addLabelledValue (String label, String value, Color labelColor, Color valueColor, float width, float pad)
float	getHeightSoFar ()
IntelUIAPI	getIntelUI ()
EventProgressBarAPI	addEventProgressBar (BaseEventIntel intel, float pad)
UIComponentAPI	addCustomDoNotSetPosition (UIComponentAPI comp)
UIComponentAPI	addEventStageMarker (EventStageDisplayData data)
UIComponentAPI	addEventProgressMarker (BaseEventIntel intel)
TooltipMakerAPI	beginImageWithText (String spriteName, float imageHeight, float widthWithImage, boolean midAlignImage)
LabelAPI	addSectionHeading (String str, Color textColor, Color bgColor, Alignment align, float width, float pad)
TooltipMakerAPI	beginSubTooltip (float width)
void	endSubTooltip ()
void	setHeightSoFar (float height)
UIPanelAPI	createSectorMap (float w, float h, MapParams p, String title)
UIPanelAPI	createSectorMap (float w, float h, MapParams p, String title, Color color, Color dark)
float	getWidthSoFar ()
void	addTooltipToPrevious (TooltipCreator tc, TooltipLocation loc, boolean recreateEveryFrame)
LabelAPI	createLabel (String str, Color color)
LabelAPI	createLabel (String str, Color color, float maxTextWidth)
void	addTableHeaderTooltip (int colIndex, TooltipCreator tc)
void	addTableHeaderTooltip (int colIndex, String text)
UIPanelAPI	addSectorMap (float w, float h, StarSystemAPI system, float pad)
void	addTooltipTo (TooltipCreator tc, UIComponentAPI to, TooltipLocation loc)
void	addTooltipTo (TooltipCreator tc, UIComponentAPI to, TooltipLocation loc, boolean recreateEveryFrame)
UIComponentAPI	createRect (Color color, float thickness)
void	makeTableItemsClickable ()
void	setIdForAddedRow (Object id)
void	setExternalScroller (ScrollPanelAPI scroller)
ScrollPanelAPI	getExternalScroller ()
void	setBgAlpha (float bgAlpha)
void	setButtonFontOrbitron20 ()
void	setButtonFontOrbitron20Bold ()
void	setButtonFontOrbitron24 ()
void	setButtonFontOrbitron24Bold ()
void	showPlanetInfo (PlanetAPI planet, float pad)
void	showPlanetInfo (PlanetAPI planet, float w, float h, boolean withName, float pad)
void	showPlanetInfo (PlanetAPI planet, float w, float h, PlanetInfoParams params, float pad)
ButtonAPI	addCheckbox (float width, float height, String text, Object data, UICheckboxSize size, float pad)
ButtonAPI	addCheckbox (float width, float height, String text, Object data, String font, Color textColor, UICheckboxSize size, float pad)
UIComponentAPI	addSkillPanel (PersonAPI person, boolean admin, float pad)
UIComponentAPI	addSkillPanelOneColumn (PersonAPI person, boolean admin, float pad)
void	addCodexEntries (String title, Set< String > entryIds, boolean sort, float pad)
void	setCodexEntryId (String codexEntryId)
String	getCodexEntryId ()
void	setCodexEntryFleetMember (FleetMemberAPI member)
void	setCodexTempEntry (CodexEntryPlugin tempCodexEntry)
LabelAPI	addParaWithMarkup (String str, float pad)
LabelAPI	addParaWithMarkup (String str, Color color, float pad)
LabelAPI	addParaWithMarkup (String str, float pad, String... tokens)
LabelAPI	addParaWithMarkup (String str, Color color, float pad, String... tokens)
void	showCargo (CargoAPI cargo, int max, boolean sort, float pad, float itemHeight, float itemPad)
void	setActionListenerDelegate (ActionListenerDelegate delegate)
Public Member Functions inherited from com.fs.starfarer.api.ui.UIPanelAPI
PositionAPI	addComponent (UIComponentAPI custom)
void	removeComponent (UIComponentAPI component)
void	bringComponentToTop (UIComponentAPI c)
void	sendToBottom (UIComponentAPI c)
Public Member Functions inherited from com.fs.starfarer.api.ui.UIComponentAPI
PositionAPI	getPosition ()
void	render (float alphaMult)
void	processInput (List< InputEventAPI > events)
void	advance (float amount)
void	setOpacity (float opacity)
float	getOpacity ()

Detailed Description

Not just for tooltips; used for normal UI elements as well.

Author

Alex Mosolov

Copyright 2018 Fractal Softworks, LLC

Definition at line 35 of file TooltipMakerAPI.java.

Member Function Documentation

addAreaCheckbox() [1/2]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addAreaCheckbox	(	String	text,
		Object	data,
		Color	base,
		Color	bg,
		Color	bright,
		float	width,
		float	height,
		float	pad )

addAreaCheckbox() [2/2]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addAreaCheckbox	(	String	text,
		Object	data,
		Color	base,
		Color	bg,
		Color	bright,
		float	width,
		float	height,
		float	pad,
		boolean	leftAlign )

addButton() [1/3]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addButton	(	String	text,
		Object	data,
		Color	base,
		Color	bg,
		Alignment	align,
		CutStyle	style,
		float	width,
		float	height,
		float	pad )

addButton() [2/3]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addButton	(	String	text,
		Object	data,
		Color	base,
		Color	bg,
		float	width,
		float	height,
		float	pad )

addButton() [3/3]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addButton	(	String	text,
		Object	data,
		float	width,
		float	height,
		float	pad )

addCheckbox() [1/4]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addCheckbox	(	float	width,
		float	height,
		String	text,
		Object	data,
		String	font,
		Color	textColor,
		UICheckboxSize	size,
		float	pad )

addCheckbox() [2/4]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addCheckbox	(	float	width,
		float	height,
		String	text,
		Object	data,
		UICheckboxSize	size,
		float	pad )

addCheckbox() [3/4]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addCheckbox	(	float	width,
		float	height,
		String	text,
		String	font,
		Color	textColor,
		UICheckboxSize	size,
		float	pad )

Use the method with the Object data param

addCheckbox() [4/4]

ButtonAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addCheckbox	(	float	width,
		float	height,
		String	text,
		UICheckboxSize	size,
		float	pad )

Use the method with the Object data param

addCodexEntries()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addCodexEntries	(	String	title,
		Set< String >	entryIds,
		boolean	sort,
		float	pad )

addCustom()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addCustom	(	UIComponentAPI	comp,
		float	pad )

addCustomDoNotSetPosition()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addCustomDoNotSetPosition

(

UIComponentAPI

comp

)

Add a custom component without appending it to the bottom of the tooltip. Will need to call one of the .getPosition().inXXX methods to actually place it somewhere specific within the tooltip.

Parameters

comp

Returns

addEventProgressBar()

EventProgressBarAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addEventProgressBar	(	BaseEventIntel	intel,
		float	pad )

addEventProgressMarker()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addEventProgressMarker

(

BaseEventIntel

intel

)

addEventStageMarker()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addEventStageMarker

(

EventStageDisplayData

data

)

addGrid()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addGrid

(

float

pad

)

addIconGroup() [1/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addIconGroup

(

float

pad

)

addIconGroup() [2/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addIconGroup	(	float	rowHeight,
		float	pad )

addIconGroup() [3/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addIconGroup	(	float	rowHeight,
		int	rows,
		float	pad )

addIconGroupAndCenter()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addIconGroupAndCenter

(

float

pad

)

Assumes a single icon, hacky.

Parameters

pad

addIcons() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addIcons	(	CommodityOnMarketAPI	com,
		int	num,
		IconRenderMode	mode )

addIcons() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addIcons	(	CommoditySpecAPI	com,
		int	num,
		IconRenderMode	mode )

addImage() [1/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addImage	(	String	spriteName,
		float	pad )

addImage() [2/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addImage	(	String	spriteName,
		float	width,
		float	height,
		float	pad )

addImage() [3/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addImage	(	String	spriteName,
		float	width,
		float	pad )

addImages()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addImages	(	float	width,
		float	height,
		float	pad,
		float	imagePad,
		String ...	spriteNames )

addImageWithText()

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addImageWithText

(

float

pad

)

addImportanceIndicator()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addImportanceIndicator	(	PersonImportance	importance,
		float	width,
		float	pad )

addLabelledValue()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addLabelledValue	(	String	label,
		String	value,
		Color	labelColor,
		Color	valueColor,
		float	width,
		float	pad )

addPara() [1/5]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addPara	(	String	format,
		float	pad,
		Color	color,
		Color	hl,
		String ...	highlights )

addPara() [2/5]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addPara	(	String	format,
		float	pad,
		Color	hl,
		String...	highlights )

addPara() [3/5]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addPara	(	String	format,
		float	pad,
		Color[]	hl,
		String ...	highlights )

addPara() [4/5]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addPara	(	String	str,
		Color	color,
		float	pad )

addPara() [5/5]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addPara	(	String	str,
		float	pad )

addParaWithMarkup() [1/4]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addParaWithMarkup	(	String	str,
		Color	color,
		float	pad )

addParaWithMarkup() [2/4]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addParaWithMarkup	(	String	str,
		Color	color,
		float	pad,
		String...	tokens )

Markup: {{string}} -> highlights it {{color:<color>|string}} -> highlights it with color color can be h|good|bad|text|gray|blue or a color in settings.json If passing in tokens and needing to use a % in the base string: use %% (tokens means a String.format call) If NOT passing in tokens and needing to use a % in the base string: use % (no String.format call)

Parameters

str
color
pad
tokens

Returns

addParaWithMarkup() [3/4]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addParaWithMarkup	(	String	str,
		float	pad )

addParaWithMarkup() [4/4]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addParaWithMarkup	(	String	str,
		float	pad,
		String...	tokens )

addPlaythroughDataPanel()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addPlaythroughDataPanel	(	float	width,
		float	height )

addRelationshipBar() [1/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addRelationshipBar	(	FactionAPI	faction,
		float	pad )

addRelationshipBar() [2/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addRelationshipBar	(	FactionAPI	faction,
		float	width,
		float	pad )

addRelationshipBar() [3/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addRelationshipBar	(	float	value,
		float	pad )

addRelationshipBar() [4/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addRelationshipBar	(	float	value,
		float	width,
		float	pad )

addRelationshipBar() [5/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addRelationshipBar	(	PersonAPI	person,
		float	pad )

addRelationshipBar() [6/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addRelationshipBar	(	PersonAPI	person,
		float	width,
		float	pad )

addRow()

Object com.fs.starfarer.api.ui.TooltipMakerAPI.addRow

(

Object ...

data

)

Possible sets of data for a column: string | color, string | alignment, color, string | alignment, color, LabelAPI

Parameters

data

addRowWithGlow()

Object com.fs.starfarer.api.ui.TooltipMakerAPI.addRowWithGlow

(

Object ...

data

)

Possible sets of data for a column: string color, string alignment, color, string alignment, color, LabelAPI

Parameters

data

addSectionHeading() [1/3]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSectionHeading	(	String	str,
		Alignment	align,
		float	pad )

addSectionHeading() [2/3]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSectionHeading	(	String	str,
		Color	textColor,
		Color	bgColor,
		Alignment	align,
		float	pad )

addSectionHeading() [3/3]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSectionHeading	(	String	str,
		Color	textColor,
		Color	bgColor,
		Alignment	align,
		float	width,
		float	pad )

addSectorMap()

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSectorMap	(	float	w,
		float	h,
		StarSystemAPI	system,
		float	pad )

addShipList()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addShipList	(	int	cols,
		int	rows,
		float	iconSize,
		Color	baseColor,
		List< FleetMemberAPI >	ships,
		float	pad )

addSkillPanel() [1/2]

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSkillPanel	(	PersonAPI	person,
		boolean	admin,
		float	pad )

addSkillPanel() [2/2]

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSkillPanel	(	PersonAPI	person,
		float	pad )

addSkillPanelOneColumn() [1/2]

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSkillPanelOneColumn	(	PersonAPI	person,
		boolean	admin,
		float	pad )

addSkillPanelOneColumn() [2/2]

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSkillPanelOneColumn	(	PersonAPI	person,
		float	pad )

addSpacer()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addSpacer

(

float

height

)

addStatGridForShips()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStatGridForShips	(	float	width,
		float	valueWidth,
		float	valuePad,
		float	pad,
		CampaignFleetAPI	fleet,
		int	maxNum,
		boolean	ascending,
		FleetMemberValueGetter	getter )

addStatModGrid() [1/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStatModGrid	(	float	width,
		float	valueWidth,
		float	valuePad,
		float	pad,
		MutableStat	stat )

addStatModGrid() [2/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStatModGrid	(	float	width,
		float	valueWidth,
		float	valuePad,
		float	pad,
		MutableStat	stat,
		boolean	showNonMods,
		StatModValueGetter	getter )

addStatModGrid() [3/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStatModGrid	(	float	width,
		float	valueWidth,
		float	valuePad,
		float	pad,
		MutableStat	stat,
		StatModValueGetter	getter )

addStatModGrid() [4/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStatModGrid	(	float	width,
		float	valueWidth,
		float	valuePad,
		float	pad,
		StatBonus	stat )

addStatModGrid() [5/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStatModGrid	(	float	width,
		float	valueWidth,
		float	valuePad,
		float	pad,
		StatBonus	stat,
		boolean	showNonMods,
		StatModValueGetter	getter )

addStatModGrid() [6/6]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStatModGrid	(	float	width,
		float	valueWidth,
		float	valuePad,
		float	pad,
		StatBonus	stat,
		StatModValueGetter	getter )

addStoryPointUseInfo() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStoryPointUseInfo	(	float	pad,
		float	bonusXPFraction,
		boolean	withNoSPNotification )

addStoryPointUseInfo() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addStoryPointUseInfo	(	float	pad,
		int	numPoints,
		float	bonusXPFraction,
		boolean	withNoSPNotification )

addTable()

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTable	(	String	emptyText,
		int	andMore,
		float	pad )

addTableHeaderTooltip() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTableHeaderTooltip	(	int	colIndex,
		String	text )

addTableHeaderTooltip() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTableHeaderTooltip	(	int	colIndex,
		TooltipCreator	tc )

addTextField() [1/3]

TextFieldAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addTextField	(	float	width,
		float	height,
		String	font,
		float	pad )

addTextField() [2/3]

TextFieldAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addTextField	(	float	width,
		float	pad )

addTextField() [3/3]

TextFieldAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addTextField	(	float	width,
		String	font,
		float	pad )

addTitle() [1/2]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addTitle

(

String

text

)

addTitle() [2/2]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.addTitle	(	String	text,
		Color	color )

addToGrid() [1/2]

Object com.fs.starfarer.api.ui.TooltipMakerAPI.addToGrid	(	int	x,
		int	y,
		String	label,
		String	value )

addToGrid() [2/2]

Object com.fs.starfarer.api.ui.TooltipMakerAPI.addToGrid	(	int	x,
		int	y,
		String	label,
		String	value,
		Color	valueColor )

addTooltipTo() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTooltipTo	(	TooltipCreator	tc,
		UIComponentAPI	to,
		TooltipLocation	loc )

addTooltipTo() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTooltipTo	(	TooltipCreator	tc,
		UIComponentAPI	to,
		TooltipLocation	loc,
		boolean	recreateEveryFrame )

addTooltipToAddedRow() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTooltipToAddedRow	(	TooltipCreator	tc,
		TooltipLocation	loc )

addTooltipToAddedRow() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTooltipToAddedRow	(	TooltipCreator	tc,
		TooltipLocation	loc,
		boolean	recreateEveryFrame )

addTooltipToPrevious() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTooltipToPrevious	(	TooltipCreator	tc,
		TooltipLocation	loc )

addTooltipToPrevious() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.addTooltipToPrevious	(	TooltipCreator	tc,
		TooltipLocation	loc,
		boolean	recreateEveryFrame )

beginGrid() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.beginGrid	(	float	itemWidth,
		int	cols )

beginGrid() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.beginGrid	(	float	itemWidth,
		int	cols,
		Color	labelColor )

beginGridFlipped() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.beginGridFlipped	(	float	itemWidth,
		int	cols,
		Color	labelColor,
		float	valueWidth,
		float	valuePad )

beginGridFlipped() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.beginGridFlipped	(	float	itemWidth,
		int	cols,
		float	valueWidth,
		float	valuePad )

beginIconGroup()

void com.fs.starfarer.api.ui.TooltipMakerAPI.beginIconGroup

(

)

beginImageWithText() [1/2]

TooltipMakerAPI com.fs.starfarer.api.ui.TooltipMakerAPI.beginImageWithText	(	String	spriteName,
		float	imageHeight )

beginImageWithText() [2/2]

TooltipMakerAPI com.fs.starfarer.api.ui.TooltipMakerAPI.beginImageWithText	(	String	spriteName,
		float	imageHeight,
		float	widthWithImage,
		boolean	midAlignImage )

beginSubTooltip()

TooltipMakerAPI com.fs.starfarer.api.ui.TooltipMakerAPI.beginSubTooltip

(

float

width

)

beginTable() [1/3]

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.beginTable	(	Color	base,
		Color	dark,
		Color	bright,
		float	itemHeight,
		boolean	withBorder,
		boolean	withHeader,
		Object ...	columns )

beginTable() [2/3]

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.beginTable	(	Color	base,
		Color	dark,
		Color	bright,
		float	itemHeight,
		Object ...	columns )

Columns are pairs of <string name> <Float|Integer width>

beginTable() [3/3]

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.beginTable	(	FactionAPI	faction,
		float	itemHeight,
		Object ...	columns )

Columns are pairs of <string name> <Float|Integer width>

Parameters

faction
itemHeight
columns

beginTable2()

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.beginTable2	(	FactionAPI	faction,
		float	itemHeight,
		boolean	withBorder,
		boolean	withHeader,
		Object ...	columns )

cancelGrid()

void com.fs.starfarer.api.ui.TooltipMakerAPI.cancelGrid

(

)

computeStringWidth()

float com.fs.starfarer.api.ui.TooltipMakerAPI.computeStringWidth

(

String

in

)

createLabel() [1/2]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.createLabel	(	String	str,
		Color	color )

Create a label without adding it to the tooltip, so it can be added via addCustom() or passed in to a table row. Uses the current paragraph font.

createLabel() [2/2]

LabelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.createLabel	(	String	str,
		Color	color,
		float	maxTextWidth )

Create a label without adding it to the tooltip, so it can be added via addCustom() or passed in to a table row. Uses the current paragraph font.

createRect()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.createRect	(	Color	color,
		float	thickness )

createSectorMap() [1/2]

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.createSectorMap	(	float	w,
		float	h,
		MapParams	p,
		String	title )

TODO: maps don't seem to work right if the tooltip is recreated every frame, for now make sure to use the addTooltipToPrevious method that takes a boolean to turn that off.

createSectorMap() [2/2]

UIPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.createSectorMap	(	float	w,
		float	h,
		MapParams	p,
		String	title,
		Color	color,
		Color	dark )

TODO: maps don't seem to work right if the tooltip is recreated every frame, for now make sure to use the addTooltipToPrevious method that takes a boolean to turn that off.

endSubTooltip()

void com.fs.starfarer.api.ui.TooltipMakerAPI.endSubTooltip

(

)

Tooltip still needs to be added using addCustom() or similar.

getBulletedListPrefix()

String com.fs.starfarer.api.ui.TooltipMakerAPI.getBulletedListPrefix

(

)

getCodexEntryId()

String com.fs.starfarer.api.ui.TooltipMakerAPI.getCodexEntryId

(

)

getExternalScroller()

ScrollPanelAPI com.fs.starfarer.api.ui.TooltipMakerAPI.getExternalScroller

(

)

Only non-null if this tooltip was added to a CustomPanelAPI using addUIElement().

Returns

getHeightSoFar()

float com.fs.starfarer.api.ui.TooltipMakerAPI.getHeightSoFar

(

)

getIntelUI()

IntelUIAPI com.fs.starfarer.api.ui.TooltipMakerAPI.getIntelUI

(

)

Returns the intel UI; only works when creating small intel descriptions.

Returns

getPrev()

UIComponentAPI com.fs.starfarer.api.ui.TooltipMakerAPI.getPrev

(

)

getTextWidthOverride()

float com.fs.starfarer.api.ui.TooltipMakerAPI.getTextWidthOverride

(

)

getWidthSoFar()

float com.fs.starfarer.api.ui.TooltipMakerAPI.getWidthSoFar

(

)

makeTableItemsClickable()

void com.fs.starfarer.api.ui.TooltipMakerAPI.makeTableItemsClickable

(

)

resetGridRowHeight()

void com.fs.starfarer.api.ui.TooltipMakerAPI.resetGridRowHeight

(

)

setActionListenerDelegate()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setActionListenerDelegate

(

ActionListenerDelegate

delegate

)

Needs to be called before any methods that create UI elements that call the action listener (such as addButton) are called. Warning: If the TooltipMakerAPI already has an action listener, it will be overridden.

Parameters

delegate

setAreaCheckboxFont()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setAreaCheckboxFont

(

String

areaCheckboxFont

)

setAreaCheckboxFontDefault()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setAreaCheckboxFontDefault

(

)

setBgAlpha()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setBgAlpha

(

float

bgAlpha

)

Default is 0.85f.

setBulletColor()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setBulletColor

(

Color

bulletColor

)

setBulletedListMode()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setBulletedListMode

(

String

itemPrefix

)

setBulletWidth()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setBulletWidth

(

Float

bulletWidth

)

setButtonFontDefault()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setButtonFontDefault

(

)

setButtonFontOrbitron20()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setButtonFontOrbitron20

(

)

setButtonFontOrbitron20Bold()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setButtonFontOrbitron20Bold

(

)

setButtonFontOrbitron24()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setButtonFontOrbitron24

(

)

setButtonFontOrbitron24Bold()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setButtonFontOrbitron24Bold

(

)

setButtonFontVictor10()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setButtonFontVictor10

(

)

setButtonFontVictor14()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setButtonFontVictor14

(

)

setCodexEntryFleetMember()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setCodexEntryFleetMember

(

FleetMemberAPI

member

)

setCodexEntryId()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setCodexEntryId

(

String

codexEntryId

)

ID of codex entry to open with F2 when this tooltip is shown. Setting it to something and then back to null will not remove the "press F2" prompt etc. See: CodexDataV2.getXXXXEntryId() methods for how to get entry ids.

Parameters

codexEntryId

setCodexTempEntry()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setCodexTempEntry

(

CodexEntryPlugin

tempCodexEntry

)

setExternalScroller()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setExternalScroller

(

ScrollPanelAPI

scroller

)

setForceProcessInput()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setForceProcessInput

(

boolean

forceProcessInput

)

setGridFont()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setGridFont

(

String

gridFont

)

setGridFontDefault()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setGridFontDefault

(

)

setGridFontSmallInsignia()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setGridFontSmallInsignia

(

)

setGridLabelColor()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setGridLabelColor

(

Color

nameColor

)

setGridRowHeight()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setGridRowHeight

(

float

gridSize

)

setGridValueColor()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setGridValueColor

(

Color

valueColor

)

setHeightSoFar()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setHeightSoFar

(

float

height

)

setIconSpacingMedium()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setIconSpacingMedium

(

)

setIconSpacingWide()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setIconSpacingWide

(

)

setIdForAddedRow()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setIdForAddedRow

(

Object

id

)

To identify which row was clicked on.

Parameters

id

setLowGridRowHeight()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setLowGridRowHeight

(

)

setParaFont()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaFont

(

String

paraFont

)

setParaFontColor()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaFontColor

(

Color

paraFontColor

)

setParaFontDefault()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaFontDefault

(

)

setParaFontOrbitron()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaFontOrbitron

(

)

setParaFontVictor14()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaFontVictor14

(

)

setParaInsigniaLarge()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaInsigniaLarge

(

)

setParaInsigniaVeryLarge()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaInsigniaVeryLarge

(

)

setParaOrbitronLarge()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaOrbitronLarge

(

)

setParaOrbitronVeryLarge()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaOrbitronVeryLarge

(

)

setParaSmallInsignia()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaSmallInsignia

(

)

setParaSmallOrbitron()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setParaSmallOrbitron

(

)

setTextWidthOverride()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setTextWidthOverride

(

float

textWidthOverride

)

setTitleFont()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setTitleFont

(

String

titleFont

)

setTitleFontColor()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setTitleFontColor

(

Color

titleFontColor

)

setTitleOrbitronLarge()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setTitleOrbitronLarge

(

)

setTitleOrbitronVeryLarge()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setTitleOrbitronVeryLarge

(

)

setTitleSmallOrbitron()

void com.fs.starfarer.api.ui.TooltipMakerAPI.setTitleSmallOrbitron

(

)

shortenString()

String com.fs.starfarer.api.ui.TooltipMakerAPI.shortenString	(	String	in,
		float	maxWidth )

showCargo() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showCargo	(	CargoAPI	cargo,
		int	max,
		boolean	sort,
		float	pad )

Sort is based on stack size.

Parameters

cargo
max
sort
pad

showCargo() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showCargo	(	CargoAPI	cargo,
		int	max,
		boolean	sort,
		float	pad,
		float	itemHeight,
		float	itemPad )

showCost() [1/4]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showCost	(	Color	color,
		Color	dark,
		float	pad,
		String[]	res,
		int[]	quantities )

showCost() [2/4]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showCost	(	String	title,
		boolean	withAvailable,
		Color	color,
		Color	dark,
		float	pad,
		String[]	res,
		int[]	quantities )

showCost() [3/4]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showCost	(	String	title,
		boolean	withAvailable,
		float	widthOverride,
		Color	color,
		Color	dark,
		float	pad,
		String[]	res,
		int[]	quantities,
		boolean[]	consumed )

showCost() [4/4]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showCost	(	String	title,
		boolean	withAvailable,
		float	widthOverride,
		float	heightOverride,
		Color	color,
		Color	dark,
		float	pad,
		String[]	res,
		int[]	quantities,
		boolean[]	consumed )

showFullSurveyReqs()

void com.fs.starfarer.api.ui.TooltipMakerAPI.showFullSurveyReqs	(	PlanetAPI	planet,
		boolean	withText,
		float	pad )

showPlanetInfo() [1/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showPlanetInfo	(	PlanetAPI	planet,
		float	pad )

showPlanetInfo() [2/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showPlanetInfo	(	PlanetAPI	planet,
		float	w,
		float	h,
		boolean	withName,
		float	pad )

showPlanetInfo() [3/3]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showPlanetInfo	(	PlanetAPI	planet,
		float	w,
		float	h,
		PlanetInfoParams	params,
		float	pad )

showShips() [1/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showShips	(	List< FleetMemberAPI >	ships,
		int	max,
		boolean	sort,
		boolean	showBaseHullForDHulls,
		float	pad )

showShips() [2/2]

void com.fs.starfarer.api.ui.TooltipMakerAPI.showShips	(	List< FleetMemberAPI >	ships,
		int	max,
		boolean	sort,
		float	pad )

---

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

• src/com/fs/starfarer/api/ui/TooltipMakerAPI.java