Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 16.1
edited by klaus
on 2019/02/01 16:14
Change comment: Added some pre-2.0 notes
To version 31.1
edited by stefan
on 2019/06/25 13:43
Change comment: added breaking change for GetMiniGameCursorPosition()

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.klaus
1 +xwiki:XWiki.stefan
Content
... ... @@ -25,10 +25,143 @@
25 25  )))|=(((
26 26  Summary
27 27  )))
28 +|(% colspan="1" %)(% colspan="1" %)
29 +(((
30 +UI core
31 +)))|(% colspan="1" %)(% colspan="1" %)
32 +(((
33 +3.0 Beta 1
34 +)))|(% colspan="1" %)(% colspan="1" %)
35 +(((
36 +**Lua: **GetMiniGameCursorPosition() removed
37 +)))
38 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
39 +(((
40 +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.
41 +)))
42 +|(% colspan="1" %)(% colspan="1" %)
43 +(((
44 +Scripts
45 +)))|(% colspan="1" %)(% colspan="1" %)
46 +(((
47 +3.0 Beta 1
48 +)))|(% colspan="1" %)(% colspan="1" %)
49 +(((
50 +$ware.illegal updated
51 +)))
52 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
53 +(((
54 +$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
55 +\\It now returns true if $ware is illegal to any faction in the game.
56 +)))
57 +|(% colspan="1" %)(% colspan="1" %)
58 +(((
59 +Scripts
60 +)))|(% colspan="1" %)(% colspan="1" %)
61 +(((
62 +3.0 Beta 1
63 +)))|(% colspan="1" %)(% colspan="1" %)
64 +(((
65 +'checkoperational' filter behaviour changed
66 +)))
67 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
68 +(((
69 +//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.//
70 +
71 +//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
72 +)))
73 +|(% colspan="1" %)(% colspan="1" %)
74 +(((
75 +Scripts
76 +)))|(% colspan="1" %)(% colspan="1" %)
77 +(((
78 +3.0 Beta 1
79 +)))|(% colspan="1" %)(% colspan="1" %)
80 +(((
81 +MD script **RML_Flight_Along_Path** removed
82 +)))
83 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
84 +(((
85 +//The MD script RML_Flight_Along_Path was not referened and was removed.//
86 +)))
87 +|(% colspan="1" %)(% colspan="1" %)
88 +(((
89 +UI core
90 +)))|(% colspan="1" %)(% colspan="1" %)
91 +(((
92 +2.20 Beta 3/4
93 +)))|(% colspan="1" %)(% colspan="1" %)
94 +(((
95 +**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
96 +)))
97 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
98 +(((
99 +//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.
100 +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.//
101 +
102 +//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.
103 +//
104 +)))
105 +|(% colspan="1" %)(% colspan="1" %)
106 +(((
107 +Scripts
108 +)))|(% colspan="1" %)(% colspan="1" %)
109 +(((
110 +2.20 Beta 3
111 +)))|(% colspan="1" %)(% colspan="1" %)
112 +(((
113 +Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
114 +)))
115 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
116 +(((
117 +//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
118 +)))
119 +|(% colspan="1" %)(% colspan="1" %)
120 +(((
121 +Scripts
122 +)))|(% colspan="1" %)(% colspan="1" %)
123 +(((
124 +2.00 Beta 1
125 +)))|(% colspan="1" %)(% colspan="1" %)
126 +(((
127 +**<event_build_finished/> **param2 now returns null instead of a construction sequence
128 +)))
129 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
130 +(((
131 +//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
132 +)))
133 +|(% colspan="1" %)(% colspan="1" %)
134 +(((
135 +Scripts
136 +)))|(% colspan="1" %)(% colspan="1" %)
137 +(((
138 +2.00 Beta 1
139 +)))|(% colspan="1" %)(% colspan="1" %)
140 +(((
141 +**param.boarding.{...}** strength parameters removed
142 +)))
143 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
144 +(((
145 +//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
146 +)))
147 +|(% colspan="1" %)(% colspan="1" %)
148 +(((
149 +Scripts
150 +)))|(% colspan="1" %)(% colspan="1" %)
151 +(((
152 +2.00 Beta 1
153 +)))|(% colspan="1" %)(% colspan="1" %)
154 +(((
155 +**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
156 +)))
157 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
158 +(((
159 +//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.//
160 +)))
28 28  |(((
29 29  UI extensions
30 30  )))|(((
31 -2.0 Beta 1
164 +2.00 Beta 1
32 32  )))|(((
33 33  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
34 34  )))
... ... @@ -39,7 +39,7 @@
39 39  |(((
40 40  UI extensions
41 41  )))|(((
42 -2.0 Beta 1
175 +2.00 Beta 1
43 43  )))|(((
44 44  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
45 45  )))
... ... @@ -51,7 +51,7 @@
51 51  |(((
52 52  Scripts
53 53  )))|(((
54 -2.0 Beta 1
187 +2.00 Beta 1
55 55  )))|(((
56 56  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
57 57  )))
... ... @@ -62,7 +62,7 @@
62 62  |(((
63 63  Scripts
64 64  )))|(((
65 -2.0 Beta 1
198 +2.00 Beta 1
66 66  )))|(((
67 67  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
68 68  )))
... ... @@ -73,9 +73,9 @@
73 73  |(((
74 74  AI Scripts
75 75  )))|(((
76 -2.0 Beta 1
209 +2.00 Beta 1
77 77  )))|(((
78 -Attribute changes to **<shoot/>** and **<shoot_at/>**
211 +**<shoot/>/<shoot_at/>** attribute changes.
79 79  )))
80 80  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
81 81  (((
... ... @@ -86,11 +86,66 @@
86 86  //Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
87 87  )))
88 88  |(((
222 +UI extensions
223 +)))|(((
224 +2.00 Beta 1
225 +)))|(((
226 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
227 +)))
228 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
229 +(((
230 +//Added possibility to query build tasks of a certain buildmodule.//
231 +)))
232 +|(((
233 +UI extensions
234 +)))|(((
235 +2.00 Beta 1
236 +)))|(((
237 +**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
238 +)))
239 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
240 +(((
241 +//Added list of resources a buildmodule needs to build.//
242 +)))
243 +|(((
244 +UI extensions
245 +)))|(((
246 +2.00 Beta 1
247 +)))|(((
248 +(% 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);" %)
249 +)))
250 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
251 +(((
252 +//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
253 +)))
254 +|(((
255 +UI extensions
256 +)))|(((
257 +2.00 Beta 1
258 +)))|(((
259 +**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" %)
260 +)))
261 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
262 +(((
263 +//Changed return value type to const char* to better identify failure reasons in Lua script.//
264 +)))
265 +|(((
266 +UI extensions
267 +)))|(((
268 +1.50 Beta 3
269 +)))|(((
270 +**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
271 +)))
272 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
273 +(((
274 +//The "docksizes" property no longer includes internal ship storage docks.//
275 +)))
276 +|(((
89 89  All
90 90  )))|(((
91 91  1.50 Beta 2
92 92  )))|(((
93 -Corrected **meaning of "Shipyard"** throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
281 +**Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
94 94  )))
95 95  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
96 96  (((
... ... @@ -100,6 +100,17 @@
100 100  //Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
101 101  //Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
102 102  )))
291 +|(((
292 +UI extensions
293 +)))|(((
294 +1.50 Beta 2
295 +)))|(((
296 +**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
297 +)))
298 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
299 +(((
300 +//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
301 +)))
103 103  |(% colspan="1" %)(% colspan="1" %)
104 104  (((
105 105  UI extensions
... ... @@ -108,20 +108,45 @@
108 108  1.50 Beta 1
109 109  )))|(% colspan="1" %)(% colspan="1" %)
110 110  (((
111 -**FFI:** Removed **SetGuidance()** argument useinfopoint.
310 +**FFI: SetGuidance()** removed useinfopoint argument.
112 112  )))
113 113  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
114 114  (((
115 -//The deprecated third argument was removed. The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
314 +//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.
315 +//
316 +
317 +//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
116 116  )))
117 117  |(((
118 118  UI extensions
119 119  )))|(((
322 +1.50 Beta 1
323 +)))|(((
324 +**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
325 +)))
326 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
327 +(((
328 +(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
329 +)))
330 +|(((
331 +UI extensions
332 +)))|(((
120 120  1.32
121 121  )))|(((
122 -**Lua:** Removed **GetComponentData()** property "**nextdestname**".
335 +**Lua: GetComponentData() **removed the "nextdestname" property.
123 123  )))
124 124  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
125 125  (((
126 -//Instead of "nextdestname", use the GetComponentData() properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
339 +//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
127 127  )))
341 +|(((
342 +UI extensions
343 +)))|(((
344 +1.20
345 +)))|(((
346 +**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
347 +)))
348 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
349 +(((
350 +//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.//
351 +)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -78577909
1 +83460733
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577909/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/83460733/Breaking Changes