com.fs.starfarer.api

Interface FactoryAPI

public interface FactoryAPI

Provides methods for creating various entities, such as fleets, markets, orbits, cargo, and more.

Method Summary

Modifier and Type	Method and Description
BattleAPI	createBattle(CampaignFleetAPI one, CampaignFleetAPI two)
CargoAPI	createCargo(boolean unlimitedStacks)
CargoStackAPI	createCargoStack(CargoAPI.CargoItemType type, java.lang.Object data, CargoAPI cargo)
OrbitAPI	createCircularOrbit(SectorEntityToken focus, float angle, float orbitRadius, float orbitDays)
OrbitAPI	createCircularOrbitPointingDown(SectorEntityToken focus, float angle, float orbitRadius, float orbitDays)
OrbitAPI	createCircularOrbitWithSpin(SectorEntityToken focus, float angle, float orbitRadius, float orbitDays, float spin)
CrewCompositionAPI	createCrewComposition()
CampaignFleetAPI	createEmptyFleet(FactionAPI faction, boolean aiMode)
CampaignFleetAPI	createEmptyFleet(java.lang.String factionId, java.lang.String name, boolean aiMode)
CampaignFleetAIAPI	createFleetAI(CampaignFleetAPI fleet)
FleetMemberAPI	createFleetMember(FleetMemberType type, ShipVariantAPI variant)
FleetMemberAPI	createFleetMember(FleetMemberType type, java.lang.String variantOrWingId)
JumpPointAPI	createJumpPoint(java.lang.String id, java.lang.String name)
MarketAPI	createMarket(java.lang.String id, java.lang.String name, int size)
MemoryAPI	createMemory()
CommMessageAPI	createMessage()
OfficerDataAPI	createOfficerData(PersonAPI person)
PersonAPI	createPerson()
CampaignProgressIndicatorAPI	createProgressIndicator(java.lang.String text, SectorEntityToken target, float durationDays)
FleetStubAPI	createStub()
void	setCurrentlyOpenMarket(MarketAPI currentlyOpenMarket)

Method Detail

createFleetMember

FleetMemberAPI createFleetMember(FleetMemberType type,
                                 java.lang.String variantOrWingId)

createCargo

CargoAPI createCargo(boolean unlimitedStacks)

createCrewComposition

CrewCompositionAPI createCrewComposition()

createJumpPoint

JumpPointAPI createJumpPoint(java.lang.String id,
                             java.lang.String name)

createCircularOrbit

OrbitAPI createCircularOrbit(SectorEntityToken focus,
                             float angle,
                             float orbitRadius,
                             float orbitDays)

createProgressIndicator

CampaignProgressIndicatorAPI createProgressIndicator(java.lang.String text,
                                                     SectorEntityToken target,
                                                     float durationDays)

createMemory

MemoryAPI createMemory()

createMarket

MarketAPI createMarket(java.lang.String id,
                       java.lang.String name,
                       int size)

createEmptyFleet

CampaignFleetAPI createEmptyFleet(java.lang.String factionId,
                                  java.lang.String name,
                                  boolean aiMode)

createPerson

PersonAPI createPerson()

createOfficerData

OfficerDataAPI createOfficerData(PersonAPI person)

createBattle

BattleAPI createBattle(CampaignFleetAPI one,
                       CampaignFleetAPI two)

createCargoStack

CargoStackAPI createCargoStack(CargoAPI.CargoItemType type,
                               java.lang.Object data,
                               CargoAPI cargo)

createMessage

CommMessageAPI createMessage()

createStub

FleetStubAPI createStub()

createCircularOrbitWithSpin

OrbitAPI createCircularOrbitWithSpin(SectorEntityToken focus,
                                     float angle,
                                     float orbitRadius,
                                     float orbitDays,
                                     float spin)

createFleetMember

FleetMemberAPI createFleetMember(FleetMemberType type,
                                 ShipVariantAPI variant)

createFleetAI

CampaignFleetAIAPI createFleetAI(CampaignFleetAPI fleet)

createCircularOrbitPointingDown

OrbitAPI createCircularOrbitPointingDown(SectorEntityToken focus,
                                         float angle,
                                         float orbitRadius,
                                         float orbitDays)

createEmptyFleet

CampaignFleetAPI createEmptyFleet(FactionAPI faction,
                                  boolean aiMode)

setCurrentlyOpenMarket

void setCurrentlyOpenMarket(MarketAPI currentlyOpenMarket)