Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03

Manage
- Copy
Actions
- Export
- Print Preview

From 1.1 to 2.1 From 31.1 to 32.1

From version 2.1

edited by stefan
on 2019/02/01 01:44

Change comment: There is no comment for this version

To version 31.1

edited by stefan
on 2019/06/25 13:43

Change comment: added breaking change for GetMiniGameCursorPosition()

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -1,12 +1,351 @@
  = Introduction =
--Our goal is to keep breaking changes between any given version of X4 to an absolute minimum. In some cases, however, we have had to change things which break scripts/mods which were written for older versions.
++Our goal is to keep breaking changes between any given version of X4 to an absolute minimum. In some cases, however, we have had to change things which break scripts/mods written for older versions.
  The following table provides an overview about all breaking changes. This should help you to make any necessary changes to restore compatibility of older mods with new versions of X4.
++Feel free to drop a note if a certain breaking change is breaking your mod and you have difficulties finding a way to work around the issue.
  {{note}}
--The list of breaking changes does **NOT** cover changes in the provided/shipped Lua scripts (for instance the ones located under ui/addons/XXX or ui/core/Lua. These scripts can change anytime without explicit notice. If you hook into one of these scripts or provide replacements for these, please check the script for possible breaking changes yourself.
++The list of breaking changes does **NOT** cover changes in the provided/shipped scripts (for instance UI scripts like the ones located under ui/addons/XXX or ui/core/Lua). These scripts can change anytime without explicit notice. If you hook into one of these scripts or provide replacements for these, please check the script for possible breaking changes yourself.
++
++Further note that the list provides information about breaking changes which are in the pipeline of being released. This is meant merely as an informational heads up. Neither do mistake this as an announcement of that version becoming available soon nor take it for granted that such a change will go live. Any information provided for not yet released versions can change (and even be removed) prior to such version having seen the light of day.
++
++As a final note, please be aware that issues introduced during the beta phase might not be explicitly mentioned in the list below, if things would only be broken in-between two beta versions. While we still aim to document any (potential) breaking change here, there might be circumstances for which we divert from that procedure (especially in case of only minor issues which are considered merely bugfixes rather than an intended behavior change).
  {{/note}}
--Please note that issues introduced during the beta phase might not be explicitly mentioned as a breaking change, if things would only be broken in-between two beta versions.
++{{warning title="UI modding considered unstable until further notice..."}}
++Please note that UI modding must be considered **unstable** in the current version. While we are working hard to get the UI modding integration into a stable state, we might have to introduce larger backwards incompatibilities in the following patches. This means that you might have to modify any mod using UI modding capabilities to a larger extend to keep it compatible with certain patches. Still, we are doing our best not to unnecessarily break things for modders and certainly will announce such changes on this page here.
++{{/warning}}
--The following pages list all breaking changes related to UI modding.
++= Breaking Changes =
++
++|=(((
++Type
++)))|=(((
++Version
++)))|=(((
++Summary
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++UI core
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++**Lua: **GetMiniGameCursorPosition() removed
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++GetMiniGameCursorPosition() was a left over from the XR era and never supposed to be shipped with X4. The function practically always returned 0 and hence we don't expect the removal of this obsolete function causing any actual mod to break.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++$ware.illegal updated
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
++\\It now returns true if $ware is illegal to any faction in the game.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++'checkoperational' filter behaviour changed
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Actions and conditions which use the 'checkoperational' filter now behave differently. Instead of changing how 'class' and 'exactclass' behave, checkoperational == true adds an additional filter for the components being of state operational, equivalent to state="componentstate.operational". This is implicitly enabled in action elements (e.g. <find_.../>) or condition elements (e.g. <count_...>), meaning that find_ship will only find operational ships. Using such actions/conditions with checkoperational="false" will include non-operational components such as wrecked and constructions. Existing uses may find that results now exclude non-operational components.//
++
++//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++MD script **RML_Flight_Along_Path** removed
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The MD script RML_Flight_Along_Path was not referened and was removed.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++UI core
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++2.20 Beta 3/4
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//2.20 Beta 3 introduced the new direct mouse steering mode. The mode was however not integrated as a first level mode and hence GetControllerInfo() returned the "gamepad" mode while direct mouse steering was active.
++In 2.20 Beta 4 we improved the situation slightly so that a call to GetControllerInfo() will return either "mouseCursor" or "mouseSteering" in any of the 3 mouse modes.//
++
++//It's a pending change to ensure that the returned mode is more reasonable in an upcoming patch. So be aware that another breaking change might be introduced at some point.
++//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++2.20 Beta 3
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++2.00 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++**<event_build_finished/> **param2 now returns null instead of a construction sequence
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++2.00 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++**param.boarding.{...}** strength parameters removed
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++2.00 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Due to changes to boarding in X4, the boarding connections accessed by these script properties and actions became redundent and thus, removed. Any connections set by these actions in a savegame will not survive loading.//
++)))
++|(((
++UI extensions
++)))|(((
++2.00 Beta 1
++)))|(((
++**FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Before 2.0 Beta 1 using GetUpgradeSlotCurrentComponent() or GetUpgradeSlotGroup() only performed on operational objects (i.e. not wrecked objects or objects under construction). Since this is inconsistent with the rest of the UI functions, this was considered a bug and fixed in 2.0 Beta 1. If you require the old behavior, use the FFI function: IsComponentOperational() to check the passed object's state before making the call.//
++)))
++|(((
++UI extensions
++)))|(((
++2.00 Beta 1
++)))|(((
++**FFI: SetFormationShape()** no longer indicates an error upon certain error cases
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Before 2.0 Beta 1 a call to SetFormationShape() indicated an error state to the caller in certain cases where setting a formation shape (potentially) failed. Due to a design flaw in the handling of formations, this however doesn't do any good, since the function by itself doesn't really set the formation shape in all cases. On top of that the call can fail at random. Hence, at the moment an indication of an error case that setting a formation potentially fails is no good to the caller and he has no means to distinguish that case from a real error case.//
++//Therefore, in 2.0 Beta 1 we drop the error indication in case of an attempt to set the formation fails. We are currently working on a better solution to the underlying problem and hope to have it ready as part of a following beta.//
++)))
++|(((
++Scripts
++)))|(((
++2.00 Beta 1
++)))|(((
++**<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//This now enforces a leader and at least one follower in order to create or change a formation.  Former implementation made it possible to create formations without any followers which led to issues.//
++)))
++|(((
++Scripts
++)))|(((
++2.00 Beta 1
++)))|(((
++**<event_player_changed_target/>** now fires and returns null if the player deselects a target.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//For prior behavior, check for event.param being non-null.//
++)))
++|(((
++AI Scripts
++)))|(((
++2.00 Beta 1
++)))|(((
++**<shoot/>/<shoot_at/>** attribute changes.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
++//New attribute: "secondary" is an optional attribute that defines whether weapons from the ship's active secondary weapon group will be fired. Defaults to true.//
++//New attribute: "missiles" is an optional attribute that defines whether only missile launchers will be used. If false, only guns will be fired. Defaults to false.//
++
++//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
++)))
++|(((
++UI extensions
++)))|(((
++2.00 Beta 1
++)))|(((
++**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Added possibility to query build tasks of a certain buildmodule.//
++)))
++|(((
++UI extensions
++)))|(((
++2.00 Beta 1
++)))|(((
++**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Added list of resources a buildmodule needs to build.//
++)))
++|(((
++UI extensions
++)))|(((
++2.00 Beta 1
++)))|(((
++(% style="color: rgb(0,0,0);" %)**Lua:**(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)** CalculateTotalHullFraction()**(% style="color: rgb(0,0,0);" %)** **(%%)was removed.(% style="color: rgb(0,0,0);" %)
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
++)))
++|(((
++UI extensions
++)))|(((
++2.00 Beta 1
++)))|(((
++**FFI: (% style="color: rgb(0,0,0);" %)RequestDockAtReason()/(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)UndockPlayerShip()(%%) **changed their return values.(% style="color: rgb(0,0,0);" class="confluenceTd" %)
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Changed return value type to const char* to better identify failure reasons in Lua script.//
++)))
++|(((
++UI extensions
++)))|(((
++1.50 Beta 3
++)))|(((
++**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The "docksizes" property no longer includes internal ship storage docks.//
++)))
++|(((
++All
++)))|(((
++1.50 Beta 2
++)))|(((
++**Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Shipyards (formerly also known as Capital Shipyards) can build capital ships, while Wharfs only build non-capital ships. To check whether a station is a Shipyard or a Wharf, check whether the station "can build ships".//
++
++//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
++//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
++//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
++)))
++|(((
++UI extensions
++)))|(((
++1.50 Beta 2
++)))|(((
++**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++UI extensions
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++1.50 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++**FFI: SetGuidance()** removed useinfopoint argument.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//In X Rebirth "info points" existed (which were mainly used as interaction points to scan stations/access information about modules). These were removed in X4 but this left-over property here was missed to be removed in-time for release. It was therefore removed now in order to move towards a stable/clean UI API.
++//
++
++//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
++)))
++|(((
++UI extensions
++)))|(((
++1.50 Beta 1
++)))|(((
++**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
++)))
++|(((
++UI extensions
++)))|(((
++1.32
++)))|(((
++**Lua: GetComponentData() **removed the "nextdestname" property.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
++)))
++|(((
++UI extensions
++)))|(((
++1.20
++)))|(((
++**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The AA setting was changed to check the new setting with the user. In order to restore the old setting (% style="color: rgb(0,0,0);" %)GetAAOption() gets the option to retrieve the config settings.//
++)))

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--78577859
++83460733

url

@@ -1,1 +1,1 @@
--https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577859/Breaking Changes
++https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/83460733/Breaking Changes

Changes for page Breaking Changes

Summary

Details

Navigation

Applications