root/org.magiclib.util/MagicCampaign

MagicCampaign

open class MagicCampaign

A collection of methods to help do a variety of things on the campaign layer.

Constructors

MagicCampaign

constructor()

Types

lootType

enum lootType

Functions

addCustomPerson

open fun addCustomPerson(market: MarketAPI, firstName: String, lastName: String, portraitId: String, gender: Gender, factionId: String, rankId: String, postId: String, isMarketAdmin: Boolean, industrialPlanning_level: Integer, commScreenPosition: Integer): PersonAPI

Adds a custom character to a given market

addJumpPoint

open fun addJumpPoint(id: String, name: String, linkedPlanet: SectorEntityToken, orbitCenter: SectorEntityToken, orbitStartAngle: Float, orbitRadius: Float, orbitDays: Float): SectorEntityToken

Shorthand to add custom jump-point.

addSalvage

open fun addSalvage(cargo: CargoAPI, carrier: SectorEntityToken, type: MagicCampaign.lootType, lootID: String, amount: Int): CargoAPI

Adds items to a salvageable entity such as a debris field, a recoverable ship or a wreck.

addSimpleMarket

open fun addSimpleMarket(entity: SectorEntityToken, id: String, name: String, size: Integer, faction: String, isFreeport: Boolean, isHidden: Boolean, conditions: List<String>, industries: List<String>, hasStorage: Boolean, paidForStorage: Boolean, hasBlackmarket: Boolean, hasOpenmarket: Boolean, hasMilitarymarket: Boolean, isAbandonedStation: Boolean): MarketAPI

Adds a simple custom market to a system entity

createCaptainBuilder

open fun createCaptainBuilder(factionId: String): MagicCaptainBuilder

Creates a captain PersonAPI.

createDebrisField

open fun createDebrisField(id: String, radius: Float, density: Float, duration: Float, glowDuration: Float, salvageXp: Integer, defenderProbability: Float, defenderFaction: String, defenderFP: Integer, detectionMult: Float, discoverable: Boolean, discoveryXp: Integer, orbitCenter: SectorEntityToken, orbitStartAngle: Float, orbitRadius: Float, orbitDays: Float): SectorEntityToken

Creates a debris field with generic commodity loot to salvage

createDerelict

open fun createDerelict(variantId: String, condition: ShipCondition, discoverable: Boolean, discoveryXp: Integer, recoverable: Boolean, orbitCenter: SectorEntityToken, orbitStartAngle: Float, orbitRadius: Float, orbitDays: Float): SectorEntityToken

Creates a derelict ship at the desired emplacement.

createFleetBuilder

open fun createFleetBuilder(): MagicFleetBuilder

Creates a fleet with a defined flagship and optional escort.

findSuitableTarget

open fun findSuitableTarget(entityIDs: List<String>, marketFactions: List<String>, distance: String, seek_themes: List<String>, avoid_themes: List<String>, entities: List<String>, defaultToAnyEntity: Boolean, prioritizeUnexplored: Boolean, verbose: Boolean): SectorEntityToken

Returns a random target SectorEntityToken given the following parameters:

hyperspaceCleanup

open fun hyperspaceCleanup(system: StarSystemAPI)

Removes hyperspace clouds around the system, up to the outer-most jump point radius

isAvailableAtMarket

open fun isAvailableAtMarket(market: MarketAPI, market_id: List<String>, marketFaction_any: List<String>, marketFaction_alliedWith: Boolean, marketFaction_none: List<String>, marketFaction_enemyWith: Boolean, market_minSize: Int): Boolean

isAvailableToPlayer

open fun isAvailableToPlayer(player_minLevel: Int, min_days_elapsed: Int, min_fleet_size: Int, memKeys_all: Map<String, Boolean>, memKeys_any: Map<String, Boolean>, memKeys_none: Map<String, Boolean>, playerRelationship_atLeast: Map<String, Float>, playerRelationship_atMost: Map<String, Float>): Boolean

loadVariant

open fun loadVariant(path: String): ShipVariantAPI

Creates a ship variant from a regular variant file.

placeOnStableOrbit

open fun placeOnStableOrbit(object: SectorEntityToken, spin: Boolean)

Place an object on a stable orbit similar to the most approaching existing one that can be found

PlayerFleetSizeMultiplier

open fun PlayerFleetSizeMultiplier(enemyBaseFP: Float): Float

RelativeEffectiveStrength

open fun RelativeEffectiveStrength(enemyFleet: CampaignFleetAPI): Float

spawnFleet

open fun spawnFleet(fleet: CampaignFleetAPI, spawnLocation: SectorEntityToken, assignment: FleetAssignment, target: SectorEntityToken, isImportant: Boolean, transponderOn: Boolean, verbose: Boolean)

Spawn a fleet in its intended location with the proper order and target