Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 96.1
edited by klaus
on 2023/01/04 13:23
Change comment: There is no comment for this version
To version 106.1
edited by Daniel Turner
on 2023/08/25 10:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +X4 Foundations Wiki.Modding Support.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.klaus
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.
... ... @@ -31,6 +31,82 @@
31 31  == 6.00 ==
32 32  )))
33 33  |(((
34 +Libraries
35 +)))|(((
36 +6.00 Beta 7
37 +)))|(((
38 +Updated weights for ship groups in shipgroups.xml libraries of base game and all DLCs.
39 +)))
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 +(((
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 +
44 +//All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.//
45 +)))
46 +|(% colspan="1" %)(% colspan="1" %)
47 +(((
48 +Scripts
49 +)))|(% colspan="1" %)(% colspan="1" %)
50 +(((
51 +6.00 Beta 4
52 +)))|(% colspan="1" %)(% colspan="1" %)
53 +(((
54 +Changed conditions for **<event_player_travelmode_started> <event_player_travelmode_stopped> <event_player_travelmode_charge_started> <event_player_travelmode_charge_aborted>** to be raised.
55 +)))
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 :" %)
57 +(((
58 +//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. //
59 +
60 +//Scripts that need to check whether the player exits travel mode may also need to consider checking whether the player leaves the control seat using <event_player_stopped_control> since this will also result in travel mode stopping.//
61 +)))
62 +|(% colspan="1" %)(% colspan="1" %)
63 +(((
64 +Scripts
65 +)))|(% colspan="1" %)(% colspan="1" %)
66 +(((
67 +6.00 Beta 3
68 +)))|(% colspan="1" %)(% colspan="1" %)
69 +(((
70 +Changed result of **<find_object_surface>** action in the case of a failure
71 +)))
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 :" %)
73 +(((
74 +//The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.//
75 +
76 +//Previously, it returned null only if there was a physics error. It however returned a valid, somewhat-random, position if physics were fine but it was still unable to find a suitable surface position. This position was often unsuitable to use for gameplay purposes so it is now null so the caller can handle the situation.//
77 +
78 +//The action itself has been improved to increase the chance of finding suitable surface positions.//
79 +)))
80 +|(% colspan="1" %)(% colspan="1" %)
81 +(((
82 +Scripts
83 +)))|(% colspan="1" %)(% colspan="1" %)
84 +(((
85 +6.00 Beta 1
86 +)))|(% colspan="1" %)(% colspan="1" %)
87 +(((
88 +Behaviour change for **<match_dock>** script component filter
89 +)))
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 :" %)
91 +(((
92 +//<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
93 +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.//
94 +)))
95 +|(% colspan="1" %)(% colspan="1" %)
96 +(((
97 +Scripts
98 +)))|(% colspan="1" %)(% colspan="1" %)
99 +(((
100 +6.00 Beta 1
101 +)))|(% colspan="1" %)(% colspan="1" %)
102 +(((
103 +Changed result attribute location for **<get_attackstrength>**
104 +)))
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 :" %)
106 +(((
107 +//The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.//
108 +)))
109 +|(((
34 34  Assets
35 35  )))|(((
36 36  6.00 Beta 1
... ... @@ -37,10 +37,10 @@
37 37  )))|(((
38 38  Surface element **connections** are incompatible by default unless tagged as "**standard**", and also "**combat**" for non-missile, non-mining weapons
39 39  )))
40 -|(% 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%" %)
41 41  (((
42 42  //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.
43 -//
119 +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.//
44 44  )))
45 45  |(% colspan="1" %)(% colspan="1" %)
46 46  (((
... ... @@ -52,7 +52,7 @@
52 52  (((
53 53  Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
54 54  )))
55 -|(% 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%" %)
56 56  (((
57 57  //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.//
58 58  )))
... ... @@ -63,10 +63,21 @@
63 63  )))|(((
64 64  **<event_player_owned_killed_object>** and **<event_player_owned_destroyed>** are now triggered before the corresponding **<event_object_destroyed>**, instead of afterwards.
65 65  )))
66 -|(% 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%" %)
67 67  (((
68 68  //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.//
69 69  )))
146 +|(((
147 +Cutscenes
148 +)))|(((
149 +6.00 Beta 1
150 +)))|(((
151 +Changed behaviour of **<angles>** in cutscenes
152 +)))
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%" %)
154 +(((
155 +//The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.//
156 +)))
70 70  |(% colspan="3" %)(% colspan="3" %)
71 71  (((
72 72  == 5.00 ==
... ... @@ -94,11 +94,11 @@
94 94  4.10 Beta 7
95 95  )))|(% colspan="1" %)(% colspan="1" %)
96 96  (((
97 -**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**: SetMapRenderCargoContents(%%)(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos()(%%) deprecated
98 98  )))
99 99  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
100 100  (((
101 -//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 SetMapRenderCargoContents(%%)(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos()(%%) has been removed and the function was therefore stubbed.//
102 102  )))
103 103  |(% colspan="1" %)(% colspan="1" %)
104 104  (((
... ... @@ -147,7 +147,7 @@
147 147  )))|(((
148 148  4.10 Beta 2
149 149  )))|(((
150 -**FFI**: (% style="color: rgb(0,0,0);" %)FilterComponentForMapMode(%%)() and (% style="color: rgb(0,0,0);" %)SetMapObjectFilter() changed
237 +**FFI**: FilterComponentForMapMode(%%)() and SetMapObjectFilter() changed
151 151  )))
152 152  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
153 153  (((
... ... @@ -158,7 +158,7 @@
158 158  )))|(((
159 159  4.10 Beta 1
160 160  )))|(((
161 -People related attributes of mission** <delivery> **node moved
248 +People related attributes of mission** <delivery> **node moved
162 162  )))
163 163  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
164 164  (((
... ... @@ -206,8 +206,7 @@
206 206  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
207 207  (((
208 208  //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).
209 -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.
210 -//
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.//
211 211  )))
212 212  |(((
213 213  Scripts
... ... @@ -237,8 +237,7 @@
237 237  //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.
238 238  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).//
239 239  
240 -//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
241 -//
326 +//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.//
242 242  )))
243 243  |(% colspan="1" %)(% colspan="1" %)
244 244  (((
... ... @@ -287,11 +287,11 @@
287 287  )))|(((
288 288  3.30 Beta 3
289 289  )))|(((
290 -**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** GetMissionLimit() (%%)**and** IsMissionLimit**(%%)**Enabled()**
291 291  )))
292 292  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
293 293  (((
294 -//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 IsMissionLimit(%%)Reached()//
295 295  )))
296 296  |(% colspan="3" %)(% colspan="3" %)
297 297  (((
... ... @@ -397,7 +397,7 @@
397 397  )))
398 398  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
399 399  (((
400 -//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.)
401 401  
402 402  //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).//
403 403  )))
... ... @@ -735,8 +735,7 @@
735 735  //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.
736 736  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.//
737 737  
738 -//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.
739 -//
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.//
740 740  )))
741 741  |(% colspan="1" %)(% colspan="1" %)
742 742  (((
... ... @@ -885,7 +885,7 @@
885 885  )))|(((
886 886  2.00 Beta 1
887 887  )))|(((
888 -(% 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 +**Lua: CalculateTotalHullFraction() **(%%)was removed.
889 889  )))
890 890  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
891 891  (((
... ... @@ -896,7 +896,7 @@
896 896  )))|(((
897 897  2.00 Beta 1
898 898  )))|(((
899 -**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: RequestDockAtReason()/UndockPlayerShip()(%%) **changed their return values.
900 900  )))
901 901  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
902 902  (((
... ... @@ -955,8 +955,7 @@
955 955  )))
956 956  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
957 957  (((
958 -//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.
959 -//
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.//
960 960  
961 961  //The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
962 962  )))
... ... @@ -969,7 +969,7 @@
969 969  )))
970 970  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
971 971  (((
972 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
1055 +//CancelConstruction() now returns if the cancellation was successful. //
973 973  )))
974 974  |(% colspan="3" %)(% colspan="3" %)
975 975  (((
... ... @@ -999,5 +999,5 @@
999 999  )))
1000 1000  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1001 1001  (((
1002 -//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 GetAAOption() gets the option to retrieve the config settings.//
1003 1003  )))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -135856500
1 +78577854
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/135856500/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577854/Breaking Changes