Contents#

Types and methods. Parameter and result types refer to the stated X4 layer; unknown contracts are explicit.

Combat and ammunition#

Call / event Returns
AbortBoardingOperation bool
AddAttackerToBoardingOperation bool
CreateBoardingOperation bool
GetAllCountermeasures uint32_t
GetAllLaserTowers uint32_t
GetAllMines uint32_t
GetAllMissiles uint32_t
GetAttackersOfBoardingOperation uint32_t
GetBoardingActionOfAttacker const char*
GetBoardingCasualtiesOfTier uint32_t
GetBoardingMarineTierAmountsFromAttacker bool
GetBoardingRiskThresholds BoardingRiskThresholds
GetBoardingStrengthFromOperation uint32_t
GetCurrentAmmoOfWeapon const char*
GetCurrentBoardingPhase const char*
GetCurrentDroneMode const char*
GetDefaultCountermeasureStorageCapacity uint32_t
GetDefaultMissileStorageCapacity uint32_t
GetNumAllCountermeasures uint32_t
GetNumAllLaserTowers uint32_t
GetNumAllMines uint32_t
GetNumAllMissiles uint32_t
GetNumAttackersOfBoardingOperation uint32_t
GetNumBoardingMarinesFromOperation uint32_t
GetNumCountermeasures uint32_t
GetTurretGroupMode2 const char*
GetUserTransportDroneMode const char*
GetWeaponMode const char*
IsDroneTypeArmed bool
IsWeaponArmed bool
RemoveAttackerFromBoardingOperation bool
StartBoardingOperation bool
UpdateAttackerOfBoardingOperation bool
UpdateBoardingOperation bool

Shipyards and construction#

Call / event Returns
AddBuildTask6 BuildTaskID
ForceBuildCompletion void
GetAvailableEquipment uint32_t
GetBuilderHiringFee int64_t
GetBuildPlotCenterOffset Coord3D
GetBuildPlotPayment int64_t
GetBuildPlotPrice int64_t
GetBuildPlotSize Coord3D
GetBuildProcessorEstimatedTimeLeft double
GetBuildTaskDuration double
GetBuildTaskInfo BuildTaskInfo
GetBuildTasks uint32_t
GetBuildWarePrice int64_t
GetContainerBuilderMacros uint32_t
GetContainerBuildMethod const char*
GetCurrentBuildProgress float
GetDefaultPlayerBuildMethod const char*
GetDefensibleLoadoutLevel float
GetLoadoutsInfo uint32_t
GetNumAvailableEquipment uint32_t
GetNumBuildTasks uint32_t
GetNumContainerBuilderMacros uint32_t
GetNumLoadoutsInfo uint32_t
GetNumSoftwarePredecessors uint32_t
GetNumSoftwareSlots uint32_t
GetNumUpgradeSlots size_t
GetNumVirtualUpgradeSlots size_t
GetPaidBuildPlotCenterOffset Coord3D
GetPaidBuildPlotSize Coord3D
GetPlayerGlobalLoadoutLevel float
GetSoftwarePredecessors uint32_t
GetSoftwareSlots uint32_t
GetUpgradeSlotCurrentComponent UniverseID
GetUpgradeSlotCurrentMacro const char*
GetUpgradeSlotGroup UpgradeGroup
GetWorkForceInfo WorkForceInfo
IsBuilderBusy bool
IsLoadoutCompatible bool
IsLoadoutValid bool
IsUpgradeGroupMacroCompatible bool
IsUpgradeMacroCompatible bool
IsVirtualUpgradeMacroCompatible bool
RemoveLoadout bool
SetContainerBuildMethod void
SetDefensibleLoadoutLevel void

Other X4 functions#

Call / event Returns
CanContainerEquipShip bool
CanTeleportPlayerTo const char*
GetAllNavBeacons uint32_t
GetAllSatellites uint32_t
GetAllUnits uint32_t
GetBlueprints uint32_t
GetComponentCollidableSize float
GetCompSlotPlayerActions uint32_t
GetCurrentGameTime double
GetMacroDeployableCapacity uint32_t
GetNumAllNavBeacons uint32_t
GetNumAllSatellites uint32_t
GetNumAllUnits uint32_t
GetNumBlueprints uint32_t
GetNumCompSlotPlayerActions uint32_t
GetNumConstructionPlanInfo size_t
GetNumImportableConstructionPlans uint32_t
GetNumPlannedStationModules size_t
GetNumStationModules uint32_t
GetNumTransactionLog uint32_t
GetOwnerDetails FactionDetails
GetParentComponent UniverseID
GetPlannedStationModules size_t
GetPlayerComputerID UniverseID
GetPlayerControlledShipID UniverseID
GetPlayerCurrentControlGroup const char*
GetPlayerID UniverseID
GetPlayerOccupiedShipID UniverseID
GetRemainingOxygen float
GetStationModules uint32_t
GetTopLevelContainer UniverseID
GetTransactionLog uint32_t
HasLimitedOxygenSupply bool
IsAutoPilotActive bool
IsComponentClass bool
IsComponentOperational bool
IsConstructionPlanValid bool
IsDefensibleBeingBoardedBy bool
IsDeployableMacroCompatible bool
IsGamePaused bool
IsIconValid bool
IsInfoUnlockedForPlayer bool
IsKnownToPlayer bool
IsPlayerControlGroupValid bool
IsSetaActive bool
IsStartmenu bool
IsUnitMacroCompatible bool
PerformCompSlotPlayerAction bool
SetComponentOwner void
SetGuidance void
ShowInteractMenu void
SpawnStationAtPos UniverseID
ToggleAutoPilot bool

Loading and saving#

Call / event Returns
SaveLoadout void
SaveLoadout2 void
TriggerAutosave void

Map and presentation#

Call / event Returns
ClearMapBuildPlot void
GetBuildMapStationLocation2 UniverseID
GetMapFocusComponent UniverseID
GetMapPositionOnEcliptic2 UniverseID
GetMapRenderedComponents uint32_t
GetMapState void
GetNumMapRenderedComponents uint32_t
GetPickedMapComponent UniverseID
GetPickedMapOrder UniverseID
ImportMapConstructionPlan void
IsCurrentBuildMapPlotValid bool
RemoveHoloMap void
SetFocusMapComponent void
SetFocusMapOrder void
SetMapTargetDistance void
ShowConstructionMap void
UpdateConstructionMapBuildPlot void
UpdateMapBuildPlot void

World and position#

Call / event Returns
GetAllResourceProbes uint32_t
GetCameraRotation Rotation
GetCompSlotControlPosition const char*
GetContextByClass UniverseID
GetDiscoveredSectorResources uint32_t
GetNumAllResourceProbes uint32_t
GetNumDiscoveredSectorResources uint32_t
GetObjectPositionInSector UIPosRot
GetPositionalOffset UIPosRot
GetSectorControlStation UniverseID
GetSectorPopulation uint64_t
IsContestedSector bool
SetPlayerCameraTargetView void
SetPositionalOffset void
SetSofttarget bool

Objects and identifiers#

Call / event Returns
ConvertStringTo64Bit uint64_t
GetObjectIDCode const char*

AI rules and behavior#

Call / event Returns
CreateBlacklist2 BlacklistID
CreateFightRule FightRuleID
CreateTradeRule TradeRuleID
GetAllBlacklists uint32_t
GetAllFightRules uint32_t
GetAllResponsesToSignal uint32_t
GetAllSignals uint32_t
GetAllTradeRules uint32_t
GetAskToSignalForControllable bool
GetAskToSignalForFaction bool
GetBlacklistInfo2 bool
GetBlacklistInfoCounts BlacklistCounts
GetContainerTradeRuleID TradeRuleID
GetControllableBlacklistID BlacklistID
GetControllableFightRuleID FightRuleID
GetDefaultResponseToSignalForControllable const char*
GetDefaultResponseToSignalForFaction2 const char*
GetFightRuleInfo bool
GetFightRuleInfoCounts FightRuleCounts
GetNumAllBlacklists uint32_t
GetNumAllFightRules uint32_t
GetNumAllResponsesToSignal uint32_t
GetNumAllSignals uint32_t
GetNumAllTradeRules uint32_t
GetNumBlacklistTypes uint32_t
GetNumFightRuleTypes uint32_t
GetSubordinateGroupAssignment const char*
GetSubordinateGroupProtectedPosition UIPosRot
GetSubordinateGroupProtectedSector UniverseID
GetTradeRuleInfo bool
GetTradeRuleInfoCounts TradeRuleCounts
HasContainerOwnTradeRule bool
HasControllableOwnBlacklist bool
HasControllableOwnFightRule bool
HasControllableOwnResponse bool
ReleaseDetachedSubordinateGroup void
RemoveBlacklist void
RemoveFightRule void
RemoveTradeRule void
ResetDefaultResponseToSignalForFaction void
ResetResponseToSignalForControllable bool
SetContainerTradeRule void
SetControllableBlacklist void
SetControllableFightRule void
SetDefaultResponseToSignalForControllable bool
SetDefaultResponseToSignalForFaction2 bool
SetSubordinateGroupAssignment void
SetSubordinateGroupAttackOnSight unknown
SetSubordinateGroupDockAtCommander unknown
SetSubordinateGroupProtectedLocation void
SetSubordinateGroupReinforceFleet unknown
SetSubordinateGroupRespondToDistressCalls unknown
SetSubordinateGroupResupplyAtFleet unknown
ShouldSubordinateGroupAttackOnSight unknown
ShouldSubordinateGroupDockAtCommander unknown
ShouldSubordinateGroupReinforceFleet unknown
ShouldSubordinateGroupRespondToDistressCalls unknown
ShouldSubordinateGroupResupplyAtFleet unknown
UpdateBlacklist2 void
UpdateFightRule void
UpdateTradeRule void

Orders and control#

Call / event Returns
AdjustOrder bool
CreateOrder3 uint32_t
EnablePlannedDefaultOrder bool
GetDefaultOrder bool
GetDefaultOrderFailure bool
GetDockedShips uint32_t
GetFormationShapes uint32_t
GetNumDockedShips uint32_t
GetNumFormationShapes uint32_t
GetNumOrderDefinitions uint32_t
GetNumOrderFailures uint32_t
GetNumOrders uint32_t
GetNumValidTransporterTargets2 uint32_t
GetOrderDefinitions uint32_t
GetOrderFailures uint32_t
GetOrderID AIOrderID
GetOrderLoopSkillLimit uint32_t
GetOrderQueueFirstLoopIdx size_t
GetOrders3 uint32_t
GetPlannedDefaultOrder bool
GetRoomForTransporter UniverseID
GetValidTransporterTargets2 uint32_t
IsOrderLoopable bool
IsOrderSelectableFor bool
IsShipAtExternalDock bool
QuickDock bool
RemoveAllOrders bool
RemoveDefaultOrderFailure void
RemoveOrder bool
RemoveOrderFailure void
RemovePlannedDefaultOrder void
RequestDockAt bool
RequestDockAtReason const char*
ResetOrderLoop void
SetFormationShape UIFormationInfo
SetOrderLoop bool
StartPlayerActivity void
StopPlayerActivity void
TransportPlayerToTarget void
UndockPlayerShip const char*

Trade, cargo and accounts#

Call / event Returns
GetCargo uint32_t
GetMoneyLog uint32_t
GetNumCargo uint32_t
GetNumUnitCargo uint32_t
GetNumWares uint32_t
GetPlayerGlobalTradeLoopCargoReservationSetting bool
GetShipTradeLoopCargoReservationSetting bool
GetSupplyBudget int64_t
GetTradeWareBudget int64_t
GetUnitCargo uint32_t
GetWares uint32_t
HasShipTradeLoopCargoReservationOverride bool
RemoveShipTradeLoopCargoReservationOverride void
SetShipTradeLoopCargoReservationOverride void

Factions and diplomacy#

Call / event Returns
GetAllFactions uint32_t
GetAllFactionStations uint32_t
GetCurrentFleetLogo UILogo
GetCurrentPlayerLogo UILogo
GetFactionBuildMethod unknown
GetFleetName const char*
GetNumAllFactions uint32_t
GetNumAllFactionStations uint32_t
GetNumPlayerLogos uint32_t
GetPlayerFactionName const char*
GetPlayerLogos uint32_t
IsFactionEnemyToFaction bool
SetFactionBuildMethod void
SetFleetLogo void
SetFleetName void
SetPlayerFactionName void

NPCs and characters#

Call / event Returns
GetContainerBuildPriceFactor float
GetControlPanelName const char*
GetEntityCombinedSkill int32_t
GetPersonCombinedSkill int32_t
GetPersonName const char*
GetPersonRole const char*
GetPlayerName const char*
PerformCrewExchange2 UICrewExchangeResult