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 29.1
edited by owen
on 2019/05/24 17:31
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,114 @@
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 +'checkoperational' filter behaviour changed
37 +)))
38 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
39 +(((
40 +//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.//
41 +
42 +//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
43 +)))
44 +|(% colspan="1" %)(% colspan="1" %)
45 +(((
46 +Scripts
47 +)))|(% colspan="1" %)(% colspan="1" %)
48 +(((
49 +3.0 Beta 1
50 +)))|(% colspan="1" %)(% colspan="1" %)
51 +(((
52 +MD script **RML_Flight_Along_Path** removed
53 +)))
54 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
55 +(((
56 +//The MD script RML_Flight_Along_Path was not referened and was removed.//
57 +)))
58 +|(% colspan="1" %)(% colspan="1" %)
59 +(((
60 +UI core
61 +)))|(% colspan="1" %)(% colspan="1" %)
62 +(((
63 +2.20 Beta 3/4
64 +)))|(% colspan="1" %)(% colspan="1" %)
65 +(((
66 +**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
67 +)))
68 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
69 +(((
70 +//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.
71 +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.//
72 +
73 +//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.
74 +//
75 +)))
76 +|(% colspan="1" %)(% colspan="1" %)
77 +(((
78 +Scripts
79 +)))|(% colspan="1" %)(% colspan="1" %)
80 +(((
81 +2.20 Beta 3
82 +)))|(% colspan="1" %)(% colspan="1" %)
83 +(((
84 +Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
85 +)))
86 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
87 +(((
88 +//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
89 +)))
90 +|(% colspan="1" %)(% colspan="1" %)
91 +(((
92 +Scripts
93 +)))|(% colspan="1" %)(% colspan="1" %)
94 +(((
95 +2.00 Beta 1
96 +)))|(% colspan="1" %)(% colspan="1" %)
97 +(((
98 +**<event_build_finished/> **param2 now returns null instead of a construction sequence
99 +)))
100 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
101 +(((
102 +//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
103 +)))
104 +|(% colspan="1" %)(% colspan="1" %)
105 +(((
106 +Scripts
107 +)))|(% colspan="1" %)(% colspan="1" %)
108 +(((
109 +2.00 Beta 1
110 +)))|(% colspan="1" %)(% colspan="1" %)
111 +(((
112 +**param.boarding.{...}** strength parameters removed
113 +)))
114 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
115 +(((
116 +//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
117 +)))
118 +|(% colspan="1" %)(% colspan="1" %)
119 +(((
120 +Scripts
121 +)))|(% colspan="1" %)(% colspan="1" %)
122 +(((
123 +2.00 Beta 1
124 +)))|(% colspan="1" %)(% colspan="1" %)
125 +(((
126 +**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
127 +)))
128 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
129 +(((
130 +//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.//
131 +)))
28 28  |(((
29 29  UI extensions
30 30  )))|(((
31 -2.0 Beta 1
135 +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
146 +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
158 +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
169 +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
180 +2.00 Beta 1
77 77  )))|(((
78 -Attribute changes to **<shoot/>** and **<shoot_at/>**
182 +**<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  |(((
193 +UI extensions
194 +)))|(((
195 +2.00 Beta 1
196 +)))|(((
197 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
198 +)))
199 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
200 +(((
201 +//Added possibility to query build tasks of a certain buildmodule.//
202 +)))
203 +|(((
204 +UI extensions
205 +)))|(((
206 +2.00 Beta 1
207 +)))|(((
208 +**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
209 +)))
210 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
211 +(((
212 +//Added list of resources a buildmodule needs to build.//
213 +)))
214 +|(((
215 +UI extensions
216 +)))|(((
217 +2.00 Beta 1
218 +)))|(((
219 +(% 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);" %)
220 +)))
221 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
222 +(((
223 +//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
224 +)))
225 +|(((
226 +UI extensions
227 +)))|(((
228 +2.00 Beta 1
229 +)))|(((
230 +**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" %)
231 +)))
232 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
233 +(((
234 +//Changed return value type to const char* to better identify failure reasons in Lua script.//
235 +)))
236 +|(((
237 +UI extensions
238 +)))|(((
239 +1.50 Beta 3
240 +)))|(((
241 +**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
242 +)))
243 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
244 +(((
245 +//The "docksizes" property no longer includes internal ship storage docks.//
246 +)))
247 +|(((
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).
252 +**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  )))
262 +|(((
263 +UI extensions
264 +)))|(((
265 +1.50 Beta 2
266 +)))|(((
267 +**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
268 +)))
269 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
270 +(((
271 +//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
272 +)))
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.
281 +**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)//
285 +//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.
286 +//
287 +
288 +//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
116 116  )))
117 117  |(((
118 118  UI extensions
119 119  )))|(((
293 +1.50 Beta 1
294 +)))|(((
295 +**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
296 +)))
297 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
298 +(((
299 +(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
300 +)))
301 +|(((
302 +UI extensions
303 +)))|(((
120 120  1.32
121 121  )))|(((
122 -**Lua:** Removed **GetComponentData()** property "**nextdestname**".
306 +**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.//
310 +//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
127 127  )))
312 +|(((
313 +UI extensions
314 +)))|(((
315 +1.20
316 +)))|(((
317 +**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
318 +)))
319 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
320 +(((
321 +//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.//
322 +)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -78577909
1 +83066959
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/83066959/Breaking Changes