Uses of Interface
com.fs.starfarer.api.campaign.rules.CommandPlugin

Packages that use CommandPlugin

Package	Description
com.fs.starfarer.api.impl.campaign.rulecmd
com.fs.starfarer.api.impl.campaign.rulecmd.academy
com.fs.starfarer.api.impl.campaign.rulecmd.missions
com.fs.starfarer.api.impl.campaign.rulecmd.newgame
com.fs.starfarer.api.impl.campaign.rulecmd.salvage

Uses of CommandPlugin in com.fs.starfarer.api.impl.campaign.rulecmd

Classes in com.fs.starfarer.api.impl.campaign.rulecmd that implement CommandPlugin

Modifier and Type	Class	Description
class	AbortMission	Assumes BeginMission false was called earlier.
class	AbortWait	Usage: AbortWait $waitHandle
class	AcceptMission	Assumes BeginMission false was called earlier.
class	ActivateAbility	ActivateAbility
class	AddAbility	AddAbility
class	AddCommodity	AddCommodity
class	AddCredits	AddCredits
class	AddOption
class	AddPopGrowth	Per month can be negative.
class	AddPotentialContact	AddPotentialContact
class	AddRemoveAnyItem	First param is one of: RESOURCES WEAPONS FIGHTER_CHIP SPECIAL SPECIAL catalytic_core 1 SPECIAL ship_bp paragon 1 WEAPONS ionpulser 1 AddRemoveAnyItem
class	AddRemoveCommodity	AddRemoveCommodity
class	AddSelector
class	AddShip	AddShip
class	AddShipToOtherFleet	RemoveShip
class	AddStoryPoints	Gives the player the specified number of story points.
class	AddText
class	AddTextSmall	AddTextSmall "text OR text OR text"
class	AddXP	AddXP
class	AdjustRep	AdjustRep
class	AdjustRepActivePerson	AdjustRepActivePerson
class	AdjustRepPerson	AdjustRepActivePerson
class	AnyNearbyFleetsHostileAndAware	AnyNearbyFleetsHostileAndAware
class	ApplyCRDamage	ApplyCRDamage ApplyCRDamage $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.
class	ArePatrolsNearby	ArePatrolsNearby
class	BaseCommandPlugin
class	BeginConversation	Person must have been added to SectorAPI.getImportantPeople().
class	BeginMission	Assumes active person is the mission giver.
class	BroadcastCancelPlayerAction
class	BroadcastPlayerAction
class	BroadcastPlayerWaitAction
class	Call	Call $reference
class	CallEvent	Use "Call" instead; same functionality, more accurate and shorter name.
class	CaresAboutTransponder	IsSeenByPatrols
class	CargoScan
class	CargoScanApplyResult
class	CheckSetting	CheckSetting <boolean setting in settings.json>
class	ClearActiveMission	Super unused.
class	ClearText
class	CustomsInspectionApplyRepLoss
class	CustomsInspectionApplyResult
class	CustomsInspectionGenerateResult
class	DeactivateAbility	ActivateAbility
class	DespawnEntity	DespawnEntity Copyright 2015 Fractal Softworks, LLC
class	DismissDialog
class	DoCanAffordCheck	DoCanAffordCheck
class	DumpMemory	Usage: AbortWait $waitHandle
class	DwellerCMD
class	EndConversation
class	expire
class	FireAll
class	FireBest
class	FleetDesc
class	GiveOtherFleetAssignment	GiveOtherFleetAssignment
class	HA_CMD	For hostile activity ("HA") related tasks.
class	HailPlayer	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".
class	HasAttentionOfAuthorities	Of the local market's faction, if any.
class	HideFirstPerson
class	HideMapMarker
class	HideSecondPerson
class	HideThirdPerson
class	HideVisual
class	Highlight
class	HighlightComms	HighlightComms Changes the "open comm link" option to a yellow color.
class	HT_CMD	For Hyperspace Topography ("HT") related tasks.
class	ImportanceAtLeast	gte = greater than or equals ImportanceAtLeast $importance test
class	IncreaseSmugglingSuspicion	IncreaseSmugglingSuspicion An amount of 1 is maxed-out suspicion.
class	InstallCommSniffer
class	IsSeenByAnyFleet	IsSeenByAnyFleet
class	IsSeenByPatrols	IsSeenByPatrols
class	IsSoughtByPatrols	IsSoughtByPatrols
class	KantaCMD	KantaCMD
class	LPTitheCalc	LPTitheCalc
class	MakeFullySurveyed
class	MakeHostileWhileTOff
class	MakeNearbyFleetsHostile	Issues: 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>
class	MakeNearbyFleetsNonHostile	MakeNearbyFleetsNonHostile
class	MakeOptionOpenCore	OpenCoreTab <optional: onlyShowTargetTabShortcut>
class	MakeOtherFleetAggressive	Doesn't matter unless the other fleet is also hostile or preventing disengage.
class	MakeOtherFleetAggressiveOnce	Doesn't matter unless the other fleet is also hostile or preventing disengage.
class	MakeOtherFleetAllowDisengage
class	MakeOtherFleetAvoidContact	MakeOtherFleetAvoidContact Copyright 2015 Fractal Softworks, LLC
class	MakeOtherFleetDoThing	MakeOtherFleetDoThing Copyright 2015 Fractal Softworks, LLC
class	MakeOtherFleetGoAway	MakeOtherFleetGoAway Copyright 2015 Fractal Softworks, LLC
class	MakeOtherFleetHostile
class	MakeOtherFleetImportant
class	MakeOtherFleetLowRepImpact
class	MakeOtherFleetNonAggressive
class	MakeOtherFleetNonHostile
class	MakeOtherFleetNoRepImpact
class	MakeOtherFleetPreventDisengage	Prevents disengaging by player even if not hostile.
class	MakePlayerImmediatelyAttackable
class	MarketGainRandomRep	Does not start an actual conversation, but does set them as the active person (so $heOrShe etc tokens work)
class	MarketReduceRandomRep	Does not start an actual conversation, but does set them as the active person (so $heOrShe etc tokens work)
class	MovePersonToMarket	Can pass in an invalid person ID to use the active person instead.
class	NGCAddCargo	NGCAddCargo
class	NGCAddCharacterPoints	NGCAddAptitudePoints
class	NGCAddCredits	NGCAddCredits
class	NGCAddDevStartingScript	$ngcAddOfficer $ngcSkipTutorial
class	NGCAddShip	NGCAddShip
class	NGCAddShipSilent	NGCAddShip
class	NGCAddStandardStartingScript	$ngcAddOfficer $ngcSkipTutorial
class	NGCCanSkipTutorial	NGCCanSkipTutorial
class	NGCDone	NGCDone
class	NGCRemoveCargo	NGCRemoveCargo
class	NGCRemoveShip	NGCAddShip
class	NGCSetAptitude	NGCSetAptitude
class	NGCSetCustom	NGCSetCustom
class	NGCSetDifficulty	NGCSetDifficulty <difficulty, EASY | NORMAL>
class	NGCSetSkill	NGCSetSkill
class	NGCSetStartingLocation	NGCSetStartingLocation
class	NGCSetWithTimePass	NGCSetDifficulty <difficulty, EASY | NORMAL>
class	NPCWantsComms
class	OpenCommDirectory	OpenCoreTab <CoreUITradeMode (optional)>
class	OpenComms
class	OpenCoreTab	OpenCoreTab <CoreUITradeMode (optional)>
class	PaginatedOptions
class	PaginatedOptionsExample
class	PauseMusic	Pauses all music, custom or otherwise.
class	PickCommsNPC	OpenCoreTab <CoreUITradeMode (optional)>
class	Ping
class	PK_CMD	For planetkiller ("PK") related tasks.
class	PLAddEntry	PLAddEntry
class	PlayCustomMusic	Plays custom music with the provided ID.
class	PlayerFleetHasFragmentShips
class	PlayerFleetHasShipWithBaseHull	PlayerFleetHasShipWithId
class	PlayerFleetHasShipWithId	PlayerFleetHasShipWithId
class	PlayerFleetHasShroudedShips
class	PlayerHasCargo	PlayerHasCargo <cargo id - commodity, weapon, fighter, special item> <optional: quantity, default 1>
class	PlaySound	The sound should be stereo.
class	PrintDescription
class	ReinitDialog	SetActiveMission $missionEventHandle
class	RemoveCommodity	AddRemoveCommodity
class	RemoveContact	RemoveContact
class	RemoveOption
class	RemoveShip	RemoveShip
class	RemoveShipWithBaseHull	PlayerFleetHasShipWithId
class	RemoveShipWithId	RemoveShipWithId
class	RepairAll	RepairAll <useSupplies, true by default> Copyright 2017 Fractal Softworks, LLC
class	RepairAvailable
class	RepairEnoughSupplies
class	RepairNeeded
class	RepGTE	gte = greater than or equals RepGTE RepLevel
class	RepIsAtBest	RepIsAtBest RepLevel
class	RepIsAtWorst	RepIsAtWorst RepLevel
class	RepLTE	lte = less than or equal RepLTE RepLevel
class	ResetActivePerson	Sets active person to null.
class	RestoreSavedVisual	Restores visual saved by SaveCurrentVisual.
class	ResumeNormalMusic	Ends custom music playback and restarts whatever the default music would be.
class	RollProbability	RollProbability
class	SaveCurrentVisual	Saves current visual so it can be restored using RestoreCurrentVisual.
class	SetActiveMission	SetActiveMission $missionEventHandle
class	SetCodexEntryId	SetCodexEntryId Sets the id of the entry to show when the Codex is opened, with an expiration of 0.
class	SetColor	SetColor $variable color
class	SetEnabled
class	SetFlagship
class	SetHistorianBlurbShownAfterDelay	SetHistorianBlurbShownAfterDelay
class	SetLater	SetLater
class	SetNearbyFleetsVariable	SetNearbyFleetsVariable
class	SetOptionColor	SetOptionColor
class	SetOptionText	SetOptionText optionId newText
class	SetOtherFleetAllowJump	SetFleetAllowJump <true|false> Copyright 2015 Fractal Softworks, LLC
class	SetPersonHidden	SetPersonHidden set person hidden boolean by character id
class	SetPersonPortrait	SetPersonPortrait by person id, sprite as defined in settings "characters" section
class	SetPromptText	SetPromptText "-" is a special value for no text Copyright 2015 Fractal Softworks, LLC
class	SetShortcut	SetShortcut (from Keyboard, after KEY_)
class	SetStoryColor	SetStoryColor
class	SetStoryOption	SetStoryColor <optional: story point spent sound id> <optional: playthrough log text>
class	SetTextHighlightColors
class	SetTextHighlights
class	SetTooltip
class	SetTooltipHighlightColors
class	SetTooltipHighlights	SetTooltipHighlights params
class	ShowDefaultVisual
class	ShowFirstPerson	ShowSecondPerson
class	ShowImageVisual	ShowImageVisual
class	ShowLargePlanet
class	ShowMapMarker	ShowIntelMarker
class	ShowPersonVisual	ShowPersonVisual <optional - minimal mode>
class	ShowPic	Parameter is key from settings.json under "illustrations".
class	ShowRemainingCapacity	ShowRemainingCapacity
class	ShowResCost	ShowResCost <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
class	ShowSecondPerson	ShowSecondPerson
class	ShowThirdPerson	ShowSecondPerson
class	ShowThreatPersonVisual
class	SubCredits	SubCredits
class	TakeRepCheck	TakeRepCheck
class	TT_CMD	For Tri-Tachyon (inc) Business (c) TT_CMD
class	UnhidePerson	Unhide person in CommDirectory by id
class	UninstallCommSniffer
class	UniqueEncounter	UniqueEncounter
class	unset
class	unsetAll
class	UpdateMemory	SetActiveMission $missionEventHandle
class	Wait
class	WasHistorianBlurbShown	SetHistorianBlurbShownAfterDelay

Uses of CommandPlugin in com.fs.starfarer.api.impl.campaign.rulecmd.academy

Classes in com.fs.starfarer.api.impl.campaign.rulecmd.academy that implement CommandPlugin

Modifier and Type	Class	Description
class	AddGAOfficerToCoatl	"I'll buy you a pint on coatl station"
class	CESetHidden	CESetHidden <true|false>
class	GAReduceRandomRep	Does not start an actual conversation, but does set them as the active person (so $heOrShe etc tokens work)
class	GenGAIntroAcademician	Does not start an actual conversation, but does set them as the active person (so $heOrShe etc tokens work)
class	ShowGAOfficer	Does not start an actual conversation, but does set them as the active person (so $heOrShe etc tokens work)
class	UnhideGACharacters	Unhide the comm directory entities for baird and sebestyen in the Galatia Academy

Uses of CommandPlugin in com.fs.starfarer.api.impl.campaign.rulecmd.missions

Classes in com.fs.starfarer.api.impl.campaign.rulecmd.missions that implement CommandPlugin

Modifier and Type	Class	Description
class	BarCMD	BarCMD
class	Commission	NotifyEvent $eventHandle
class	DeliveryMission
class	GateCMD	NotifyEvent $eventHandle
class	GateHaulerCMD	NotifyEvent $eventHandle
class	MissionHubCMD	MissionHubCMD
class	ShrineCMD	ShrineCMD <optional id - either market, or entity>

Uses of CommandPlugin in com.fs.starfarer.api.impl.campaign.rulecmd.newgame

Classes in com.fs.starfarer.api.impl.campaign.rulecmd.newgame that implement CommandPlugin

Modifier and Type	Class	Description
class	NGC	Not actually used.

Uses of CommandPlugin in com.fs.starfarer.api.impl.campaign.rulecmd.salvage

Classes in com.fs.starfarer.api.impl.campaign.rulecmd.salvage that implement CommandPlugin

Modifier and Type	Class	Description
class	AddBarEvent	AddBarEvent
class	AddRaidObjective	Icon id is under raidObjectives in settings.json.
class	AICores	NotifyEvent $eventHandle
class	CargoPods	NotifyEvent $eventHandle
class	DemandCargo
class	DistressResponse	NotifyEvent $eventHandle
class	FactionFleetNearbyAndAware	HostileFleetNearbyAndAware
class	HostileFleetNearbyAndAware	HostileFleetNearbyAndAware
class	MarketCMD
class	MiscCMD
class	Objectives	NotifyEvent $eventHandle
class	PrintWreckDescription	NotifyEvent $eventHandle
class	RedPlanet
class	RemoveBarEvent	RemoveBarEvent
class	SalvageDefenderInteraction	SalvageDefenderInteraction
class	SalvageEntity	NotifyEvent $eventHandle
class	SalvageGenFromSeed	Actually just generates automated defenses, not salvage.
class	SalvageSpecialInteraction	SalvageSpecialInteraction
class	ZGRTurnIn	NotifyEvent $eventHandle
class	ZigguratCMD