Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 104.2
edited by Volodymyr Boichuk
on 2023/07/10 12:21
Change comment: Update document after refactoring.
To version 105.1
edited by Daniel Turner
on 2023/08/25 09:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -X4WIKI.X4 Wiki Home.Modding Support.WebHome
1 +X4 Foundations Wiki.Modding Support.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.Volodymyr
1 +xwiki:XWiki.Daniel
Content
... ... @@ -4,13 +4,13 @@
4 4  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.
5 5  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.
6 6  
7 -{{note}}
8 -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.
7 +{{info}}
8 +⚠ 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.
9 9  
10 10  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.
11 11  
12 12  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).
13 -{{/note}}
13 +{{/info}}
14 14  
15 15  {{warning title="UI modding considered unstable until further notice..."}}
16 16  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.
... ... @@ -37,10 +37,9 @@
37 37  )))|(((
38 38  Updated weights for ship groups in shipgroups.xml libraries of base game and all DLCs.
39 39  )))
40 -|(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)
40 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
41 41  (((
42 -//Previously some entries were lacking "weight" parameter, causing it to default to "1", which prevent adding new ships to the group with appropriate/configurable granularity.
43 -//
42 +//Previously some entries were lacking "weight" parameter, causing it to default to "1", which prevent adding new ships to the group with appropriate/configurable granularity.//
44 44  
45 45  //All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.//
46 46  )))
... ... @@ -54,7 +54,7 @@
54 54  (((
55 55  Changed conditions for **<event_player_travelmode_started> <event_player_travelmode_stopped> <event_player_travelmode_charge_started> <event_player_travelmode_charge_aborted>** to be raised.
56 56  )))
57 -|(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)
56 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
58 58  (((
59 59  //The <event_player_travelmode_started>, <event_player_travelmode_stopped>, <event_player_travelmode_charge_started> and <event_player_travelmode_charge_aborted> events will no longer be raised if the player is a passenger on board a ship which enters or leaves travel mode. Previously these events would be raised whether the player was the pilot or a passenger. //
60 60  
... ... @@ -70,7 +70,7 @@
70 70  (((
71 71  Changed result of **<find_object_surface>** action in the case of a failure
72 72  )))
73 -|(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)
72 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
74 74  (((
75 75  //The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.//
76 76  
... ... @@ -88,7 +88,7 @@
88 88  (((
89 89  Behaviour change for **<match_dock>** script component filter
90 90  )))
91 -|(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)
90 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
92 92  (((
93 93  //<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
94 94  This has introduced a new potential pitfall: If finding or counting contained components be wary that there may be multiple positive results, even if there is only one dockingbay. e.g. matching contents for a station will include the dockingbay but also its containing walkable module as that also contains the dockingbay. To only account for docking bays, also filter by dockingbay class.//
... ... @@ -103,7 +103,7 @@
103 103  (((
104 104  Changed result attribute location for **<get_attackstrength>**
105 105  )))
106 -|(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" title="Background colour : " colspan="3" data-highlight-colour="grey" %)
105 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
107 107  (((
108 108  //The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.//
109 109  )))
... ... @@ -114,7 +114,7 @@
114 114  )))|(((
115 115  Surface element **connections** are incompatible by default unless tagged as "**standard**", and also "**combat**" for non-missile, non-mining weapons
116 116  )))
117 -|(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)
116 +|(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
118 118  (((
119 119  //Connection tags used to specify compatibilities in component templates between a ship or station module and engines or shields now additionally require the use of the "standard" tag matching weapon or turret logic. For weapons that are neither Missile Launcher nor Mining Laser, the tag "combat" is also required.
120 120  Exception: special equipment that is deliberately not compatible with the majority of slots may use another tag instead of "standard", e.g. "highpower" for certain Terran weapons.//
... ... @@ -129,7 +129,7 @@
129 129  (((
130 130  Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
131 131  )))
132 -|(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)
131 +|(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
133 133  (((
134 134  //When finding components with attribute "sortbygatedistanceto", e.g. in <find_object>, any objects with a negative gatedistance (i.e. unreachable objects) are automatically excluded from the result.//
135 135  )))
... ... @@ -140,7 +140,7 @@
140 140  )))|(((
141 141  **<event_player_owned_killed_object>** and **<event_player_owned_destroyed>** are now triggered before the corresponding **<event_object_destroyed>**, instead of afterwards.
142 142  )))
143 -|(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)
142 +|(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
144 144  (((
145 145  //The order of events was adjusted, allowing handlers of <event_player_owned_killed_object> and <event_player_owned_destroyed> to access commander/subordinate relationship of the destroyed object.//
146 146  )))
... ... @@ -151,7 +151,7 @@
151 151  )))|(((
152 152  Changed behaviour of **<angles>** in cutscenes
153 153  )))
154 -|(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)
153 +|(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-#f4f5f7" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
155 155  (((
156 156  //The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.//
157 157  )))
... ... @@ -182,11 +182,11 @@
182 182  4.10 Beta 7
183 183  )))|(% colspan="1" %)(% colspan="1" %)
184 184  (((
185 -**FFI**: (% style="color: rgb(0,0,0);" %)SetMapRenderCargoContents(%%)(), (% style="color: rgb(0,0,0);" %)SetMapRenderWorkForceInfo(), (% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)SetMapRenderCrewInfo() and (% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)SetMapRenderDockedShipInfos()(%%) deprecated
184 +**FFI**: (% style="color:#000000" %)SetMapRenderCargoContents(%%)(), (% style="color:#000000" %)SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos()(%%) deprecated
186 186  )))
187 187  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
188 188  (((
189 -//The functionality represented by (% style="color: rgb(0,0,0);" %)SetMapRenderCargoContents(%%)(), (% style="color: rgb(0,0,0);" %)SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos()(%%) has been removed and the function was therefore stubbed.//
188 +//The functionality represented by (% style="color:#000000" %)SetMapRenderCargoContents(%%)(), (% style="color:#000000" %)SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos()(%%) has been removed and the function was therefore stubbed.//
190 190  )))
191 191  |(% colspan="1" %)(% colspan="1" %)
192 192  (((
... ... @@ -235,7 +235,7 @@
235 235  )))|(((
236 236  4.10 Beta 2
237 237  )))|(((
238 -**FFI**: (% style="color: rgb(0,0,0);" %)FilterComponentForMapMode(%%)() and (% style="color: rgb(0,0,0);" %)SetMapObjectFilter() changed
237 +**FFI**: (% style="color:#000000" %)FilterComponentForMapMode(%%)() and (% style="color:#000000" %)SetMapObjectFilter() changed
239 239  )))
240 240  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
241 241  (((
... ... @@ -246,7 +246,7 @@
246 246  )))|(((
247 247  4.10 Beta 1
248 248  )))|(((
249 -People related attributes of mission** <delivery> **node moved
248 +People related attributes of mission** <delivery> **node moved
250 250  )))
251 251  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
252 252  (((
... ... @@ -294,8 +294,7 @@
294 294  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
295 295  (((
296 296  //Before 4.00 Beta 10 it was ensured that there is no direct transition between the 'cockpit ui mode' of one ship to another. Instead, it was always ensured that the UI first transitions into the firstperson mode and then back into the cockpit mode (controlling then the other ship).
297 -In order to support the new emergency eject feature which was added in 4.00 Beta 7, this assurance was dropped. As of 4.00 Beta 10 it is now possible that the ship the player controls can swap without the gameplanchange-event being risen which one could rely upon in previous versions. If your addon relied on the fact that the ship would not change without first going into first person mode, you will have to adjust your addon accordingly.
298 -//
296 +In order to support the new emergency eject feature which was added in 4.00 Beta 7, this assurance was dropped. As of 4.00 Beta 10 it is now possible that the ship the player controls can swap without the gameplanchange-event being risen which one could rely upon in previous versions. If your addon relied on the fact that the ship would not change without first going into first person mode, you will have to adjust your addon accordingly.//
299 299  )))
300 300  |(((
301 301  Scripts
... ... @@ -325,8 +325,7 @@
325 325  //In order to keep consistency with regards to the new behvior 'hostile' relation state and the older (deprecated) UI functions, the behavior of the deprecated GetFactionRelationStatus() function was changed according to the behavior of the GetRelationStatus()/GetRelationStatus2() functions which was done in the previous beta.
326 326  Factions with a relation rating between -20 and -10 will now report a relation status of 'neutral' (aka: 1) instead of 'hostile'/'enemy' (aka: 0).//
327 327  
328 -//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
329 -//
326 +//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.//
330 330  )))
331 331  |(% colspan="1" %)(% colspan="1" %)
332 332  (((
... ... @@ -375,11 +375,11 @@
375 375  )))|(((
376 376  3.30 Beta 3
377 377  )))|(((
378 -**FFI: **Removed** (% style="color: rgb(0,0,0);" %)GetMissionLimit() (%%)**(% style="color: rgb(0,0,0);" %)and** **(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)**IsMissionLimit**(%%)**Enabled()**
375 +**FFI: **Removed** (% style="color:#000000" %)GetMissionLimit() (%%)**(% style="color:#000000" %)and** IsMissionLimit**(%%)**Enabled()**
379 379  )))
380 380  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
381 381  (((
382 -//These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI (% style="color: rgb(0,0,0);" %)IsMissionLimit(%%)Reach(% style="color: rgb(0,0,0);" %)ed()//
379 +//These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI (% style="color:#000000" %)IsMissionLimit(%%)Reach(% style="color:#000000" %)ed()//
383 383  )))
384 384  |(% colspan="3" %)(% colspan="3" %)
385 385  (((
... ... @@ -485,7 +485,7 @@
485 485  )))
486 486  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
487 487  (((
488 -//All MD, UI, and cutscene files have been renamed as lower-case. For most users this should have no effect since files packed in catalogs are essentially case-insensitive. However, this change can affect users on Linux systems when running a mod that contains single files instead of a catalog, and/or when playing with unpacked base game files//. If your mod has XML patch files that are not packed in a catalog, the filenames must be lower-case to match the filenames in the base game. (For info on using mod catalogs, see the Readme of the X Catalog Tool.)\\
485 +//All MD, UI, and cutscene files have been renamed as lower-case. For most users this should have no effect since files packed in catalogs are essentially case-insensitive. However, this change can affect users on Linux systems when running a mod that contains single files instead of a catalog, and/or when playing with unpacked base game files//. If your mod has XML patch files that are not packed in a catalog, the filenames must be lower-case to match the filenames in the base game. (For info on using mod catalogs, see the Readme of the X Catalog Tool.)
489 489  
490 490  //Note that this change has no effect on the actual content of scripts or cutscenes. The MD script/cutscene names are stored in the files, regardless of the filenames, so that references to them remain unchanged (e.g., "md.Setup.Start" references a cue in setup.xml).//
491 491  )))
... ... @@ -823,8 +823,7 @@
823 823  //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.
824 824  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.//
825 825  
826 -//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.
827 -//
823 +//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.//
828 828  )))
829 829  |(% colspan="1" %)(% colspan="1" %)
830 830  (((
... ... @@ -973,7 +973,7 @@
973 973  )))|(((
974 974  2.00 Beta 1
975 975  )))|(((
976 -(% 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);" %)
972 +(% style="color:#000000" %)**Lua: CalculateTotalHullFraction() **(%%)was removed.(% style="color:#000000" %)
977 977  )))
978 978  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
979 979  (((
... ... @@ -984,7 +984,7 @@
984 984  )))|(((
985 985  2.00 Beta 1
986 986  )))|(((
987 -**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.
983 +**FFI: (% style="color:#000000" %)RequestDockAtReason()/UndockPlayerShip()(%%) **changed their return values.
988 988  )))
989 989  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
990 990  (((
... ... @@ -1043,8 +1043,7 @@
1043 1043  )))
1044 1044  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1045 1045  (((
1046 -//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.
1047 -//
1042 +//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.//
1048 1048  
1049 1049  //The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1050 1050  )))
... ... @@ -1057,7 +1057,7 @@
1057 1057  )))
1058 1058  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1059 1059  (((
1060 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
1055 +(% style="color:#000000" %)//CancelConstruction() now returns if the cancellation was successful. //
1061 1061  )))
1062 1062  |(% colspan="3" %)(% colspan="3" %)
1063 1063  (((
... ... @@ -1087,5 +1087,5 @@
1087 1087  )))
1088 1088  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1089 1089  (((
1090 -//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.//
1085 +//The AA setting was changed to check the new setting with the user. In order to restore the old setting (% style="color:#000000" %)GetAAOption() gets the option to retrieve the config settings.//
1091 1091  )))