Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 37.1
edited by nick
on 2019/09/02 12:03
Change comment: There is no comment for this version
To version 14.1
edited by nick
on 2019/02/01 14:21
Change comment: updated with breaking changes to script actions

Summary

Details

Page properties
Content
... ... @@ -16,7 +16,7 @@
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.
17 17  {{/warning}}
18 18  
19 -= Breaking Changes =
19 += Breaking Changes (since 2.0 Beta 1) =
20 20  
21 21  |=(((
22 22  Type
... ... @@ -25,252 +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 -Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
37 -)))
38 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
39 -(((
40 -Due to engine changes, script action <add_actor_to_room/> has had the attribute 'room' changed to 'object', which is more accurate. Most likely requires a 'position' if a slot is not provided.
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 -Script action **<set_doors_locked/>** attribute **'group'** changed
51 -)))
52 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
53 -(((
54 -//The 'group' attribute of <set_doors_locked/> can no longer be a list. It must be a single tag value. Previously, a list containing one tag was accepted, which was redundant.//
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 -Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
65 -)))
66 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
67 -(((
68 -//These events were never triggered, with the exception of <event_hack_started/> on the player entity for instant control panel hacks. Use <event_player_hacked_object> instead.//
69 -)))
70 -|(% colspan="1" %)(% colspan="1" %)
71 -(((
72 -Scripts
73 -)))|(% colspan="1" %)(% colspan="1" %)
74 -(((
75 -3.0 Beta 1
76 -)))|(% colspan="1" %)(% colspan="1" %)
77 -(((
78 -Script actions **<set_hack_target/>** and **<abort_hack/>** removed
79 -)))
80 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
81 -(((
82 -//These actions had no effect and were removed.//
83 -)))
84 -|(% colspan="1" %)(% colspan="1" %)
85 -(((
86 -Scripts
87 -)))|(% colspan="1" %)(% colspan="1" %)
88 -(((
89 -3.0 Beta 1
90 -)))|(% colspan="1" %)(% colspan="1" %)
91 -(((
92 -**<setup_conversation_minigame/>** script action removed
93 -)))
94 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
95 -(((
96 -//The script action was a leftover from the XR era and was never supported in X4 and couldn't be used in a meaningful way. It was therefore decided to better drop it altogether as it's not expected having been used by any mods.//
97 -)))
98 -|(% colspan="1" %)(% colspan="1" %)
99 -(((
100 -Scripts
101 -)))|(% colspan="1" %)(% colspan="1" %)
102 -(((
103 -3.0 Beta 1
104 -)))|(% colspan="1" %)(% colspan="1" %)
105 -(((
106 -<add_player_choice_*> **confidence** attribute removed
107 -)))
108 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
109 -(((
110 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
111 -)))
112 -|(% colspan="1" %)(% colspan="1" %)
113 -(((
114 -Scripts
115 -)))|(% colspan="1" %)(% colspan="1" %)
116 -(((
117 -3.0 Beta 1
118 -)))|(% colspan="1" %)(% colspan="1" %)
119 -(((
120 -**<hack_via_control_panel/>** script action removed
121 -)))
122 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
123 -(((
124 -//Unused script action <hack_via_control_panel/> was removed.//
125 -)))
126 -|(% colspan="1" %)(% colspan="1" %)
127 -(((
128 -UI core
129 -)))|(% colspan="1" %)(% colspan="1" %)
130 -(((
131 -3.0 Beta 1
132 -)))|(% colspan="1" %)(% colspan="1" %)
133 -(((
134 -**Lua: **GetMiniGameCursorPosition() removed
135 -)))
136 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
137 -(((
138 -//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.//
139 -)))
140 -|(% colspan="1" %)(% colspan="1" %)
141 -(((
142 -Scripts
143 -)))|(% colspan="1" %)(% colspan="1" %)
144 -(((
145 -3.0 Beta 1
146 -)))|(% colspan="1" %)(% colspan="1" %)
147 -(((
148 -**$ware.illegal** updated
149 -)))
150 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
151 -(((
152 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
153 -\\//It now returns true if $ware is illegal to any faction in the game.//
154 -)))
155 -|(% colspan="1" %)(% colspan="1" %)
156 -(((
157 -Scripts
158 -)))|(% colspan="1" %)(% colspan="1" %)
159 -(((
160 -3.0 Beta 1
161 -)))|(% colspan="1" %)(% colspan="1" %)
162 -(((
163 -'**checkoperational**' filter behaviour changed
164 -)))
165 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
166 -(((
167 -//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.//
168 -
169 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
170 -)))
171 -|(% colspan="1" %)(% colspan="1" %)
172 -(((
173 -Scripts
174 -)))|(% colspan="1" %)(% colspan="1" %)
175 -(((
176 -3.0 Beta 1
177 -)))|(% colspan="1" %)(% colspan="1" %)
178 -(((
179 -MD script **RML_Flight_Along_Path** removed
180 -)))
181 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
182 -(((
183 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
184 -)))
185 185  |(((
186 -Scripts
187 -)))|(((
188 -2.60 Beta 1
189 -)))|(((
190 -$container.supplyresources behavior changed
191 -)))
192 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
193 -(((
194 -//The script keyword $container.supplyresources now includes reserved wares.//
195 -)))
196 -|(% colspan="1" %)(% colspan="1" %)
197 -(((
198 -UI core
199 -)))|(% colspan="1" %)(% colspan="1" %)
200 -(((
201 -2.20 Beta 3/4
202 -)))|(% colspan="1" %)(% colspan="1" %)
203 -(((
204 -**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
205 -)))
206 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
207 -(((
208 -//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.
209 -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.//
210 -
211 -//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.
212 -//
213 -)))
214 -|(% colspan="1" %)(% colspan="1" %)
215 -(((
216 -Scripts
217 -)))|(% colspan="1" %)(% colspan="1" %)
218 -(((
219 -2.20 Beta 3
220 -)))|(% colspan="1" %)(% colspan="1" %)
221 -(((
222 -Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
223 -)))
224 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
225 -(((
226 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
227 -)))
228 -|(% colspan="1" %)(% colspan="1" %)
229 -(((
230 -Scripts
231 -)))|(% colspan="1" %)(% colspan="1" %)
232 -(((
233 -2.00 Beta 1
234 -)))|(% colspan="1" %)(% colspan="1" %)
235 -(((
236 -**<event_build_finished/> **param2 now returns null instead of a construction sequence
237 -)))
238 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
239 -(((
240 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
241 -)))
242 -|(% colspan="1" %)(% colspan="1" %)
243 -(((
244 -Scripts
245 -)))|(% colspan="1" %)(% colspan="1" %)
246 -(((
247 -2.00 Beta 1
248 -)))|(% colspan="1" %)(% colspan="1" %)
249 -(((
250 -**param.boarding.{...}** strength parameters removed
251 -)))
252 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
253 -(((
254 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
255 -)))
256 -|(% colspan="1" %)(% colspan="1" %)
257 -(((
258 -Scripts
259 -)))|(% colspan="1" %)(% colspan="1" %)
260 -(((
261 -2.00 Beta 1
262 -)))|(% colspan="1" %)(% colspan="1" %)
263 -(((
264 -**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
265 -)))
266 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
267 -(((
268 -//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.//
269 -)))
270 -|(((
271 271  UI extensions
272 272  )))|(((
273 -2.00 Beta 1
31 +2.0 Beta 1
274 274  )))|(((
275 275  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
276 276  )))
... ... @@ -281,7 +281,7 @@
281 281  |(((
282 282  UI extensions
283 283  )))|(((
284 -2.00 Beta 1
42 +2.0 Beta 1
285 285  )))|(((
286 286  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
287 287  )))
... ... @@ -293,7 +293,7 @@
293 293  |(((
294 294  Scripts
295 295  )))|(((
296 -2.00 Beta 1
54 +2.0 Beta 1
297 297  )))|(((
298 298  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
299 299  )))
... ... @@ -304,7 +304,7 @@
304 304  |(((
305 305  Scripts
306 306  )))|(((
307 -2.00 Beta 1
65 +2.0 Beta 1
308 308  )))|(((
309 309  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
310 310  )))
... ... @@ -315,146 +315,15 @@
315 315  |(((
316 316  AI Scripts
317 317  )))|(((
318 -2.00 Beta 1
76 +2.0 Beta 1
319 319  )))|(((
320 -**<shoot/>/<shoot_at/>** attribute changes.
78 +Attribute changes to **<shoot/>** and **<shoot_at/>**:
79 +
80 +Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.
81 +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.
82 +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.
321 321  )))
322 322  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
323 323  (((
324 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
325 -//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.//
326 -//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.//
327 -
328 328  //Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
329 329  )))
330 -|(((
331 -UI extensions
332 -)))|(((
333 -2.00 Beta 1
334 -)))|(((
335 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
336 -)))
337 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
338 -(((
339 -//Added possibility to query build tasks of a certain buildmodule.//
340 -)))
341 -|(((
342 -UI extensions
343 -)))|(((
344 -2.00 Beta 1
345 -)))|(((
346 -**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
347 -)))
348 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
349 -(((
350 -//Added list of resources a buildmodule needs to build.//
351 -)))
352 -|(((
353 -UI extensions
354 -)))|(((
355 -2.00 Beta 1
356 -)))|(((
357 -(% 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);" %)
358 -)))
359 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
360 -(((
361 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
362 -)))
363 -|(((
364 -UI extensions
365 -)))|(((
366 -2.00 Beta 1
367 -)))|(((
368 -**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" %)
369 -)))
370 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
371 -(((
372 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
373 -)))
374 -|(((
375 -UI extensions
376 -)))|(((
377 -1.50 Beta 3
378 -)))|(((
379 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
380 -)))
381 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
382 -(((
383 -//The "docksizes" property no longer includes internal ship storage docks.//
384 -)))
385 -|(((
386 -All
387 -)))|(((
388 -1.50 Beta 2
389 -)))|(((
390 -**Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
391 -)))
392 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
393 -(((
394 -//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".//
395 -
396 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
397 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
398 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
399 -)))
400 -|(((
401 -UI extensions
402 -)))|(((
403 -1.50 Beta 2
404 -)))|(((
405 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
406 -)))
407 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
408 -(((
409 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
410 -)))
411 -|(% colspan="1" %)(% colspan="1" %)
412 -(((
413 -UI extensions
414 -)))|(% colspan="1" %)(% colspan="1" %)
415 -(((
416 -1.50 Beta 1
417 -)))|(% colspan="1" %)(% colspan="1" %)
418 -(((
419 -**FFI: SetGuidance()** removed useinfopoint argument.
420 -)))
421 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
422 -(((
423 -//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.
424 -//
425 -
426 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
427 -)))
428 -|(((
429 -UI extensions
430 -)))|(((
431 -1.50 Beta 1
432 -)))|(((
433 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
434 -)))
435 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
436 -(((
437 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
438 -)))
439 -|(((
440 -UI extensions
441 -)))|(((
442 -1.32
443 -)))|(((
444 -**Lua: GetComponentData() **removed the "nextdestname" property.
445 -)))
446 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
447 -(((
448 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
449 -)))
450 -|(((
451 -UI extensions
452 -)))|(((
453 -1.20
454 -)))|(((
455 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
456 -)))
457 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
458 -(((
459 -//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.//
460 -)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -85132000
1 +78577897
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/85132000/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577897/Breaking Changes