root/org.magiclib.campaign/MagicFleetBuilder

MagicFleetBuilder

open class MagicFleetBuilder

Creates a fleet with a defined flagship and optional escort.

Not all fields are required. Each `set` method has a comment showing the default value for if it is not used.

Example usage: 

MagicCampaign.createFleetBuilder()
        .setFleetName("Hegemony Attack Fleet")
        .setFleetFaction(Factions.HEGEMONY)
        .setFleetType(FleetTypes.TASK_FORCE)
        .setFlagshipName("HSS Onslaught")
        .setFlagshipVariant("onslaught_xiv_Elite")
        .setFlagshipAlwaysRecoverable(false)
        .setFlagshipAutofit(true)
        .setCaptain(theCaptain)
        .setSupportAutofit(true)
        .setReinforcementFaction(Factions.HEGEMONY)
        .create()
Content copied to clipboard

Author

Wisp

Constructors

Link copied to clipboard
constructor()
Creates a fleet with a defined flagship and optional escort.

Functions

Link copied to clipboard
open fun create(): CampaignFleetAPI
Link copied to clipboard
open fun setAssignment(assignment: FleetAssignment): MagicFleetBuilder
com.fs.starfarer.api.campaign.FleetAssignment.
Link copied to clipboard
open fun setAssignmentTarget(assignmentTarget: SectorEntityToken): MagicFleetBuilder
Where the fleet will go to execute its order.
Link copied to clipboard
open fun setCaptain(captain: PersonAPI): MagicFleetBuilder
Can be null for a random captain, otherwise use MagicCampaign.
Link copied to clipboard
open fun setFlagshipAlwaysRecoverable(flagshipAlwaysRecoverable: Boolean): MagicFleetBuilder
Default: false.
Link copied to clipboard
open fun setFlagshipAutofit(flagshipAutofit: Boolean): MagicFleetBuilder
Whether the flagship will be autofitted.
Link copied to clipboard
open fun setFlagshipName(flagshipName: String): MagicFleetBuilder
Default: automatically picked by the game.
Link copied to clipboard
open fun setFlagshipVariant(flagshipVariant: String): MagicFleetBuilder
Default: picks the first ship in the fleet after it has been sorted.
Link copied to clipboard
open fun setFleetFaction(fleetFaction: String): MagicFleetBuilder
Default: MagicVariables.BOUNTY_FACTION ("ML_bounty").
Link copied to clipboard
open fun setFleetName(fleetName: String): MagicFleetBuilder
Default: "Fleet".
Link copied to clipboard
open fun setFleetType(fleetType: String): MagicFleetBuilder
campaign.ids.FleetTypes, defaults to FleetTypes.
Link copied to clipboard
open fun setIsImportant(isImportant: Boolean): MagicFleetBuilder
Default: false.
Link copied to clipboard
open fun setMinFP(minFP: Int): MagicFleetBuilder
Minimal fleet size, can be used to adjust to the player's power.
Link copied to clipboard
open fun setQualityOverride(qualityOverride: Float): MagicFleetBuilder
Ship quality override.
Link copied to clipboard
open fun setReinforcementFaction(reinforcementFaction: String): MagicFleetBuilder
Reinforcement faction, if the fleet faction is a "neutral" faction without ships Default: fleetFaction.
Link copied to clipboard
open fun setSpawnLocation(spawnLocation: SectorEntityToken): MagicFleetBuilder
Where the fleet will spawn.
Link copied to clipboard
open fun setSupportAutofit(supportAutofit: Boolean): MagicFleetBuilder
Whether the preset ships will be autofitted.
Link copied to clipboard
open fun setSupportFleet(supportFleet: Map<String, Integer>): MagicFleetBuilder
MapOptional escort ship variants and how many of each to create.
Link copied to clipboard
open fun setTransponderOn(transponderOn: Boolean): MagicFleetBuilder
Default: false.
Link copied to clipboard
open fun setVariantsPath(variantsPath: String): MagicFleetBuilder
If not null, the script will try to find missing variant files there.

Properties

Link copied to clipboard
val fleetParams: FleetParamsV3