Package com.fs.starfarer.api.impl.campaign.rulecmd
package com.fs.starfarer.api.impl.campaign.rulecmd
-
ClassDescriptionAssumes BeginMission
false was called earlier. Usage: AbortWait $waitHandleAssumes BeginMissionfalse was called earlier. ActivateAbilityAddAbilityAddCommodityAddCreditsPer month can be negative.AddPotentialContactFirst param is one of: RESOURCES WEAPONS FIGHTER_CHIP SPECIAL SPECIAL catalytic_core 1 SPECIAL ship_bp paragon 1 WEAPONS ionpulser 1 AddRemoveAnyItemAddRemoveCommodityAddShipRemoveShipGives the player the specified number of story points.AddTextSmall "text OR text OR text"AddXPAdjustRepAdjustRepActivePersonAdjustRepActivePersonAnyNearbyFleetsHostileAndAwareApplyCRDamageApplyCRDamage $entity.fleetPoints 0.2 1 "Vindictive search" The first param is the base number of fleet points for the amount of CR damage to do - so, for an inspection it's based on the fleet points of the inspecting fleet, but it could also just be a flat number, or based on the player fleet if we wanted something like "half your ships take CR damage" The second param is the multiplier for that number (basically, making up for the fact that you can't say "$fleetPoints * 0.2" in rules - so the multiplication happens inside the command. ArePatrolsNearbyPerson must have been added to SectorAPI.getImportantPeople().Assumes active person is the mission giver.Call $referenceUse "Call" instead; same functionality, more accurate and shorter name.IsSeenByPatrolsCheckSetting <boolean setting in settings.json>Super unused.ActivateAbilityDespawnEntityCopyright 2015 Fractal Softworks, LLC DoCanAffordCheckUsage: AbortWait $waitHandleGiveOtherFleetAssignmentFor hostile activity ("HA") related tasks.HailPlayer Equivalent to: AddText "You're being hailed by the $faction $otherShipOrFleet." $faction.baseColor $hailing = true 0 The latter changes the "open comm link" text to a yellow "accept the comm request".Of the local market's faction, if any.HighlightComms Changes the "open comm link" option to a yellow color.For Hyperspace Topography ("HT") related tasks.gte = greater than or equals ImportanceAtLeast $importance testIncreaseSmugglingSuspicionAn amount of 1 is maxed-out suspicion. IsSeenByAnyFleetIsSeenByPatrolsIsSoughtByPatrolsKantaCMDLPTitheCalcIssues: The dialog greeting text is still the same They still try to engage in toll collection NOT CURRENTLY USED, SHOULDN'T BE AS IT DOESN'T WORK MakeNearbyFleetsHostile<optional: also know player identity regardless of transponder, defaults to false> MakeNearbyFleetsNonHostileOpenCoreTab<optional: onlyShowTargetTabShortcut> Doesn't matter unless the other fleet is also hostile or preventing disengage.Doesn't matter unless the other fleet is also hostile or preventing disengage.MakeOtherFleetAvoidContactCopyright 2015 Fractal Softworks, LLC MakeOtherFleetDoThingCopyright 2015 Fractal Softworks, LLC MakeOtherFleetGoAwayCopyright 2015 Fractal Softworks, LLC Prevents disengaging by player even if not hostile.Does not start an actual conversation, but does set them as the active person (so $heOrShe etc tokens work)Does not start an actual conversation, but does set them as the active person (so $heOrShe etc tokens work)Can pass in an invalid person ID to use the active person instead.NGCAddCargoNGCAddAptitudePointsNGCAddCredits$ngcAddOfficer $ngcSkipTutorialNGCAddShipNGCAddShip$ngcAddOfficer $ngcSkipTutorialNGCCanSkipTutorialNGCDoneNGCRemoveCargoNGCAddShipNGCSetAptitudeNGCSetCustomNGCSetDifficulty <difficulty, EASY | NORMAL>NGCSetSkillNGCSetStartingLocationNGCSetDifficulty <difficulty, EASY | NORMAL>OpenCoreTab<CoreUITradeMode (optional)> OpenCoreTab<CoreUITradeMode (optional)> Pauses all music, custom or otherwise.OpenCoreTab<CoreUITradeMode (optional)> For planetkiller ("PK") related tasks.PLAddEntryPlays custom music with the provided ID.PlayerFleetHasShipWithIdPlayerFleetHasShipWithIdPlayerHasCargo <cargo id - commodity, weapon, fighter, special item> <optional: quantity, default 1>The sound should be stereo.SetActiveMission $missionEventHandleAddRemoveCommodityRemoveContactRemoveShipPlayerFleetHasShipWithIdRemoveShipWithIdRepairAll <useSupplies, true by default> Copyright 2017 Fractal Softworks, LLCgte = greater than or equals RepGTERepLevel RepIsAtBestRepLevel RepIsAtWorstRepLevel lte = less than or equal RepLTERepLevel Sets active person to null.Restores visual saved by SaveCurrentVisual.Ends custom music playback and restarts whatever the default music would be.RollProbabilitySaves current visual so it can be restored using RestoreCurrentVisual.SetActiveMission $missionEventHandleSetCodexEntryIdSets the id of the entry to show when the Codex is opened, with an expiration of 0. SetColor $variable colorSetHistorianBlurbShownAfterDelaySetLaterSetNearbyFleetsVariableSetOptionColorSetOptionText optionId newTextSetFleetAllowJump <true|false> Copyright 2015 Fractal Softworks, LLCSetPersonHidden set person hidden boolean by character idSetPersonPortrait by person id, sprite as defined in settings "characters" sectionSetPromptText"-" is a special value for no text Copyright 2015 Fractal Softworks, LLC SetShortcutSetStoryColorSetStoryColorSetTooltipHighlightsShowSecondPersonShowImageVisualShowIntelMarkerShowPersonVisual <optional - minimal mode>Parameter is key from settings.json under "illustrations".ShowRemainingCapacityShowResCost<optional: consumed> (repeated); optional: width of each panel ShowResCost crew 1000 supplies 100 true 200 = requires 1000 crew, 100 supplis (consumed), each item is 200 pixels wide ShowSecondPersonShowSecondPersonSubCreditsTakeRepCheckFor Tri-Tachyon (inc) Business (c) TT_CMDUnhide person in CommDirectory by idUniqueEncounterSetActiveMission $missionEventHandleSetHistorianBlurbShownAfterDelay