Package com.fs.starfarer.api.impl.campaign.missions.hub

Class BaseHubMission.LocData

java.lang.Object

com.fs.starfarer.api.impl.campaign.missions.hub.BaseHubMission.LocData

Enclosing class:

BaseHubMission

public static class BaseHubMission.LocData
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
SectorEntityToken	centerOn
BaseThemeGenerator.EntityLocation	loc
boolean	removeOnMissionOver
LocationAPI	system
CampaignTerrainAPI	terrain
BaseHubMission.EntityLocationType	type

Constructor Summary

Constructors

Constructor	Description
LocData(SectorEntityToken centerOn)	Set to a zero-radius orbit around centerOn.
LocData(SectorEntityToken centerOn, boolean removeOnMissionOver)	Set to a zero-radius orbit around centerOn.
LocData(BaseHubMission.EntityLocationType type, SectorEntityToken centerOn, LocationAPI system)	Generate an EntityLocation based on the type.
LocData(BaseHubMission.EntityLocationType type, SectorEntityToken centerOn, LocationAPI system, boolean removeOnMissionOver)	Generate an EntityLocation based on the type.
LocData(BaseThemeGenerator.EntityLocation loc, LocationAPI system)	At provided EntityLocation.
LocData(BaseThemeGenerator.EntityLocation loc, LocationAPI system, boolean removeOnMissionOver)	At provided EntityLocation.
LocData(org.lwjgl.util.vector.Vector2f loc, LocationAPI system)	At fixed coordinates, no orbit.
LocData(org.lwjgl.util.vector.Vector2f loc, LocationAPI system, boolean removeOnMissionOver)	At fixed coordinates, no orbit.

Method Summary

Modifier and Type	Method	Description
void	placeEntity(SectorEntityToken entity)
boolean	updateLocIfNeeded(BaseHubMission mission, String entityId)

Methods inherited from class java.lang.Object

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

Field Details

terrain

public CampaignTerrainAPI terrain

loc

public BaseThemeGenerator.EntityLocation loc

type

public BaseHubMission.EntityLocationType type

centerOn

public SectorEntityToken centerOn

system

public LocationAPI system

removeOnMissionOver

public boolean removeOnMissionOver

Constructor Details

LocData

public LocData(BaseThemeGenerator.EntityLocation loc,
 LocationAPI system,
 boolean removeOnMissionOver)

At provided EntityLocation.

LocData

public LocData(BaseHubMission.EntityLocationType type,
 SectorEntityToken centerOn,
 LocationAPI system,
 boolean removeOnMissionOver)

Generate an EntityLocation based on the type. centerOn is used if type is ORBITING_PARAM.

LocData

public LocData(SectorEntityToken centerOn,
 boolean removeOnMissionOver)

Set to a zero-radius orbit around centerOn.

LocData

public LocData(org.lwjgl.util.vector.Vector2f loc,
 LocationAPI system,
 boolean removeOnMissionOver)

At fixed coordinates, no orbit.

LocData

public LocData(BaseThemeGenerator.EntityLocation loc,
 LocationAPI system)

At provided EntityLocation.

LocData

public LocData(BaseHubMission.EntityLocationType type,
 SectorEntityToken centerOn,
 LocationAPI system)

Generate an EntityLocation based on the type. centerOn is used if type is ORBITING_PARAM.

LocData

public LocData(SectorEntityToken centerOn)

Set to a zero-radius orbit around centerOn.

LocData

public LocData(org.lwjgl.util.vector.Vector2f loc,
 LocationAPI system)

At fixed coordinates, no orbit.

Method Details

updateLocIfNeeded

public boolean updateLocIfNeeded(BaseHubMission mission,
 String entityId)

placeEntity

public void placeEntity(SectorEntityToken entity)