Skip to end of metadata
Go to start of metadata
Icon

This list can contain details about planned functions in yet unreleased versions.

Please understand that the mentioning of such a version in this list does not imply that the version will become available in the near future (it's not even a confirmation that the version will be released at all). It's merely to be understood as a heads-up information of what a following version might provide and ensures that if that version is released, the documentation is already up to date at the time of the release.

Also note that any information provided here for not yet released versions can change at any time before the version is released without any further notice (that includes even the removal of a function which was mentioned here before the release of a particular version).

VersionStructureNote
added in 4.00 Beta 4typedef uint64_t TradeID; 
added in 3.50 Beta 2typedef uint64_t UniverseID; 
added in 4.00 Beta 6

typedef struct {
    const char* macro;
    const char* ware;
    uint32_t amount;
    uint32_t capacity;
} AmmoData;

 
added in 4.21 Beta 1 (VR: 4.20)typedef struct {
    float angle;
    bool inside;
} ArrowDetails;
 
 

typedef struct {
    const char* name;
    float hull;
    float shield;
    bool hasShield;
} ComponentDetails;

 
added in 4.31 Beta 1typedef struct {
    uint32_t messageID;
    bool obstructed;
} CrosshairMessage;
 
added in 4.00 Beta 1

typedef struct {
    uint32_t width;
    uint32_t height;
    uint32_t xHotspot;
    uint32_t yHotspot;
} CursorInfo;

 
added in 4.00 Beta 1

typedef struct {
    uint32_t red;
    uint32_t green;
    uint32_t blue;
    uint32_t alpha;
} Color;

 
renamed in 3.50 Beta 3

typedef struct {
    const char* factionName;
    const char* factionIcon;
} OwnerFactionDetails;

 
added in 4.00 Beta 1

typedef struct {
    const char* name;
    uint32_t size;
} Font;

 
added in 4.21 Beta 1 (VR: 4.20)

typedef struct {
    double fps;
    double moveTime;
    double renderTime;
    double gpuTime;
} FPSDetails;

moveTime, renderTime, and gpuTime always return 0
 

typedef struct {
    int major;
    int minor;
} GameVersion;

 
added in 4.00 Beta 1

typedef struct {
    double x;
    double y;
} GraphDataPoint;

 
added in 4.00 Beta 1 / changed in 4.00 Beta 5

typedef struct {
    uint32_t MarkerType;
    uint32_t MarkerSize;
    Color MarkerColor;
    uint32_t LineType;
    uint32_t LineWidth;
    Color LineColor;
    size_t NumData;
    bool Highlighted;
    const char* MouseOverText;
} GraphDataRecord;

4.00 Beta 5: added MouseOverText field
added in 4.00 Beta 1

typedef struct {
    size_t DataRecordIdx;
    size_t DataIdx;
    const char* IconID;
    const char* MouseOverText;
} GraphIcon;

 
added in 4.00 Beta 1

typedef struct {
    const char* text;
    Font font;
    Color color;
} GraphTextInfo;

 
added in 4.00 Beta 1

typedef struct {
    GraphTextInfo label;
    double startvalue;
    double endvalue;
    double granularity;
    bool grid;
    Color color;
    Color gridcolor;
} GraphAxisInfo;

 
added in 4.00 Beta 2

typedef struct {
   bool charging;
   bool jumping;
   float charge;
} JumpDriveDetails;

 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)

typedef struct {
int32_t id;
const char* name;
const char* warning;
const char* font;
bool voice;
} LanguageInfo;

only available in XR VR
added in 3.50 Beta 2

typedef struct {
    const char* HintText;
   long HintID;
} LoadingHint;

 
 

typedef struct {
    uint64_t poiID;
    UniverseID componentID;
    const char* messageType;
    const char* connectionName;
    bool isCollectable;
    bool isAssociative;
    bool showIndicator;
} MessageDetails;

 
deprecated in 4.00 Beta 3

DEPRECATED
typedef struct {
    const char* missionName;
    const char* missionDescription;
    int difficulty;
    const char* mainType;
    const char* subType;
    const char* faction;
    int64_t reward;
    const char* rewardText;
    size_t numBriefingObjectives;
    int activeBriefingStep;
    const char* opposingFaction;
    const char* license;
    float timeLeft;
    double duration;
    bool abortable;
    UniverseID associatedComponent;
} MissionDetails;

(warning) DEPRECATED - use MissionDetails2 instead
added in 4.00 Beta 3typedef struct {
    const char* missionName;
    const char* missionDescription;
    int difficulty;
    const char* mainType;
    const char* subType;
    const char* faction;
    int64_t reward;
    const char* rewardText;
    size_t numBriefingObjectives;
    int activeBriefingStep;
    const char* opposingFaction;
    const char* license;
    float timeLeft;
    double duration;
    bool abortable;
    bool hasObjective;
    UniverseID associatedComponent;
} MissionDetails2;
 
 

typedef struct {
    const char* objectiveText;
    float timeout;
    size_t numTargets;
} MissionObjective;

 
 

typedef struct {
    const char* text;
    int step;
} MissionObjectiveStep;

 
 

typedef struct {
    const char* POIName;
    const char* POIType;
} POIDetails;

 
 

typedef struct {
    int x;
    int y;
} Position2D;

 
added in 4.21 Beta 1 (VR: 4.20)typedef struct {
   float x;
   float y;
   float z;
   float yaw;
   float pitch;
   float roll;
} PosRot;
Note: yaw/pitch/roll are given in radian.
added in 3.50 Beta 3

typedef struct {
    int relationStatus;
    int relationValue;
    int relationLEDValue;
    bool isBoostedValue;
} RelationDetails;

 
added in 4.10 Beta 1

typedef struct {
int x;
int y;
} ResolutionInfo;

 
added in 4.10 Beta 1typedef struct {
   float yaw;
   float pitch;
   float roll;
} Rotation;
Note: yaw/pitch/roll are given in radian.
 

typedef struct {
    UniverseID softtargetID;
    const char* softtargetName;
    const char* softtargetConnectionName;
} SofttargetDetails;

 
added in 4.00 Beta 6

typedef struct {
int64_t trade;
int64_t defence;
int64_t missile;
} SupplyBudget;

 
added in 4.00 Beta 6

typedef struct {
const char* macro;
int amount;
} SupplyOverride;

 
added in 4.00 Beta 6

typedef struct {
double time;
int64_t money;
} UIAccountStatData;

 
added in 4.00 Beta 5

typedef struct {
double time;
uint64_t amount;
} UICargoStatData;

 
added in 4.00 Beta 5typedef struct {
const char* wareid;
UICargoStatData* data;
uint32_t numdata;
} UICargoStat;
 
added in 4.00 Beta 1

typedef struct {
float x;
float y;
float z;
float yaw;
float pitch;
float roll;
} UIPosRot;

 
added in 4.00 Beta 2

typedef struct {
double time;
int64_t price;
int amount;
int limit;
} UITradeOfferStatData;

 
added in 4.00 Beta 2

typedef struct {
const char* wareid;
bool isSellOffer;
UITradeOfferStatData* data;
uint32_t numdata;
} UITradeOfferStat;

 
added in 4.00 Beta 4typedef struct {
   const char* wareid;
   uint32_t amount;
} UIWareAmount;
 
added in 4.00 Beta 3

typedef struct {
uint32_t ID;
const char* Name;
const char* RawName;
const char* WeaponMacro;
const char* Ware;
float DamageFactor;
float CoolingFactor;
float ReloadFactor;
float SpeedFactor;
float LifeTimeFactor;
float MiningFactor;
float StickTimeFactor;
float ChargeTimeFactor;
float BeamLengthFactor;
uint32_t AddedAmount;
} UIWeaponMod;

 
 

typedef struct {
    const char* ClusterName;
    const char* SectorName;
    const char* ZoneName;
    bool isLocalHighway;
    bool isSuperHighway;
} ZoneDetails;

 
VersionFunctionNote
 void AbortCurrentNotification() 
 void ActivateDirectInput() 
added in 4.22 Beta 2 (VR: 4.22)
void ActivatePlayerControls() 
 

UniverseID AddHoloMap(const char* texturename, float x0, float x1, float y0, float y1)
Adds a holomap on the specified rendertarget.

 
added in 4.00 Beta 3void AddTradeWare(UniverseID containerid, const char* wareid)
Add wareid as a tradeware to container. 
 
added in 4.00 Beta 5bool AllowPersonalizedData()(warning) Designed for internal use only.
added in 4.00 RC 2bool AreShipSystemsEnabled()
Indicates whether the (player) ship systems are enabled.
Note: This is used in the vanilla game only at the early state during the campaign before the ship systems are enabled. In all other cases the ship systems are always enabled.
 bool AreAssertsEnabled() 
 bool AreMandatoryAssertsEnabled() 
 bool AreOptionalAssertEnabled() 
added in 4.00 Beta 3

bool CanActivateSeta()
Indicates whether we can activate SETA atm.

 
 bool CanActivateSmartDefense()
Indicates whether smart defense can be activated.
 
 bool CanCancelRecallDrones()
Indicates whether recalling drones can be canceled atm.
 
 

void CancelRecallDrones()
Cancels recalling drones.

 
added in 4.00 Beta 5bool CanOpenWebBrowser()(warning) Designed for internal use only.
 

bool CanRecallDrones()
Indicates whether drones cann be recalled atm.

 
added in 4.21 Beta 1 (VR: 4.20)void CircularMenuClosed()
Notifies the system that the circular menu was closed.
 
 void ClearErrorLog() 
 

void ClearHighlightMapComponent(UniverseID holomapid)
Clear the highlighted component on the specified holomap.

 
 bool CopyToClipboard(const char*const text)
Copies the specified text to the clipboard (so it can be pasted outside the game for instance).
 
added in 4.21 Beta 1 (VR: 4.20)bool CycleNextPrimaryWeapon()
Cycles the player's primary weapons (to the next one). The return value indicates whether weapon cycling failed (note: it's considered a success if the function is called without any weapon or only a single one).
 
added in 4.21 Beta 1 (VR: 4.20)bool CycleNextSecondaryWeapon()
Cycles the player's secondary weapons (to the next one). The return value indicates whether weapon cycling failed (note: it's considered a success if the function is called without any weapon or only a single one).
 
added in 4.21 Beta 1 (VR: 4.20)

bool CyclePrevPrimaryWeapon()
Cycles the player's primary weapons (to the previous one). The return value indicates whether weapon cycling failed (note: it's considered a success if the function is called without any weapon or only a single one).

 
added in 4.21 Beta 1 (VR: 4.20)bool CyclePrevSecondaryWeapon()
Cycles the player's secondary weapons (to the previous one). The return value indicates whether weapon cycling failed (note: it's considered a success if the function is called without any weapon or only a single one).
 
 void DeactivateDirectInput() 
added in 4.22 Beta 2 (VR: 4.22)void DeactivatePlayerControls() 
 void DisableAsserts() 
added in 4.00 RC 2void DisableMapPicking(UniverseID holomapid) 
 void DisableOptionalAsserts() 
added in 4.00 Beta 3bool DismantleWeaponMod(uint32_t weaponmodid) 
 void EnableAsserts() 
added in 4.00 RC 2void EnableMapPicking(UniverseID holomapid) 
 void EnableOptionalAsserts() 
added in 4.21 Beta 1 (VR: 4.20)void EnterInteractMenu()
Starts the interact menu interaction mode.
 
added in 4.21 Beta 1 (VR: 4.20)

void FadeScreen(float fadeouttime, float fadeintime)
Starts fading out and back in the screen with the given timings.

 
 UniverseID GetActiveMissionID()
Returns the active mission id. 
 
added in 4.21 Beta 1 (VR: 4.20)float GetAdaptiveSamplingOption() 
added in 4.10 RC 1

uint32_t GetAllMissiles(AmmoData* result, uint32_t resultlen, UniverseID defensibleid)
Stores the missile types an object can use in result. Returns the number of results.

 
added in 4.00 Beta 6uint32_t GetAmmoStorage(AmmoData* result, uint32_t resultlen, UniverseID defensibleid, const char* ammotype);
Stores the ammo storage data in result. Returns the number of results.
 
 const char* GetBuildSourceSequence(UniverseID componentid)
Returns the build sequence of the specified component. 
 
added in 4.10 Beta 1Rotation GetCameraRotation()
Returns the player's current camera rotation.
 
added in 3.50 Beta 3int GetCargoSpaceUsedAfterShoppingList(UniverseID containerid)
Returns the cargo space used after the trade queue. 
SetVirtualCargoMode() must be called prior to calling GetCargoSpaceUsedAfterShoppingList()
added in 4.00 Beta 5uint32_t GetCargoStatistics(UICargoStat* result, uint32_t resultlen, size_t numdatapoints)
Stores the cargo statistics in result. Returns the number of results.
 
added in 4.00 Beta 2bool GetCheckBoxColor(const int checkboxid, Color* color) 
 const char* GetComponentClass(UniverseID componentid)
Returns the class of the specified component. 
 
 ComponentDetails GetComponentDetails(const UniverseID componentid) 
 const char* GetComponentName(UniverseID componentid)
Returns the name of the specified component. 
 
 int GetConfigSetting(const char*const setting) 
added in 4.00 Beta 3bool GetContainerWareIsBuyable(UniverseID containerid, const char* wareid)
Returns whether the specified ware is buyable by the specified container. 
 
added in 4.00 Beta 3
bool GetContainerWareIsSellable(UniverseID containerid, const char* wareid)
Returns whether the specified ware is sellable by the specified container. 
 
 UniverseID GetContextByClass(UniverseID componentid, const char* classname, bool includeself)
Returns the context of the specified component with the given class. 
 
 int64_t GetCreditsDueFromPlayerTrades()
Returns the amount of money expected from outstanding trade queues. 
 
added in 4.10 Beta 1ArrowDetails GetCrosshairArrowDetails(int posid, float radius)
Returns the crosshair arrow details (ArrowDetails.angle in degree - upper position 0° - clock-wise; ArrowDetails.inside indicating whether the element is within the specified radius; ArrowDetails.valid indicates whether the return value is valid).
posid corresponds to the target element and radius is an arbitrary number specifying a radius around the center of the crosshair. If the target element is within that radius, ArrowDetails.inside will be true.
 
deprecated in 4.31 Beta 1DEPRECATED uint32_t GetCurrentCrosshairMessage()(warning) DEPRECATED - use GetCurrentCrosshairMessage2() instead
added in 4.31 Beta 1CrosshairMessage GetCurrentCrosshairMessage2() 
added in 4.00 Beta 1CursorInfo GetCurrentCursorInfo() 
added in 4.22 Beta 2 (VR: 4.22)double GetCurrentGameTime()
Returns the current game time.
 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)int32_t GetCurrentLanguage()
Returns the ID of the currently used language.
only functional in X Rebirth VR Edition
 UniverseID GetCurrentlyScannedObject() 
added in 4.00 Beta 1uint32_t GetCurrentMissionOffers(uint64_t* result, uint32_t resultlen, bool showninbbs)
Stores the missionIDs of current mission offers in result, returns the number of items in result.
See also GetNumCurrentMissionOffers()
added in 4.00 Beta 5float GetDefensibleDPS(UniverseID defensibleid, bool primary, bool secondary, bool turrets)
Get the damage per second value for the given defensible, using the flagged weapon systems. 
 
added in 3.50 RC 1float GetDistanceBetween(UniverseID component1id, UniverseID component2id)
Returns the distance between the specified components. 
 
 float GetDistanceToPlayerShip() 
 const char* GetEntityActiveIcon(const UniverseID componentid) 
 const char* GetEntityInactiveIcon(const UniverseID componentid) 
 const char* GetEntitySelectedIcon(const UniverseID componentid) 
 UniverseID GetEnvironmentObject() 
added in 4.00 Beta 2UniverseID GetExternalTargetViewComponent()
Retrieves the component the external target view is set to (only valid in external target view).
 
added in 3.50 Beta 3DEPRECATED const char* GetFactionNameForEventMonitorHack(UniverseID componentid)(warning) DEPRECATED - use GetOwnerDetails() instead
added in 3.50 Beta 3const char* GetFactionName(const UniverseID componentid) 
added in 3.50 Beta 3RelationDetails GetFactionRelationStatus(const char* factionid) 
added in 4.10 Beta 1bool GetForceShootingAtCursorOption()
Returns whether shooting is forced to always aim towards the cursor position (rather than also towards the crosshair).
 
added in 4.21 Beta 1 (VR: 4.20)FPSDetails GetFPS()
Returns the current frames per second.
 
 

uint32_t GetFXAAOption()
Returns the current FXAA setting. 

 
 GameVersion GetGameVersion() 
added in 4.00 Beta 1bool GetGraphBackgroundColor(const int graphid, Color* color) 
added in 4.00 Beta 1
uint32_t GetGraphData(GraphDataPoint* result, uint32_t resultlen, const int graphid, const size_t datarecordidx) 
added in 4.00 Beta 1
uint32_t GetGraphDataRecords(GraphDataRecord* result, uint32_t resultlen, int graphid) 
added in 4.00 Beta 1
uint32_t GetGraphIcons(GraphIcon* result, uint32_t resultlen, int graphid) 
added in 4.00 Beta 1
bool GetGraphTitle(const int graphid, GraphTextInfo* title) 
added in 4.00 Beta 1
uint32_t GetGraphType(const int graphid) 
added in 4.00 Beta 1
bool GetGraphXAxis(const int graphid, GraphAxisInfo* axis) 
added in 4.00 Beta 1
bool GetGraphYAxis(const int graphid, GraphAxisInfo* axis) 
added in 4.00 Beta 3bool GetInstalledWeaponMod(UniverseID weaponid, UIWeaponMod* weaponmod) 
added in 4.21 Beta 1 (VR: 4.20)const char* GetItemTraderTypeByWare(const char* wareid)
Allows to reverse lookup the correct item trader entitytype for a certain ware.
 
added in 4.00 Beta 2JumpDriveDetails GetJumpDriveDetails()
Retrieves details about the player's jumpdrive. Only valid, if the player has a jumpdrive atm.
 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)uint32_t GetLanguages(LanguageInfo* result, uint32_t resultlen)
Returns information about available languages.
only functional in X Rebirth VR Edition
added in 4.00 RC 2bool GetLargeHUDMenusOption() 
added in 3.50 Beta 2LoadingHint GetLoadingHint(const long excludeid) 
 const char* GetLocalizedInteractiveNotificationKey() 
 const char* GetLocalizedText(const long pageid, const long textid, const char*const defaultvalue) 
 int GetMainMissiontargetPOSID() 
 UniverseID GetMapComponentBelowCamera(UniverseID holomapid)
Returns the component in the center of the specified holomap. 
 
added in 4.00 Beta 1bool GetMapPositionOnEcliptic(UniverseID holomapid, UIPosRot* position, bool showposition)
Returns the position on the ecliptic that the mouse cursor is currently pointing to. 
 
 const char* GetMapShortName(UniverseID componentid)
Returns the short name of the specified space. 
 
 MessageDetails GetMessageDetails(const uint32_t messageid) 
deprecated in 4.00 Beta 3DEPRECATED MissionDetails GetMissionIDDetails(uint64_t missionid)
Returns details of the specified mission.
(warning) DEPRECATED - use GetMissionIDDetails2() instead
added in 4.00 Beta 3MissionDetails2 GetMissionIDDetails2(uint64_t missionid)
Returns details of the specified mission.
Note: In addition to the details returned by GetMissionIDDetails() this function returns whether the mission has an objective or not.
deprecated in 4.31 Beta 1

DEPRECATED MissionObjective GetMissionIDObjective(uint64_t missionid, const char* fontname, uint32_t fontsize, uint32_t textwidth)
Returns the mission objective of the specified mission. 

(warning) DEPRECATED - use GetMissionIDObjective2() instead
added in 4.31 Beta 1MissionObjective GetMissionIDObjective2(uint64_t missionid)
Returns the mission objective of the specified mission.
 
 

UniverseID GetMissionIDObjectiveTarget(uint64_t missionid, size_t targetIndex)
Returns the target of the current objective of the specified mission. 

 
deprecated in 4.31 Beta 1DEPRECATED MissionObjectiveStep GetMissionObjectiveStep(uint64_t missionid, size_t objectiveIndex, const char* fontname, uint32_t fontsize, uint32_t textwidth)
Returns the objective of the specified mission and objectiveindex.
(warning) DEPRECATED - use GetMissionObjectiveStep2() instead
added in 4.31 Beta 1MissionObjectiveStep GetMissionObjectiveStep2(uint64_t missionid, size_t objectiveIndex)
Returns the objective of the specified mission and objectiveindex.
 
added in 4.00 Beta 1const char* GetMouseOverText(const int widgetid) 
added in 4.00 Beta 1bool GetMouseOverTextOption() 
added  in 4.22 Beta 2 (VR: 4.22)float GetMouseVRSensitivityPitch()only available in XR VR
added  in 4.22 Beta 2 (VR: 4.22)float GetMouseVRSensitivityYaw()only available in XR VR
 int GetNotificationID(const size_t num) 
added in 4.00 Beta 6uint32_t GetNPCAccountStatistics(UIAccountStatData* result, size_t resultlen, UniverseID entityid, double starttime, double endtime)
Stores the npc account statistics in result. Returns the number of entries in result. 
 
added in 4.10 RC 1uint32_t GetNumAllMissiles(UniverseID defensibleid)
Returns the number of missile types an object can use.
 
added in 4.00 Beta 6uint32_t GetNumAmmoStorage(UniverseID defensibleid, const char* ammotype)
Returns the number of entries in the ammo storage. 
 
added in 4.00 Beta 5uint32_t GetNumCargoStatistics(UniverseID containerorspaceid, double starttime, double endtime, size_t numdatapoints)
Returns the number of entries in the cargo statistics.
 
added in 4.00 Beta 5uint32_t GetNumContainedKnownUnreadSpaces(UniverseID spaceid)
Returns the number of unread known spaces contained in the specified space. 
 
added in 4.00 Beta 1
uint32_t GetNumCurrentMissionOffers(bool showninbbs)
Returns the number of current mission offers.
See also GetCurrentMissionOffers()
added in 4.00 Beta 1
uint32_t GetNumGraphDataRecords(int graphid);  
added in 4.00 Beta 1
uint32_t GetNumGraphIcons(int graphid) 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)uint32_t GetNumLanguages()
Returns the number of available languages.
only functional in X Rebirth VR Edition
 size_t GetNumNotifications()
Returns the number of current notifications.
 
added in 4.21 Beta 1 (VR: 4.20)size_t GetNumPrimaryWeapons()
Returns the number of primary weapons in the player ship.
Before 4.22 Beta 2 (VR: 4.22) this returned the number of weapons in the currently controlled player object.
added in 4.21 Beta 1 (VR: 4.20)size_t GetNumSecondaryWeapons()
Returns the number of secondary weapons in the player ship.
Before 4.22 Beta 2 (VR: 4.22) this returned the number of weapons in the currently controlled player object.
added in 4.00 Beta 4uint32_t GetNumStoredUnits(UniverseID defensibleid, const char* cat, bool virtualammo)
Returns the number of stored units on the specified defensible and category. 
 
added in 4.00 Beta 2uint32_t GetNumTradeOfferStatistics(UniverseID containerorspaceid, double starttime, double endtime, size_t numdatapoints)
Returns the number of entries in the trade offer statistics.
 
added in 4.00 Beta 3uint32_t GetNumTradeWares()
Returns the number of possible trade wares in the game.
 
added in 4.00 Beta 5uint32_t GetNumUnreadLibraryEntries(const char* libraryid)
Returns the number of unread library entries in the specified library.
 
added in 4.00 Beta 3uint32_t GetNumWeaponMods() 
 FactionDetails GetOwnerDetails(UniverseID componentid) 
 UniverseID GetParentComponent(UniverseID componentid)
Returns the parent of the specified component.
 
 UniverseID GetPickedMapComponent(UniverseID holomapid)
Returns the currently picked component on the specified holomap.
 
added in 4.21 Beta 1 (VR: 4.20)

UniverseID GetPlayerComputerID()
Returns the player computer entity (Betty).

 
added in 4.21 Beta 1 (VR: 4.20)UniverseID GetPlayerControlledShipID()
Returns the ship or drone the player is currently controlling.
 
added in 4.21 Beta 1 (VR: 4.20)UniverseID GetPlayerCoPilotID()
Returns the player's co-pilot entity (Yisha).
 
added in 4.21 Beta 1 (VR: 4.20)UniverseID GetPlayerID()
Returns the player entity.
 
added in 4.21 Beta 1 (VR: 4.20)UniverseID GetPlayerObjectID()
Returns the object context of the player (ship or station).
 
added in 4.21 Beta 1 (VR: 4.20)UniverseID GetPlayerShipID()
Returns the ship context of the player if the player is on a ship.
 
added in 3.50 RC 1int GetPlayerShipNumFreeActorSlots()
Returns the number of free actor slots on the player ship. 
 
added in 4.21 Beta 1 (VR: 4.20)UniverseID GetPlayerZoneID()
Returns the zone context of the player.
 
 const char* GetPlayerZoneName() 
 POIDetails GetPOIDetails(const uint64_t poiid) 
added in 4.21 Beta 1 (VR: 4.20)const char* GetQuickMenuHotkey(uint32_t num)
Returns the hotkey assigned to the button of the specified number in the quick menu.
num ranging from 1-10.
 

added in 4.21 Beta 1 (VR: 4.20)
deprecated in 4.31 Beta 1

DEPRECATED float GetRectangleTargetElementExtends(const int posid)
Returns the rectangular extents for the specified target element.
(warning) DEPRECATED - use GetRectangleTargetElementExtents() instead
added in 4.31 Beta 1float GetRectangleTargetElementExtents(const int posid)
Returns the rectangular extents for the specified target element.
 
changed in 3.50 Beta 3int RelationDetails GetRelationStatus(const UniverseID componentid) 
added in 4.21 Beta 1 (VR: 4.20)

PosRot GetRelativeAimOffset(const UniverseID componentid)
Returns the position and rotation of the aim-at-offset (in worldspace) to shoot at in order to hit the specified object.

 
deprecated in 4.21 Beta 1 (VR: 4.20)DEPRECATED Position2D GetRelativeAimPosition(const UniverseID componentid, const uint32_t iconsizeonscreen, const uint32_t iconsizeoffscreen)
Returns the 2D screen position to aim-at in order to hit the specified object.
The on-/off-screen iconsizes specify the icon size of targetelements which icons have on screen.

(warning) DEPRECATED - use GetRelativeAimScreenPosition() instead


Note: As of 4.00 Beta 1 this function returns the aim position relative to the object the player currently controls (aka: player ship or remote controlled drone/torpedo). Before, it always determined the aim position based on the player ship.

added in 4.21 Beta 1 (VR: 4.20)Position2D GetRelativeAimScreenPosition(const UniverseID componentid, const uint32_t iconsizeonscreen, const uint32_t iconsizeoffscreen)
Returns the 2D screen position to aim-at in order to hit the specified object.
The on-/off-screen iconsizes specify the icon size of targetelements which icons have on screen.
 
added in 4.10 Beta 1ResolutionInfo GetRenderResolutionOption()
Returns the current render resolution;
 
 uint32_t GetRenderTargetAlpha(const int rendertargetid) 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)int32_t GetRequestedLanguage()
Returns the ID of the currently requested language (the actual setting)
only functional in X Rebirth VR Edition
added in 4.00 Beta 1bool GetSavesCompressedOption()
Returns whether save game compression is active. 
 
 float GetScanProgress(UniverseID componentid) 
 const char* GetShipSize(const UniverseID componentid) 
 SofttargetDetails GetSofttarget() 
added in 4.00 Beta 6SupplyBudget GetSupplyBudget(UniverseID containerid)
Returns the supply budget information of the specified container. 
 
added in 4.21 Beta 1 (VR: 4.20)

bool GetTableAlertEffectColor(const int tableid, Color* color)
Retrieves alert effect color of a table if available. Returns false if there is no alert effect.

 
added in 4.21 Beta 1 (VR: 4.20)PosRot GetTargetElementOffset(const int posid)
Retrieves the position and rotation values of the target element in worldspace.
 
added in 4.31 Beta 1

uint32_t GetTextHeight(const char*const text, const char*const fontname, const uint32_t fontsize, const uint32_t wordwrapwidth)
Returns the height in pixels of the specified text.
If wordwrapwidth is set to 0, the text height will be calculated without performing any word wrapping.

 
added in 4.31 Beta 1uint32_t GetTextWidth(const char*const text, const char*const fontname, const uint32_t fontsize)
Returns the width in pixels of the specified text.
 
added in 4.00 Beta 4bool GetTradeMemoryBestBuyOffers(TradeID* result, uint32_t resultlen, UniverseID spaceid, UniverseID traderid, TradeID* uiselloffers, uint32_t uisellofferslen, UIWareAmount* uicargospace, uint32_t uicargospacelen)
Creates a list of trade ids of best buy offers matching the list of sell offers, if return value is true. Space is the range in which trades are searched; Trader is the tradeship used, defaults to the playership; Cargospace defines the possible amount of all wares in the sell offer list.

 

added in 4.00 Beta 2uint32_t GetTradeOfferStatistics(UITradeOfferStat* result, uint32_t resultlen, size_t numdatapoints)
Stores the trade offer statistics in result. Returns the number of results. 
Only works if GetNumTradeOfferStatistics() was called before.
added in 4.00 Beta 3uint32_t GetTradeWares(const char** result, uint32_t resultlen)
Stores all possible trade wares in the game in result. Returns number of results. 
 

deprecated in 4.30 Beta 1

added in 4.10 Beta 1

 

DEPRECATED float GetUIScale()
Returns the UI scale factor.

(warning) DEPRECATED - use GetUIScale2() instead

added in 4.30 Beta 1

float GetUIScale2(const bool scaleWithResolution)
Returns the UI scale factor depending on the scaling mode set via the scaleWithResolutionparameter.

If scaleWithResolution is set to true, it's assumed that the to be scaled UI element should scale alongside larger game resolutions (i.e. the element will become/appear larger on higher resolutions). If set to false, it's assumed that the to be scaled UI element should remain in its current set size (i.e. appear smaller on higher resolutions).

 
added in 4.30 Beta 1float GetUIScaleFactor()
Returns the plain UI scale factor.
 
added in 4.30 Beta 1uint32_t GetUIScaledFontSize(uint32_t fontsize)
Returns the ui scaled fontsize of the specified one.
 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)int GetVRControllerAutoHide()
Gets the currently defined setting for hiding VR controllers in the VR display if using a different controller.
 
added in 4.21 Beta 1 (VR: 4.20)

int GetVRVivePointerHand()
Retrieves the controller currently defined as the active pointing device. (1 == Right, 0 == Left. For use with the Vive controller.)

only functional in X Rebirth VR Edition
added in 4.22 Beta 2 (VR: 4.20 Hotfix 1)

float GetVRViveTouchpadLockTime()
Retrieves the currently defined latency for the touchpads on vive controllers.

 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)int GetVRWindowMode()
Gets the currently defined render mode on the monitor while VR headset is on.
 
added in 4.21 Beta 1 (VR: 4.20)ResolutionInfo GetWindowSize()
Returns the current window size.
 
added in 4.00 Beta 3uint32_t GetWeaponMods(UIWeaponMod* result, uint32_t resultlen) 
added in 4.00 Beta 2UniverseID GetZoneAt(UniverseID sectorid, UIPosRot* uioffset)
Returns the zone at the given sector position. Can create a temporary zone if needed.
 
 ZoneDetails GetZoneDetails(const UniverseID zoneid) 
added in 3.52 RC 2bool HasCustomConversation(UniverseID entityid) 
added in 4.00 Beta 6bool HasEntityMoneyLogEntries(UniverseID entityid)
Returns whether the specified entity has a money log. 
 
 bool HasDockedPassiveDrones() 
added 4.00 Beta 2bool HasJumpDrive()
Indicates whether the player ship has a jumpdrive atm.
 
 bool HasPassiveDroneAbilities() 
added 4.00 Beta 3bool HasRemoteControl()
Indicates whether the player has remote control atm (aka: controlling a drone or a torpedo).
 
added in 4.10 Beta 1

bool HasSavegame()
Indicates whether there's at least one savegame in the savegame directory.

Note: doesn't necessarily have to be a valid/loadable savegame.
Also note that unless IsSaveListLoadingComplete() indicates that the processing is done, HasSavegame() can return false, even though there would be a savegame in the savegame directory.

 
added 4.00 Beta 2bool HasSeta()
Indicates whether the player has SETA.
 
 bool HasSmalltalkOption(const UniverseID componentid) 
added in 4.00 Beta 3bool InstallWeaponMod(uint32_t weaponmodid) 
added in 4.00 Beta 6 (Hotfix 1)bool IsAppStoreVersion()Note: This function is of little interest to mods. It's only required for some internal checks.
 

bool IsAsteroid(const UniverseID componentid)
Indicates whether the specified component is an asteroid.

 
added in 4.30 RC 3 (VR: 4.30 Hotfix 2)bool IsAutotargetingActive()
Indicates whether the autotarget function of the target system is active atm.
 
 

bool IsBomb(const UniverseID componentid)
Indicates whether the specified component is a bomb.

 
 bool IsBuyOffer(UniverseID tradeofferdockid)
Checks whether the specified tradeofferdock is a buy offer.
 
added in 4.00 Beta 2
bool IsCheckBoxActive(const int checkboxid) 
added in 4.00 Beta 2
bool IsCheckBoxChecked(const int checkboxid) 
 bool IsComponentOperational(UniverseID componentid)
Checks whether the specified component is operational. 
 
 bool IsCrate(const UniverseID componentid)
Indicates whether the specified component is a crate.
 
added in 4.00 Beta 5bool IsDemoVersion()
Indicates whether we are running the demo version atm.
Note: This function is of little interest to mods, since mods are disabled in the demo version.
 bool IsDestructible(const UniverseID componentid)
Indicates whether the specified component is a destructible.
 
 bool IsDetailMonitorFullscreenMode() 
added in 4.00 Beta 1

bool IsDroneMode()
Indicates whether the UI is currently in drone-mode.

 
 bool IsEntity(const UniverseID componentid)
Returns true, if the specified component is an entity.
 
 bool IsErrorLogActive()
Indicates whether error logging is currently active.
 
 bool IsExternalViewActive()
Determined whether the game is currently in external view mode.
 
added in 4.00 Beta 2bool IsExternalTargetMode()
Determines whether the game is currently in external target view mode.
 
added in 4.21 Beta 1 (VR: 4.20)bool IsFPSEnabled()
Indicates whether the FPS counter is enabled atm.
 
added in 4.10 Beta 4bool IsFrameUsingMiniWidgetSystem(const int frameid) 
added in 4.00 Beta 1bool IsGamePaused()
Indicates whether the game is paused atm.
 
 bool IsGateTransition(const UniverseID zone1id, const UniverseID zone2id) 
added in 4.22 Beta 2 (VR: 4.22)bool IsGestureSteeringActive()only functional in XR VR
added in 4.31 Beta 1bool IsHeadTrackingActive()
Indicates whether head tracking (f.e. TrackIR) is active atm.
 
added in 4.00 Beta 2 bool IsHUDActive()
Indicates whether the HUD is currently active.
 
 bool IsInfoUnlockedForPlayer(UniverseID componentid, const char* infostring)
Checks whether the specified info of the component is unlocked for the player. 
 
 bool IsInHackRange(const UniverseID componentid) 
 bool IsInScanRange(const UniverseID componentid) 
added in 4.00 Beta 5bool IsKnownItemRead(const char* libraryid, const char* itemid)
Returns whether the specified library entry is read. 
 
added in 4.00 Beta 5bool IsKnownRead(UniverseID componentid)
Returns whether the specified component is read. 
 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)bool IsLanguageValid()
Returns whether the currently used language is a valid setting or defaulted to English.
only functional in X Rebirth VR Edition
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)bool IsLanguageSettingEnabled()
Returns whether the language setting should be displayed in the menu.
only functional in X Rebirth VR Edition
added in 4.31 Beta 1bool IsLockbox(UniverseID targetid)
Returns true, if the specified target is a lockbox.
 
added  in 4.22 Beta 2 (VR: 4.22)bool IsMouseVRPointerAllowed()
Returns whether the mouse VR pointer is allowed to activate.
only functional in X Rebirth VR Edition
added in 4.31 Beta 1bool IsNavBeacon(UniverseID targetid)
Returns true, if the specified target is a nav beacon.
 
added in 4.00 Beta 6bool IsPlayerCameraTargetViewPossible(UniverseID targetid, bool force)
Can the player camera be set to the specified target's external view?
 
added in 4.00 Beta 5bool IsPlayerValid()
Check whether the player has a valid context (e.g. they are not in game over mode) 
 
added in 4.00 Beta 1bool IsPointingWithinAimingRange()
Indicates whether the cursor is pointing within the aiming range of the weapons.
 
added in 4.10 Beta 1bool IsSaveListLoadingComplete()
Indicates whether processing the savegame directory is complete and a following call to GetSaveList2() will return a complete list (rather than a temporary list).
 
 bool IsSellOffer(UniverseID componentid)
Checks whether the specified tradeofferdock is a sell offer.
 
added in 4.00 Beta 2bool IsSetaActive()
Indicates whether Seta is active atm.
 
 bool IsShip(const UniverseID componentid) 
 bool IsSofttargetManagerActive(); 
added in 4.31 Beta 1bool IsStartmenu()
Indicates whether the UI script is running inside the startmenu or not.
 
 bool IsStation(const UniverseID componentid) 
 bool IsSurfaceElement(const UniverseID componentid) 
 bool IsSwitchable(const UniverseID componentid) 
added in 4.30 RC 1 (VR: 4.30)bool IsTargetable(const uint32_t messageid)
Indicates whether the target element (specified via its underlying messageid) is targetable atm.
 
 bool IsTargetInPlayerActivePrimaryWeaponRange(const UniverseID componentid)
Indicates whether the current target is within the weapon range of the current active primary weapon.
Note: As of 4.00 Beta 1 this function takes the object the player controls (aka: player ship or remote controlled drone/torpedo) at the time of the call when determining whether the component is in weapon range. Before, it always determined whether the component is in weapon range to the playership.
added in 4.21 Beta 1bool IsThrottleBidirectional()
Checks whether bidirectional throttle is enabled.
 
added in 3.50 Beta 2bool IsValidComponent(const UniverseID componentid); 
added in 4.21 Beta 1 (VR: 4.20)

bool IsVROculusTouchActive()
Indicates if an Oculus Touch controller is active.

only functional in X Rebirth VR Edition
added in 4.21 Beta 1 (VR: 4.20)bool IsVRMode()
Indicates whether the VR mode is active.
Note: If IsVRMode() returns true, it implies that IsVRVersion() returns true as well.
only functional in X Rebirth VR Edition
added in 4.10 Beta 1bool IsVRVersion()
Indicates whether we are running the VR version.
 
added in 4.10 Beta 4bool IsVRPointerActive()
Indicates whether the in-game VR-pointer is displayed atm.
 
added in 4.21 Beta 1 (VR: 4.20)

bool IsVRViveControllerActive()
Indicates if a Vive controller is active.

only functional in X Rebirth VR Edition
 bool IsWalkInAnimationRunning() 
added in 4.21 Beta 1 (VR: 4.20)void LeaveInteractMenu()
Ends the interact menu interaction mode.
 
 bool MarkIndicatorShown(const UniverseID componentid); 
 void NotifyDisplayNotification(const int notificationid);
Notifies the game engine about that the given notification is currently displayed.
 
 void NotifyErrorLogDispatching()
Notifies the game engine that error log dispatching/processing starts.
 
 void NotifyErrorLogDispatchingDone()
Notifies the game engine that error log dispatching/processing was done.
 
added in 4.21 Beta 1 (VR: 4.20)void NotifyInteractMenuHidden()
Notifies the game engine that the interact menu is hidden.
 
added in 4.21 Beta 1 (VR: 4.20)void NotifyInteractMenuShown()
Notifies the game engine that the interact menu is shown.
 
added in 4.00 Beta 5void OpenWebBrowser(const char* url)(warning) Designed for internal use only.
added in 4.21 Beta 1 (VR: 4.20)bool QuickDock()
Quick access to player docking (if the player currently has targeted a dock).
Return value indicates success.
 
added in 4.21 Beta 1 (VR: 4.20)bool QuickMenuAccess(const char* menu);(warning) Designed for internal use only. Use Lua function: StartConversationFromMenu() instead.
added in 4.21 Beta 1 (VR: 4.20)bool QuickUndock()
Quick access to player undocking (if the player is currently docked).
Return value indicates success.
 
added in 4.00 Beta 5void ReadKnownItem(const char* libraryid, const char* itemid, bool read);
Sets the specified library item to read. 
 
 

void RecallDrones()
Orders all drones to return to the player ship.

 
 void ReenableErrorLog()
Special function designed to be called to reenable the error log if it was automatically turned off to prevent potential deadlock conditions.
 
added in 4.10 Beta 1void ReloadSaveList()
Triggers processing of the savegame directory, starting the asynchronous loading of all savegame data in that directory. Used in combination with GetSaveList2().
 
 void RemoveFill(const UniverseID componentid)
Removes the fill effect of the specified component.
 
deprecated in 4.00 Beta 3DEPRECATED void RemoveHoloMap(UniverseID holomapid)
Removes the holomap.

(warning) DEPRECATED - use RemoveHoloMap2() instead

Note: As of 4.00 Beta 3 only a single holomap is supported. Therefore the specified ID is ignored.

added in 4.00 Beta 3void RemoveHoloMap2()
Removes the holomap.
 
added in 4.00 Beta 3bool RemoveInstalledWeaponMod(UniverseID weaponid) 
 void RemoveOutline(const UniverseID componentid) 
added in 4.00 Beta 3void RemoveTradeWare(UniverseID containerid, const char* wareid)
Removes the specified ware as a trade ware from the specified container. 
 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)void RequestLanguageChange(int32_t id)
Sets the requested language to id.
only functional in X Rebirth VR Edition
NOTE: This only works if IsLanguageSettingEnabled() returned true
added in 4.00 Beta 5void RevealEncyclopedia()
Completly reveals the enycyclopedia. 
NOTE: This will show some entries that normally are not discover-able by the player. Needs cheats enabled.
added in 4.00 Beta 6void ScheduleSupplyUpdate(UniverseID componentid)
Schedules an update of the supply calculations on the specified component. 
 
added in 4.21 Beta 1 (VR: 4.20)void SetAdaptiveSamplingOption(float value) 
 void SetConfigSetting(const char*const setting, const bool value) 
added in 4.00 Beta 3void SetContainerWareIsBuyable(UniverseID containerid, const char* wareid, bool allowed)
Sets whether the specified ware is buyable on the specified container according to the value of allowed.
 
added in 4.00 Beta 3
void SetContainerWareIsSellable(UniverseID containerid, const char* wareid, bool allowed)
Sets whether the specified ware is sellable on the specified container according to the value of allowed.
 
 void SetCrosshairMessage(const uint32_t messageid) 
 void SetFill(const UniverseID componentid, const uint8_t red, const uint8_t green, const uint8_t blue, const float alpha, const bool animated, const float minalpha, const float maxalpha, const float transitiontime) 
added in 4.10 Beta 1 / changed in 4.10 Beta 6void SetForceShootingAtCursorOption(bool value)
Sets whether shooting is forced to always aim towards the cursor position (rather than also towards the crosshair).
Renamed in 4.10 Beta 6; was ToggleForceShootingAtCursorOption(void) before
 void SetFXAAOption(uint32_t fxaa)
Sets the FXAA setting. 
 
 void SetHighlightMapComponent(UniverseID holomapid, UniverseID componentid, bool resetplayerpan)
Sets the highlighted component on the specified holomap. 
 
added in 4.00 Beta 5void SetKnownRead(UniverseID componentid, bool read)
Sets the specified component to read. 
 
added in 3.60 Beta 4void SetKnownTo(UniverseID componentid, const char* factionid) 
added in 4.00 RC 2void SetLargeHUDMenusOption(bool value) 
added in 4.00 Beta 3void SetLootMagnetActive(bool active)
(De)Activates the playership's loot magnet.
 

deprecated in 4.31 Beta 1
changed in 4.00 Beta 2

bool SetMapRenderTarget(const char*const rendertargettexture, const UniverseID referencecomponent, const bool mapmode)
Displays a radar on the given texture in the specified mode. Referencecomponent will be the highlighted one in the radar. 0 indicates no highlighted object.

(warning)DEPRECATED - use SetRadarRenderTarget() instead

In 4.00 Beta 2 the function creates a map which is focused around the object the player controls atm (so the drone in case it's called while the player controls a drone). Pre 4.00 Beta 2 behavior was always to focus the player ship.

deprecated in 4.31 Beta 1
added in 4.00 Beta 2
bool SetMapRenderTargetOnTarget(const char*const rendertargettexture, const UniverseID focuscomponent, const UniverseID referencecomponent, const bool mapmode)
Same as SetMapRenderTarget but allows specifying the component which the radar will be focused on.
(warning)DEPRECATED - use SetRadarRenderTargetOnTarget() instead
added in 4.00 Beta 1void SetMouseOverTextOption(bool value) 
added  in 4.22 Beta 2 (VR: 4.22)void SetMouseVRPointerAllowed(bool newsetting)
Allows or disallows Mouse VR Pointer activation.
only available in XR VR
added  in 4.22 Beta 2 (VR: 4.22)void SetMouseVRSensitivityPitch(float value)only available in XR VR
added  in 4.22 Beta 2 (VR: 4.22)void SetMouseVRSensitivityYaw(float value)only available in XR VR
 void SetOutline(const UniverseID componentid, const uint8_t red, const uint8_t green, const uint8_t blue, const bool animated) 
added in 4.00 Beta 3void SetPlayerCameraCockpitView(bool force)
Set the player camera to the normal cockpit view. 
 
added in 4.00 Beta 3
void SetPlayerCameraExternalView(bool force)
Set the player camera to the external view of the playership. 
 
added in 4.00 Beta 3
void SetPlayerCameraTargetView(UniverseID targetid, bool force)
Set the player camera to the specified target's external view.
 
added in 4.31 Beta 1bool SetRadarRenderTarget(const char*const rendertargettexture, const UniverseID referencecomponent, const bool mapmode)
Displays a radar on the given texture in the specified mode. Referencecomponent will be the highlighted one in the radar. 0 indicates no highlighted object.
 
added in 4.31 Beta 1bool SetMapRenderTargetOnTarget(const char*const rendertargettexture, const UniverseID focuscomponent, const UniverseID referencecomponent, const bool mapmode)
Same as SetMapRenderTarget but allows specifying the component which the radar will be focused on.
 
added in 4.00 Beta 1void SetSavesCompressedOption(bool value)
Sets the save game compression option. 
 
added in 3.60 Beta 2bool SetSofttarget(const UniverseID componentid)
Sets the current target to the specified one. The return value indicates whether setting succeeded.
 
added in 4.21 Beta 1 (VR: 4.20)bool SetSofttargetByMissionOffer(const uint64_t missionofferid)
Sets the current target to the one representing the given mission offer. The return value indicates whether setting succeeded.
 
added in 4.21 Beta 1void SetThrottleBidirectional(bool newsetting)
Enables/disables bidirectional throttle.
 

deprecated in 4.30 Beta 1

added in 4.10

DEPRECATED void SetUIScale(float scale)
Sets the uiscale to the given value.
(warning) DEPRECATED - use SetUIScaleFactor() instead
added in 4.30 Beta 1void SetUIScaleFactor(float scale)
Sets the uiscale to the given value.
 
 void ShowUniverseMap(UniverseID holomapid, UniverseID componentid, bool resetplayerzoom, int overridezoom)
Set the specified holomap to display the map of given component. 
 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)void SetVRControllerAutoHide(int newmode)
Sets newmode as the currently defined setting for hiding VR controllers in the VR display if using a different controller.
 
added in 4.22 Beta 2 (VR: 4.20 Hotfix 1)

void SetVRVivePointerHand(int hand)
Set the designated controller as active pointing device. (1 == Right, 0 == Left. For use with the Vive controller.)

only functional in X Rebirth VR Edition
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)

void SetVRViveTouchpadLockTime(float newtime)
Set newtime as the latency time for the touch pads on vive controllers.

 
added in 4.21 Beta 1 (VR: 4.20 Hotfix 1)void SetVRWindowMode(int mode)
Set new mode for rendering on the monitor while VR headset is on.
 
added in 4.21 Beta 1 (VR: 4.20)

void StartIntroAnimation()
Start an intro animation.

 
 void StartPanMap(UniverseID holomapid)
Signal the specified holomap that panning started. 
 
 void StartRotateMap(UniverseID holomapid)
Signal the specified holomap that rotation started. 
 
 void StopPanMap(UniverseID holomapid)
Signal the specified holomap that panning stopped. 
 
 void StopRotateMap(UniverseID holomapid)
Signal the specified holomap that rotation stopped. 
 
added in 4.21 Beta 1 (VR: 4.20)void StartStartMenuBGMusic()
Start the startmenu background music, cancelling all previous start menu music.
 
added in 4.21 Beta 1 (VR: 4.20)void StopStartMenuBGMusic()
Stops all previous start menu music.
 
added in 4.00 Beta 1
void ToggleAutoPilot()
Toggle the autopilot on the current mission target. 
 
added in 4.00 Beta 3
void ToggleEventMonitorDetails()
Toggle the display of details on the eventmonitor. 
 
added in 4.00 Beta 3
void ToggleFlightAssist()
Toggle the flight assist mode. 
 
added in 4.21 Beta 1 (VR: 4.20)void ToggleLootMagnet()
Toggle the loot magnet.
 
added in 4.00 Beta 3void ToggleMouseSteeringMode()
Toggle mouse steering mode. 
 
added in 4.00 Beta 3
void ToggleRadarMode()
Toggle between the radar modes. 
 
added in 4.21 Beta 1 (VR: 4.20)void ToggleSeta()
Toggle Seta on/off.
(warning) Designed for internal use only. Use the MD action: ToggleTimeWarpAction instead.
added in 4.00 Beta 6void UpdateBlackboardSupplyOverrides(UniverseID entityid, SupplyOverride* overrides, uint32_t numoverrides)
Updates the blackboard variables for supply overrides with the given data. 
 
added in 4.31 Beta 1void UnsetRadarRenderTarget()
Resets the render target for the radar/map display.
 
 void ZoomMap(UniverseID holomapid, float zoomstep)
Zoom the specified holomap. 
 

 

DEPRECATED