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

Public Member Functions
void	setVisualFade (float in, float out)
void	showFleetInfo (String titleOne, CampaignFleetAPI one, String titleTwo, CampaignFleetAPI two)
void	showFleetInfo (String titleOne, CampaignFleetAPI one, String titleTwo, CampaignFleetAPI two, FleetEncounterContextPlugin context)
void	showPersonInfo (PersonAPI person)
void	showSecondPerson (PersonAPI person)
void	hideSecondPerson ()
void	showPlanetInfo (SectorEntityToken planet)
void	showFleetMemberInfo (FleetMemberAPI member)
void	showImagePortion (String category, String id, float x, float y, float w, float h, float xOffset, float yOffset, float displayWidth, float displayHeight)
void	showImagePortion (String category, String id, float w, float h, float xOffset, float yOffset, float displayWidth, float displayHeight)
void	showImageVisual (InteractionDialogImageVisual visual)
CustomPanelAPI	showCustomPanel (float width, float height, CustomUIPanelPlugin plugin)
void	fadeVisualOut ()
void	showLoot (String title, CargoAPI otherCargo, boolean generatePods, CoreInteractionListener listener)
void	showLoot (String title, CargoAPI otherCargo, boolean canLeavePersonnel, boolean revealMode, boolean generatePods, CoreInteractionListener listener)
void	showCore (CoreUITabId tabId, SectorEntityToken other, boolean noCost, CoreInteractionListener listener)
void	showCore (CoreUITabId tabId, SectorEntityToken other, CoreInteractionListener listener)
void	showCore (CoreUITabId tabId, SectorEntityToken other, CoreUITradeMode mode, CoreInteractionListener listener)
void	hideCore ()
void	showNewGameOptionsPanel (CharacterCreationData data)
void	showPersonInfo (PersonAPI person, boolean minimalMode)
void	showPreBattleJoinInfo (String playerTitle, CampaignFleetAPI playerFleet, String titleOne, String titleTwo, FleetEncounterContextPlugin context)
void	showFleetMemberInfo (FleetMemberAPI member, boolean recoveryMode)
void	showFleetInfo (String titleOne, CampaignFleetAPI one, String titleTwo, CampaignFleetAPI two, FleetEncounterContextPlugin context, boolean recoveryMode)
void	finishFadeFast ()
void	saveCurrentVisual ()
void	restoreSavedVisual ()
void	closeCoreUI ()
void	showPersonInfo (PersonAPI person, boolean minimalMode, boolean withRelBar)
void	showThirdPerson (PersonAPI person)
void	hideThirdPerson ()
void	showCore (CoreUITabId tabId, SectorEntityToken other, Object custom, CoreInteractionListener listener)
void	showCore (CoreUITabId tabId, SectorEntityToken other, Object custom, CoreUITradeMode mode, CoreInteractionListener listener)
void	showMapMarker (SectorEntityToken marker, String title, Color titleColor, boolean withIntel, String icon, String text, Set< String > intelTags)
void	removeMapMarkerFromPersonInfo ()
void	showFirstPerson ()
void	hideFirstPerson ()
void	showLargePlanet (SectorEntityToken planet)
boolean	isShowingPersonInfo (PersonAPI person)

Detailed Description

Definition at line 13 of file VisualPanelAPI.java.

Member Function Documentation

closeCoreUI()

void com.fs.starfarer.api.campaign.VisualPanelAPI.closeCoreUI

(

)

fadeVisualOut()

void com.fs.starfarer.api.campaign.VisualPanelAPI.fadeVisualOut

(

)

finishFadeFast()

void com.fs.starfarer.api.campaign.VisualPanelAPI.finishFadeFast

(

)

hideCore()

void com.fs.starfarer.api.campaign.VisualPanelAPI.hideCore

(

)

hideFirstPerson()

void com.fs.starfarer.api.campaign.VisualPanelAPI.hideFirstPerson

(

)

hideSecondPerson()

void com.fs.starfarer.api.campaign.VisualPanelAPI.hideSecondPerson

(

)

hideThirdPerson()

void com.fs.starfarer.api.campaign.VisualPanelAPI.hideThirdPerson

(

)

isShowingPersonInfo()

boolean com.fs.starfarer.api.campaign.VisualPanelAPI.isShowingPersonInfo

(

PersonAPI

person

)

Only checks the "first" person, not second or third.

removeMapMarkerFromPersonInfo()

void com.fs.starfarer.api.campaign.VisualPanelAPI.removeMapMarkerFromPersonInfo

(

)

restoreSavedVisual()

void com.fs.starfarer.api.campaign.VisualPanelAPI.restoreSavedVisual

(

)

saveCurrentVisual()

void com.fs.starfarer.api.campaign.VisualPanelAPI.saveCurrentVisual

(

)

setVisualFade()

void com.fs.starfarer.api.campaign.VisualPanelAPI.setVisualFade	(	float	in,
		float	out
	)

showCore() [1/5]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showCore	(	CoreUITabId	tabId,
		SectorEntityToken	other,
		boolean	noCost,
		CoreInteractionListener	listener
	)

The noCost parameter isn't used; (other.isFreeTranser() || other.getFaction().isNeutralFaction) is used instead. Use the other showCore() method.

Parameters

tabId
other
noCost
listener

showCore() [2/5]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showCore	(	CoreUITabId	tabId,
		SectorEntityToken	other,
		CoreInteractionListener	listener
	)

showCore() [3/5]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showCore	(	CoreUITabId	tabId,
		SectorEntityToken	other,
		CoreUITradeMode	mode,
		CoreInteractionListener	listener
	)

showCore() [4/5]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showCore	(	CoreUITabId	tabId,
		SectorEntityToken	other,
		Object	custom,
		CoreInteractionListener	listener
	)

showCore() [5/5]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showCore	(	CoreUITabId	tabId,
		SectorEntityToken	other,
		Object	custom,
		CoreUITradeMode	mode,
		CoreInteractionListener	listener
	)

showCustomPanel()

CustomPanelAPI com.fs.starfarer.api.campaign.VisualPanelAPI.showCustomPanel	(	float	width,
		float	height,
		CustomUIPanelPlugin	plugin
	)

showFirstPerson()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showFirstPerson

(

)

showFleetInfo() [1/3]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showFleetInfo	(	String	titleOne,
		CampaignFleetAPI	one,
		String	titleTwo,
		CampaignFleetAPI	two
	)

showFleetInfo() [2/3]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showFleetInfo	(	String	titleOne,
		CampaignFleetAPI	one,
		String	titleTwo,
		CampaignFleetAPI	two,
		FleetEncounterContextPlugin	context
	)

showFleetInfo() [3/3]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showFleetInfo	(	String	titleOne,
		CampaignFleetAPI	one,
		String	titleTwo,
		CampaignFleetAPI	two,
		FleetEncounterContextPlugin	context,
		boolean	recoveryMode
	)

showFleetMemberInfo() [1/2]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showFleetMemberInfo

(

FleetMemberAPI

member

)

showFleetMemberInfo() [2/2]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showFleetMemberInfo	(	FleetMemberAPI	member,
		boolean	recoveryMode
	)

showImagePortion() [1/2]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showImagePortion	(	String	category,
		String	id,
		float	w,
		float	h,
		float	xOffset,
		float	yOffset,
		float	displayWidth,
		float	displayHeight
	)

showImagePortion() [2/2]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showImagePortion	(	String	category,
		String	id,
		float	x,
		float	y,
		float	w,
		float	h,
		float	xOffset,
		float	yOffset,
		float	displayWidth,
		float	displayHeight
	)

showImageVisual()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showImageVisual

(

InteractionDialogImageVisual

visual

)

showLargePlanet()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showLargePlanet

(

SectorEntityToken

planet

)

showLoot() [1/2]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showLoot	(	String	title,
		CargoAPI	otherCargo,
		boolean	canLeavePersonnel,
		boolean	revealMode,
		boolean	generatePods,
		CoreInteractionListener	listener
	)

showLoot() [2/2]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showLoot	(	String	title,
		CargoAPI	otherCargo,
		boolean	generatePods,
		CoreInteractionListener	listener
	)

showMapMarker()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showMapMarker	(	SectorEntityToken	marker,
		String	title,
		Color	titleColor,
		boolean	withIntel,
		String	icon,
		String	text,
		Set< String >	intelTags
	)

showNewGameOptionsPanel()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showNewGameOptionsPanel

(

CharacterCreationData

data

)

showPersonInfo() [1/3]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showPersonInfo

(

PersonAPI

person

)

showPersonInfo() [2/3]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showPersonInfo	(	PersonAPI	person,
		boolean	minimalMode
	)

showPersonInfo() [3/3]

void com.fs.starfarer.api.campaign.VisualPanelAPI.showPersonInfo	(	PersonAPI	person,
		boolean	minimalMode,
		boolean	withRelBar
	)

showPlanetInfo()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showPlanetInfo

(

SectorEntityToken

planet

)

showPreBattleJoinInfo()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showPreBattleJoinInfo	(	String	playerTitle,
		CampaignFleetAPI	playerFleet,
		String	titleOne,
		String	titleTwo,
		FleetEncounterContextPlugin	context
	)

showSecondPerson()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showSecondPerson

(

PersonAPI

person

)

showThirdPerson()

void com.fs.starfarer.api.campaign.VisualPanelAPI.showThirdPerson

(

PersonAPI

person

)

---

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

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