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 35.1
edited by owen
on 2019/08/15 17:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.klaus
1 +xwiki:XWiki.owen
Content
... ... @@ -25,10 +25,227 @@
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 **<set_doors_locked/>** attribute **'group'** changed
37 +)))
38 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
39 +(((
40 +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.
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 conditions **<event_hack_*/>** and **<event_controlpanel_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 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.//
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 actions **<set_hack_target/>** and **<abort_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 actions had no effect and were removed.//
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 +**<setup_conversation_minigame/>** script action removed
79 +)))
80 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
81 +(((
82 +//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.//
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 +<add_player_choice_*> **confidence** attribute removed
93 +)))
94 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
95 +(((
96 +//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
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 +**<hack_via_control_panel/>** script action removed
107 +)))
108 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
109 +(((
110 +//Unused script action <hack_via_control_panel/> was removed.//
111 +)))
112 +|(% colspan="1" %)(% colspan="1" %)
113 +(((
114 +UI core
115 +)))|(% colspan="1" %)(% colspan="1" %)
116 +(((
117 +3.0 Beta 1
118 +)))|(% colspan="1" %)(% colspan="1" %)
119 +(((
120 +**Lua: **GetMiniGameCursorPosition() removed
121 +)))
122 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
123 +(((
124 +//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.//
125 +)))
126 +|(% colspan="1" %)(% colspan="1" %)
127 +(((
128 +Scripts
129 +)))|(% colspan="1" %)(% colspan="1" %)
130 +(((
131 +3.0 Beta 1
132 +)))|(% colspan="1" %)(% colspan="1" %)
133 +(((
134 +**$ware.illegal** updated
135 +)))
136 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
137 +(((
138 +//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
139 +\\//It now returns true if $ware is illegal to any faction in the game.//
140 +)))
141 +|(% colspan="1" %)(% colspan="1" %)
142 +(((
143 +Scripts
144 +)))|(% colspan="1" %)(% colspan="1" %)
145 +(((
146 +3.0 Beta 1
147 +)))|(% colspan="1" %)(% colspan="1" %)
148 +(((
149 +'**checkoperational**' filter behaviour changed
150 +)))
151 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
152 +(((
153 +//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.//
154 +
155 +//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
156 +)))
157 +|(% colspan="1" %)(% colspan="1" %)
158 +(((
159 +Scripts
160 +)))|(% colspan="1" %)(% colspan="1" %)
161 +(((
162 +3.0 Beta 1
163 +)))|(% colspan="1" %)(% colspan="1" %)
164 +(((
165 +MD script **RML_Flight_Along_Path** removed
166 +)))
167 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
168 +(((
169 +//The MD script RML_Flight_Along_Path was not referened and was removed.//
170 +)))
171 +|(% colspan="1" %)(% colspan="1" %)
172 +(((
173 +UI core
174 +)))|(% colspan="1" %)(% colspan="1" %)
175 +(((
176 +2.20 Beta 3/4
177 +)))|(% colspan="1" %)(% colspan="1" %)
178 +(((
179 +**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
180 +)))
181 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
182 +(((
183 +//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.
184 +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.//
185 +
186 +//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.
187 +//
188 +)))
189 +|(% colspan="1" %)(% colspan="1" %)
190 +(((
191 +Scripts
192 +)))|(% colspan="1" %)(% colspan="1" %)
193 +(((
194 +2.20 Beta 3
195 +)))|(% colspan="1" %)(% colspan="1" %)
196 +(((
197 +Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
198 +)))
199 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
200 +(((
201 +//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
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 +**<event_build_finished/> **param2 now returns null instead of a construction sequence
212 +)))
213 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
214 +(((
215 +//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
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 +**param.boarding.{...}** strength parameters removed
226 +)))
227 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
228 +(((
229 +//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
230 +)))
231 +|(% colspan="1" %)(% colspan="1" %)
232 +(((
233 +Scripts
234 +)))|(% colspan="1" %)(% colspan="1" %)
235 +(((
236 +2.00 Beta 1
237 +)))|(% colspan="1" %)(% colspan="1" %)
238 +(((
239 +**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
240 +)))
241 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
242 +(((
243 +//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.//
244 +)))
28 28  |(((
29 29  UI extensions
30 30  )))|(((
31 -2.0 Beta 1
248 +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
259 +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
271 +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
282 +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
293 +2.00 Beta 1
77 77  )))|(((
78 -Attribute changes to **<shoot/>** and **<shoot_at/>**
295 +**<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  |(((
306 +UI extensions
307 +)))|(((
308 +2.00 Beta 1
309 +)))|(((
310 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% 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 possibility to query build tasks of a certain buildmodule.//
315 +)))
316 +|(((
317 +UI extensions
318 +)))|(((
319 +2.00 Beta 1
320 +)))|(((
321 +**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
322 +)))
323 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
324 +(((
325 +//Added list of resources a buildmodule needs to build.//
326 +)))
327 +|(((
328 +UI extensions
329 +)))|(((
330 +2.00 Beta 1
331 +)))|(((
332 +(% 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);" %)
333 +)))
334 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
335 +(((
336 +//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
337 +)))
338 +|(((
339 +UI extensions
340 +)))|(((
341 +2.00 Beta 1
342 +)))|(((
343 +**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" %)
344 +)))
345 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
346 +(((
347 +//Changed return value type to const char* to better identify failure reasons in Lua script.//
348 +)))
349 +|(((
350 +UI extensions
351 +)))|(((
352 +1.50 Beta 3
353 +)))|(((
354 +**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
355 +)))
356 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
357 +(((
358 +//The "docksizes" property no longer includes internal ship storage docks.//
359 +)))
360 +|(((
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).
365 +**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  )))
375 +|(((
376 +UI extensions
377 +)))|(((
378 +1.50 Beta 2
379 +)))|(((
380 +**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
381 +)))
382 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
383 +(((
384 +//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
385 +)))
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.
394 +**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)//
398 +//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.
399 +//
400 +
401 +//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
116 116  )))
117 117  |(((
118 118  UI extensions
119 119  )))|(((
406 +1.50 Beta 1
407 +)))|(((
408 +**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
409 +)))
410 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
411 +(((
412 +(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
413 +)))
414 +|(((
415 +UI extensions
416 +)))|(((
120 120  1.32
121 121  )))|(((
122 -**Lua:** Removed **GetComponentData()** property "**nextdestname**".
419 +**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.//
423 +//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
127 127  )))
425 +|(((
426 +UI extensions
427 +)))|(((
428 +1.20
429 +)))|(((
430 +**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
431 +)))
432 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
433 +(((
434 +//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.//
435 +)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -78577909
1 +85131714
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/85131714/Breaking Changes