Lua function overview
Version | Function | Note | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
deprecated in 4.21 Beta 1 (VR: 4.20) | DEPRECATED AbilityMenuClosed() | DEPRECATED - use FFI function CircularMenuClosed() instead | ||||||||
added in 4.00 RC 2 | AbilityMenuOpened() |
| ||||||||
| AbortMission(missionID) |
| ||||||||
| ActivateDroneAbility(droneSlotNumber) |
| ||||||||
| ActivatePassiveDroneAbilities() |
| ||||||||
changed in 4.00 Beta 4 | addedamount = AddAmmo(defensible, ammomacroname, amount, [checkonly]) | Added "checkonly" parameter in 4.00 Beta 4 | ||||||||
| AddCargo(containerID, ware, amount) |
| ||||||||
changed in 4.00 Beta 4 | AddInventory(entityID, ware, amount[, crafting]) | Added "crafting" parameter in 4.00 Beta 4 | ||||||||
| AddKnownItem(library, item) |
| ||||||||
| AddLicence(faction, licencetype, licencefaction) |
| ||||||||
| AddLogbookEntry(category, text [, interaction [, interactioncomponent]]) |
| ||||||||
| transferredamount = AddMoney(entityID, amount) |
| ||||||||
| AddPlayerDrone(macro, amount) |
| ||||||||
| tradeID = AddTradeToShipQueue(tradeID, containerID, amount) |
| ||||||||
changed in 4.00 RC 2 | AddUITriggeredEvent(screen, control[, screenparam]) | optional screenparam parameter added in 4.00 RC 2 | ||||||||
| AddUnits(defensibleID, unitMacro, amount, unavailable) |
| ||||||||
| string = AdjustMultilineString(string) |
| ||||||||
| AIRangeUpdated(controllableID, entityID) |
| ||||||||
| AreAttackersInWarningRange |
| ||||||||
| AreObserversInWarningRange |
| ||||||||
| AreSliderValuesFixed |
| ||||||||
| AttackEnemySettingChanged(defencenpcID) |
| ||||||||
| hullfraction = CalculateBuildSlotHullFraction(componentID, sequence, stage) |
| ||||||||
| hullfraction = CalculateTotalHullFraction(componentID) |
| ||||||||
| bool = CanBeSubordinateOf(controllableID, othercontrollableID) |
| ||||||||
| success = CancelConversation() |
| ||||||||
| bool, error = CanTradeWith(tradeID, containerID, amount) | It may be necessary to call SetVirtualCargoMode on containerID first, if the container has a shopping queue. | ||||||||
| bool = CanViewLiveData(objectID or zoneID) |
| ||||||||
| bool = CheckInputProfileRegression() |
| ||||||||
| bool = CheckSuitableTransportType(containerID, ware) |
| ||||||||
added in 4.00 Beta 3 | ClearContainerStockLimitOverride(containerID, ware) |
| ||||||||
| ClearContainerWarePriceOverride(destructibleID [, ware] [, buysellswitch]) |
| ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED ClearErrors() | DEPRECATED - use FFI function ClearErrorLog() instead | ||||||||
| ClearLogbook([keepnumentries [, category]]) |
| ||||||||
| ClearTradeQueue(containerID) | Clearing the trade queue will not happen instantaneously, especially if a trade is of the queue is already in progress. | ||||||||
| CloseMenusUponMouseClick |
| ||||||||
| bool = CompareJumpRoute(numgates, numjumps, othernumgates, othernumjumps) |
| ||||||||
| 64-bit int = ConvertIDTo64Bit(luaID) |
| ||||||||
| string = ConvertIntegerString(number [, separators [, accuracy [, notrailingspaces [, colorprefix]]]]) |
| ||||||||
| string = ConvertMissionLevelString(difficulty) |
| ||||||||
added in 4.00 Beta 1 | string = ConvertMissionTypeString(missiontype) |
| ||||||||
| string = ConvertMoneyString(money [,showcents [, separators [, accuracy [, notrailingspaces [, colorprefix]]]]]) |
| ||||||||
| 64-bit int = ConvertStringTo64Bit(64BitStringID) |
| ||||||||
| luaID = ConvertStringToLuaID(64BitStringID) |
| ||||||||
changed in 4.00 Beta 1 | string = ConvertTimeString(time [, format [, separators [, precision]]]) Possible specifiers in the format string:
Default format is "%T" if no format string is provided. Separators: Use thousand separators, only applies to %s, %m, %h, %d Precision: Number of fractional digits. Only applies to %s, %S, and %T. Default is 0. Use -1 for automatic display. A value of -1 is not compatible with separators. (Can be overridden by .# notation in format string) | precision support for %s, %S, and %T were added in 4.00 Beta 1 | ||||||||
| CreateButton |
| ||||||||
added in 4.00 Beta 2 | descriptor = CreateCheckBox(checkboxDescription) |
| ||||||||
| CreateCutsceneDescriptor |
| ||||||||
| CreateEditBox |
| ||||||||
| CreateFontString |
| ||||||||
added in 4.00 Beta 1 | descriptor = CreateGraph(graphDescription) |
| ||||||||
| CreateIcon |
| ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED descriptor = CreateInteractionDescriptor(param1, param2) | DEPRECATED - use CreateInteractionDescriptor2() instead | ||||||||
added in 4.31 Beta 1 | interactionDescriptorID = CreateInteractionDescriptor2(param1, param2) |
| ||||||||
| clusterID, objectID = CreateObjectInPresentationCluster(objectmacro [, backgroundmacro]) | The cluster needs to be destroyed using DestroyPresentationCluster, when it is no longer needed. | ||||||||
| CreateProgressElement |
| ||||||||
| CreateRenderTarget |
| ||||||||
| CreateSink |
| ||||||||
| CreateSlider |
| ||||||||
| CreateSliderTableView |
| ||||||||
| CreateSliderView |
| ||||||||
| CreateSource |
| ||||||||
changed in 4.21 Beta 1 (VR: 4.20) | CreateTable | optional argument alerteffectcolor added in 4.21 Beta 1 (VR: 4.20) | ||||||||
| CreateTableView |
| ||||||||
| CreateThreeTableRenderTargetView |
| ||||||||
| CreateThreeTableView |
| ||||||||
| CreateTimer |
| ||||||||
| CreateTwoTableRenderTargetView |
| ||||||||
| CreateTwoTableSliderRenderTargetView |
| ||||||||
| CreateTwoTableSliderView |
| ||||||||
| CreateTwoTableView |
| ||||||||
| DeactivateView |
| ||||||||
| DebugError |
| ||||||||
| DebugProfileStart() |
| ||||||||
| timeInMs = DebugProfileStop() |
| ||||||||
| DestroyPresentationCluster(clusterID) |
| ||||||||
| DialogMenuHidden |
| ||||||||
| DialogMenuShown |
| ||||||||
| DisableMissionObjectiveBar |
| ||||||||
| DisplayView |
| ||||||||
| DumpAllMessages |
| ||||||||
| DumpAllMessageSinks |
| ||||||||
| DumpAllMessageSources |
| ||||||||
| EnableMissionObjectiveBar |
| ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED EventmonitorInteractionHidden | UNSUPPORTED. Not designed to be used by mods. | ||||||||
added in 4.31 Beta 1 | EventmonitorInteractionHidden2 |
| ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED EventmonitorInteractionShown | UNSUPPORTED. Not designed to be used by mods. | ||||||||
added in 4.31 Beta 1 | EventmonitorInteractionShown2 |
| ||||||||
| ExecuteDebugCommand |
| ||||||||
| text or nil = ExistsText(page, line) |
| ||||||||
| numgates, numjumps = FindJumpRoute(fromsectorID, tosectorID) |
| ||||||||
| ForceAnarkUpdate |
| ||||||||
| ... = GetAccountData(entityID, ...) |
| ||||||||
| GetActionDetails |
| ||||||||
| GetActionInfo |
| ||||||||
| componentID or nil = GetActiveGuidanceMissionComponent() |
| ||||||||
| GetActiveMission |
| ||||||||
| string = GetAdapterOption() |
| ||||||||
| int = GetAimAssistOption() |
| ||||||||
| GetAlignment |
| ||||||||
| componentIDArray = GetAllCommanders(controllableID) |
| ||||||||
| extensionSettingsTable = GetAllExtensionSettings() extensionSettingsTable extensionSettingsTable = { [extensionid] = { enabled = is extension enabled?, sync = is extension synced? }, ... } |
| ||||||||
| upgradeArray = GetAllMacroUpgrades(macro, sequence, stage, buildlimit) upgradeArray upgradeArray = { [1] = { upgrade = upgrade type, name = upgrade name, total = total of available slots }, [2] = { ... } } |
| ||||||||
| stringArray = GetAllStatIDs() |
| ||||||||
| upgradeTable = GetAllUpgrades(destructibleID [, buildlimit] [, tag]) upgradeTable upgradeTable = { upgradetype = { name = upgrade name, ware = upgrade ware, tags = upgrade tags, total = total number of upgrades, free = number of free upgrades, operational = number of operational upgrades, construction = number of upgrades in construction }, totaltotal = sum of total number of upgrades, totalfree = sum of number of free upgrades, totaloperational = sum of the number of operational upgrades, totalconstruction = sum of the number of upgrades in construction, estimated = is data filtered? } |
| ||||||||
| weaponTable = GetAllWeapons(destructibleID) weaponTable weaponTable = { weapons = { [1] = { component = component id, macro = macro name, name = weapon name, range = bullet range, dps = hull and shield damage per sec }, [2] = { ... } }, missiles = { [1] = { name = missile name, speed = missile range, damage = explosion damage, macro = macro name, amount = amount number }, [2] = { ... } } } |
| ||||||||
| wareKeyTable = GetAmmoCountAfterShoppingList(containerID) wareKeyTable wareKeyTable = { [ware] = amount, ... } | Call SetVirtualCargoMode on containerID first, otherwise result will be empty. | ||||||||
| int = GetAntiAliasModeOption() |
| ||||||||
| aaModesArray = GetAntiAliasModes() |
| ||||||||
| componentID or nil = GetAutoPilotTarget() |
| ||||||||
| bool = GetAutorollOption() |
| ||||||||
| bool = GetAutosaveOption() |
| ||||||||
| fontsize = GetBestFontSize(fontname, fontsize) |
| ||||||||
| bonusContentArray = GetBonusContentData() bonusContentArray bonusContentArray = { [1] = { appid = appID, name = "Name", description = "Description", path = "path\\to\\content", optional = true|false, owned = true|false, installed = true|false, changed = true|false, -- installation state already changed, can't be changed again }, [2] = ... } |
| ||||||||
| bool = GetBoostToggleOption() |
| ||||||||
| ... = GetBudgetData(entityID, ...) |
| ||||||||
| componentID or nil = GetBuildAnchor(containerID or buildmoduleID) |
| ||||||||
| builderMacrosArray = GetBuilderMacros(containerID or buildmoduleID) builderMacrosArray builderMacrosArray = { [1] = { macro = macro, name = name }, [2] = { ... } } |
| ||||||||
| method = GetBuildProductionMethod(containerID or buildmoduleID, macro) |
| ||||||||
| duration = GetBuildSlotDuration(macro or componentID, sequence, stage) |
| ||||||||
| resourceTable = GetBuildSlotResources(containerID or buildmoduleID, macro or componentID, sequence, stage, upgradePlanArray) resourceTable resourceTable = { [1] = { ware = ware id, name = ware name, cycle = amount, price = price }, [2] = { ... }, ..., totalprice = totalprice } upgradePlanArray upgradePlanArray = { [1] = { [1] = upgradetype, [2] = level }, [2] = { ... } } |
| ||||||||
| moduleArray = GetBuildStageModules(macro or componentID, sequence, stage) moduleArray moduleArray = { [1] = { macro = module macro, name = module name, library = moduletypes library }, [2] = { ... } } |
| ||||||||
| upgradeTable = GetBuildStageUpgrades(containerID, sequence, stage [, buildlimit] [, tags]) upgradeTable upgradeTable = { upgradetype = { name = upgrade name, tags = upgrade tags, total = total number of upgrades, operational = number of operational upgrades, construction = number of upgrades in construction }, totaltotal = sum of total number of upgrades, totaloperational = sum of the number of operational upgrades, totalconstruction = sum of the number of upgrades in construction } |
| ||||||||
| buildTreeTable = GetBuildTree(macro or componentID) buildTreeTable buildTreeTable = { name = "Station (base module) name for display", [1] = { sequence = "sequencename" name = "Sequence name for display", currentstage = currentstagenumber or 0, -- only if component supplied [1] = { stage = stagenumber, name = "Stage module name for display", primarycomponent = Primary component of that stage, if it is already build (Note: At the moment gives just the first of the primary components) }, [2] = ... }, [2] = ... } |
| ||||||||
| GetButtonColor |
| ||||||||
| GetButtonFont |
| ||||||||
| GetButtonHotkeyDetails |
| ||||||||
| GetButtonIcon |
| ||||||||
| GetButtonIcon2 |
| ||||||||
| GetButtonIcon2Color |
| ||||||||
| GetButtonIcon2Offset |
| ||||||||
| GetButtonIcon2Size |
| ||||||||
| GetButtonIconColor |
| ||||||||
| GetButtonIconOffset |
| ||||||||
| GetButtonIconSize |
| ||||||||
| GetButtonSwapIcon |
| ||||||||
| GetButtonSwapIcon2 |
| ||||||||
| GetButtonText |
| ||||||||
| GetButtonTextAlignment |
| ||||||||
| GetButtonTextColor |
| ||||||||
| GetButtonTextOffset |
| ||||||||
| bool = GetCaptureHQOption() |
| ||||||||
| wareKeyTable = GetCargoAfterShoppingList(containerID) wareKeyTable wareKeyTable = { [ware] = amount, ... } | Call SetVirtualCargoMode on containerID first, otherwise result will be empty. | ||||||||
| GetCellContent |
| ||||||||
| GetCellText |
| ||||||||
| GetChildren |
| ||||||||
| GetClosestAttackerDistance |
| ||||||||
| GetClosestHighwaySection |
| ||||||||
| GetClosestObserverDistance |
| ||||||||
| componentIDArray = GetClusters([showonmap]) |
| ||||||||
changed in 4.10 Beta 1 | collectableDataTable = GetCollectableData(collectableID) collectableDataTable collectableDataTable = { type = "ammo" | "wares" | "shieldrestore", #if ammo: macro = ammo macro name, name = ammo name, icon = ammo icon, amount = ammo amount #elseif wares: wares = { [1] = { ware = ware, amount = amount }, [2] = ... }, money = contained money #elseif shieldrestore: restoretype = "duration" | "hp" | "percent", value = value (depending on restoretype) #end } | shieldrestore value changed to return a floating point number (rather than an integer number) in 4.10 Beta 1 | ||||||||
| bool = GetCollisionAvoidanceAssistOption() |
| ||||||||
| GetColor |
| ||||||||
| commanderID or nil = GetCommander(controllableID) |
| ||||||||
| entityID or nil = GetCommanderEntity(controllableID) |
| ||||||||
changed in 3.60 Beta 3, 4.00 Beta 2, 4.00 Beta 3 and 4.00 Beta 5 | ... = GetComponentData(componentID, ...) Possible properties - Any Component: "name", "uiname", "description", "image", "owner", "ownername", "ownershortname", "ownericon", "size", "zone", "zoneid", "sector", "sectorid", "cluster", "clusterid", "galaxyid", "macro", "parent", "revealpercent", "isplayerowned", "isfriend", "isenemy", "iskill", "isdock" "wares", "caninitiatecomm", "sequence", "stage" - Destructible: "hull", "hullmax", "hullpercent", "shield", "shieldmax", "shieldpercent", "efficiencyfactor", "efficiencybonus", "efficiencythreshold", "isfunctional" - Controllable: "controlentity", "pilot", "defencenpc", "tradenpc", "engineer", "boardingnpc", "architect", "maxforwardspeed", "maxradarrange" - Defensible: "missilecapacity", "boardingresistance", "boardingstrength" - Object: "primarypurpose", "primarypurposename" - Container: "engines", "shieldgenerators", "cargo", "products", "availableproducts", "allresources", "pureresources", "intermediatewares", "buildingmodule", "tradeoffers", "tradesubscription", "numtrips", "isshipyard", "tradewares" - Ship: "hasjumpdrive", "basejumpcost", "issellable", "nextjumptime", "isjumpdrivecharging", "isjumpdrivebusy", "isdocked", "isdocking" - Station: "istradestation" - Entity: "typestring", "typeicon", "typename", "skills", "combinedskill", "experienceprogress", "neededexperience", "skillsvisible", "repairqueue", "aicommandstack", "aicommand", "aicommandraw", "aicommandparam", "aicommandparam2", "aicommandaction", "aicommandactionparam", "iscontrolentity", "money", "commissions", "discounts", "hasownaccount", "isspecialist", "isremotecommable", "wantedmoney", "ismissionactor", "buildmodule", "productionmoney", "isitemtrader" - Radar: "radarrange" - CollectableWares/Crate: "money" - ControlPanel "requireditems", "iscontrolpanelhacked", "hackexpirationtime" - Gate "destination" - Highway, HighwayEntryGate, HighwayExitGate "nextdestname" - Space "mapshortname" - Dockingbay "populationtype" - Production Module "isproducing" - Zone "istemporaryzone", "hasjumpbeacon", "exitsector" - Lockbox "numlocks" | Container "tradewares" property added in 3.60 Beta 3 | ||||||||
removed 3.50 Beta 3 |
|
| ||||||||
| name = GetComponentName(componentID, fontname, fontsize, availablewidth[, omitfaction[, forcewidth]]) |
| ||||||||
| bool = GetConfineMouseOption() |
| ||||||||
| objectIDArray = GetContainedObjectsByOwner(faction, [space]) |
| ||||||||
| shipIDArray = GetContainedShips([space], [showonmap]) |
| ||||||||
| shipIDArray = GetContainedShipsByOwner(faction, [space]) |
| ||||||||
| stationIDArray = GetContainedStations([space], [showonmap], [includeconstruction]) |
| ||||||||
| stationIDArray = GetContainedStationsByOwner(faction, [space], [includeconstruction]) |
| ||||||||
| price = GetContainerWarePrice(containerID or buildmoduleID, ware, buysellswitch) |
| ||||||||
| contextID or nil = GetContextByClass(componentID, classname [, includeself]) |
| ||||||||
| entityID or nil = GetControlEntity(controllableID, commandertype) |
| ||||||||
changed in 4.21 Beta 1 (VR: 4.20) and 4.30 RC2 (VR: 4.30 Hotfix 2) | mode, angle = GetControllerInfo() The angle value will be -1, if the joystick is in its safe area. Otherwise it returns the angle in radian [0..2π] (with 0 corresponding to the joystick pointing upwards - rotation is clockwise). | 4.21 Beta 1 (VR: 4.20): Added "touch" as new possible input mode. | ||||||||
| bool = GetCrashReportOption() |
| ||||||||
| time = GetCurRealTime() |
| ||||||||
| sequence, stage, progress, upgradePlanArray = GetCurrentBuildSlot(containerID) upgradePlanArray upgradePlanArray = { [1] = { [1] = upgradetype, [2] = level }, [2] = { ... } } |
| ||||||||
| resourceTable = GetCurrentBuildSlotResources(containerID or buildmoduleID) resourceTable resourceTable = { [1] = { ware = ware id, name = ware name, cycle = amount, price = price }, [2] = { ... }, ..., totalprice = totalprice } |
| ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED string = GetCurrentModuleName() | DEPRECATED - use FFI function IsStartmenu() instead | ||||||||
deprecated in 4.22 Beta 2 (VR: 4.22) | DEPRECATED time = GetCurTime() | DEPRECATED - use FFI function GetCurrentGameTime() instead | ||||||||
changed in 4.30 RC 1 (VR: 4.30) | string|table = GetDate([format [,time]]) | As of XR 4.30 RC 1 GetDate() supports only the following format specifiers: Unknown macro: expand. Click on this message for details. | ||||||||
| int = GetDeadzoneOption() |
| ||||||||
| text, isSelectable, isImmediate, shortcutKey, RESERVED, mouseOverText = GetDialogOption(index) |
| ||||||||
| string = GetDifficultyOption() |
| ||||||||
| bool = GetDistortionOption() |
| ||||||||
| dronecommanderID or nil = GetDroneCommander(drone) |
| ||||||||
| droneIDArray = GetDrones(shipID) | See also GetUnitStorageData. | ||||||||
| GetDroneWeapon |
| ||||||||
| GetEditBoxCloseMenuOption |
| ||||||||
| GetEditBoxColor |
| ||||||||
| GetEditBoxFont |
| ||||||||
| GetEditBoxHotkeyDetails |
| ||||||||
| GetEditBoxText |
| ||||||||
| GetEditBoxTextAlignment |
| ||||||||
| GetEditBoxTextColor |
| ||||||||
| number = GetEffectDistanceOption() |
| ||||||||
| stringArray = GetEfficiencyUpgrades(destructible) |
| ||||||||
| DEPRECATED bool = GetEMCutsceneOption() | DEPRECATED - do not use | ||||||||
| .. = GetEntityTypeData(entitytype, ...) |
| ||||||||
| GetError |
| ||||||||
changed in 4.30 RC 1 (VR: 4.30) | severity = GetErrorSeverity(logMessageIndex)
| 4.30 RC 1 changed the severity levels and introduced the new info level. | ||||||||
| GetErrorTimestamp |
| ||||||||
| GetEventMonitorDetailsBridge |
| ||||||||
removed in 3.50 RC 1 |
|
| ||||||||
| extensionTable = GetExtensionList() extensionTable extensionTable = { [1] = { id = extension id, index = extension index, name = extension name, desc = extension description, author = extension author, date = extension date, location = extension location, version = extension version, enabled = extension enabled, sync = extension sync, personal = extension personal, isworkshop = is extension in workshop, error = extension error ID, if any, errortext = extension error text, if any, warning = workshop update warning, if any, warningtext = workshop update warning, if any, dependencies = { id = dependency id, name = dependency name, version = dependency version } } } |
| ||||||||
| string or nil = GetExtensionUpdateWarningText(extensionid, personal) |
| ||||||||
removed 3.50 Beta 3 |
|
| ||||||||
| GetFont |
| ||||||||
| GetFontHeight |
| ||||||||
| number = GetFOVOption() |
| ||||||||
| GetFrameBackgroundID |
| ||||||||
| GetFrameOverlayID |
| ||||||||
| GetFramePosition |
| ||||||||
| amount = GetFreeCargoAfterShoppingList(containerID, ware) | Call SetVirtualCargoMode on containerID first, otherwise result will be empty. | ||||||||
| amount = GetFreeUnitStorageAfterShoppingList(containerID) | Call SetVirtualCargoMode on containerID first, otherwise result will be empty. | ||||||||
| bool = GetFullscreenDetailmonitorOption() |
| ||||||||
| fullscreen, borderless = GetFullscreenOption() |
| ||||||||
| int = GetGamepadModeOption() |
| ||||||||
| number = GetGammaOption() |
| ||||||||
| gateIDArray = GetGates(space [, showonmap]) |
| ||||||||
| int = GetGfxQualityOption() |
| ||||||||
| bool = GetGlobalSyncSetting() |
| ||||||||
| int = GetGlowOption() |
| ||||||||
| GetHeader |
| ||||||||
| licenceTable = GetHeldLicences(faction) licenceTable licenceTable = { [1] = { id = licence id, type = licence type, name = licence name, icon = licence icon, price = licence price, minrelation = minimum relation required, faction = factionid }, [2] = { ... } } |
| ||||||||
| x, y = GetHintPosition(position) |
| ||||||||
| productionColor, buildColor, storageColor, radarColor, dronedockColor, efficiencyColor, defenceColor, playerColor, friendColor, enemyColor, missionColor = GetHoloMapColors() Color Color = { r = red (0-255), g = green (0-255), b = blue (0-255), a = alpha (0-100) } |
| ||||||||
| GetIconDetails |
| ||||||||
| wareKeyTable = GetIncomingRemoteWares(wareType) wareKeyTable wareKeyTable = { [ware] = amount, ... } |
| ||||||||
| actionTable = GetInputActionMap() actionTable actionTable = { [ActionID] = { [1] = { [1] = InputID Source, [2] = InputID Code, [3] = InputID Signum }, [2] = { ... } }, [ActionID] = { ... } } |
| ||||||||
| inputProfileTable = GetInputProfiles() inputProfileTable inputProfileTable = { [1] = { id = profile ID, version = profile version, filename = filename, personal = is file in personal folder?, name = profile name, customname = profile custom name }, [2] = { ... } } |
| ||||||||
| rangeTable = GetInputRangeMap() rangeTable rangeTable = { [RangeID] = { [1] = { [1] = InputID Source, [2] = InputID Code, [3] = InputID Signum }, [2] = { ... } }, [RangeID] = { ... } } |
| ||||||||
| stateTable = GetInputStateMap() stateTable stateTable = { [StateID] = { [1] = { [1] = InputID Source, [2] = InputID Code, [3] = InputID Signum }, [2] = { ... } }, [StateID] = { ... } } |
| ||||||||
| GetInteractiveObject |
| ||||||||
| wareTable = GetInventory(entityID) wareTable wareTable = { [ware1] = { name = ware name amount = ware amount price = ware price }, [ware2] = { ... } } |
| ||||||||
| bool = GetInversionSetting(rangeid) |
| ||||||||
| joystickTable = GetJoysticksOption() joystickTable joystickTable = { [1] = { name = joystick name, guid = joystick guid }, [2] = { ... } } |
| ||||||||
| jumpbeaconIDArray = GetJumpBeacons(zoneID, [showonmap]) |
| ||||||||
| bool = GetLegacyMainMenuOption() |
| ||||||||
| bool = GetLegacyShadersOption() |
| ||||||||
| libraryTable = GetLibrary(library) libraryTable libraryTable = { [1] = { id = item id, name = item name, icon = item icon [parent = item parent] [relation = player relation] }, [2] = { ... } } |
| ||||||||
changed in 4.22 Beta 2 (VR: 4.22) | entryTable = GetLibraryEntry(library, itemid) entryTable entryTable = { name = info name, description = info description, icon = info icon, image = info image, video = info video [race = npc race, faction = npc faction] [hull = object hull, maxspeed = object maxspeed, shield = object shield, jumpdrive = object has jumpdrive?, storagecapacity = storage capacity, storagetags = storage tags, storagenames = storage names, unitcapacity = unit capacity, productions = { [1] = { [1] = { id = product id, name = product name, cycle = product cycle time, amount = product amount }, [2] = { ... } }, [2] = { ... } }, weapons = { [1] = { class = weapon / missile, id = weapon id, name = weapon name }, [2] = { ... } }, upgrades = { [1] = { upgrade = upgrade type, name = upgrade name, total = upgrade total amount }, [2] = { ... } }] [primaryrace = faction primaryrace] [avgprice = ware average price, volume = ware volume, transporttype = ware transport type, methods = { [1] = method, [2] = ... }] [range = weapon range, dps = weapon dps] [speed = missile speed, acceleration = missile acceleration, damage = missile damage] [hull = shieldgen hull, shield = shieldgen shield] [hull = turret hull, range = turret range, dps = turret dps, rotation = turret rotation speed] } | "storagenames" field added in 4.22 Beta 2 (VR: 4.22) | ||||||||
| int = GetLibrarySize(library) |
| ||||||||
| GetLiveDataBridge |
| ||||||||
| GetLoadingInfo |
| ||||||||
changed in 4.00 Beta 3 | string = GetLocalizedKeyName(type, id) |
| ||||||||
| string = GetLocalizedRawKeyName(keycode) |
| ||||||||
added in 4.00 Beta 2 | mouseX, mouseY = GetLocalMouseClickPosition() |
| ||||||||
| mouseX, mouseY = GetLocalMousePosition() |
| ||||||||
| number = GetLODOption() |
| ||||||||
| logbookTable = GetLogbook(start, count [, category]) logbookTable logbookTable = { [1] = { text = log text, time = timestamp, category = log category, interaction = log interaction type, interactioncomponent = log interaction component, dependent on type [2] = ... } |
| ||||||||
| resourceTable = GetMacroBuildSlotResources(macro, sequence, stage)Returns the needed resources to build the specified macro build slot. resourceTable resourceTable = { [1] = { ware = ware id, name = ware name, cycle = amount, price = price }, [2] = { ... }, ..., totalprice = totalprice } |
| ||||||||
changed in 4.00 RC 1 | ... = GetMacroData(macro, ...) | "scanlevel" property added in 4.00 RC 1 | ||||||||
| int = GetMacroUnitStorageCapacity(macro, sequence, stage [, buildlimit]) |
| ||||||||
| joystickIndexArray = GetMappedJoysticks() |
| ||||||||
| GetMaxRemoteControlRange |
| ||||||||
| stringLength = GetMaxTextLength(text, fontname, fontsize, width) |
| ||||||||
| param, param2 = GetMenuParameters() |
| ||||||||
UNSUPPORTED | GetMessageScreenPosition |
| ||||||||
| GetMiniGameCursorPosition |
| ||||||||
| macroArray = GetMiningUnitMacros(macro) |
| ||||||||
updated in 4.00 Beta 3 | missionID, name, description, difficulty, maintype, subtype, faction, rewardmoney, rewardtext, briefingobjectives, activebriefingstep, opposingfaction, licence, timeleft, duration, abortable, guidancedisabled, associatedcomponent, hasObjective = GetMissionDetails(missionIndex | 4.00 Beta 3: added hasObjective return value | ||||||||
updated in 4.31 Beta 1 | objectivetext, objectiveicon, timeout, progressname, curprogress, maxprogress, objectivetargets = GetMissionObjective(missionIndex | 4.31 Beta 1: removed fontname, fontsize, and textwidth parameters | ||||||||
| GetMissionObjectiveBarInfo |
| ||||||||
| name, desc, faction, type, level, reward, opposingfaction, licence, associatedcomponent = GetMissionOfferAtConnection(componentID, templateConnectionName) |
| ||||||||
updated in 4.10 Beta 5 | name, description, difficulty, maintype, subtype, faction, rewardmoney, rewardtext, briefingobjectives, activebriefingstep, opposingfaction, licence, timeleft, duration, abortable, guidancedisabled, associatedcomponent, offeractor, offercomponent = GetMissionOfferDetails(offerID | 4.10 Beta 5: added offercomponent return value | ||||||||
| type = GetModuleType(destructibleID) |
| ||||||||
| resourceTable = GetNeededBuildSlotResources(containerID or buildmoduleID) resourceTable resourceTable = { [1] = { ware = ware id, name = ware name, cycle = amount, price = price }, [2] = { ... }, ..., totalprice = totalprice } |
| ||||||||
| bool = GetNonSquadShipsForTradeOffersOption() |
| ||||||||
updated in 4.31 Beta 1 | notificationDetailsTable = GetNotificationDetails(notificationID) | 4.31 Beta 1: added the interactionID to the returned table | ||||||||
| GetNotificationPriority |
| ||||||||
| componentIDArray = GetNotUpgradesByClass(destructibleID, class) |
| ||||||||
| value or nil = GetNPCBlackboard(entityID, valueName) |
| ||||||||
| entityIDArray = GetNPCs(destructibleID) |
| ||||||||
| entityIDArray = GetNPCsInSectorOnStations(sectorID, distance) |
| ||||||||
| GetNumAttackers |
| ||||||||
| GetNumErrors |
| ||||||||
| int = GetNumIncomingRemoteWares(wareType) |
| ||||||||
| int = GetNumLogbook([category]) |
| ||||||||
| int = GetNumMissions() |
| ||||||||
| GetNumObservers |
| ||||||||
| subsystemsTable = GetObjectRepairStatus(containerID) subsystemsTable subsystemsTable = { shieldgens = { [1] = component id, [2] = ... }, engines = { [1] = component id, [2] = ... }, weapons = { [1] = component id, [2] = ... }, jumpdrives = { [1] = component id, [2] = ... } } |
| ||||||||
| GetOffset |
| ||||||||
| GetOrigin |
| ||||||||
| licenceTable = GetOwnLicences(faction) licenceTable licenceTable = { [1] = { id = licence id, type = licence type, name = licence name, icon = licence icon, price = licence price, minrelation = minimum relation required, issellable = can the licence be bought }, [2] = { ... } } |
| ||||||||
| bool = GetPersonalizedCrashReportsOption() |
| ||||||||
| dockingbayIDArray = GetPlatforms(containerID) |
| ||||||||
| string = GetPlayerActivity() |
| ||||||||
| int = GetPlayerAmmoCount(macro) |
| ||||||||
| contextID or nil = GetPlayerContextByClass(class) |
| ||||||||
| GetPlayerControlledHullShield |
| ||||||||
| GetPlayerDroneDetails |
| ||||||||
| int = GetPlayerDroneSlots() |
| ||||||||
| GetPlayerDroneSpeed |
| ||||||||
| playerDroneTable = GetPlayerDroneStorageData() playerDroneTable playerDroneTable = { stored = total stored amount, [1] = { name = "Unit Name", amount = amountnumber, macro = Macro Name }, [2] = { ... } } |
| ||||||||
| GetPlayerDroneSystems |
| ||||||||
| componentID = GetPlayerEnvironmentObject() |
| ||||||||
| wareTable = GetPlayerInventory() wareTable wareTable = { [ware1] = { name = ware name amount = ware amount price = ware price }, [ware2] = { ... } } |
| ||||||||
| money = GetPlayerMoney() |
| ||||||||
| macro = GetPlayerPrimaryShipCockpitMacro() |
| ||||||||
| shipID = GetPlayerPrimaryShipID() |
| ||||||||
| macro = GetPlayerPrimaryShipMacro() |
| ||||||||
| roomID = GetPlayerRoom() |
| ||||||||
| GetPlayerShipHullShield |
| ||||||||
| GetPlayerShipShieldDetails |
| ||||||||
| GetPlayerSpeed |
| ||||||||
| GetPlayerSteeringStrength |
| ||||||||
| componentID = GetPlayerTarget() |
| ||||||||
| adapterTable = GetPossibleAdapters() adapterTable adapterTable = { [1] = { name = adapter name, ordinal = adapter ordinal } } |
| ||||||||
| productionInfoTable = GetPossibleProducts(productionmoduleID) productionInfoTable productionInfoTable = { [1] = { ware = product id, name = product name, cycletime = cycle duration, component = componentname resources = { [1] = { ware = resource id, name = resource name, cycle = cycle amount }, [2] = { ... } } }, [2] = { ... } } |
| ||||||||
| resolutionsTable = GetPossibleResolutions() resolutionsTable resolutionsTable = { [1] = { height = resolution height in px, width = resolution width in px }, [2] = { ... } } |
| ||||||||
| GetPrimaryShipWeapon |
| ||||||||
| entityIDArray = GetPrioritizedPlatformNPCs(dockingbayID) |
| ||||||||
| productionDataTable = GetProductionModuleData(productionmoduleID) productionDataTable if production queue empty: productionDataTable = { state = "empty" } else: productionDataTable = { state = "ProductionState", cycletime = CycleTime (only if state == "producing", otherwise 0), cycleefficiency = cycle efficiency percentage (100% default), remainingcycletime = Time remaining for this cycle (only if state == "producing", otherwise 0), cycleprogress = percentage of current cycle progress (only if state = "producing", otherwise 0), remainingtime = time until out of resources (does not take limited storage space into account), products = { efficiency = product efficiency percentage (100% default), [1] = { ware = "wareid", name = "Ware Name", amount = storageamount, cycle = cycleamount, component = componentname }, [2] = { ... } }, presources = { ... }, -- primary resources, analogous to products table sresources = { ... }, -- secondary resources, analogous to products table estimated = is data filtered? } |
| ||||||||
| productionmoduleIDArray = GetProductionModules(destructible) |
| ||||||||
| GetProgressElementDetails |
| ||||||||
| string = GetRadarModuleName(objectID) |
| ||||||||
| int = GetRadarOption() |
| ||||||||
| money or nil = GetReferenceProfit(container, ware, price, amount [, shoppinglistidx]) |
| ||||||||
| moduleArray = GetRegisteredModules() moduleArray moduleArray = { id = module id, name = module name, description = gamestart description, if any, image = gamestart image, if any } |
| ||||||||
removed 3.50 Beta 3 |
|
| ||||||||
removed 3.50 Beta 3 |
|
| ||||||||
added in 4.21 Beta 1 (VR: 4.20) | x, y, z = GetRelativeMousePosition(element[, sizedMousePoint]) Note that the return value is undefined if the element is not pickable at all or wasn't hit by the mouse cursor in the current frame. | 4.31 Beta 1: added sizedMousePoint parameter | ||||||||
| GetRelativePlayerShipPosition |
| ||||||||
| GetRemoteControlHUDIcons |
| ||||||||
| resourceTable = GetRepairResources(containerID or buildmoduleID, repairdestructibleID, sequence, stage, buildlimit, targethullfraction) resourceTable resourceTable = { [1] = { ware = ware id, name = ware name, cycle = amount, price = price }, [2] = { ... }, ..., totalprice = totalprice } |
| ||||||||
| resolutionTable = GetResolutionOption([checkconfig]) |
| ||||||||
| number = GetRumbleOption() |
| ||||||||
| productionmoduleID = GetSalesRepProduction(entityID) |
| ||||||||
| savegameTable = GetSaveList() savegameTable savegameTable = { filename = save filename, name = savegame name, version = savegame version, time = formatted save date, rawtime = save date, playtime = played time, playername = player name, location = save location, money = player money, difficulty = save difficulty, mindifficulty = minimum difficulty the save was ever set to, error = there was an error loading the savegame (non-localized error message in name property) [invalidgameid = the save is from an invalid game], [invalidversion = save version is higher than current game version], invalidpatches = { [1] = { id = patch id, name = patch name, state = patch state, requiredversion = version of this patch required by the savegame, installedversion = version of this patch that is installed }, [2] = { ... } } } | Performance critical, do not call unnecessarily. | ||||||||
added in 4.10 Beta 1 | savegameTable = GetSaveList2() Note to trigger population of the list GetSaveList2() returns, call the FFI function ReloadSaveList() first (or make sure it was called before at some point). |
| ||||||||
| GetScreenAspects |
| ||||||||
| getScreenInfo |
| ||||||||
| GetSecondaryShipWeapon |
| ||||||||
| sectorIDArray = GetSectors(clusterID) |
| ||||||||
| number = GetSensitivitySetting(rangeid) |
| ||||||||
| int = GetShaderQualityOption() |
| ||||||||
| int = GetShadowOption() |
| ||||||||
| shoppingListTable = GetShoppingList(containerID) shoppingListTable shoppingListTable = { [1] = { id = trade id, name = ware name, amount = trade amount, minamount = trade minimum amount, price = trade price, isbuyoffer = is the container selling?, isselloffer = is the container buying?, averageprice = trade ware avg. price, [station = trade partner, stationname = trade partner's name, stationzone = trade partner's zone name, stationsectorid = trade partner's sector,] iswareexchange = is it a ware exchange trade?, ispassive = is container passive? }, [2] = { ... } } |
| ||||||||
| GetSize |
| ||||||||
| GetSliderGranularity |
| ||||||||
| GetSliderText |
| ||||||||
| DEPRECATED GetSliderValues | DEPRECATED - use GetSliderValues2() instead | ||||||||
added in 4.10 Beta 1 | GetSliderValues2 |
| ||||||||
| GetSliderValueSuffix |
| ||||||||
| bool = GetSoftShadowsOption() |
| ||||||||
| bool = GetSoundOption() |
| ||||||||
| int = GetSSAOOption() |
| ||||||||
| GetStandardButtons |
| ||||||||
| macroArray = GetStandardUnitMacros(macro) |
| ||||||||
| ... = GetStatData(stat, ...) |
| ||||||||
| bool = GetSteeringNoteOption() |
| ||||||||
| bool = GetStopShipInMenuOption() |
| ||||||||
| storageDataTable = GetStorageData(destructibleID) storageDataTable storageDataTable = { modules = { [1] = storagemodule, [2] = ... } capacity = totalcapacityamount, stored = totalstoredamount, estimated = is data filtered?, [1] = { name = "cargobayname", capacity = capacityamount, stored = storedamount, consumption = totalconsumption, [1] = { ware = "wareid", name = "Ware Name", amount = amountnumber, volume = ware volume, consumption = consumption and production of this ware, }, [2] = ... }, [2] = ... } |
| ||||||||
| componentIDArray = GetSubordinates(controllableID [, commandertype]) |
| ||||||||
| string = GetSubtitleOption() |
| ||||||||
| GetTableColumnSpan |
| ||||||||
| GetTableColumnWidths |
| ||||||||
| GetTableFullHeight |
| ||||||||
| GetTableInitialSelectedColumn |
| ||||||||
| GetTableInitialSelectedRow |
| ||||||||
| GetTableInitialTopRow |
| ||||||||
| GetTableNumFixedRows |
| ||||||||
| GetTableNumRows |
| ||||||||
| GetTableRowColor |
| ||||||||
| GetTableRowHeight |
| ||||||||
UNSUPPORTED | GetTargetElementInfo |
| ||||||||
| GetText |
| ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED int = GetTextHeightExact(text, font, fontsize, width, wordwrap) | DEPRECATED - use FFI function GetTextHeight() instead | ||||||||
changed in 4.00 Beta 1 | int, actualwidth = GetTextNumLines(text, font, fontsize, width) | 4.00 Beta 1: added the second return value (actualwidth) | ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED int = GetTextWidth(text, fontname, fontsize) | DEPRECATED - use FFI function GetTextWidth() instead | ||||||||
| GetTimeLeft |
| ||||||||
UNSUPPORTED | GetTopTargetPriorityMessages |
| ||||||||
| money = GetTotalValue(containerID [, sellprice] [, referenceContainerID]) |
| ||||||||
| tradeData = GetTradeData(trade) tradeDataTable tradeData = { id = trade id, ware = trade ware, name = ware name, amount = trade amount, desiredamount = trade desired amount, minamount = trade min amount, price = trade price, marketprice = price without discounts/commissions, quantityfactor = market price / average price, total price = price * amount, totalmarketprice = market price * amount, isbuyoffer = is it a buy offer?, isselloffer = is it a sell offer?, rebundle = rebundle units?, unbundle = unbundle units? [station = trade container, stationname = trade container name, stationzone = trade container zone name, stationzoneid = trade container zone, stationsectorid = trade container sector, isplayer = is trade container player owned, pricemodifiers = { [1] = { name = modifier name, level = modifier level, amount = modifier amount, expire = modifier expire time }, [2] = { ... } }, faction = trade container faction,] expire = trade expire time } |
| ||||||||
changed in 4.00 Beta 4 | tradeDataArray = GetTradeList([tradeship], [sortby], [indexbyid]) tradeDataArray tradeDataArray = { [1 or IDString] = { id = trade id, ware = trade ware, name = ware name, amount = trade amount, desiredamount = trade desired amount, minamount = trade min amount, price = trade price, marketprice = price without discounts/commissions, quantityfactor = market price / average price, total price = price * amount, totalmarketprice = market price * amount, isbuyoffer = is it a buy offer?, isselloffer = is it a sell offer?, rebundle = rebundle units?, unbundle = unbundle units? [station = trade container, stationname = trade container name, stationzone = trade container zone name, stationzoneid = trade container zone, stationsectorid = trade container sector, isplayer = is trade container player owned, pricemodifiers = { [1] = { name = modifier name, level = modifier level, amount = modifier amount, expire = modifier expire time }, [2] = { ... } }, faction = trade container faction,] expire = trade expire time }, [2 or IDString] = { ... } } | Added "indexbyid" parameter in 4.00 Beta 4 | ||||||||
| restrictionsTable = GetTradeRestrictions(containerID) restrictionsTable restrictionsTable = { faction = global restriction to trade with other factions, overrrides = { [ware] = bool, ... } } |
| ||||||||
| tradeArray = GetTradesAtConnection(componentID, templateConnectionName) |
| ||||||||
| tradeShipData = GetTradeShipData(shipID) tradeShipData tradeShipData = { shipid = shipID, name = ship name, cargo = { ware = ware, name = ware name, amount = ware amount, volume = ware volume }, queue = { [1] = { id = trade id, name = ware name, amount = trade amount, minamount = trade min amount, price = trade price, isbuyoffer = is the ship selling?, isselloffer = is the ship buying?, averageprice = trade ware avg. price, [stationname = trade partner name, stationsectorid = trade partner sector] }, [2]= { ... } }, cargocurrent = currently used cargo space, cargomax = cargo capacity, cargofree = free cargo capacity, numtrips = number of planned trips } |
| ||||||||
| tradeShipDataArray = GetTradeShipList() tradeShipDataArray tradeShipDataArray = { [1] = { shipid = shipID, name = ship name, cargo = { ware = ware, name = ware name, amount = ware amount, volume = ware volume }, queue = { [1] = { id = trade id, name = ware name, amount = trade amount, minamount = trade min amount, price = trade price, isbuyoffer = is the ship selling?, isselloffer = is the ship buying?, averageprice = trade ware avg. price, [stationname = trade partner name, stationsectorid = trade partner sector] }, [2]= { ... } }, cargocurrent = currently used cargo space, cargomax = cargo capacity, cargofree = free cargo capacity, numtrips = number of planned trips }, [2] = { ... } } |
| ||||||||
| macroArray = GetTransportUnitMacros(macro) |
| ||||||||
| x2d, y2d, z, onscreen, width, height = GetUIElementRectangleScreenPosition(posID, minRecSize, maxRecSize) width and height indicate the size of the rectangle and is ensured to always be a multiply of 2. |
| ||||||||
| x2d, y2d, z, onscreen = GetUIElementScreenPosition(posID, iconSizeOnScreen, iconSizeOffScreen) |
| ||||||||
| relation = GetUIRelation(faction) |
| ||||||||
changed in 4.00 Beta 6 | unitTable = GetUnitStorageData(defensibleID [, unitcategory] [, virtualammo][, excluderestricted]) unitTable unitTable = { capacity = capacityamount, stored = storedamount, [categorystored = storedamount of this category] [1] = { macro = "macroname", name = "Unit Name", amount = amountnumber, unavailable = unavailablenumber, }, [2] = { ... } } | If you want to use the virtualammo flag, call SetVirtualCargoMode first. 4.00 Beta 6: added excluderestricted parameter | ||||||||
| resourceTable = GetUpgradesResources(containerID or buildmoduleID, upgradeDestructibleID, sequence, stage, buildlimit, upgradePlanArray) resourceTable resourceTable = { [1] = { ware = ware id, name = ware name, cycle = amount, price = price }, [2] = { ... }, ..., totalprice = totalprice } upgradePlanArray upgradePlanArray = { [1] = { [1] = upgradetype, [2] = level }, [2] = { ... } } |
| ||||||||
| string = GetVersionString() |
| ||||||||
| number = GetViewDistanceOption() |
| ||||||||
| GetViewSize |
| ||||||||
| number = GetVolumeOption(volumetype) |
| ||||||||
| bool = GetVSyncOption() |
| ||||||||
| int = GetWareCapacity(containerID, ware [, ignoreexisting = true]) |
| ||||||||
changed in 4.00 Beta 1, 4.00 Beta 4, 4.00 Beta 5 | ... = GetWareData(ware, ...) | "allowdrop" property added in 4.00 Beta 1 | ||||||||
| tradeDataArray = GetWareExchangeTradeList(tradingshipID, tradedcontainerID [, sortby]) tradeDataArray tradeDataArray = { [1] = { id = trade id, ware = trade ware, name = ware name, amount = trade amount, desiredamount = trade desired amount, minamount = trade min amount, price = trade price, marketprice = price without discounts/commissions, quantityfactor = market price / average price, total price = price * amount, totalmarketprice = market price * amount, isbuyoffer = is it a buy offer?, isselloffer = is it a sell offer?, rebundle = rebundle units?, unbundle = unbundle units? [station = trade container, stationname = trade container name, stationzone = trade container zone name, stationzoneid = trade container zone, stationsectorid = trade container sector, isplayer = is trade container player owned, pricemodifiers = { [1] = { name = modifier name, level = modifier level, amount = modifier amount, expire = modifier expire time }, [2] = { ... } }, faction = trade container faction,] expire = trade expire time }, [2] = { ... } } | Call SetVirtualCargoMode on tradingshipid and tradedcontainerid first, otherwise result will be empty. | ||||||||
| int = GetWareProductionLimit(containerID, ware) |
| ||||||||
| GetWordWrap |
| ||||||||
| zoneIDArray = GetZones(sectorID) |
| ||||||||
| yieldTable = GetZoneYield(zoneID [, skipmaxyields]) yieldTable yieldTable = { [1] = { ware = ware, name = ware name, amount = current yield, max = max yield }, [2] = { ... }, ..., snapshottime = time when data was taken, 0 if live. } | Performance critical, set skipmaxyields = true, if possible. | ||||||||
| bool = HasAllResourcesToCraft(entityID, ware) |
| ||||||||
added in 4.00 Beta 3 | bool = HasContainerStockLimitOverride(containerID, ware) |
| ||||||||
| bool = HasContainerWarePriceOverride(containerID or buildmoduleID, ware, buysellswitch) |
| ||||||||
| HasDroneControl |
| ||||||||
| HasFlightControl |
| ||||||||
| bool = HasLicence(faction, licencetype, licencefaction) |
| ||||||||
| HasShipControl |
| ||||||||
| bool = HasShipyard(spaceID) |
| ||||||||
| HasSliderTwoScales |
| ||||||||
| bool = HasTag(componentID, templateConnectionName, tagname) |
| ||||||||
| DEPRECATED int = HasToRestoreOptionsMenu() | DEPRECATED - This solution for static variables is deprecated. Use <savedvariable /> in ui.xml instead. | ||||||||
| bool = HaveExtensionSettingsChanged() |
| ||||||||
| HideMissionObjective |
| ||||||||
| HidePresentation |
| ||||||||
| HideView |
| ||||||||
| IncStatValue(stat[, addvalue]) |
| ||||||||
| InstallSteamDLC(appid) |
| ||||||||
| InterruptPlayerComputer() |
| ||||||||
| IsBorderEnabled |
| ||||||||
| IsButtonActive |
| ||||||||
| IsCheatVersion() |
| ||||||||
| bool IsComponentClass(componentID, classname) |
| ||||||||
| bool IsComponentConstruction(componentiD) |
| ||||||||
| bool = IsComponentOperational(componentID) |
| ||||||||
removed in 3.50 Beta 2 |
| replaced by IsValidComponent() | ||||||||
| bool = IsContainerOperationalRangeSufficient(containerID, spaceID) |
| ||||||||
| IsDialogActive |
| ||||||||
| bool = IsDockingPossible(shipID, dockingbayID) |
| ||||||||
| bool = IsFactionKnown(faction) |
| ||||||||
| IsFadeEnabled |
| ||||||||
| IsFirstPerson |
| ||||||||
| bool = IsGamepadActive() |
| ||||||||
| bool = IsInfoUnlockedForPlayer(componentID, info) |
| ||||||||
| IsInteractive |
| ||||||||
| bool = IsKnownItem(library, itemid) |
| ||||||||
| bool = IsMacroClass(macro, classname) |
| ||||||||
changed in 4.21 Beta 1 (VR: 4.20 Hotfix 1) | bool = IsObstructed(posID, canBeObstructedByOwnComponent[, ignoreCockpitObstruction]) | "ignoreCockpitObstruction" argument was added in 4.21 Beta 1 (VR:4.20 Hotfix 1) | ||||||||
| bool = IsPlayerFirstPerson() |
| ||||||||
| bool = IsSameComponent(component1ID, component2ID) |
| ||||||||
| bool = IsSameTrade(trade1ID, trade2ID) |
| ||||||||
| bool = IsSavingPossible() |
| ||||||||
| IsSelectable |
| ||||||||
| IsSliderCenterValueDisplayed |
| ||||||||
| IsSliderIndicatorInverted |
| ||||||||
| IsSliderScaleInverted |
| ||||||||
| IsSofttargetLocked |
| ||||||||
| bool = IsSteamworksEnabled() |
| ||||||||
| IsTableColumnWidthPercentage |
| ||||||||
| IsTableRowSelectable |
| ||||||||
| IsType |
| ||||||||
added in 3.50 Beta 2 | bool = IsValidComponent(componentID) |
| ||||||||
| IsValidWidgetElement |
| ||||||||
| bool = IsWareIllegalTo(ware, licencefaction [, policefaction]) |
| ||||||||
deprecated in 4.21 Beta 1 (VR: 4.20) | DEPRECATED LeaveInteractMenu() | DEPRECATED - use FFI function LeaveInteractMenu() instead | ||||||||
| ListenForInput() |
| ||||||||
| LoadGame(filename) |
| ||||||||
| LoadInputProfile(filename, personal) |
| ||||||||
| LockPresentation |
| ||||||||
| MakeRepairPriority(entityID, componentID) |
| ||||||||
| MovePlayerToZone(zoneID) | Needs cheats enabled. | ||||||||
| NewGame(modulename, difficulty) |
| ||||||||
| NotifyOnActionPerformed |
| ||||||||
| NotifyOnChangedEnvironmentObject |
| ||||||||
| NotifyOnChangedZone |
| ||||||||
| NotifyOnConversationFinished |
| ||||||||
| NotifyOnCutsceneStopped |
| ||||||||
| NotifyOnCycleWeapon |
| ||||||||
| NotifyOnHackAborted |
| ||||||||
| NotifyOnHackFinished |
| ||||||||
| NotifyOnHackStarted |
| ||||||||
added in 4.00 Beta 2 | NotifyOnInventoryWaresAdded |
| ||||||||
added in 4.00 Beta 3 | NotifyOnJumpDriveCharging |
| ||||||||
| NotifyOnMissionObjectiveBarUpdate |
| ||||||||
added in 4.31 Beta 1 | NotifyOnObservationStarted |
| ||||||||
added in 4.31 Beta 1 | NotifyOnObservationStopped |
| ||||||||
| NotifyOnPlayerControlStarted |
| ||||||||
| NotifyOnPlayerControlStopped |
| ||||||||
| NotifyOnScanAborted |
| ||||||||
| NotifyOnScanFinished |
| ||||||||
| NotifyOnScanStarted |
| ||||||||
| NotifyOnStartDialog |
| ||||||||
| NotifyOnStopDialog |
| ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED NotifyOnTargetElementDisplayed | DEPRECATED - use NotifyTargetElementShown() instead | ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED NotifyOnTargetElementHidden | DEPRECATED - use NotifyTargetElementHidden() instead | ||||||||
added in 4.31 Beta 1 | NotifyTargetElementHidden |
| ||||||||
added in 4.31 Beta 1 | NotifyTargetElementShown |
| ||||||||
| NotifyVoiceOutput |
| ||||||||
| OpenSteamOverlayStorePage([appid]) |
| ||||||||
| OpenSteamOverlayWebPage(url) |
| ||||||||
| OpenWorkshop(id, personal) |
| ||||||||
changed in 4.00 Beta 3 | Pause([explicit]) | Note: prior to 4.21 Beta 1 (VR: 4.20) a call to Pause() (or Pause(false) didn't display a Game Paused text. As of 4.21 Beta 1 (VR: 4.20) both cases will display this text now. | ||||||||
| PerformAction |
| ||||||||
| PlayAmbientSound |
| ||||||||
| PlayCredits() |
| ||||||||
| bool = PlayerPrimaryShipHasContents(key) |
| ||||||||
| PlaySound |
| ||||||||
added in 4.00 Beta 6 | PrepareIcon | UNSUPPORTED. Not designed to be used by mods. | ||||||||
| success = PrepareRenderTarget(texturename) | UNSUPPORTED. Not designed to be used by mods. | ||||||||
| ProceedFromMenu(convsection[, choiceparam][, baseparam]) |
| ||||||||
added in 4.21 Beta 1 (VR: 4.20) | QuickMenuOpened() |
| ||||||||
| QuitGame() |
| ||||||||
| QuitModule() |
| ||||||||
| RaisePlayerInteractionEvent |
| ||||||||
| text = ReadText(page, line) |
| ||||||||
| RegisterAddonBindings(addonname [, groupid = ""]) | UNSUPPORTED. Not designed to be used by mods. | ||||||||
| RegisterMouseInteractions(element) |
| ||||||||
| RegisterWidget |
| ||||||||
| ReleaseCutsceneDescriptor |
| ||||||||
| ReleaseDescriptor |
| ||||||||
depreacted in 4.31 Beta 1 | DEPRECATED ReleaseInteractionDescriptor(descriptor) | DEPRECATED - use FFI: ReleaseInteractionDescriptor() instead | ||||||||
| ReleaseListener |
| ||||||||
| ReleaseNotification |
| ||||||||
| ReleaseViewDescriptor |
| ||||||||
| RemoveAmmo(defensibleID, ammoMacro, amount) |
| ||||||||
| RemoveCargo(containerID, ware, amount) |
| ||||||||
| RemoveInventory(entityID, ware, amount) |
| ||||||||
| RemoveLogbookEntry(index [, category]) |
| ||||||||
| RemovePlayerDrone(macroname, amount) |
| ||||||||
| RemoveSofttarget |
| ||||||||
| requesterRemoved = RemoveSofttargetLockRequest(requesterID) Removes the lock-request for the specified requesterID. Note that the return value only indicates whether the requester was removed. It does not necessarily correspond to the target lock having been lifted (i.e. if there are still outstanding lock-requests). |
| ||||||||
| RepairDestructibles(destructible1ID, destructible2ID, ...) |
| ||||||||
| ReplacePlayerCockpit(cockpitmacro) |
| ||||||||
updated in 4.21 Beta 1 (VR: 4.20) | success = RequestSofttargetLock(requesterID) | 4.21 Beta 1 (VR: 4.20): added success return value | ||||||||
| ResetAllExtensionSettings() |
| ||||||||
| RestoreGameOptions() |
| ||||||||
| RestoreGraphicOptions() |
| ||||||||
| RestoreOptionsMenu() |
| ||||||||
| RestoreSoundOptions() |
| ||||||||
| ReturnFromMenu([returnparam]) |
| ||||||||
| SaveFullscreenOption() |
| ||||||||
| SaveGame(filename, savename) |
| ||||||||
| SaveInputProfile(filename, id, customname[, copyfromfile]) |
| ||||||||
| SaveInputSettings(actionTable, stateTable, rangeTable) actionTable actionTable = { [ActionID] = { [1] = { [1] = InputID Source, [2] = InputID Code, [3] = InputID Signum }, [2] = { ... } }, [ActionID] = { ... } } stateTable stateTable = { [StateID] = { [1] = { [1] = InputID Source, [2] = InputID Code, [3] = InputID Signum }, [2] = { ... } }, [StateID] = { ... } } rangeTable rangeTable = { [RangeID] = { [1] = { [1] = InputID Source, [2] = InputID Code, [3] = InputID Signum }, [2] = { ... } }, [RangeID] = { ... } } |
| ||||||||
| SaveResolutionOption() |
| ||||||||
| ScheduleReloadUI() |
| ||||||||
| SelectAction |
| ||||||||
| bool = SelectBackOption() |
| ||||||||
| SelectDialogOption |
| ||||||||
| SendEntityTransportDrone(entityID, containerID or nil) |
| ||||||||
added in 3.50 RC 1 | SignalObject(componentID [, param1] [, param2] [, param3] [, delay]) |
| ||||||||
| SendTransportDrone(sendingentityID, receivingentityID, waretype, wareAmountArray) wareAmountArray wareAmountArray = { [1] = { [1] = ware, [2] = amount }, [2] = { ... } } |
| ||||||||
| SetActiveMission(missionID) |
| ||||||||
| SetAdapterOption(adapterOrdinal) |
| ||||||||
| SetAimAssistOption(setting) |
| ||||||||
| SetAntiAliasModeOption(antialiasmode) |
| ||||||||
| SetAutorollOption() |
| ||||||||
| SetAutosaveOption() |
| ||||||||
| SetBoostToggleOption() |
| ||||||||
| responsibility = SetBudgetResponsibility(entityID, responsibility) |
| ||||||||
added in 3.60 Beta 1 | SetButtonColor(buttonID, r, g, b, alpha) |
| ||||||||
| SetButtonText |
| ||||||||
| SetCaptureHQOption() |
| ||||||||
| SetCellContent |
| ||||||||
| SetCollisionAvoidanceAssistOption() |
| ||||||||
| SetComponentName(componentID, name) |
| ||||||||
| SetConfineMouseOption() |
| ||||||||
added in 4.00 Beta 3 | SetContainerStockLimitOverride(containerID, ware, amount) |
| ||||||||
| SetContainerWarePriceOverride(containerID or buildmoduleID, ware, buysellswitch, price) |
| ||||||||
| SetCrashReportOption() |
| ||||||||
| SetDeadzoneOption(percentage) |
| ||||||||
| SetDifficultyOption(setting) |
| ||||||||
| SetDiffuseColor |
| ||||||||
| SetDistortionOption() |
| ||||||||
| SetEffectDistanceOption(distance) |
| ||||||||
| DEPRECATED SetEMCutsceneOption() | DEPRECATED - do not use | ||||||||
| SetExtensionSettings(id, personal, setting, value) |
| ||||||||
| SetFOVOption(fov) |
| ||||||||
| SetFullscreenDetailmonitorOption() |
| ||||||||
updated in 4.10 Beta 1 | bool = SetFullScreenOneToOne() | 4.10 Beta 1: added boolean return value. | ||||||||
added in 4.21 Beta 1 (VR: 4.20) | SetFullScreenWorldSpace() |
| ||||||||
| SetFullscreenOption(setting, [checksetting]) |
| ||||||||
| SetGamepadModeOption(setting) |
| ||||||||
| SetGammaOption(gamma) |
| ||||||||
| SetGfxQualityOption(setting) |
| ||||||||
| SetGlowOption(setting) |
| ||||||||
| SetHeight |
| ||||||||
| SetIcon |
| ||||||||
| SetInversionSetting(rangeid, configname) |
| ||||||||
| SetJoysticksOption(joystick, guid) |
| ||||||||
| SetLegacyMainMenuOption() |
| ||||||||
| SetLegacyShadersOption() |
| ||||||||
| SetLODOption(lodfactor) |
| ||||||||
| SetMainMissiontargetMessage(posID, messageID) | UNSUPPORTED. Not designed to be used by mods. | ||||||||
| amount = SetMaxBudget(entityID, amount) |
| ||||||||
| amount = SetMinBudget(entityID, amount) |
| ||||||||
deprecated in 4.21 Beta 1 (VR: 4.20) | DEPRECATED SetMouseOverride(element, cursorIcon) | DEPRECATED - use SetPointerOverride() instead (simply pass the cursorIcon as pointerID) | ||||||||
| SetMouseSleeping() |
| ||||||||
| SetNonSquadShipsForTradeOffersOption() |
| ||||||||
changed in 4.10 Beta 5 | SetNPCBlackboard(entityID, valueName, value) | 4.10 Beta 5: If the "value" is nil, the blackboard variable is cleared. | ||||||||
| SetNPCSkill(entityID, skill, value) |
| ||||||||
| SetPersonalizedCrashReportsOption() |
| ||||||||
added in 4.21 Beta 1 (VR: 4.20) | SetPointerOverride(element, pointerID) |
| ||||||||
added in 4.31 Beta 1 | SetPriorityMissionTargetMessage(posID, messageID) | UNSUPPORTED. Not designed to be used by mods. | ||||||||
| SetRadarOption(setting) |
| ||||||||
added in 4.00 Beta 1 | SetRenderTargetOneToOne() |
| ||||||||
| SetRenderTargetSize(texturename, width, height) | UNSUPPORTED. Not designed to be used by mods. | ||||||||
| SetResolutionOption(width, height [, checksetting]) |
| ||||||||
| SetRumbleOption(setting) |
| ||||||||
| SetSensitivitySetting(rangeid, configname, sensitivity) |
| ||||||||
| SetShaderQualityOption(setting) |
| ||||||||
| SetShadowOption(setting) |
| ||||||||
| SetSoftShadowsOption() |
| ||||||||
| SetSofttarget |
| ||||||||
| SetSoundOption() |
| ||||||||
| SetSSAOOption(setting) |
| ||||||||
| SetStatValue(stat, value) |
| ||||||||
| SetSteeringNoteOption() |
| ||||||||
| SetStopShipInMenuOption() |
| ||||||||
| SetSubtitleOption(setting) |
| ||||||||
| SetText |
| ||||||||
| SetTextColor |
| ||||||||
| SetTextureColorMode |
| ||||||||
| SetViewDistanceOption(distance) |
| ||||||||
| SetVirtualCargoMode(containerID, onoff) | Virtual cargo mode should be disabled again when leaving the current menu. | ||||||||
| SetVolumeOption(volumetype, volume) |
| ||||||||
| SetVSyncOption() |
| ||||||||
| SetWidth |
| ||||||||
deprecated in 4.21 Beta 1 (VR: 4.20) | DEPRECATED ShowInteractMenu() | DEPRECATED - use FFI function EnterInteractMenu() instead | ||||||||
| ShowMissionObjective |
| ||||||||
| ShowPresentation |
| ||||||||
| StartAutoPilot(componentID) |
| ||||||||
| StartBriefing(missionid, {texturename1, ...}) |
| ||||||||
added in 4.21 Beta 1 (VR: 4.20) | success = StartConversationFromMenu(conversation, actor, convparam) |
| ||||||||
| StartCutscene |
| ||||||||
| StartPlayingSound |
| ||||||||
| success = StartSubConversationFromMenu(conversation, actor[, convparam][, baseparam][, view]) |
| ||||||||
| StopAutoPilot() |
| ||||||||
| StopBriefing(missionid) |
| ||||||||
| StopCutscene |
| ||||||||
| StopPlayingSound |
| ||||||||
| StopRestoringOptionsMenu() |
| ||||||||
| SwitchInteractiveObject |
| ||||||||
| ToggleFactionTradeRestriction(containerID) |
| ||||||||
| ToggleFactionTradeWareOverride(containerID, ware) |
| ||||||||
| ToggleMissionGuidance(missionid) |
| ||||||||
| TraceBack |
| ||||||||
| transferredAmount = TransferInventoryToPlayer(ware, amount, entityID) |
| ||||||||
| transferredMoney = TransferMoneyToPlayer(amount, entityID) |
| ||||||||
| transferredAmount = TransferPlayerInventoryTo(ware, amount, entityID) |
| ||||||||
| transferredMoney = TransferPlayerMoneyTo(amount, entityID) |
| ||||||||
| text = TruncateText(text, fontname, fontsize, width [, wordwrap, textheight]) |
| ||||||||
| UninstallSteamDLC(appid) |
| ||||||||
changed in 4.00 Beta 3 | Unpause([explicit]) |
| ||||||||
| UnregisterAddonBindings(addonname, [, groupid = ""]) | UNSUPPORTED. Not designed to be used by mods. | ||||||||
deprecated in 4.31 Beta 1 | DEPRECATED UnsetMapRenderTarget() | DEPRECATED - use FFI function UnsetRadarRendertTarget() instead | ||||||||
deprecated in 4.21 Beta 1 (VR: 4.20) | DEPRECATED UnsetMouseOverride(element) | DEPRECATED - use UnsetPointerOverride() instead | ||||||||
added in 4.21 Beta 1 (VR: 4.20) | UnsetPointerOverride(element) |
| ||||||||
added in 4.31 Beta 1 | UnregisterMouseInteractions(element) |
| ||||||||
| UnsuspendConversation |
| ||||||||
| UpdateRegisteredWidget |
| ||||||||
| UpgradeObject(destructibleID, upgradetype, level) |
|
// @since 4.31 Beta 1: depreacted (use NotifyTargetElementShown)