Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 32.1
edited by owen
on 2019/06/26 10:11
Change comment: There is no comment for this version
To version 16.1
edited by klaus
on 2019/02/01 16:14
Change comment: Added some pre-2.0 notes

Summary

Details

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