Package com.fs.starfarer.api

Interface EveryFrameScript

All Known Subinterfaces:
EveryFrameScriptWithCleanup, SensorGhost
All Known Implementing Classes:
AbyssalDrifterGhost, AbyssalLightBonus, AbyssalLightEntityPlugin.AbyssalLightSoundStopper, AbyssalLightEntityPlugin.DwellerEncounterScript, AbyssalLocationDespawner, AddRaidObjective.CustomRaidObjectiveAdder, AFavorForKanta, AnalyzeEntityMissionIntel, ANewHope, AngryVIPTransport, AsteroidImpact, AutoDespawnScript, BarCMD.BarAmbiencePlayer, BarEventManager, BaseAbilityPlugin, BaseAssignmentAI, BaseBarEventIntel, BaseCampaignEventListenerAndScript, BaseCustomBounty, BaseDisruptIndustry, BaseDurationAbility, BaseEventIntel, BaseEventManager, BaseHistorianOffer, BaseHistorianOfferWithLocation, BaseHubMission, BaseIntelPlugin, BaseLimitedFleetManager, BaseMissionIntel, BaseRouteFleetManager, BaseSensorGhost, BaseToggleAbility, BasicExampleGADataFromRuins, BlockadeFGI, BlueprintIntel, BornanewFilesFalseIdols, BreadcrumbIntel, BreadcrumbIntelV2, CampaignTutorialScript, CargoPodsIntel, CargoPodsResponse, ChargerGhost, CheapCommodityMission, CodexIntelAdder, CodexUpdateIntel, CommerceBountyManager, CommodityProductionMission, CommSnifferIntel, ContactIntel, CoreDiscoverEntityPlugin.SalvorsTallyAdder, CoreEventProbabilityManager, CoreScript, CoronalTapParticleScript, CryosleeperIntel, CustomProductionContract, DeadDropMission, DecivIntel, DecivTracker, DelayedActionScript, DelayedBlueprintLearnScript, DelayedFleetEncounter, DeliveryFailureConsequences, DeliveryMissionIntel, DisposableAggroAssignmentAI, DisposableFleetManager, DisposableHostileActivityFleetManager, DisposableLuddicPathFleetManager, DisposablePirateFleetManager, DisposableThreatFleetManager, DisruptCompetitorMission, DisruptHeavyIndustry, DisruptSpaceport, DistressCallAbility, DistressCallIntel, DistressCallNormalAssignmentAI, DistressCallPirateAmbushAssignmentAI, DistressCallPirateAmbushTrapAssignmentAI, DistressCallResponseAssignmentAI, DistressCallResponsePirateAssignmentAI, DonationOffer, DurationAbilityWithCost2, EchoGhost, EconomyFleetAssignmentAI, EconomyFleetRouteManager, EmergencyBurnAbility, EncounterManager, EncounterTricksterGhost, ExtractionMission, FactionCommissionIntel, FactionHostilityIntel, FactionHostilityManager, FieldRepairsScript, FighterBlueprintOffer, FleetAdvanceScript, FleetCreatorMission, FleetGroupIntel, FleetLogIntel, FractureJumpAbility, GAAtTheGates, GABaseMission, GABuyArtifact, GACelestialObject, GADataFromRuins, GADeliverVIP, GADerelictArtifact, GADetectHyperspaceOddity, GAFindingCoureuse, GAIntro, GAIntro2, GAKallichore, GalatiaMarketScript, GAOutpost, GAProbePackage, GAProjectZiggurat, GAPZPostEncounters, GARansomResearcher, GAReturnHamatsu, GATalkToBaird, GATalkToSebestyen, GateExplosionScript, GateExplosionScript.SystemCutOffRemoverScript, GateHaulerIntel, GateIntel, GATransverseJump, GBIGenerateSlipstream, GenerateSlipsurgeAbility, GenerateSlipsurgeAbility.ExpandStormRadiusScript, GenerateSlipsurgeAbility.SlipsurgeEffectScript, GenerateSlipsurgeAbility.SlipsurgeFadeInScript, GenericMissionManager, GenericRaidFGI, GensHannanMachinations, GoDarkAbility, GraviticScanAbility, GuideGhost, HA_CMD.StationKingScript, HandMeDownFreighter, HassleNPCScript, HasslePlayerScript, HegemonyInspectionIntel, HegemonyInspectionManager, HijackingMission, HostileActivityEventIntel, HostileActivityManager, HTFactorTracker, HubMissionWithBarEvent, HubMissionWithSearch, HubMissionWithTriggers, HubMissionWithTriggers.AddTagAfterDelay, HubMissionWithTriggers.RunScriptAfterDelay, HubMissionWithTriggers.SetMemoryValueAfterDelay, HypershuntIntel, HyperspaceTopographyEventIntel, HyperStormBoost, IntelMarkerIntel, InterdictionPulseAbility, InterdictionPulseAbility.IPReactionScript, JailbreakMission, KantaCMD.DelayedInstallItemScript, KantaCMD.FusionLampColorChanger, KantaCMD.KantaFavorTrigger, KnightsOfLuddTakeoverExpedition, LeashScript, LeviathanCalfGhost, LeviathanGhost, LostOutpostCrewReturnLuddicFind, LuddicChurchImmigrationDeal, LuddicKnightErrant, LuddicPathBaseIntel, LuddicPathBaseManager, LuddicPathCellsIntel, LuddicPathFleetManager, LuddicPilgrimsPath, LuddicPilgrimTransport, LuddicShrineIntel, MapMarkerIntel, MarketCMD.BombardmentAnimation, MercAssignmentAIV2, MercFleetManagerV2, MercsOnTheRun, MessageIntel, MilitaryCustomBounty, MilitaryResponseScript, MinnowGhost, MiscellaneousThemeGenerator.MakeCoronalTapFaceNearestStar, MiscFleetAssignmentAI, MiscFleetRouteManager, MissionFleetAutoDespawn, MissionFleetInterceptPlayerIfNearby, MissionFleetStopPursuingPlayer, MoteParticleScript, NewMessagesIntel, NoGhost, NPCHassler, OfficerManagerEvent, PatrolAssignmentAI, PatrolAssignmentAIV2, PatrolAssignmentAIV4, PatrolFleetManager, PatrolFleetManagerV2, PerseanLeagueBlockade, PerseanLeagueMembership, PerseanLeaguePunitiveExpedition, PersonalFleetHoracioCaden, PersonalFleetOxanaHyder, PersonalFleetScript, PersonBountyIntel, PersonBountyManager, PilgrimageFleetAssignmentAI, PilgrimageFleetRouteManager, PirateActivityIntel, PirateBaseIntel, PirateBaseManager, PirateFleetManager, PirateSystemBounty, PlanetaryShieldIntel, PlayerRelatedPirateBaseManager, PlayerVisibleFleetManager, PLIntel, PopulationAndInfrastructure.LampRemover, PortsideBarData, ProcurementMission, ProcurementMissionIntel, ProductionReportIntel, PromoteOfficerIntel, PunitiveExpeditionIntel, PunitiveExpeditionManager, RacerGhost, RaidAssignmentAI, RaidIntel, RaidSecretOutpostMission, RecoverAPlanetkiller, RemnantAssignmentAI, RemnantGhost, RemnantNexusIntel, RemnantSeededFleetManager, RemnantStationFleetManager, RemoraGhost, RemoteSurveyAbility, RemoteSurveyDataForPlanetIntel, ReversePolarityToggle, RogueMinerMiscFleetManager, RouteFleetAssignmentAI, RuinsDataSwapMission, RuinsFleetRouteManager, SalvorsTallyIntel, SaveNagScript, ScavengeAbility, ScavengerFleetAssignmentAI, ScavengerPiracyScript, ScientistAICoreIntel, SDFBase, SDFHegemony, SDFLeague, SDFLuddicChurch, SDFTriTachyon, SecurityCodes, SeededFleetManager, SensorBurstAbility, SensorGhostManager, ShipBlueprintOffer, ShipGhost, ShoveFleetScript, ShrineCMD.ShrineMusicStopFailsafe, SimUpdateIntel, SindrianDiktatFuelDeal, SindrianDiktatPunitiveExpedition, SlipstreamManager, SmugglingFactionChangeScript, SmugglingMission, SmugglingScanScript, SourceBasedFleetManager, SpecialItemOffer, SpeedReduction, SpySatDeployment, StormcallerGhost, StormTricksterGhost, StrandedGiveTJScript, SurplusShipHull, SurveyDataForPlanetIntel, SurveyPlanetMissionIntel, SustainedBurnAbility, SwordOfEventide, SwordOfEventide.SOEMusicPlayer, SystemBountyIntel, SystemBountyManager, TacticallyBombardColony, TestFleetGroupIntel, TestGhost, TheUsurpers, ThreatFleetBehaviorScript, TOffAlarm, ToggleAbilityWithCost, TradeFleetDepartureIntel, TransponderAbility, TriggerFleetAssignmentAI, TriggerFleetTravelAssignmentAI, TriTachLoanIncentiveScript, TriTachLoanIntel, TriTachyonCommerceRaiding, TriTachyonDeal, TTMercenaryAttack, TTMercenaryReversedAttack, TutorialLeashAssignmentAI, TutorialMissionIntel, UnderworldCustomBounty, WarfleetAssignmentAI, WarningBeaconIntel, WarSimScript, WeaponBlueprintOffer, WormholeIntel, ZigguratGhost, ZigLeashAssignmentAI
public interface EveryFrameScript

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    advance(float amount)
    Use SectorAPI.getClock() to convert to campaign days.
    boolean
    isDone()
     
    boolean
    runWhilePaused()
     

  • Method Details

    • isDone

      boolean isDone()
      Returns:
      true when the script is finished and can be cleaned up by the engine.

    • runWhilePaused

      boolean runWhilePaused()
      Returns:
      whether advance() should be called while the campaign engine is paused.

    • advance

      void advance(float amount)
      Use SectorAPI.getClock() to convert to campaign days.
      Parameters:
      amount - seconds elapsed during the last frame.