Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Next »

VersionFunctionNote
 AbilityMenuClosed()
Notifies the system that the ability menu was closed.
 
 AbortMission(missionID)
Aborts the specified mission.
 
 ActivateDroneAbility(droneSlotNumber)
Activates the drone in the given drone slot number (valid range: 1-8).
 
 

ActivatePassiveDroneAbilities()
Activates all drones with passive abilities.

 
 AddAmmo(defensibleID, ammoMacro, amount)
Adds the specified amount of the ammo to the object.
 
 

AddCargo(containerID, ware, amount)
Adds the specified amount of the ware to the object.

 
 

AddInventory(entityID, ware, amount)
Adds the specified amount of the ware to the inventory of the entity. 

 
 

AddKnownItem(library, item)
Adds the item to the specified library, if not yet added. 

 
 AddLicence(faction, licencetype, licencefaction)
Adds the licence of the specified type of the licencefaction to the faction
 
 

AddLogbookEntry(category, text [, interaction [, interactioncomponent]])
Adds text as a logbook entry in the specified category.

 
 transferredamount = AddMoney(entityID, amount)
Adds or removes the specified amount to the entity account 
 
 AddPlayerDrone(macro, amount)
Adds specified macro as drones to the playership.
 
 tradeID = AddTradeToShipQueue(tradeID, containerID, amount)
Adds the specified trade to the queue of the container. Returns ID of the trade on the queue.
 
 AddUITriggeredEvent(screen, control)
Triggers MD/AI event condition <event_ui_triggered />.
 
 

AddUnits(defensibleID, unitMacro, amount, unavailable)
Adds or removes the specified amount of units to/from the defensible. Units can be flagged unavailable.

 
 string = AdjustMultilineString(string)
Helper function to fix unsupported line breaks.
 
 AIRangeUpdated(controllableID, entityID)
Triggers the object signal "range_setting_updated" on all subordinates of the controllable.
 
 AreAttackersInWarningRange 
 AreObserversInWarningRange 
 AreSliderValuesFixed 
 AttackEnemySettingChanged(defencenpcID)
Triggers the object signal "update config" on defence npc
 
 hullfraction = CalculateBuildSlotHullFraction(componentID, sequence, stage)
Calculates the fraction of hull for an individual build slot of the component.
 
 hullfraction = CalculateTotalHullFraction(componentID)
Calculates the fraction of hull of the component. 
 
 bool = CanBeSubordinateOf(controllableID, othercontrollableID)
Checks whether the controllable can be subordiante of the othercontrollable.
 
 success = CancelConversation()
Cancels the current conversation, e.g. when closing a conversation menu.
 
 bool, error = CanTradeWith(tradeID, containerID, amount)
Checks if trade is possible for the specified container.
It may be necessary to call SetVirtualCargoMode on containerID first, if the container has a shopping queue.
 bool = CanViewLiveData(objectID or zoneID)
Checks whether live data is available for the specified object or zone.
 
 bool = CheckInputProfileRegression()
Checks whether inputmap.xml version regressed in the past.
 
 bool = CheckSuitableTransportType(containerID, ware)
Checks whether the specified container can transport the ware. 
 
 ClearContainerWarePriceOverride(destructibleID [, ware] [, buysellswitch])
Removes custom prices from the container of the destructible. Optional only for the specified ware and only buy/sell prices.
 
 ClearErrors 
 ClearLogbook([keepnumentries [, category]])
Removes all entries from the logbook. Optional a number of entries can be preserved and only affect a specified category.
 
 ClearTradeQueue(containerID)
Clear the trade queue of the specified container. 
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)
Compare the length of one jump route with another. Both are specified with the amount of gate transitions and jumps they include. 
 
 64-bit int = ConvertIDTo64Bit(luaID)
Converts a luaID to a 64-bit integer, e.g.to interface with an FFI function.
 
 string = ConvertIntegerString(number [, separators [, accuracy [, notrailingspaces [, colorprefix]]]])
Formats number into a string with a given accuracy, thousand seperators, trailing spaces to offset SI prefixes and colored SI prefixes.
 
 string = ConvertMissionLevelString(difficulty)
Converts the difficulty of a mission into a string.
 
 string = ConvertMoneyString(money [,showcents [, separators [, accuracy [, notrailingspaces [, colorprefix]]]]])
Formats a money value into a string with a given accuracy, thousand seperators, credit cents, trailing spaces to offset SI prefixes and colored SI prefixes.
 
 64-bit int = ConvertStringTo64Bit(64BitStringID)
Converts a string representing a 64-bit value to a 64-bit integer. 
 
 luaID = ConvertStringToLuaID(64BitStringID)
Converts a string representing a 64-bit value to a luaID, e.g. to pass it to MD/AI as a component.
 
 

string = ConvertTimeString(time [, format [, separators [, accuracy]]])
Formats a time value in seconmds into a string with a format, seperators and accuracy.

Possible formats:

  • %s: All seconds
  • %S: Seconds (00-59)
  • %m: All minutes
  • %M: Minutes (00-59)
  • %h: All hours
  • %H: Hours (00-23)
  • %d: All days
  • %%: A % sign
  • %T: Use time format from TextDB, showing days only if time > 1d

Separators: Use thousand separators, only applies to %s, %m, %h, %d
Accuracy: Number of fractional digits. Only applies to %s and %S. Default is 0. Use -1 for automatic display. A non-zero value is not compatible with separators.

 
 CreateButton 
 CreateCutsceneDescriptor 
 CreateEditBox 
 CreateFontString 
 CreateIcon 
 descriptor = CreateInteractionDescriptor(param1, param2)
Creates an interaction descriptor with the specified parameters.
 
 clusterID, objectID = CreateObjectInPresentationCluster(objectmacro [, backgroundmacro])
Creates the specified object in a new cluster with the optional background.
The cluster needs to be destroyed using DestroyPresentationCluster, when it is no longer needed.
 CreateProgressElement 
 CreateRenderTarget 
 CreateSink 
 CreateSlider 
 CreateSliderTableView 
 CreateSliderView 
 CreateSource 
 CreateTable 
 CreateTableView 
 CreateThreeTableRenderTargetView 
 CreateThreeTableView 
 CreateTimer 
 CreateTwoTableRenderTargetView 
 CreateTwoTableSliderRenderTargetView 
 CreateTwoTableSliderView 
 CreateTwoTableView 
 DeactivateView 
 DebugError 
 DebugProfileStart 
 DebugProfileStop 
 DestroyPresentationCluster(clusterID)
Destroys a previously created cluster and everything inside it.
 
 DialogMenuHidden 
 DialogMenuShown 
 DisableMissionObjectiveBar 
 DisplayView 
 DumpAllMessages 
 DumpAllMessageSinks 
 DumpAllMessageSources 
 EnableMissionObjectiveBar 
 EventmonitorInteractionHidden 
 EventmonitorInteractionShown 
 ExecuteDebugCommand 
 text or nil = ExistsText(page, line)
Returns text if it exists, nil otherwise.
 
 numgates, numjumps = FindJumpRoute(fromsectorID, tosectorID)
Calculates the distance between two sectors in number of gate transitions and jumps needed.
 
 ForceAnarkUpdate 
 ... = GetAccountData(entityID, ...)
Returns properties of the account of the specified entity. Possible properties are: "money", "minmoney", "maxmoney", "isdummy".
 
 GetActionDetails 
 GetActionInfo 
 componentID or nil = GetActiveGuidanceMissionComponent()
Returns the component with the active mission guidance if any.
 
 GetActiveMission 
 string = GetAdapterOption()
Returns the name of the current adapter.
 
 int = GetAimAssistOption()
Get current setting of the aim assist option. 
 
 GetAlignment 
 componentIDArray = GetAllCommanders(controllableID)
Returns the chain of commanders for the specified controllable.
 
 

extensionSettingsTable = GetAllExtensionSettings()
Returns the settings for all registered extensions.

extensionSettingsTable
extensionSettingsTable = {
  [extensionid] = {
    enabled = is extension enabled?,
    sync = is extension synced?
  },
  ...
}
 
 

upgradeArray = GetAllMacroUpgrades(macro, sequence, stage, buildlimit)
Returns information about all upgrades on a specified macro, with options to limit the information to parts of the buildplan.

upgradeArray
upgradeArray = {
  [1] = {
    upgrade = upgrade type,
    name = upgrade name,
    total = total of available slots
  },
  [2] = { ... }
} 
 
 stringArray = GetAllStatIDs()
Returns the ids of all statistic properties.
 
 

upgradeTable = GetAllUpgrades(destructibleID [, buildlimit] [, tag])
Returns information about all upgrades of the specified destructible, with options to limit the information to the base buildplan and/or upgrades with the specified 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)
Returns information of all primary weapons and missiles of the destructible.

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)
Returns information of ammo counts on the container after the trade queue is resolved.

wareKeyTable
wareKeyTable = {
  [ware] = amount,
  ...
}
Call SetVirtualCargoMode on containerID first, otherwise result will be empty.
 int = GetAntiAliasModeOption()
Returns the current anti alias mode setting.
 
 

aaModesArray = GetAntiAliasModes()
Returns all possible anti alias modes currently possible. 

 
 componentID or nil = GetAutoPilotTarget()
Returns the target of the auto pilot, if any.
 
 bool = GetAutorollOption()
Returns current autoroll setting. 
 
 bool = GetAutosaveOption()
Returns current autosave setting. 
 
 fontsize = GetBestFontSize(fontname, fontsize)
Returns the best matching font size available for the specified font and size. 
 
 

bonusContentArray = GetBonusContentData()
Returns information about all bonus content.

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()
Returns the current boost toggle setting. 
 
 ... = GetBudgetData(entityID, ...)
Returns properties of the budget of the specified entity. Possible properties are: "min", "max", "responsibility".
 
 

componentID or nil = GetBuildAnchor(containerID or buildmoduleID)
Returns the build anchor of a container or buildmodule, e.g. the station a CV is building. 

 
 

builderMacrosArray = GetBuilderMacros(containerID or buildmoduleID)
Returns all information about all macros a container or buildmodule can build.

builderMacrosArray
builderMacrosArray = {
  [1] = {
    macro = macro,
    name = name
  },
  [2] = { ... }
}
 
 method = GetBuildProductionMethod(containerID or buildmoduleID, macro)
Returns the production method used by the specified container or buildmodule to produce macro. 
 
 

duration = GetBuildSlotDuration(macro or componentID, sequence, stage)
Returns the time the construction of the specified build slot takes on average.

 
 

resourceTable = GetBuildSlotResources(containerID or buildmoduleID, macro or componentID, sequence, stage, upgradePlanArray)
Returns the needed resources to build the specified build slot with this container or buildmodule.

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)
Returns all modules included in the specified buildslot. 

moduleArray
moduleArray  = {
  [1] = {
    macro = module macro,
    name = module name,
    library = moduletypes library
  },
  [2] = { ... }
}
 
 

upgradeTable = GetBuildStageUpgrades(containerID, sequence, stage [, buildlimit] [, tags])
Returns information about all upgrades of the specified buildslot, with options to limit the information to the base buildplan and/or upgrades with the specified tag.

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)
Returns information about the build tree of the specified macro or component.

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()
Returns current capture hq setting. 
 
 

wareKeyTable = GetCargoAfterShoppingList(containerID)
Returns information of ammo counts on the container after the trade queue is resolved.

wareKeyTable
wareKeyTable = {
  [ware] = amount,
  ...
}
Call SetVirtualCargoMode on containerID first, otherwise result will be empty.
 GetCellContent 
 GetCellText 
 GetChildren 
 GetClosestAttackerDistance 
 GetClosestHighwaySection 
 GetClosestObserverDistance 
 componentIDArray = GetClusters([showonmap])
Returns an array of all player-known clusters.
 
 

collectableDataTable = GetCollectableData(collectableID)
Returns information on the content of the specified collectable. 

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
}
 
 bool = GetCollisionAvoidanceAssistOption()
Returns current collision avoidance assist option. 
 
 GetColor 
 

commanderID or nil = GetCommander(controllableID)
Returns commander of specified controllable, if any. 

 
 entityID or nil = GetCommanderEntity(controllableID)
Returns commanding entity of specified controllable, if any. 
 
 

... = GetComponentData(componentID, ...)
Returns properties of the specified component. Possible properties are:

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"

- Ship:
  "hasjumpdrive", "basejumpcost", "issellable"

- 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"

- 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"
 
removed 3.50 Beta 3
GetComponentFactionName 
 name = GetComponentName(componentID, fontname, fontsize, availablewidth[, omitfaction[, forcewidth]])
Returns the name of the component. Iff the component is an object the name is formatted accordingly to the given parameters.
 
 bool = GetConfineMouseOption()
Returns the current confine mouse option. 
 
 objectIDArray = GetContainedObjectsByOwner(faction, [space])
Returns an array of objects owned by the specified faction. Optionally results can be confined to a specified space.
 
 shipIDArray = GetContainedShips([space], [showonmap])
Returns an array of ships in the specified space or the galaxy. 
 
 

shipIDArray = GetContainedShipsByOwner(faction, [space])
Returns an array of ships owned by the specified faction. Optionally results can be confined to a specified space.

 
 stationIDArray = GetContainedStations([space], [showonmap], [includeconstruction])
Returns an array of stations in the specified space or the galaxy.
 
 stationIDArray = GetContainedStationsByOwner(faction, [space])
Returns an array of stations owned by the specified faction. Optionally results can be confined to a specified space.
 
 price = GetContainerWarePrice(containerID or buildmoduleID, ware, buysellswitch)
Returns the price the specified container buys/sells the ware.
 
 contextID or nil = GetContextByClass(componentID, classname [, includeself])
Returns the context of the specified class of the component. 
 
 entityID or nil = GetControlEntity(controllableID, commandertype)
Returns the control entity of the specified controllable of the given type.
 
 GetControllerInfo 
 bool = GetCrashReportOption()
Returns the current crash report setting.
 
 time = GetCurRealTime()
Returns the real time since session start in seconds.
 
 

sequence, stage, progress, upgradePlanArray = GetCurrentBuildSlot(containerID)
Returns information about the current build process of the specified container. Returns nil if not currently building.

upgradePlanArray
upgradePlanArray = {
  [1] = {
    [1] = upgradetype,
    [2] = level
  },
  [2] = { ... }
}


 
 

resourceTable = GetCurrentBuildSlotResources(containerID or buildmoduleID)
Returns the needed resources to build the current build slot under construction by this container or buildmodule.

resourceTable
resourceTable = {
  [1] = {
    ware = ware id,
    name = ware name,
    cycle = amount,
    price = price
  },
  [2] = { ... },
  ...,
  totalprice = totalprice
}
 
 

string = GetCurrentModuleName()
Returns the name of the current game module.

 
 time = GetCurTime()
Returns the ingame time in seconds. 
 
 GetDate 
 int = GetDeadzoneOption()
Returns the current deadzone setting. 
 
 GetDialogOption 
 string = GetDifficultyOption()
Returns the current difficulty setting. 
 
 bool = GetDistortionOption()
Returns the current distortion setting. 
 
 dronecommanderID or nil = GetDroneCommander(drone)
Returns the drone commander of the specified drone, if any. 
 
 droneIDArray = GetDrones(shipID)
Returns an array of all drones of that ship. 
See also GetUnitStorageData.
 GetDroneWeapon 
 GetEditBoxCloseMenuOption 
 GetEditBoxColor 
 GetEditBoxFont 
 GetEditBoxHotkeyDetails 
 GetEditBoxText 
 GetEditBoxTextAlignment 
 GetEditBoxTextColor 
 

number = GetEffectDistanceOption()
Returns the current effect distance setting.

 
 stringArray = GetEfficiencyUpgrades(destructible)
Returns an array with the macro names of all efficiency upgrades connected to the specified destructible.
 
 

bool = GetEMCutsceneOption()
Returns false 

(warning)DEPRECATED
 .. = GetEntityTypeData(entitytype, ...)
Returns properties of the specified component. Possible properties are: "name", "icon" 
 
 GetError 
 GetErrorSeverity 
 GetErrorTimestamp 
 GetEventMonitorDetailsBridge 
removed in 3.50 RC 1GetEventmonitorName 
 

extensionTable = GetExtensionList()
Returns information about all extensions.

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)
Returns the update warning text of a workshop extension, if any.
 
removed 3.50 Beta 3
GetFactionDetails 
 GetFont 
 GetFontHeight 
 number = GetFOVOption()
Returns current fov setting. 
 
 GetFrameBackgroundID 
 GetFrameOverlayID 
 GetFramePosition 
 amount = GetFreeCargoAfterShoppingList(containerID, ware)
Returns amount of free cargo space for the specified ware after the trade queue will be resolved. 
Call SetVirtualCargoMode on containerID first, otherwise result will be empty.
 amount = GetFreeUnitStorageAfterShoppingList(containerID)
Returns amount for free unit storage space for the specified container.
Call SetVirtualCargoMode on containerID first, otherwise result will be empty.
 bool = GetFullscreenDetailmonitorOption()
Returns the current fullscreen detailmonitor setting. 
 
 fullscreen, borderless = GetFullscreenOption()
Returns the current fullscreen and borderless setting.
 
 int = GetGamepadModeOption()
Returns the current gamepad mode setting. 
 
 number = GetGammaOption()
Returns the current gamma setting.
 
 gateIDArray = GetGates(space [, showonmap])
Returns an array of gates in the specified space.
 
 int = GetGfxQualityOption()
Returns the current gfx quality setting. 
 
 bool = GetGlobalSyncSetting()
Returns the current global extension sync setting. 
 
 int = GetGlowOption()
Returns the current glow setting. 
 
 GetHeader 
 

licenceTable = GetHeldLicences(faction)
Returns a table with information about all held licences of the specified 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)
Returns the defined x, y coordinates of the specified position in percent with (0, 0) being in the upper left corner. Hint positions can be defined in parameters.xml.
 
 

productionColor, buildColor, storageColor, radarColor, dronedockColor, efficiencyColor, defenceColor, playerColor, friendColor, enemyColor, missionColor = GetHoloMapColors()
Returns the colors defined for various holomap items in parameters.xml.

Color
Color = {
  r = red (0-255),
  g = green (0-255),
  b = blue (0-255),
  a = alpha (0-100)
}
 
 GetIconDetails 
 

wareKeyTable = GetIncomingRemoteWares(wareType)
Returns information about incoming remote transport wares.

wareKeyTable
wareKeyTable = {
  [ware] = amount,
  ...
}
 
 

actionTable = GetInputActionMap()
Returns the current input actions mapped.

actionTable
actionTable = {
  [ActionID] = {
    [1] = {
      [1] = InputID Source,
      [2] = InputID Code,
      [3] = InputID Signum
    },
    [2] = { ... }
  },
  [ActionID] = { ... }
}
 
 

inputProfileTable = GetInputProfiles()
Returns information about the current input profiles.

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()
Returns the current input ranges mapped.

rangeTable
rangeTable = {
  [RangeID] = {
    [1] = {
      [1] = InputID Source,
      [2] = InputID Code,
      [3] = InputID Signum
    },
    [2] = { ... }
  },
  [RangeID] = { ... }
}
 
 

stateTable = GetInputStateMap()
Returns the current input states mapped.

stateTable
stateTable = {
  [StateID] = {
    [1] = {
      [1] = InputID Source,
      [2] = InputID Code,
      [3] = InputID Signum
    },
    [2] = { ... }
  },
  [StateID] = { ... }
}
 
 

GetInteractiveObject

 
 

wareTable = GetInventory(entityID)
Returns information about the wares held in the inventory of specified entity.

wareTable
wareTable = {
  [ware1] = {
    name = ware name
    amount = ware amount
    price = ware price
  },
  [ware2] = { ... }
}
 
 

bool = GetInversionSetting(rangeid)
Returns the current inversion setting for the specified input range. 

 
 

joystickTable = GetJoysticksOption()
Returns information about currently connected joysticks.

joystickTable = {
  [1] = {
    name = joystick name,
    guid = joystick guid
  },
  [2] = { ... }
}
 
 

jumpbeaconIDArray = GetJumpBeacons(zoneID, [showonmap])
Returns an array of jumpbeacons in the specified zone.

 
 bool = GetLegacyMainMenuOption()
Returns the current legacy main menu setting. 
 
 bool = GetLegacyShadersOption()
Returns the current legacy shaders setting. 
 
 

libraryTable = GetLibrary(library)
Returns information about the items in the specified library.

libraryTable
libraryTable = {
  [1] = {
    id = item id,
    name = item name,
    icon = item icon
    [parent = item parent]
    [relation = player relation]
  },
  [2] = { ... }
}
 
 

entryTable = GetLibraryEntry(library, itemid)
Returns detailed information about the specified library entry.

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,
  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]
}
 
 int = GetLibrarySize(library)
Returns the size of the specified library. 
 
 GetLiveDataBridge 
 GetLoadingInfo 
 string = GetLocalizedKeyName(actionid)
Returns the name of the key assigned to the specified input action.
 
 string = GetLocalizedRawKeyName(keycode)
Returns the name of the specified keycode. 
 
 GetLocalMousePosition 
 number = GetLODOption()
Returns the current lod setting. 
 
 

logbookTable = GetLogbook(start, count [, category])
Returns logbook entries in the specified range, optionally filtered by 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
}
 
 ... = GetMacroData(macro, ...)
Returns properties of the specified macro. Possible properties are:
"name", "icon", "efficiencyfactor", "efficiencybonus", "ware", "primarypurpose", "primarypurposename", "storagecapacity", "storagetags"
 
 int = GetMacroUnitStorageCapacity(macro, sequence, stage [, buildlimit])
Returns the capacity of unit storage on the specified macro build slot.
 
 joystickIndexArray = GetMappedJoysticks()
Returns an array of joysticks currently mapped for input. Indices refer to the return value of GetJoysticksOption().
 
 GetMaxRemoteControlRange 
 stringLength = GetMaxTextLength(text, fontname, fontsize, width)
Returns the maximum length of the specified text which can fit in the given width in this font. 
 
 param, param2 = GetMenuParameters()
Returns the parameters the current menu was opened with.
 
 GetMessageScreenPosition 
 GetMiniGameCursorPosition 
 macroArray = GetMiningUnitMacros(macro)
Returns all unit macros the specified macro can use to mine, if any.
 
 missionID, name, description, difficulty, maintype, subtype, faction, reward, briefingobjectives, activebriefingstep, timeleft, duration, abortable, guidancedisabled = GetMissionDetails(missionIndex, fontname, fontsize, textwidth)
Returns details of the specified mission.
 
 objectivetext, objectiveicon, timeout, progressname, curprogress, maxprogress, objectivetargets = GetMissionObjective(missionIndex, fontname, fontsize, textwidth)
Returns details of the specified mission's objective.
 
 GetMissionObjectiveBarInfo 
 name, desc, faction, type, level, reward, opposingfaction, licence, associatedcomponent = GetMissionOfferAtConnection(componentID, templateConnectionName)
Returns details about the mission offer at the specified location. 
 
 name, description, difficulty, maintype, subtype, faction, reward, briefingobjectives, activebriefingstep = GetMissionOfferDetails(offerID, fontname, fontsize, textwidth)
Returns details about the specified mission offer. 
 
 type = GetModuleType(destructibleID)
Returns the module type of the specified destructible. 
 
 resourceTable = GetNeededBuildSlotResources(containerID or buildmoduleID)

Returns the needed resources of the specified buildmodule.

resourceTable
resourceTable = {
  [1] = {
    ware = ware id,
    name = ware name,
    cycle = amount,
    price = price
  },
  [2] = { ... },
  ...,
  totalprice = totalprice
}
 
 bool = GetNonSquadShipsForTradeOffersOption()
Returns the setting whether non-squad ships should be included in the trade offers menu. 
 
 GetNotificationDetails 
 GetNotificationPriority 
 componentIDArray = GetNotUpgradesByClass(destructibleID, class)
Returns an array of all components included in the specified destructible of the specified class, which are not upgrades. 
 
 value or nil = GetNPCBlackboard(entityID, valueName)
Return the blackboard variable "valueName" from the blackboard of the specified entity.
 
 entityIDArray = GetNPCs(destructibleID)
Returns an array of entities in the specified desctructible.
 
 entityIDArray = GetNPCsInSectorOnStations(sectorID, distance)
Returns an array of entities on stations in the specified sector within the given distance to the player.
 
 GetNumAttackers 
 GetNumErrors 
 int = GetNumIncomingRemoteWares(wareType)
Returns the number of incoming remote transport wares for specified type.
 
 int = GetNumLogbook([category])
Returns the number of logbook entries, optionally filtered by the given category. 
 
 int = GetNumMissions()
Returns the number of accecpted missions. 
 
 GetNumObservers 
 

subsystemsTable = GetObjectRepairStatus(containerID)
Returns information of all damaged subsystems of the specified container. 

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)
Returns information of the own licences the specified faction offers.

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()
Returns the setting to send personalized crash reports. 
 
 dockingbayIDArray = GetPlatforms(containerID)
Returns an array of dockingbays that are platforms of the specified container.
 
 string = GetPlayerActivity()
Returns the current player mode. 
 
 int = GetPlayerAmmoCount(macro)
Returns the ammo count of the specified macro on the player ship. 
 
 contextID or nil = GetPlayerContextByClass(class)
Returns the context of the player with the specified class, if any. 
 
 GetPlayerControlledHullShield 
 GetPlayerDroneDetails 
 int = GetPlayerDroneSlots()
Returns the number of drone slots on the player ship.
 
 GetPlayerDroneSpeed 
 

playerDroneTable = GetPlayerDroneStorageData()
Returns information on the drones of the playership.

playerDroneTable
playerDroneTable = {
  stored = total stored amount,
  [1] = {
    name = "Unit Name",
    amount = amountnumber,
    macro = Macro Name
  },
  [2] = { ... }
}
 
 GetPlayerDroneSystems 
 componentID = GetPlayerEnvironmentObject()
Returns the player's enviroment object. 
 
 

wareTable = GetPlayerInventory()
Returns information about the wares held in the inventory of specified entity.

wareTable
wareTable = {
  [ware1] = {
    name = ware name
    amount = ware amount
    price = ware price
  },
  [ware2] = { ... }
}
 
 money = GetPlayerMoney()
Returns the amount of money in the player account. 
 
 macro = GetPlayerPrimaryShipCockpitMacro()
Returns the macro of the cockpit currently installed in the player ship. 
 
 shipID = GetPlayerPrimaryShipID()
Returns the player primary ship. 
 
 macro = GetPlayerPrimaryShipMacro()
Returns the macro of the player primary ship. 
 
 roomID = GetPlayerRoom()
Returns the current player room. 
 
 GetPlayerShipHullShield 
 GetPlayerShipShieldDetails 
 GetPlayerSpeed 
 GetPlayerSteeringStrength 
 componentID = GetPlayerTarget()
Returns the current player target. 
 
 

adapterTable = GetPossibleAdapters()
Returns information about all possible display adapters.

adapterTable
adapterTable = {
  [1] = {
    name = adapter name,
    ordinal = adapter ordinal
  }
}
 
 

productionInfoTable = GetPossibleProducts(productionmoduleID)
Returns information about all possible products of the specified productionmodule.

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()
Returns information about all possible resolutions.

resolutionsTable
resolutionsTable = {
  [1] = {
    height = resolution height in px,
    width = resolution width in px
  },
  [2] = { ... }
}

 

 
 GetPrimaryShipWeapon 
 entityIDArray = GetPrioritizedPlatformNPCs(dockingbayID)
Returns an array of entities on the specified dockingbay. 
 
 

productionDataTable = GetProductionModuleData(productionmoduleID)
Returns information about the specified productionmodule.

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)
Returns an array with all productionmodules in the specified destructible. 
 
 GetProgressElementDetails 
 string = GetRadarModuleName(objectID)
Returns the name of the macro with biggest radar range included in the specified object.
 
 int = GetRadarOption()
Returns the current radar setting.
 
 money or nil = GetReferenceProfit(container, ware, price, amount [, shoppinglistidx])
Returns the profit selling the specified ware from the given container at the given price will provide.
 
 

moduleArray = GetRegisteredModules()
Returns information about all registered modules.

moduleArray
moduleArray = {
  id = module id,
  name = module name,
  description = gamestart description, if any,
  image = gamestart image, if any
}
 
removed 3.50 Beta 3
GetRelationComponentStatus 
removed 3.50 Beta 3
GetRelationFactionStatus 
 GetRelativePlayerShipPosition 
 GetRemoteControlHUDIcons 
 

resourceTable = GetRepairResources(containerID or buildmoduleID, repairdestructibleID, sequence, stage, buildlimit, targethullfraction)
Returns the resources needed to repair the specified repairdestructible by the given buildmodule to targethullfraction.

resourceTable
resourceTable = {
  [1] = {
    ware = ware id,
    name = ware name,
    cycle = amount,
    price = price
  },
  [2] = { ... },
  ...,
  totalprice = totalprice
}
 
 resolutionTable = GetResolutionOption([checkconfig])
Returns the current resolution or the resolution set in config.xml.
 
 number = GetRumbleOption()
Returns the current controller rumble intensity setting.
 
 productionmoduleID = GetSalesRepProduction(entityID)
Returns the productionmodule in the same build slot as the specified entity. 
 
 

savegameTable = GetSaveList()
Returns information about existing savegames.

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,
  [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 unnecessary.
 GetScreenAspects 
 getScreenInfo 
 GetSecondaryShipWeapon 
 sectorIDArray = GetSectors(clusterID)
Returns an array of sectors in the specified cluster. 
 
 number = GetSensitivitySetting(rangeid)
Returns the current sensitivity setting for the specified input range. 
 
 int = GetShaderQualityOption()
Returns the current shader quality setting. 
 
 int = GetShadowOption()
Returns the current shadow setting.
 
 

shoppingListTable = GetShoppingList(containerID)
Returns information about the trade queue of the specified container.

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 
 GetSliderValues 
 GetSliderValueSuffix 
 bool = GetSoftShadowsOption()
Returns the current soft shadow setting. 
 
 bool = GetSoundOption()
Returns the current global sound setting. 
 
 int = GetSSAOOption()
Returns the current ssao setting.
 
 GetStandardButtons 
 macroArray = GetStandardUnitMacros(macro)
Returns an array of unit macros that are considered standard for the specified macro.
 
 ... = GetStatData(stat, ...)
Returns properties of the specified statistic. Possible properties are: "exists", "value", "hidden", "displayname", "displayvalue"
 
 bool = GetSteeringNoteOption()
Returns the current steering note setting. 
 
 bool = GetStopShipInMenuOption()
Returns the current setting whether the playership should stop while a menu is open. 
 
 

storageDataTable = GetStorageData(destructibleID)
Returns information about the storage capabilities in the specified destructible.

 


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])
Returns an array with all subordinates of the specified controllable, optionally filtered by the commandertype. 
 
 string = GetSubtitleOption()
Returns the current subtitle option. 
 
 GetTableColumnSpan 
 GetTableColumnWidths 
 GetTableFullHeight 
 GetTableInitialSelectedColumn 
 GetTableInitialSelectedRow 
 GetTableInitialTopRow 
 GetTableNumFixedRows 
 GetTableNumRows 
 GetTableRowColor 
 GetTableRowHeight 
 GetTargetElementInfo 
 GetText 
 int = GetTextHeightExact(text, font, fontsize, width, wordwrap)
Returns the height in pixels of the specified text.
 
 int = GetTextNumLines(text, font, fontsize, width)
Returns the number of lines of the specified text with the given font and width.
 
 int = GetTextWidth(text, fontname, fontsize)
Returns the width in pixels of the specified text. 
 
 GetTimeLeft 
 GetTopTargetPriorityMessages 
 money = GetTotalValue(containerID [, sellprice] [, referenceContainerID])
Returns the value of the specified container, optionally for selling and in reference to the price list of the reference container.
 
 

tradeDataTable = GetTradeData(trade)
Returns information about the specified trade.

tradeDataTable = {
  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,
  ]
}
 
 GetTradeList 
 GetTradeRestrictions 
 GetTradesAtConnection 
 GetTradeShipData 
 GetTradeShipList 
 GetTransportUnitMacros 
 GetUIElementRectangleScreenPosition 
 GetUIElementScreenPosition 
 GetUIRelation 
 GetUnitStorageData 
 GetUpgradesResources 
 GetVersionString 
 GetViewDistanceOption 
 GetViewSize 
 GetVolumeOption 
 GetVSyncOption 
 GetWareCapacity 
 GetWareData 
 GetWareExchangeTradeList(tradingshipid, tradedcontainerid [, sortby])Call SetVirtualCargoMode on tradingshipid and tradedcontainerid first, otherwise result will be empty.
 GetWareProductionLimit 
 GetWordWrap 
 GetZones 
 GetZoneYield 
 HasAllResourcesToCraft 
 HasContainerWarePriceOverride 
 HasDroneControl 
 HasFlightControl 
 HasLicence 
 HasShipControl 
 HasShipyard 
 HasSliderTwoScales 
 HasTag 
 HasToRestoreOptionsMenu 
 HaveExtensionSettingsChanged 
 HideMissionObjective 
 HidePresentation 
 HideView 
 IncStatValue 
 InstallSteamDLC 
 InterruptPlayerComputer 
 IsBorderEnabled 
 IsButtonActive 
 IsCheatVersion 
 IsComponentClass 
 IsComponentConstruction 
 IsComponentOperational 
removed in 3.50 Beta 2IsComponentValidreplaced with IsValidComponent().
 IsContainerOperationalRangeSufficient 
 IsDialogActive 
 IsDockingPossible 
 IsFactionKnown 
 IsFadeEnabled 
 IsFirstPerson 
 IsGamepadActive 
 IsInfoUnlockedForPlayer 
 IsInteractive 
 IsKnownItem 
 IsMacroClass 
 IsObstructed 
 IsPlayerFirstPerson 
 IsSameComponent 
 IsSameTrade 
 IsSavingPossible 
 IsSelectable 
 IsSliderCenterValueDisplayed 
 IsSliderIndicatorInverted 
 IsSliderScaleInverted 
 IsSofttargetLocked 
 IsSteamworksEnabled 
 IsTableColumnWidthPercentage 
 IsTableRowSelectable 
 IsType 
added in 3.50 Beta 2IsValidComponent() 
 IsValidWidgetElement 
 IsWareIllegalTo 
 LeaveInteractMenu 
 ListenForInput 
 LoadGame 
 LoadInputProfile 
 LockPresentation 
 MakeRepairPriority 
 MovePlayerToZone 
 NewGame 
 NotifyOnActionPerformed 
 NotifyOnChangedEnvironmentObject 
 NotifyOnChangedZone 
 NotifyOnConversationFinished 
 NotifyOnCutsceneStopped 
 NotifyOnCycleWeapon 
 NotifyOnHackAborted 
 NotifyOnHackFinished 
 NotifyOnHackStarted 
 NotifyOnMissionObjectiveBarUpdate 
 NotifyOnPlayerControlStarted 
 NotifyOnPlayerControlStopped 
 NotifyOnScanAborted 
 NotifyOnScanFinished 
 NotifyOnScanStarted 
 NotifyOnStartDialog 
 NotifyOnStopDialog 
 NotifyOnTargetElementDisplayed 
 NotifyOnTargetElementHidden 
 NotifyVoiceOutput 
 OpenSteamOverlayStorePage 
 OpenSteamOverlayWebPage 
 OpenWorkshop 
 Pause 
 PerformAction 
 PlayAmbientSound 
 PlayCredits 
 PlayerPrimaryShipHasContents 
 PlaySound 
 PrepareRenderTarget 
 ProceedFromMenu 
 

QuitGame()

 
 QuitModule 
 RaisePlayerInteractionEvent 
 ReadText 
 RegisterAddonBindings 
 RegisterMouseInteractions 
 RegisterWidget 
 ReleaseCutsceneDescriptor 
 ReleaseDescriptor 
 ReleaseInteractionDescriptor 
 ReleaseListener 
 ReleaseNotification 
 ReleaseViewDescriptor 
 RemoveAmmo 
 RemoveCargo 
 RemoveInventory 
 RemoveLogbookEntry 
 RemovePlayerDrone 
 RemoveSofttarget 
 RemoveSofttargetLockRequest 
 RepairDestructibles 
 ReplacePlayerCockpit 
 RequestSofttargetLock 
 ResetAllExtensionSettings 
 RestoreGameOptions 
 RestoreGraphicOptions 
 RestoreOptionsMenu 
 RestoreSoundOptions 
 ReturnFromMenu 
 SaveFullscreenOption 
 SaveGame 
 SaveInputProfile 
 SaveInputSettings 
 SaveResolutionOption 
 ScheduleReloadUI 
 SelectAction 
 SelectBackOption 
 SelectDialogOption 
 SendEntityTransportDrone 
added in 3.50 RC 1SignalObject(componentID [, param1] [, param2] [, param3] [, delay])
Sends a generic ObjectSignalledEvent on the specified component. These can be listened to by MD/AI script. 
 
 SendTransportDrone 
 SetActiveMission 
 SetAdapterOption 
 SetAimAssistOption 
 SetAntiAliasModeOption 
 SetAutorollOption 
 SetAutosaveOption 
 SetBoostToggleOption 
 SetBudgetResponsibility 
 SetButtonText 
 SetCaptureHQOption 
 SetCellContent 
 SetCollisionAvoidanceAssistOption 
 SetComponentName 
 SetConfineMouseOption 
 SetContainerWarePriceOverride 
 SetCrashReportOption 
 SetDeadzoneOption 
 SetDifficultyOption 
 SetDiffuseColor 
 SetDistortionOption 
 SetEffectDistanceOption 
 SetEMCutsceneOption 
 SetExtensionSettings 
 SetFOVOption 
 SetFullscreenDetailmonitorOption 
 SetFullScreenOneToOne 
 SetFullscreenOption 
 SetGamepadModeOption 
 SetGammaOption 
 SetGfxQualityOption 
 SetGlowOption 
 SetHeight 
 SetIcon 
 SetInversionSetting 
 SetJoysticksOption 
 SetLegacyMainMenuOption 
 SetLegacyShadersOption 
 SetLODOption 
 SetMainMissiontargetMessage 
 SetMaxBudget 
 SetMinBudget 
 SetMouseOverride 
 SetMouseSleeping 
 SetNonSquadShipsForTradeOffersOption 
 SetNPCBlackboard 
 SetNPCSkill 
 SetPersonalizedCrashReportsOption 
 SetRadarOption 
 SetRenderTargetSize 
 SetResolutionOption 
 SetRumbleOption 
 SetSensitivitySetting 
 SetShaderQualityOption 
 SetShadowOption 
 SetSoftShadowsOption 
 SetSofttarget 
 SetSoundOption 
 SetSSAOOption 
 SetStatValue 
 SetSteeringNoteOption 
 SetStopShipInMenuOption 
 SetSubtitleOption 
 SetText 
 SetTextColor 
 SetTextureColorMode 
 SetViewDistanceOption 
 SetVirtualCargoMode(containerid, onoff)Vitual cargo mode should be disabled again when leaving the current menu.
 SetVolumeOption 
 SetVSyncOption 
 SetWidth 
 ShowInteractMenu 
 ShowMissionObjective 
 ShowPresentation 
 StartAutoPilot 
 StartBriefing 
 StartCutscene 
 StartPlayingSound 
 StartSubConversationFromMenu 
 StopAutoPilot 
 StopBriefing 
 StopCutscene 
 StopPlayingSound 
 StopRestoringOptionsMenu 
 SwitchInteractiveObject 
 ToggleFactionTradeRestriction 
 ToggleFactionTradeWareOverride 
 ToggleMissionGuidance 
 TraceBack 
 TransferInventoryToPlayer 
 TransferMoneyToPlayer 
 TransferPlayerInventoryTo 
 TransferPlayerMoneyTo 
 TruncateText 
 UninstallSteamDLC 
 Unpause 
 UnregisterAddonBindings 
 UnsetMapRenderTarget 
 UnsetMouseOverride 
 UnsuspendConversation 
 UpdateRegisteredWidget 
 UpgradeObject 

 

(entityID)
Returns information about the wares held in the inventory of specified entity.

 

wareTable
wareTable = {
  [ware1] = {
    name = ware name
    amount = ware amount
    price = ware price
  },
  [ware2] = { ... }
}
  • No labels