Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03

From version 109.1
edited by Ketraar
on 2023/11/29 19:08
Change comment: There is no comment for this version
To version 23.1
edited by stefan
on 2019/02/08 12:15
Change comment: finished going through list

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -X4 Foundations Wiki.Modding Support.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.Ketraar
1 +xwiki:XWiki.stefan
Content
... ... @@ -4,13 +4,13 @@
4 4  The following table provides an overview about all breaking changes. This should help you to make any necessary changes to restore compatibility of older mods with new versions of X4.
5 5  Feel free to drop a note if a certain breaking change is breaking your mod and you have difficulties finding a way to work around the issue.
6 6  
7 -{{info}}
8 -The list of breaking changes does **NOT** cover changes in the provided/shipped scripts (for instance UI scripts like the ones located under ui/addons/XXX or ui/core/Lua). These scripts can change anytime without explicit notice. If you hook into one of these scripts or provide replacements for these, please check the script for possible breaking changes yourself.
7 +{{note}}
8 +The list of breaking changes does **NOT** cover changes in the provided/shipped scripts (for instance UI scripts like the ones located under ui/addons/XXX or ui/core/Lua). These scripts can change anytime without explicit notice. If you hook into one of these scripts or provide replacements for these, please check the script for possible breaking changes yourself.
9 9  
10 10  Further note that the list provides information about breaking changes which are in the pipeline of being released. This is meant merely as an informational heads up. Neither do mistake this as an announcement of that version becoming available soon nor take it for granted that such a change will go live. Any information provided for not yet released versions can change (and even be removed) prior to such version having seen the light of day.
11 11  
12 12  As a final note, please be aware that issues introduced during the beta phase might not be explicitly mentioned in the list below, if things would only be broken in-between two beta versions. While we still aim to document any (potential) breaking change here, there might be circumstances for which we divert from that procedure (especially in case of only minor issues which are considered merely bugfixes rather than an intended behavior change).
13 -{{/info}}
13 +{{/note}}
14 14  
15 15  {{warning title="UI modding considered unstable until further notice..."}}
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.
... ... @@ -18,911 +18,21 @@
18 18  
19 19  = Breaking Changes =
20 20  
21 -=== 7.00 ===
22 -
23 -(% class="wrapped" %)
24 24  |=(((
25 25  Type
23 +)))|=(((
24 +Version
25 +)))|=(((
26 +Summary
26 26  )))
27 -|(% colspan="1" %)(% colspan="1" %)
28 -(((
29 -UI extensions
30 -)))
31 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
32 -(((
33 -// The build plot's buildstorage is no longer removed implicitly. The buildstorage will instead be cleaned-up once it is empty and no ships are docked.//
34 -)))
35 -
36 -----
37 -
38 -=== 6.00 ===
39 -
40 -
41 -(% class="wrapped" %)
42 42  |(((
43 -Libraries
44 -)))|(((
45 -6.00 Beta 7
46 -)))|(% colspan="2" %)(((
47 -Updated weights for ship groups in shipgroups.xml libraries of base game and all DLCs.
48 -)))
49 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
50 -(((
51 -//Previously some entries were lacking "weight" parameter, causing it to default to "1", which prevent adding new ships to the group with appropriate/configurable granularity.//
52 -
53 -//All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.//
54 -)))
55 -|(% colspan="1" %)(% colspan="1" %)
56 -(((
57 -Scripts
58 -)))|(% colspan="1" %)(% colspan="1" %)
59 -(((
60 -6.00 Beta 4
61 -)))|(% colspan="2" %)(% colspan="1" %)
62 -(((
63 -Changed conditions for **<event_player_travelmode_started> <event_player_travelmode_stopped> <event_player_travelmode_charge_started> <event_player_travelmode_charge_aborted>** to be raised.
64 -)))
65 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
66 -(((
67 -//The <event_player_travelmode_started>, <event_player_travelmode_stopped>, <event_player_travelmode_charge_started> and <event_player_travelmode_charge_aborted> events will no longer be raised if the player is a passenger on board a ship which enters or leaves travel mode. Previously these events would be raised whether the player was the pilot or a passenger. //
68 -
69 -//Scripts that need to check whether the player exits travel mode may also need to consider checking whether the player leaves the control seat using <event_player_stopped_control> since this will also result in travel mode stopping.//
70 -)))
71 -|(% colspan="1" %)(% colspan="1" %)
72 -(((
73 -Scripts
74 -)))|(% colspan="1" %)(% colspan="1" %)
75 -(((
76 -6.00 Beta 3
77 -)))|(% colspan="2" %)(% colspan="1" %)
78 -(((
79 -Changed result of **<find_object_surface>** action in the case of a failure
80 -)))
81 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
82 -(((
83 -//The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.//
84 -
85 -//Previously, it returned null only if there was a physics error. It however returned a valid, somewhat-random, position if physics were fine but it was still unable to find a suitable surface position. This position was often unsuitable to use for gameplay purposes so it is now null so the caller can handle the situation.//
86 -
87 -//The action itself has been improved to increase the chance of finding suitable surface positions.//
88 -)))
89 -|(% colspan="1" %)(% colspan="1" %)
90 -(((
91 -Scripts
92 -)))|(% colspan="1" %)(% colspan="1" %)
93 -(((
94 -6.00 Beta 1
95 -)))|(% colspan="2" %)(% colspan="1" %)
96 -(((
97 -Behaviour change for **<match_dock>** script component filter
98 -)))
99 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
100 -(((
101 -//<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
102 -This has introduced a new potential pitfall: If finding or counting contained components be wary that there may be multiple positive results, even if there is only one dockingbay. e.g. matching contents for a station will include the dockingbay but also its containing walkable module as that also contains the dockingbay. To only account for docking bays, also filter by dockingbay class.//
103 -)))
104 -|(% colspan="1" %)(% colspan="1" %)
105 -(((
106 -Scripts
107 -)))|(% colspan="1" %)(% colspan="1" %)
108 -(((
109 -6.00 Beta 1
110 -)))|(% colspan="2" %)(% colspan="1" %)
111 -(((
112 -Changed result attribute location for **<get_attackstrength>**
113 -)))
114 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" title="Background colour :" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" title="Background colour :" %)
115 -(((
116 -//The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.//
117 -)))
118 -|(((
119 -Assets
120 -)))|(((
121 -6.00 Beta 1
122 -)))|(% colspan="2" %)(((
123 -Surface element **connections** are incompatible by default unless tagged as "**standard**", and also "**combat**" for non-missile, non-mining weapons
124 -)))
125 -|(% class="highlight-grey" colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-grey" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
126 -(((
127 -//Connection tags used to specify compatibilities in component templates between a ship or station module and engines or shields now additionally require the use of the "standard" tag matching weapon or turret logic. For weapons that are neither Missile Launcher nor Mining Laser, the tag "combat" is also required.
128 -Exception: special equipment that is deliberately not compatible with the majority of slots may use another tag instead of "standard", e.g. "highpower" for certain Terran weapons.//
129 -)))
130 -|(% colspan="1" %)(% colspan="1" %)
131 -(((
132 -Scripts
133 -)))|(% colspan="1" %)(% colspan="1" %)
134 -(((
135 -6.00 Beta 1
136 -)))|(% colspan="2" %)(% colspan="1" %)
137 -(((
138 -Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
139 -)))
140 -|(% class="highlight-grey" colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-grey" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
141 -(((
142 -//When finding components with attribute "sortbygatedistanceto", e.g. in <find_object>, any objects with a negative gatedistance (i.e. unreachable objects) are automatically excluded from the result.//
143 -)))
144 -|(((
145 -Scripts
146 -)))|(((
147 -6.00 Beta 1
148 -)))|(% colspan="2" %)(((
149 -**<event_player_owned_killed_object>** and **<event_player_owned_destroyed>** are now triggered before the corresponding **<event_object_destroyed>**, instead of afterwards.
150 -)))
151 -|(% class="highlight-grey" colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-grey" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
152 -(((
153 -//The order of events was adjusted, allowing handlers of <event_player_owned_killed_object> and <event_player_owned_destroyed> to access commander/subordinate relationship of the destroyed object.//
154 -)))
155 -|(((
156 -Cutscenes
157 -)))|(((
158 -6.00 Beta 1
159 -)))|(% colspan="2" %)(((
160 -Changed behaviour of **<angles>** in cutscenes
161 -)))
162 -|(% class="highlight-grey" colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% class="highlight-grey" colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
163 -(((
164 -//The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.//
165 -)))
166 -
167 -----
168 -
169 -=== 5.00 ===
170 -
171 -(% class="wrapped" %)
172 -|(((
173 -Parameters
174 -)))|(((
175 -5.00 Beta 1
176 -)))|(% colspan="2" %)(((
177 -**<controlpanel><entry>: minduration** removed, **maxduration** renamed to duration
178 -)))
179 -|(% class="highlight-grey" colspan="7" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
180 -(((
181 -//'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.//
182 -)))
183 -
184 -----
185 -
186 -=== 4.10 ===
187 -
188 -(% class="wrapped" %)
189 -|(% colspan="1" %)(% colspan="1" %)
190 -(((
191 191  UI extensions
192 -)))|(% colspan="1" %)(% colspan="1" %)
193 -(((
194 -4.10 Beta 7
195 -)))|(% colspan="2" %)(% colspan="1" %)
196 -(((
197 -**FFI**: SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() deprecated
198 -)))
199 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
200 -(((
201 -//The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.//
202 -)))
203 -|(% colspan="1" %)(% colspan="1" %)
204 -(((
205 -UI extensions
206 -)))|(% colspan="1" %)(% colspan="1" %)
207 -(((
208 -4.10 Beta 6
209 -)))|(% colspan="2" %)(% colspan="1" %)
210 -(((
211 -**FFI**: CustomGameStartPlayerProperty2 changed
212 -)))
213 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
214 -(((
215 -//This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.//
216 -)))
217 -|(% colspan="1" %)(% colspan="1" %)
218 -(((
219 -Parameters
220 -)))|(% colspan="1" %)(% colspan="1" %)
221 -(((
222 -4.10 Beta 3
223 -)))|(% colspan="2" %)(% colspan="1" %)
224 -(((
225 -Renamed **<stationinfobox>** to **<infobox>**
226 -)))
227 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
228 -(((
229 -//Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.//
230 -)))
231 -|(% colspan="1" %)(% colspan="1" %)
232 -(((
233 -UI extensions
234 -)))|(% colspan="1" %)(% colspan="1" %)
235 -(((
236 -4.10 Beta 2
237 -)))|(% colspan="2" %)(% colspan="1" %)
238 -(((
239 -**FFI**: SetMacroMapPlayerSectorOffset() deprecated
240 -)))
241 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
242 -(((
243 -//The functionality represented by SetMacroMapPlayerSectorOffset() has been removed and the function was therefore stubbed. Setting the gamestart properties "sector" and "offset" will affect the universe macro map instead directly.//
244 -)))
245 -|(((
246 -UI extensions
247 247  )))|(((
248 -4.10 Beta 2
249 -)))|(% colspan="2" %)(((
250 -**FFI**: FilterComponentForMapMode() and SetMapObjectFilter() changed
251 -)))
252 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
253 -(((
254 -//These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.//
255 -)))
256 -|(((
257 -Scripts
258 -)))|(((
259 -4.10 Beta 1
260 -)))|(% colspan="2" %)(((
261 -People related attributes of mission** <delivery> **node moved
262 -)))
263 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
264 -(((
265 -//The <delivery> node of <create_mission> and <update_mission> has been changed to support a new <wares> subnode. The people related attributes: 'people' and 'skills' have been moved from the <delivery> node itself to a <people> subnode.//
266 -)))
267 -|(% colspan="1" %)(% colspan="1" %)
268 -(((
269 -Scripts
270 -)))|(% colspan="1" %)(% colspan="1" %)
271 -(((
272 -4.10 Beta 1
273 -)))|(% colspan="2" %)(% colspan="1" %)
274 -(((
275 -**$destructible.productions** replaced with $defensible.productions
276 -)))
277 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
278 -(((
279 -//The $destructible.productions script property was removed and reimplemented as $defensible.productions meaning some old uses may no longer work unless the destructible is also a defensible. The old implementation functioned by finding the containing object of the destructible (including itself) to query for the production modules.//
280 -)))
281 -|(((
282 -Scripts
283 -)))|(((
284 -4.10 Beta 1
285 -)))|(% colspan="2" %)(((
286 -Removed script property **$object.spawnsourceseed**
287 -)))
288 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
289 -(((
290 -//The spawnsource seed is no longer directly accessible by scripts. Use $component.seed, which will internally use the spawnsource seed if able. Note: An improvement is that .seed on objects without a spawnsource seed will now result in a value that differs between objects of the same macro, meaning it can now reliably be used for player property or job ships.//
291 -)))
292 -
293 -----
294 -
295 -=== 4.00 ===
296 -
297 -(% class="wrapped" %)
298 -|(% colspan="1" %)(% colspan="1" %)
299 -(((
300 -UI core
301 -)))|(% colspan="1" %)(% colspan="1" %)
302 -(((
303 -4.00 Beta 10
304 -)))|(% colspan="2" %)(% colspan="1" %)
305 -(((
306 -Controlled ship can change without a **gameplanchange-event** occurring.
307 -)))
308 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
309 -(((
310 -//Before 4.00 Beta 10 it was ensured that there is no direct transition between the 'cockpit ui mode' of one ship to another. Instead, it was always ensured that the UI first transitions into the firstperson mode and then back into the cockpit mode (controlling then the other ship).
311 -In order to support the new emergency eject feature which was added in 4.00 Beta 7, this assurance was dropped. As of 4.00 Beta 10 it is now possible that the ship the player controls can swap without the gameplanchange-event being risen which one could rely upon in previous versions. If your addon relied on the fact that the ship would not change without first going into first person mode, you will have to adjust your addon accordingly.//
312 -)))
313 -|(((
314 -Scripts
315 -)))|(((
316 -4.00 Beta 7
317 -)))|(% colspan="2" %)(((
318 -Parameters of **<event_terraforming_project_succeeded>** and **<event_terraforming_project_failed>** changed
319 -)))
320 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
321 -(((
322 -//Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
323 -New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
324 -Note: param3 only exists in <event_terraforming_project_succeeded> and not in <event_terraforming_project_failed>, but both now have the booleans in a list for consistency//
325 -)))
326 -|(% colspan="1" %)(% colspan="1" %)
327 -(((
328 -UI core
329 -)))|(% colspan="1" %)(% colspan="1" %)
330 -(((
331 -4.00 Beta 6
332 -)))|(% colspan="2" %)(% colspan="1" %)
333 -(((
334 -**FFI:** GetFactionRelationStatus() handling for faction relation range [-20,-10] changed
335 -)))
336 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
337 -(((
338 -//In order to keep consistency with regards to the new behvior 'hostile' relation state and the older (deprecated) UI functions, the behavior of the deprecated GetFactionRelationStatus() function was changed according to the behavior of the GetRelationStatus()/GetRelationStatus2() functions which was done in the previous beta.
339 -Factions with a relation rating between -20 and -10 will now report a relation status of 'neutral' (aka: 1) instead of 'hostile'/'enemy' (aka: 0).//
340 -
341 -//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.//
342 -)))
343 -|(% colspan="1" %)(% colspan="1" %)
344 -(((
345 -UI core
346 -)))|(% colspan="1" %)(% colspan="1" %)
347 -(((
348 -4.00 Beta 5
349 -)))|(% colspan="2" %)(% colspan="1" %)
350 -(((
351 -**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed
352 -)))
353 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
354 -(((
355 -//4.00 Beta 5// //introduces a new 'hostile' relation status and the game now distinguishes between hostile and enemy relation states. Objects not yet 'hostile' with the player are now visualized differently and therefore distinguishable from real hostile ones. Because of that, several related changes were made for these objects to bring them more in line with how 'neutral' objects behave (f.e. no automatic attacking of these objects by the player property anymore, no target selection when targeting the closest enemy, etc.). To reflect this, these objects are now returning 1 (neutral) as the relation status by the GetRelationStatus()/GetRelationStatus2() functions.//
356 -
357 -//If you rely on a handling where they are treated like enemies, please use the new GetRelationStatus3() //function which returns the new range for these objects: 1 (meaning 'enemy' (aka: not yet hostile) here with following relations having been shifted up).
358 -)))
359 -|(((
360 -Parameters
361 -)))|(((
362 -4.00 Beta 1
363 -)))|(% colspan="2" %)(((
364 -**requiresconstructionvessel** parameter moved
365 -)))
366 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
367 -(((
368 -//The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.//
369 -)))
370 -|(((
371 -Scripts
372 -)))|(((
373 -4.00 Beta 1
374 -)))|(% colspan="2" %)(((
375 -Changed behaviour of **gatedistance** script property
376 -)))
377 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
378 -(((
379 -//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.//
380 -)))
381 -
382 -----
383 -
384 -=== 3.30 ===
385 -
386 -(% class="wrapped" %)
387 -|(((
388 -UI extensions
389 -)))|(((
390 -3.30 Beta 3
391 -)))|(% colspan="2" %)(((
392 -**FFI: **Removed** GetMissionLimit() **and** IsMissionLimitEnabled()**
393 -)))
394 -|(% class="highlight-grey" colspan="7" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
395 -(((
396 -//These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()//
397 -)))
398 -
399 -----
400 -
401 -=== 3.20 ===
402 -
403 -(% class="wrapped" %)
404 -|(((
405 -Scripts
406 -)))|(((
407 -3.20 Beta 1
408 -)))|(% colspan="2" %)(((
409 -Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
410 -)))
411 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
412 -(((
413 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
414 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
415 -Note that this also means the component attribute to the events is no longer available, so scripts checking the attacked component need to use event.param3.{1} instead//
416 -)))
417 -|(% colspan="1" %)(% colspan="1" %)
418 -(((
419 -Scripts
420 -)))|(% colspan="1" %)(% colspan="1" %)
421 -(((
422 -3.20 Beta 1
423 -)))|(% colspan="2" %)(% colspan="1" %)
424 -(((
425 -Removed script property $trade.**restriction.faction**
426 -)))
427 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
428 -(((
429 -//$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.//
430 -)))
431 -|(((
432 -UI extensions
433 -)))|(((
434 -3.20 Beta 1
435 -)))|(% colspan="2" %)(((
436 -**Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
437 -)))
438 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
439 -(((
440 -//With the addition of the Trade Rule feature the given functions are obsolete and do not function anymore. This set of functions will return dummy values to avoid breaking scripts. Use GetAllTradeRules(), GetContainerTradeRuleID(), SetContainerTradeRule() and similar trade rule functions as replacement.//
441 -)))
442 -
443 -----
444 -
445 -=== 3.10 ===
446 -
447 -(% class="wrapped" %)
448 -|(% colspan="1" %)(% colspan="1" %)
449 -(((
450 -Scripts
451 -)))|(% colspan="1" %)(% colspan="1" %)
452 -(((
453 -3.10 Beta 1
454 -)))|(% colspan="2" %)(% colspan="1" %)
455 -(((
456 -Removed script action **<add_build/>**
457 -)))
458 -|(% class="highlight-grey" colspan="7" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
459 -(((
460 -//Removed <add_build/> action which was no longer needed and would result in builds being added in unsupported ways. Use other <add_build_xxx/> actions.//
461 -)))
462 -
463 -----
464 -
465 -=== 3.00 ===
466 -
467 -(% class="wrapped" %)
468 -|(% colspan="1" %)(% colspan="1" %)
469 -(((
470 -Scripts
471 -)))|(% colspan="1" %)(% colspan="1" %)
472 -(((
473 -3.0 Beta 6
474 -)))|(% colspan="2" %)(% colspan="1" %)
475 -(((
476 -Changed behaviour of script action **<get_suitable_job/>**
477 -)))
478 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
479 -(((
480 -//<get_suitable_job/> previously did not respect job quotas or the current number of job ships. It now does, only returning job IDs which are not exceeding the maxgalaxy quota. Using 'exceedquota' allows the action to behave as before.//
481 -)))
482 -|(% colspan="1" %)(% colspan="1" %)
483 -(((
484 -Scripts
485 -)))|(% colspan="1" %)(% colspan="1" %)
486 -(((
487 -3.0 Beta 6
488 -)))|(% colspan="2" %)(% colspan="1" %)
489 -(((
490 -Changed behaviour of script action **<get_ware_definition/>**
491 -)))
492 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
493 -(((
494 -//<get_ware_definition/> previously filtered for equipment wares by default. This is now not the case and existing cases now use flags="equipment". Additional filter attributes for group and tags has also been added.//
495 -)))
496 -|(% colspan="1" %)(% colspan="1" %)
497 -(((
498 -Global
499 -)))|(% colspan="1" %)(% colspan="1" %)
500 -(((
501 -3.0 Beta 5
502 -)))|(% colspan="2" %)(% colspan="1" %)
503 -(((
504 -Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
505 -)))
506 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
507 -(((
508 -//All MD, UI, and cutscene files have been renamed as lower-case. For most users this should have no effect since files packed in catalogs are essentially case-insensitive. However, this change can affect users on Linux systems when running a mod that contains single files instead of a catalog, and/or when playing with unpacked base game files//. If your mod has XML patch files that are not packed in a catalog, the filenames must be lower-case to match the filenames in the base game. (For info on using mod catalogs, see the Readme of the X Catalog Tool.)
509 -
510 -//Note that this change has no effect on the actual content of scripts or cutscenes. The MD script/cutscene names are stored in the files, regardless of the filenames, so that references to them remain unchanged (e.g., "md.Setup.Start" references a cue in setup.xml).//
511 -)))
512 -|(% colspan="1" %)(% colspan="1" %)
513 -(((
514 -Scripts
515 -)))|(% colspan="1" %)(% colspan="1" %)
516 -(((
517 -3.0 Beta 5
518 -)))|(% colspan="2" %)(% colspan="1" %)
519 -(((
520 -Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
521 -)))
522 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
523 -(((
524 -//Some MD library cues in the base game that were previously used with <include_actions> have been adjusted, so they must now be used with the new MD action <run_actions> instead. Mods that use such a library with <include_actions> will have to switch to <run_actions> as well. A list of affected libraries is not provided here. Note: Additional library cues may be adjusted in future builds without further warning.//
525 -)))
526 -|(% colspan="1" %)(% colspan="1" %)
527 -(((
528 -Scripts
529 -)))|(% colspan="1" %)(% colspan="1" %)
530 -(((
531 -3.0 Beta 5
532 -)))|(% colspan="2" %)(% colspan="1" %)
533 -(((
534 -Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
535 -)))
536 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
537 -(((
538 -//Before the change, positions are relative to $dockingbay.parent.
539 -After the change, positions are relative to $dockingbay as specified in the documentation.//
540 -)))
541 -|(% colspan="1" %)(% colspan="1" %)
542 -(((
543 -Global
544 -)))|(% colspan="1" %)(% colspan="1" %)
545 -(((
546 -3.0 Beta 2
547 -)))|(% colspan="2" %)(% colspan="1" %)
548 -(((
549 -Support for entity flag "**skillsvisible**" dropped
550 -)))
551 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
552 -(((
553 -//Entity skills are always visible; that flag was a leftover from XR. We removed support for the script property .skillsvisible, the attribute "skillsvisible" of <set_entity_traits> and <set_npc_template_traits>, and the parameter "skillsvisible" of Lua function GetComponentData().//
554 -)))
555 -|(((
556 -Scripts
557 -)))|(((
558 -3.0 Beta 2
559 -)))|(% colspan="2" %)(((
560 -Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
561 -)))
562 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
563 -(((
564 -//Before 3.0 Beta 2 there was just a single <event_object//_changed_owner> condition. This condition was triggered in multiple cases when an owner change occurred. However, the exact cases were inconsistent and also the event could have been triggered w/o an effective owner change having been applied.
565 -3.0 Beta 2 fixes these inconsistencies and ensures that the event is only fired, if the "effective" component owner of the object changed. To handle cases where the script actually needs to be informed if the "true" owner of a component was changed (i.e. not taking the cover faction into account) a new <event_object_changed_true_owner> was introduced.
566 -If in your scripts you make use of the <event_object_changed_owner> condition you need to verify that you indeed want to work with the "effective" component owner or whether your script code actually should work with the true owner of an object and update your code accordingly.
567 -On top of that the 3rd parameter of <event_object_changed_owner> (trueprevious) was dropped as the event is no longer triggered upon a change of the true owner alone (i.e. only if the change of the true owner has also an effect on the "effective" component owner).
568 -)))
569 -|(% colspan="1" %)(% colspan="1" %)
570 -(((
571 -Global
572 -)))|(% colspan="1" %)(% colspan="1" %)
573 -(((
574 -3.0 Beta 1
575 -)))|(% colspan="2" %)(% colspan="1" %)
576 -(((
577 -**MissionBoard** support dropped
578 -)))
579 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
580 -(((
581 -//MissionBoards was a dummy asset type which was only used during early development and never meant to be shipped in the released version. If any mod tried to make use of this asset type, undefined behaviour would occur. Therefore we cleaned things up in 3.0 Beta 1 including deprecating/removing any related UI/script function.//
582 -)))
583 -|(((
584 -Job/God
585 -)))|(((
586 -3.0 Beta 1
587 -)))|(% colspan="2" %)(((
588 -By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
589 -)))
590 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
591 -(((
592 -//To better support extensions which add to the base game map, a job/god entry now defaults to only spawning objects in areas of the map that are added by the extension in which that entry is defined. You can override this behaviour by adding a matchextension="false" attribute to the job/god entry definition. This allows the entry to spawn objects anywhere that matches the entry's other criteria.//
593 -)))
594 -|(% colspan="1" %)(% colspan="1" %)
595 -(((
596 -Scripts
597 -)))|(% colspan="1" %)(% colspan="1" %)
598 -(((
599 -3.0 Beta 1
600 -)))|(% colspan="2" %)(% colspan="1" %)
601 -(((
602 -Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
603 -)))
604 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
605 -(((
606 -//Due to engine changes, script action <add_actor_to_room/> has had the attribute 'room' changed to 'object', which is more accurate. Most likely requires a 'position' if a slot is not provided.//
607 -)))
608 -|(% colspan="1" %)(% colspan="1" %)
609 -(((
610 -Scripts
611 -)))|(% colspan="1" %)(% colspan="1" %)
612 -(((
613 -3.0 Beta 1
614 -)))|(% colspan="2" %)(% colspan="1" %)
615 -(((
616 -Script action **<set_doors_locked/>** attribute **'group'** changed
617 -)))
618 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
619 -(((
620 -//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.//
621 -)))
622 -|(% colspan="1" %)(% colspan="1" %)
623 -(((
624 -Scripts
625 -)))|(% colspan="1" %)(% colspan="1" %)
626 -(((
627 -3.0 Beta 1
628 -)))|(% colspan="2" %)(% colspan="1" %)
629 -(((
630 -Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
631 -)))
632 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
633 -(((
634 -//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.//
635 -)))
636 -|(% colspan="1" %)(% colspan="1" %)
637 -(((
638 -Scripts
639 -)))|(% colspan="1" %)(% colspan="1" %)
640 -(((
641 -3.0 Beta 1
642 -)))|(% colspan="2" %)(% colspan="1" %)
643 -(((
644 -Script actions **<set_hack_target/>** and **<abort_hack/>** removed
645 -)))
646 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
647 -(((
648 -//These actions had no effect and were removed.//
649 -)))
650 -|(% colspan="1" %)(% colspan="1" %)
651 -(((
652 -Scripts
653 -)))|(% colspan="1" %)(% colspan="1" %)
654 -(((
655 -3.0 Beta 1
656 -)))|(% colspan="2" %)(% colspan="1" %)
657 -(((
658 -**<setup_conversation_minigame/>** script action removed
659 -)))
660 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
661 -(((
662 -//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.//
663 -)))
664 -|(% colspan="1" %)(% colspan="1" %)
665 -(((
666 -Scripts
667 -)))|(% colspan="1" %)(% colspan="1" %)
668 -(((
669 -3.0 Beta 1
670 -)))|(% colspan="2" %)(% colspan="1" %)
671 -(((
672 -<add_player_choice_*> **confidence** attribute removed
673 -)))
674 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
675 -(((
676 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
677 -)))
678 -|(% colspan="1" %)(% colspan="1" %)
679 -(((
680 -Scripts
681 -)))|(% colspan="1" %)(% colspan="1" %)
682 -(((
683 -3.0 Beta 1
684 -)))|(% colspan="2" %)(% colspan="1" %)
685 -(((
686 -**<hack_via_control_panel/>** script action removed
687 -)))
688 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
689 -(((
690 -//Unused script action <hack_via_control_panel/> was removed.//
691 -)))
692 -|(% colspan="1" %)(% colspan="1" %)
693 -(((
694 -UI core
695 -)))|(% colspan="1" %)(% colspan="1" %)
696 -(((
697 -3.0 Beta 1
698 -)))|(% colspan="2" %)(% colspan="1" %)
699 -(((
700 -**Lua: **GetMiniGameCursorPosition() removed
701 -)))
702 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
703 -(((
704 -//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.//
705 -)))
706 -|(((
707 -UI core
708 -)))|(((
709 -3.0 Beta 1
710 -)))|(% colspan="2" %)(((
711 -**FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
712 -)))
713 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
714 -(((
715 -//In 3.0 Beta 1 we added support to display icons for keyboard bindings, if an icon is available for the specified keys. This results in GetLocalizedInteractiveNotificationKey() potentially returning a different text now if such an icon is assigned to the mapped key/button.//
716 -)))
717 -|(% colspan="1" %)(% colspan="1" %)
718 -(((
719 -UI extensions
720 -)))|(% colspan="1" %)(% colspan="1" %)
721 -(((
722 -3.0 Beta 1
723 -)))|(% colspan="2" %)(% colspan="1" %)
724 -(((
725 -**FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
726 -)))
727 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
728 -(((
729 -//In 3.0 Beta 1 we added support for a new weapon mod property "SurfaceElementFactor" to allow weapons to deal increased damage to surface elements such as Shield Generators, Turrets or Engines.//
730 -)))
731 -|(% colspan="1" %)(% colspan="1" %)
732 -(((
733 -Scripts
734 -)))|(% colspan="1" %)(% colspan="1" %)
735 -(((
736 -3.0 Beta 1
737 -)))|(% colspan="2" %)(% colspan="1" %)
738 -(((
739 -**$ware.illegal** updated
740 -)))
741 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
742 -(((
743 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
744 -//It now returns true if $ware is illegal to any faction in the game.//
745 -)))
746 -|(% colspan="1" %)(% colspan="1" %)
747 -(((
748 -Scripts
749 -)))|(% colspan="1" %)(% colspan="1" %)
750 -(((
751 -3.0 Beta 1
752 -)))|(% colspan="2" %)(% colspan="1" %)
753 -(((
754 -MD script **RML_Flight_Along_Path** removed
755 -)))
756 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
757 -(((
758 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
759 -)))
760 -|(% colspan="1" %)(% colspan="1" %)
761 -(((
762 -Scripts
763 -)))|(% colspan="1" %)(% colspan="1" %)
764 -(((
765 -3.0 Beta 1
766 -)))|(% colspan="2" %)(% colspan="1" %)
767 -(((
768 -parameters of **<event_venture_mission_completed/>** changed
769 -)))
770 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
771 -(((
772 -//old params: param = venture details, param2 = ships involved, param3 = duration//
773 -//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
774 -)))
775 -|(((
776 -Scripts
777 -)))|(((
778 -3.0 Beta 1
779 -)))|(% colspan="2" %)(((
780 -**<set_object_wing_name/>** removed,
781 -**<set_object_fleet_name/>** added
782 -)))
783 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
784 -(((
785 -//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
786 -)))
787 -|(((
788 -Scripts
789 -)))|(((
790 -3.0 Beta 1
791 -)))|(% colspan="2" %)(((
792 -**$controllable.wing.*** removed,
793 -**$controllable.fleet.*** added
794 -)))
795 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
796 -(((
797 -$controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
798 -)))
799 -
800 -----
801 -
802 -=== 2.60 ===
803 -
804 -(% class="wrapped" %)
805 -|(((
806 -Scripts
807 -)))|(((
808 -2.60 Beta 1
809 -)))|(% colspan="2" %)(((
810 -'**checkoperational**' filter behaviour changed
811 -)))
812 -|(% class="highlight-grey" colspan="10" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
813 -(((
814 -//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.//
815 -
816 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
817 -)))
818 -|(((
819 -Scripts
820 -)))|(((
821 -2.60 Beta 1
822 -)))|(% colspan="2" %)(((
823 -$container.**supplyresources** behavior changed
824 -)))| | |
825 -|(% class="highlight-grey" colspan="10" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
826 -(((
827 -//The script keyword $container.supplyresources now includes reserved wares.//
828 -)))
829 -
830 -----
831 -
832 -=== 2.20 ===
833 -
834 -(% class="wrapped" %)
835 -|(% colspan="4" %)(% colspan="3" %)
836 -(((
837 -== 2.20 ==
838 -)))
839 -|(% colspan="1" %)(% colspan="1" %)
840 -(((
841 -UI core
842 -)))|(% colspan="1" %)(% colspan="1" %)
843 -(((
844 -2.20 Beta 3/4
845 -)))|(% colspan="2" %)(% colspan="1" %)
846 -(((
847 -**Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
848 -)))
849 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
850 -(((
851 -//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.
852 -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.//
853 -
854 -//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.//
855 -)))
856 -|(% colspan="1" %)(% colspan="1" %)
857 -(((
858 -Scripts
859 -)))|(% colspan="1" %)(% colspan="1" %)
860 -(((
861 -2.20 Beta 3
862 -)))|(% colspan="2" %)(% colspan="1" %)
863 -(((
864 -Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
865 -)))
866 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
867 -(((
868 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
869 -)))
870 -
871 -----
872 -
873 -=== 2.00 ===
874 -
875 -(% class="wrapped" %)
876 -|(% colspan="1" %)(% colspan="1" %)
877 -(((
878 -Scripts
879 -)))|(% colspan="1" %)(% colspan="1" %)
880 -(((
881 881  2.00 Beta 1
882 -)))|(% colspan="2" %)(% colspan="1" %)
883 -(((
884 -**<event_build_finished/> **param2 now returns null instead of a construction sequence
885 -)))
886 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
887 -(((
888 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
889 -)))
890 -|(% colspan="1" %)(% colspan="1" %)
891 -(((
892 -Scripts
893 -)))|(% colspan="1" %)(% colspan="1" %)
894 -(((
895 -2.00 Beta 1
896 -)))|(% colspan="2" %)(% colspan="1" %)
897 -(((
898 -**param.boarding.{...}** strength parameters removed
899 -)))
900 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
901 -(((
902 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
903 -)))
904 -|(% colspan="1" %)(% colspan="1" %)
905 -(((
906 -Scripts
907 -)))|(% colspan="1" %)(% colspan="1" %)
908 -(((
909 -2.00 Beta 1
910 -)))|(% colspan="2" %)(% colspan="1" %)
911 -(((
912 -**$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
913 -)))
914 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
915 -(((
916 -//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.//
917 -)))
918 -|(((
919 -UI extensions
920 920  )))|(((
921 -2.00 Beta 1
922 -)))|(% colspan="2" %)(((
923 923  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
924 924  )))
925 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
35 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
926 926  (((
927 927  //Before 2.0 Beta 1 using GetUpgradeSlotCurrentComponent() or GetUpgradeSlotGroup() only performed on operational objects (i.e. not wrecked objects or objects under construction). Since this is inconsistent with the rest of the UI functions, this was considered a bug and fixed in 2.0 Beta 1. If you require the old behavior, use the FFI function: IsComponentOperational() to check the passed object's state before making the call.//
928 928  )))
... ... @@ -930,10 +930,10 @@
930 930  UI extensions
931 931  )))|(((
932 932  2.00 Beta 1
933 -)))|(% colspan="2" %)(((
43 +)))|(((
934 934  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
935 935  )))
936 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
46 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
937 937  (((
938 938  //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.//
939 939  //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.//
... ... @@ -942,10 +942,10 @@
942 942  Scripts
943 943  )))|(((
944 944  2.00 Beta 1
945 -)))|(% colspan="2" %)(((
55 +)))|(((
946 946  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
947 947  )))
948 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
58 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
949 949  (((
950 950  //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.//
951 951  )))
... ... @@ -953,10 +953,10 @@
953 953  Scripts
954 954  )))|(((
955 955  2.00 Beta 1
956 -)))|(% colspan="2" %)(((
66 +)))|(((
957 957  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
958 958  )))
959 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
69 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
960 960  (((
961 961  //For prior behavior, check for event.param being non-null.//
962 962  )))
... ... @@ -964,10 +964,10 @@
964 964  AI Scripts
965 965  )))|(((
966 966  2.00 Beta 1
967 -)))|(% colspan="2" %)(((
77 +)))|(((
968 968  **<shoot/>/<shoot_at/>** attribute changes.
969 969  )))
970 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
80 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
971 971  (((
972 972  //Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
973 973  //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.//
... ... @@ -979,10 +979,10 @@
979 979  UI extensions
980 980  )))|(((
981 981  2.00 Beta 1
982 -)))|(% colspan="2" %)(((
983 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.
92 +)))|(((
93 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
984 984  )))
985 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
95 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
986 986  (((
987 987  //Added possibility to query build tasks of a certain buildmodule.//
988 988  )))
... ... @@ -990,10 +990,10 @@
990 990  UI extensions
991 991  )))|(((
992 992  2.00 Beta 1
993 -)))|(% colspan="2" %)(((
103 +)))|(((
994 994  **Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
995 995  )))
996 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
106 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
997 997  (((
998 998  //Added list of resources a buildmodule needs to build.//
999 999  )))
... ... @@ -1001,10 +1001,10 @@
1001 1001  UI extensions
1002 1002  )))|(((
1003 1003  2.00 Beta 1
1004 -)))|(% colspan="2" %)(((
1005 -**Lua: CalculateTotalHullFraction() **was removed.
114 +)))|(((
115 +(% 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);" %)
1006 1006  )))
1007 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
117 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1008 1008  (((
1009 1009  //Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
1010 1010  )))
... ... @@ -1012,27 +1012,21 @@
1012 1012  UI extensions
1013 1013  )))|(((
1014 1014  2.00 Beta 1
1015 -)))|(% colspan="2" %)(((
1016 -**FFI: RequestDockAtReason()/UndockPlayerShip() **changed their return values.
125 +)))|(((
126 +**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" %)
1017 1017  )))
1018 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
128 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1019 1019  (((
1020 1020  //Changed return value type to const char* to better identify failure reasons in Lua script.//
1021 1021  )))
1022 -
1023 -----
1024 -
1025 -=== 1.50 ===
1026 -
1027 -(% class="wrapped" %)
1028 1028  |(((
1029 1029  UI extensions
1030 1030  )))|(((
1031 1031  1.50 Beta 3
1032 -)))|(% colspan="2" %)(((
1033 -**Lua: GetComponentData() **changed behavior of "docksizes" property.
136 +)))|(((
137 +**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
1034 1034  )))
1035 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
139 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1036 1036  (((
1037 1037  //The "docksizes" property no longer includes internal ship storage docks.//
1038 1038  )))
... ... @@ -1040,10 +1040,10 @@
1040 1040  All
1041 1041  )))|(((
1042 1042  1.50 Beta 2
1043 -)))|(% colspan="2" %)(((
147 +)))|(((
1044 1044  **Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
1045 1045  )))
1046 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
150 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1047 1047  (((
1048 1048  //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".//
1049 1049  
... ... @@ -1055,10 +1055,10 @@
1055 1055  UI extensions
1056 1056  )))|(((
1057 1057  1.50 Beta 2
1058 -)))|(% colspan="2" %)(((
1059 -**FFI: UpgradeGroupInfo **datatype was changed.
162 +)))|(((
163 +**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
1060 1060  )))
1061 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
165 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1062 1062  (((
1063 1063  //Added new "operational" field to retrieve information about number of operational upgrades in a group.//
1064 1064  )))
... ... @@ -1068,13 +1068,14 @@
1068 1068  )))|(% colspan="1" %)(% colspan="1" %)
1069 1069  (((
1070 1070  1.50 Beta 1
1071 -)))|(% colspan="2" %)(% colspan="1" %)
175 +)))|(% colspan="1" %)(% colspan="1" %)
1072 1072  (((
1073 1073  **FFI: SetGuidance()** removed useinfopoint argument.
1074 1074  )))
1075 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
179 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1076 1076  (((
1077 -//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.//
181 +//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.
182 +//
1078 1078  
1079 1079  //The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1080 1080  )))
... ... @@ -1082,46 +1082,32 @@
1082 1082  UI extensions
1083 1083  )))|(((
1084 1084  1.50 Beta 1
1085 -)))|(% colspan="2" %)(((
1086 -**FFI: CancelConstruction() **changed its return value.
190 +)))|(((
191 +**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
1087 1087  )))
1088 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
193 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1089 1089  (((
1090 -//CancelConstruction() now returns if the cancellation was successful. //
195 +(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
1091 1091  )))
1092 -
1093 -----
1094 -
1095 -=== 1.32 ===
1096 -
1097 -(% class="wrapped" %)
1098 1098  |(((
1099 1099  UI extensions
1100 1100  )))|(((
1101 1101  1.32
1102 -)))|(% colspan="2" %)(((
201 +)))|(((
1103 1103  **Lua: GetComponentData() **removed the "nextdestname" property.
1104 1104  )))
1105 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
204 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1106 1106  (((
1107 1107  //Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
1108 1108  )))
1109 -
1110 -----
1111 -
1112 -=== 1.20 ===
1113 -
1114 -(% class="wrapped" %)
1115 1115  |(((
1116 1116  UI extensions
1117 1117  )))|(((
1118 1118  1.20
1119 -)))|(% colspan="2" %)(((
1120 -**FFI: GetAAOption()** got a new "useconfig" parameter.
212 +)))|(((
213 +**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
1121 1121  )))
1122 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
215 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1123 1123  (((
1124 -//The AA setting was changed to check the new setting with the user. In order to restore the old setting GetAAOption() gets the option to retrieve the config settings.//
217 +//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.//
1125 1125  )))
1126 -
1127 -
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -78577854
1 +79265840
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/78577854/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/79265840/Breaking Changes