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

Inheritance diagram for com.fs.starfarer.api.campaign.FleetOrStubAPI:

Public Member Functions
String	getId ()
LocationAPI	getContainingLocation ()
Vector2f	getLocation ()
FleetAssignmentDataAPI	getCurrentAssignment ()
List< FleetAssignmentDataAPI >	getAssignmentsCopy ()
void	addAssignment (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, Script onCompletion)
void	addAssignment (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, Script onCompletion)
void	addAssignment (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText)
void	addAssignmentAtStart (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, String actionText, Script onCompletion)
void	addAssignmentAtStart (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays, Script onCompletion)
void	addAssignment (FleetAssignment assignment, SectorEntityToken target, float maxDurationInDays)
boolean	isCurrentAssignment (FleetAssignment assignment)
void	removeFirstAssignmentIfItIs (FleetAssignment assignment)
void	removeFirstAssignment ()
void	clearAssignments ()
MemoryAPI	getMemoryWithoutUpdate ()
void	despawn ()
void	despawn (FleetDespawnReason reason, Object param)
boolean	isFleet ()
void	addScript (EveryFrameScript script)
List< FleetEventListener >	getEventListeners ()
void	addEventListener (FleetEventListener listener)
void	removeEventListener (FleetEventListener listener)
List< EveryFrameScript >	getScripts ()
Vector2f	getLocationInHyperspace ()

Detailed Description

Definition at line 14 of file FleetOrStubAPI.java.

Member Function Documentation

addAssignment() [1/4]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays )

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI.

addAssignment() [2/4]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		Script	onCompletion )

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI, and com.fs.starfarer.api.campaign.FleetStubAPI.

addAssignment() [3/4]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		String	actionText )

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI.

addAssignment() [4/4]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addAssignment	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		String	actionText,
		Script	onCompletion )

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI, and com.fs.starfarer.api.campaign.FleetStubAPI.

addAssignmentAtStart() [1/2]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addAssignmentAtStart	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		Script	onCompletion )

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

addAssignmentAtStart() [2/2]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addAssignmentAtStart	(	FleetAssignment	assignment,
		SectorEntityToken	target,
		float	maxDurationInDays,
		String	actionText,
		Script	onCompletion )

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

addEventListener()

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addEventListener

(

FleetEventListener

listener

)

addScript()

void com.fs.starfarer.api.campaign.FleetOrStubAPI.addScript

(

EveryFrameScript

script

)

clearAssignments()

void com.fs.starfarer.api.campaign.FleetOrStubAPI.clearAssignments

(

)

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI, and com.fs.starfarer.api.campaign.FleetStubAPI.

despawn() [1/2]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.despawn

(

)

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI.

despawn() [2/2]

void com.fs.starfarer.api.campaign.FleetOrStubAPI.despawn	(	FleetDespawnReason	reason,
		Object	param )

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI.

getAssignmentsCopy()

List< FleetAssignmentDataAPI > com.fs.starfarer.api.campaign.FleetOrStubAPI.getAssignmentsCopy

(

)

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

getContainingLocation()

LocationAPI com.fs.starfarer.api.campaign.FleetOrStubAPI.getContainingLocation

(

)

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI, and com.fs.starfarer.api.campaign.FleetStubAPI.

getCurrentAssignment()

FleetAssignmentDataAPI com.fs.starfarer.api.campaign.FleetOrStubAPI.getCurrentAssignment

(

)

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

getEventListeners()

List< FleetEventListener > com.fs.starfarer.api.campaign.FleetOrStubAPI.getEventListeners

(

)

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI, and com.fs.starfarer.api.campaign.FleetStubAPI.

getId()

String com.fs.starfarer.api.campaign.FleetOrStubAPI.getId

(

)

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

getLocation()

Vector2f com.fs.starfarer.api.campaign.FleetOrStubAPI.getLocation

(

)

Implemented in com.fs.starfarer.api.campaign.CampaignFleetAPI, and com.fs.starfarer.api.campaign.FleetStubAPI.

getLocationInHyperspace()

Vector2f com.fs.starfarer.api.campaign.FleetOrStubAPI.getLocationInHyperspace

(

)

getMemoryWithoutUpdate()

MemoryAPI com.fs.starfarer.api.campaign.FleetOrStubAPI.getMemoryWithoutUpdate

(

)

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

getScripts()

List< EveryFrameScript > com.fs.starfarer.api.campaign.FleetOrStubAPI.getScripts

(

)

isCurrentAssignment()

boolean com.fs.starfarer.api.campaign.FleetOrStubAPI.isCurrentAssignment

(

FleetAssignment

assignment

)

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

isFleet()

boolean com.fs.starfarer.api.campaign.FleetOrStubAPI.isFleet

(

)

removeEventListener()

void com.fs.starfarer.api.campaign.FleetOrStubAPI.removeEventListener

(

FleetEventListener

listener

)

removeFirstAssignment()

void com.fs.starfarer.api.campaign.FleetOrStubAPI.removeFirstAssignment

(

)

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

removeFirstAssignmentIfItIs()

void com.fs.starfarer.api.campaign.FleetOrStubAPI.removeFirstAssignmentIfItIs

(

FleetAssignment

assignment

)

Implemented in com.fs.starfarer.api.campaign.FleetStubAPI.

---

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

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