Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 28.1
edited by stefan
on 2019/03/14 12:26
Change comment: added breaking change note on GetControllerInfo()
To version 16.1
edited by klaus
on 2019/02/01 16:14
Change comment: Added some pre-2.0 notes

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.stefan
1 +xwiki:XWiki.klaus
Content
... ... @@ -25,84 +25,10 @@
25 25  )))|=(((
26 26  Summary
27 27  )))
28 -|(% colspan="1" %)(% colspan="1" %)
29 -(((
30 -UI core
31 -)))|(% colspan="1" %)(% colspan="1" %)
32 -(((
33 -2.20 Beta 3/4
34 -)))|(% colspan="1" %)(% colspan="1" %)
35 -(((
36 -**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
37 -)))
38 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
39 -(((
40 -//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.
41 -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.//
42 -
43 -//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.
44 -//
45 -)))
46 -|(% colspan="1" %)(% colspan="1" %)
47 -(((
48 -Scripts
49 -)))|(% colspan="1" %)(% colspan="1" %)
50 -(((
51 -2.20 Beta 3
52 -)))|(% colspan="1" %)(% colspan="1" %)
53 -(((
54 -Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
55 -)))
56 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
57 -(((
58 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
59 -)))
60 -|(% colspan="1" %)(% colspan="1" %)
61 -(((
62 -Scripts
63 -)))|(% colspan="1" %)(% colspan="1" %)
64 -(((
65 -2.00 Beta 1
66 -)))|(% colspan="1" %)(% colspan="1" %)
67 -(((
68 -**<event_build_finished/> **param2 now returns null instead of a construction sequence
69 -)))
70 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
71 -(((
72 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
73 -)))
74 -|(% colspan="1" %)(% colspan="1" %)
75 -(((
76 -Scripts
77 -)))|(% colspan="1" %)(% colspan="1" %)
78 -(((
79 -2.00 Beta 1
80 -)))|(% colspan="1" %)(% colspan="1" %)
81 -(((
82 -**param.boarding.{...}** strength parameters removed
83 -)))
84 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
85 -(((
86 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
87 -)))
88 -|(% colspan="1" %)(% colspan="1" %)
89 -(((
90 -Scripts
91 -)))|(% colspan="1" %)(% colspan="1" %)
92 -(((
93 -2.00 Beta 1
94 -)))|(% colspan="1" %)(% colspan="1" %)
95 -(((
96 -**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
97 -)))
98 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
99 -(((
100 -//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.//
101 -)))
102 102  |(((
103 103  UI extensions
104 104  )))|(((
105 -2.00 Beta 1
31 +2.0 Beta 1
106 106  )))|(((
107 107  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
108 108  )))
... ... @@ -113,7 +113,7 @@
113 113  |(((
114 114  UI extensions
115 115  )))|(((
116 -2.00 Beta 1
42 +2.0 Beta 1
117 117  )))|(((
118 118  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
119 119  )))
... ... @@ -125,7 +125,7 @@
125 125  |(((
126 126  Scripts
127 127  )))|(((
128 -2.00 Beta 1
54 +2.0 Beta 1
129 129  )))|(((
130 130  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
131 131  )))
... ... @@ -136,7 +136,7 @@
136 136  |(((
137 137  Scripts
138 138  )))|(((
139 -2.00 Beta 1
65 +2.0 Beta 1
140 140  )))|(((
141 141  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
142 142  )))
... ... @@ -147,9 +147,9 @@
147 147  |(((
148 148  AI Scripts
149 149  )))|(((
150 -2.00 Beta 1
76 +2.0 Beta 1
151 151  )))|(((
152 -**<shoot/>/<shoot_at/>** attribute changes.
78 +Attribute changes to **<shoot/>** and **<shoot_at/>**
153 153  )))
154 154  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
155 155  (((
... ... @@ -160,66 +160,11 @@
160 160  //Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
161 161  )))
162 162  |(((
163 -UI extensions
164 -)))|(((
165 -2.00 Beta 1
166 -)))|(((
167 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
168 -)))
169 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
170 -(((
171 -//Added possibility to query build tasks of a certain buildmodule.//
172 -)))
173 -|(((
174 -UI extensions
175 -)))|(((
176 -2.00 Beta 1
177 -)))|(((
178 -**Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
179 -)))
180 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
181 -(((
182 -//Added list of resources a buildmodule needs to build.//
183 -)))
184 -|(((
185 -UI extensions
186 -)))|(((
187 -2.00 Beta 1
188 -)))|(((
189 -(% 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);" %)
190 -)))
191 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
192 -(((
193 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
194 -)))
195 -|(((
196 -UI extensions
197 -)))|(((
198 -2.00 Beta 1
199 -)))|(((
200 -**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" %)
201 -)))
202 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
203 -(((
204 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
205 -)))
206 -|(((
207 -UI extensions
208 -)))|(((
209 -1.50 Beta 3
210 -)))|(((
211 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
212 -)))
213 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
214 -(((
215 -//The "docksizes" property no longer includes internal ship storage docks.//
216 -)))
217 -|(((
218 218  All
219 219  )))|(((
220 220  1.50 Beta 2
221 221  )))|(((
222 -**Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
93 +Corrected **meaning of "Shipyard"** throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
223 223  )))
224 224  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
225 225  (((
... ... @@ -229,17 +229,6 @@
229 229  //Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
230 230  //Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
231 231  )))
232 -|(((
233 -UI extensions
234 -)))|(((
235 -1.50 Beta 2
236 -)))|(((
237 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
238 -)))
239 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
240 -(((
241 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
242 -)))
243 243  |(% colspan="1" %)(% colspan="1" %)
244 244  (((
245 245  UI extensions
... ... @@ -248,45 +248,20 @@
248 248  1.50 Beta 1
249 249  )))|(% colspan="1" %)(% colspan="1" %)
250 250  (((
251 -**FFI: SetGuidance()** removed useinfopoint argument.
111 +**FFI:** Removed **SetGuidance()** argument useinfopoint.
252 252  )))
253 253  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
254 254  (((
255 -//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.
256 -//
257 -
258 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
115 +//The deprecated third argument was removed. The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
259 259  )))
260 260  |(((
261 261  UI extensions
262 262  )))|(((
263 -1.50 Beta 1
264 -)))|(((
265 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
266 -)))
267 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
268 -(((
269 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
270 -)))
271 -|(((
272 -UI extensions
273 -)))|(((
274 274  1.32
275 275  )))|(((
276 -**Lua: GetComponentData() **removed the "nextdestname" property.
122 +**Lua:** Removed **GetComponentData()** property "**nextdestname**".
277 277  )))
278 278  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
279 279  (((
280 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
126 +//Instead of "nextdestname", use the GetComponentData() properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
281 281  )))
282 -|(((
283 -UI extensions
284 -)))|(((
285 -1.20
286 -)))|(((
287 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
288 -)))
289 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
290 -(((
291 -//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.//
292 -)))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -82182742
1 +78577909
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/82182742/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577909/Breaking Changes