Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 34.1
edited by klaus
on 2019/06/28 12:10
Change comment: Removed script features related to minigame and hacking
To version 13.1
edited by stefan
on 2019/02/01 12:52
Change comment: slightly rephrasing reorganizing paragraphs

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.klaus
1 +xwiki:XWiki.stefan
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,213 +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 conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
37 -)))
38 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
39 -(((
40 -//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.//
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 actions **<set_hack_target/>** and **<abort_hack/>** removed
51 -)))
52 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
53 -(((
54 -//These actions had no effect and were removed.//
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 -**<setup_conversation_minigame/>** script action removed
65 -)))
66 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
67 -(((
68 -//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.//
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 -<add_player_choice_*> **confidence** attribute removed
79 -)))
80 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
81 -(((
82 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
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 -**<hack_via_control_panel/>** 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 -//Unused script action <hack_via_control_panel/> was removed.//
97 -)))
98 -|(% colspan="1" %)(% colspan="1" %)
99 -(((
100 -UI core
101 -)))|(% colspan="1" %)(% colspan="1" %)
102 -(((
103 -3.0 Beta 1
104 -)))|(% colspan="1" %)(% colspan="1" %)
105 -(((
106 -**Lua: **GetMiniGameCursorPosition() removed
107 -)))
108 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
109 -(((
110 -//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.//
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 -**$ware.illegal** updated
121 -)))
122 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
123 -(((
124 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
125 -\\//It now returns true if $ware is illegal to any faction in the game.//
126 -)))
127 -|(% colspan="1" %)(% colspan="1" %)
128 -(((
129 -Scripts
130 -)))|(% colspan="1" %)(% colspan="1" %)
131 -(((
132 -3.0 Beta 1
133 -)))|(% colspan="1" %)(% colspan="1" %)
134 -(((
135 -'**checkoperational**' filter behaviour changed
136 -)))
137 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
138 -(((
139 -//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.//
140 -
141 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
142 -)))
143 -|(% colspan="1" %)(% colspan="1" %)
144 -(((
145 -Scripts
146 -)))|(% colspan="1" %)(% colspan="1" %)
147 -(((
148 -3.0 Beta 1
149 -)))|(% colspan="1" %)(% colspan="1" %)
150 -(((
151 -MD script **RML_Flight_Along_Path** removed
152 -)))
153 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
154 -(((
155 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
156 -)))
157 -|(% colspan="1" %)(% colspan="1" %)
158 -(((
159 -UI core
160 -)))|(% colspan="1" %)(% colspan="1" %)
161 -(((
162 -2.20 Beta 3/4
163 -)))|(% colspan="1" %)(% colspan="1" %)
164 -(((
165 -**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
166 -)))
167 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
168 -(((
169 -//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.
170 -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.//
171 -
172 -//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.
173 -//
174 -)))
175 -|(% colspan="1" %)(% colspan="1" %)
176 -(((
177 -Scripts
178 -)))|(% colspan="1" %)(% colspan="1" %)
179 -(((
180 -2.20 Beta 3
181 -)))|(% colspan="1" %)(% colspan="1" %)
182 -(((
183 -Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
184 -)))
185 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
186 -(((
187 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
188 -)))
189 -|(% colspan="1" %)(% colspan="1" %)
190 -(((
191 -Scripts
192 -)))|(% colspan="1" %)(% colspan="1" %)
193 -(((
194 -2.00 Beta 1
195 -)))|(% colspan="1" %)(% colspan="1" %)
196 -(((
197 -**<event_build_finished/> **param2 now returns null instead of a construction sequence
198 -)))
199 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
200 -(((
201 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
202 -)))
203 -|(% colspan="1" %)(% colspan="1" %)
204 -(((
205 -Scripts
206 -)))|(% colspan="1" %)(% colspan="1" %)
207 -(((
208 -2.00 Beta 1
209 -)))|(% colspan="1" %)(% colspan="1" %)
210 -(((
211 -**param.boarding.{...}** strength parameters removed
212 -)))
213 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
214 -(((
215 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
216 -)))
217 -|(% colspan="1" %)(% colspan="1" %)
218 -(((
219 -Scripts
220 -)))|(% colspan="1" %)(% colspan="1" %)
221 -(((
222 -2.00 Beta 1
223 -)))|(% colspan="1" %)(% colspan="1" %)
224 -(((
225 -**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
226 -)))
227 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
228 -(((
229 -//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.//
230 -)))
231 231  |(((
232 232  UI extensions
233 233  )))|(((
234 -2.00 Beta 1
31 +2.0 Beta 1
235 235  )))|(((
236 236  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
237 237  )))
... ... @@ -242,7 +242,7 @@
242 242  |(((
243 243  UI extensions
244 244  )))|(((
245 -2.00 Beta 1
42 +2.0 Beta 1
246 246  )))|(((
247 247  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
248 248  )))
... ... @@ -251,171 +251,3 @@
251 251  //Before 2.0 Beta 1 a call to SetFormationShape() indicated an error state to the caller in certain cases where setting a formation shape (potentially) failed. Due to a design flaw in the handling of formations, this however doesn't do any good, since the function by itself doesn't really set the formation shape in all cases. On top of that the call can fail at random. Hence, at the moment an indication of an error case that setting a formation potentially fails is no good to the caller and he has no means to distinguish that case from a real error case.//
252 252  //Therefore, in 2.0 Beta 1 we drop the error indication in case of an attempt to set the formation fails. We are currently working on a better solution to the underlying problem and hope to have it ready as part of a following beta.//
253 253  )))
254 -|(((
255 -Scripts
256 -)))|(((
257 -2.00 Beta 1
258 -)))|(((
259 -**<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
260 -)))
261 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
262 -(((
263 -//This now enforces a leader and at least one follower in order to create or change a formation.  Former implementation made it possible to create formations without any followers which led to issues.//
264 -)))
265 -|(((
266 -Scripts
267 -)))|(((
268 -2.00 Beta 1
269 -)))|(((
270 -**<event_player_changed_target/>** now fires and returns null if the player deselects a target.
271 -)))
272 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
273 -(((
274 -//For prior behavior, check for event.param being non-null.//
275 -)))
276 -|(((
277 -AI Scripts
278 -)))|(((
279 -2.00 Beta 1
280 -)))|(((
281 -**<shoot/>/<shoot_at/>** attribute changes.
282 -)))
283 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
284 -(((
285 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
286 -//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.//
287 -//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.//
288 -
289 -//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
290 -)))
291 -|(((
292 -UI extensions
293 -)))|(((
294 -2.00 Beta 1
295 -)))|(((
296 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% 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 possibility to query build tasks of a certain buildmodule.//
301 -)))
302 -|(((
303 -UI extensions
304 -)))|(((
305 -2.00 Beta 1
306 -)))|(((
307 -**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
308 -)))
309 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
310 -(((
311 -//Added list of resources a buildmodule needs to build.//
312 -)))
313 -|(((
314 -UI extensions
315 -)))|(((
316 -2.00 Beta 1
317 -)))|(((
318 -(% 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);" %)
319 -)))
320 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
321 -(((
322 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
323 -)))
324 -|(((
325 -UI extensions
326 -)))|(((
327 -2.00 Beta 1
328 -)))|(((
329 -**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" %)
330 -)))
331 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
332 -(((
333 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
334 -)))
335 -|(((
336 -UI extensions
337 -)))|(((
338 -1.50 Beta 3
339 -)))|(((
340 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
341 -)))
342 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
343 -(((
344 -//The "docksizes" property no longer includes internal ship storage docks.//
345 -)))
346 -|(((
347 -All
348 -)))|(((
349 -1.50 Beta 2
350 -)))|(((
351 -**Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
352 -)))
353 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
354 -(((
355 -//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".//
356 -
357 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
358 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
359 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
360 -)))
361 -|(((
362 -UI extensions
363 -)))|(((
364 -1.50 Beta 2
365 -)))|(((
366 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
367 -)))
368 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
369 -(((
370 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
371 -)))
372 -|(% colspan="1" %)(% colspan="1" %)
373 -(((
374 -UI extensions
375 -)))|(% colspan="1" %)(% colspan="1" %)
376 -(((
377 -1.50 Beta 1
378 -)))|(% colspan="1" %)(% colspan="1" %)
379 -(((
380 -**FFI: SetGuidance()** removed useinfopoint argument.
381 -)))
382 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
383 -(((
384 -//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.
385 -//
386 -
387 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
388 -)))
389 -|(((
390 -UI extensions
391 -)))|(((
392 -1.50 Beta 1
393 -)))|(((
394 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
395 -)))
396 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
397 -(((
398 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
399 -)))
400 -|(((
401 -UI extensions
402 -)))|(((
403 -1.32
404 -)))|(((
405 -**Lua: GetComponentData() **removed the "nextdestname" property.
406 -)))
407 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
408 -(((
409 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
410 -)))
411 -|(((
412 -UI extensions
413 -)))|(((
414 -1.20
415 -)))|(((
416 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
417 -)))
418 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
419 -(((
420 -//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.//
421 -)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -85131350
1 +78577892
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/85131350/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577892/Breaking Changes