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 33.1
edited by stefan
on 2019/06/26 12:02
Change comment: added setup_conversation_minigame note

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.klaus
1 +xwiki:XWiki.stefan
Content
... ... @@ -25,10 +25,171 @@
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 +<setup_conversation_minigame/> 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 +//The script action was a left over 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.//
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 +<hack_via_control_panel/> script action removed
51 +)))
52 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
53 +(((
54 +//Unused script action <hack_via_control_panel/> was removed.//
55 +)))
56 +|(% colspan="1" %)(% colspan="1" %)
57 +(((
58 +UI core
59 +)))|(% colspan="1" %)(% colspan="1" %)
60 +(((
61 +3.0 Beta 1
62 +)))|(% colspan="1" %)(% colspan="1" %)
63 +(((
64 +**Lua: **GetMiniGameCursorPosition() removed
65 +)))
66 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
67 +(((
68 +//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.//
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 +$ware.illegal updated
79 +)))
80 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
81 +(((
82 +$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
83 +\\It now returns true if $ware is illegal to any faction in the game.
84 +)))
85 +|(% colspan="1" %)(% colspan="1" %)
86 +(((
87 +Scripts
88 +)))|(% colspan="1" %)(% colspan="1" %)
89 +(((
90 +3.0 Beta 1
91 +)))|(% colspan="1" %)(% colspan="1" %)
92 +(((
93 +'checkoperational' filter behaviour changed
94 +)))
95 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
96 +(((
97 +//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.//
98 +
99 +//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
100 +)))
101 +|(% colspan="1" %)(% colspan="1" %)
102 +(((
103 +Scripts
104 +)))|(% colspan="1" %)(% colspan="1" %)
105 +(((
106 +3.0 Beta 1
107 +)))|(% colspan="1" %)(% colspan="1" %)
108 +(((
109 +MD script **RML_Flight_Along_Path** removed
110 +)))
111 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
112 +(((
113 +//The MD script RML_Flight_Along_Path was not referened and was removed.//
114 +)))
115 +|(% colspan="1" %)(% colspan="1" %)
116 +(((
117 +UI core
118 +)))|(% colspan="1" %)(% colspan="1" %)
119 +(((
120 +2.20 Beta 3/4
121 +)))|(% colspan="1" %)(% colspan="1" %)
122 +(((
123 +**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
124 +)))
125 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
126 +(((
127 +//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.
128 +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.//
129 +
130 +//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.
131 +//
132 +)))
133 +|(% colspan="1" %)(% colspan="1" %)
134 +(((
135 +Scripts
136 +)))|(% colspan="1" %)(% colspan="1" %)
137 +(((
138 +2.20 Beta 3
139 +)))|(% colspan="1" %)(% colspan="1" %)
140 +(((
141 +Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
142 +)))
143 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
144 +(((
145 +//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
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 +**<event_build_finished/> **param2 now returns null instead of a construction sequence
156 +)))
157 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
158 +(((
159 +//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
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 +**param.boarding.{...}** strength parameters removed
170 +)))
171 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
172 +(((
173 +//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
174 +)))
175 +|(% colspan="1" %)(% colspan="1" %)
176 +(((
177 +Scripts
178 +)))|(% colspan="1" %)(% colspan="1" %)
179 +(((
180 +2.00 Beta 1
181 +)))|(% colspan="1" %)(% colspan="1" %)
182 +(((
183 +**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
184 +)))
185 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
186 +(((
187 +//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.//
188 +)))
28 28  |(((
29 29  UI extensions
30 30  )))|(((
31 -2.0 Beta 1
192 +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
203 +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
215 +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
226 +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
237 +2.00 Beta 1
77 77  )))|(((
78 -Attribute changes to **<shoot/>** and **<shoot_at/>**
239 +**<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  |(((
250 +UI extensions
251 +)))|(((
252 +2.00 Beta 1
253 +)))|(((
254 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
255 +)))
256 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
257 +(((
258 +//Added possibility to query build tasks of a certain buildmodule.//
259 +)))
260 +|(((
261 +UI extensions
262 +)))|(((
263 +2.00 Beta 1
264 +)))|(((
265 +**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
266 +)))
267 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
268 +(((
269 +//Added list of resources a buildmodule needs to build.//
270 +)))
271 +|(((
272 +UI extensions
273 +)))|(((
274 +2.00 Beta 1
275 +)))|(((
276 +(% 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);" %)
277 +)))
278 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
279 +(((
280 +//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
281 +)))
282 +|(((
283 +UI extensions
284 +)))|(((
285 +2.00 Beta 1
286 +)))|(((
287 +**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" %)
288 +)))
289 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
290 +(((
291 +//Changed return value type to const char* to better identify failure reasons in Lua script.//
292 +)))
293 +|(((
294 +UI extensions
295 +)))|(((
296 +1.50 Beta 3
297 +)))|(((
298 +**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
299 +)))
300 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
301 +(((
302 +//The "docksizes" property no longer includes internal ship storage docks.//
303 +)))
304 +|(((
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).
309 +**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  )))
319 +|(((
320 +UI extensions
321 +)))|(((
322 +1.50 Beta 2
323 +)))|(((
324 +**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
325 +)))
326 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
327 +(((
328 +//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
329 +)))
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.
338 +**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)//
342 +//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.
343 +//
344 +
345 +//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
116 116  )))
117 117  |(((
118 118  UI extensions
119 119  )))|(((
350 +1.50 Beta 1
351 +)))|(((
352 +**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
353 +)))
354 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
355 +(((
356 +(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
357 +)))
358 +|(((
359 +UI extensions
360 +)))|(((
120 120  1.32
121 121  )))|(((
122 -**Lua:** Removed **GetComponentData()** property "**nextdestname**".
363 +**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.//
367 +//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
127 127  )))
369 +|(((
370 +UI extensions
371 +)))|(((
372 +1.20
373 +)))|(((
374 +**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
375 +)))
376 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
377 +(((
378 +//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.//
379 +)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -78577909
1 +83460874
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/83460874/Breaking Changes