Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 31.1
edited by stefan
on 2019/06/25 13:43
Change comment: added breaking change for GetMiniGameCursorPosition()
To version 97.1
edited by klaus
on 2023/01/04 13:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.stefan
1 +xwiki:XWiki.klaus
Content
... ... @@ -18,6 +18,7 @@
18 18  
19 19  = Breaking Changes =
20 20  
21 +(% class="wrapped" %)
21 21  |=(((
22 22  Type
23 23  )))|=(((
... ... @@ -25,20 +25,463 @@
25 25  )))|=(((
26 26  Summary
27 27  )))
29 +|(% colspan="3" %)(% colspan="3" %)
30 +(((
31 +== 6.00 ==
32 +)))
33 +|(((
34 +Assets
35 +)))|(((
36 +6.00 Beta 1
37 +)))|(((
38 +Surface element **connections** are incompatible by default unless tagged as "**standard**", and also "**combat**" for non-missile, non-mining weapons
39 +)))
40 +|(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)
41 +(((
42 +//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.
43 +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.//
44 +)))
28 28  |(% colspan="1" %)(% colspan="1" %)
29 29  (((
47 +Scripts
48 +)))|(% colspan="1" %)(% colspan="1" %)
49 +(((
50 +6.00 Beta 1
51 +)))|(% colspan="1" %)(% colspan="1" %)
52 +(((
53 +Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
54 +)))
55 +|(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)
56 +(((
57 +//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.//
58 +)))
59 +|(((
60 +Scripts
61 +)))|(((
62 +6.00 Beta 1
63 +)))|(((
64 +**<event_player_owned_killed_object>** and **<event_player_owned_destroyed>** are now triggered before the corresponding **<event_object_destroyed>**, instead of afterwards.
65 +)))
66 +|(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)(% class="highlight-#f4f5f7" title="Background color : Light grey 100%" colspan="3" data-highlight-colour="#f4f5f7" %)
67 +(((
68 +//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.//
69 +)))
70 +|(% colspan="3" %)(% colspan="3" %)
71 +(((
72 +== 5.00 ==
73 +)))
74 +|(((
75 +Parameters
76 +)))|(((
77 +5.00 Beta 1
78 +)))|(((
79 +**<controlpanel><entry>: minduration** removed, **maxduration** renamed to duration
80 +)))
81 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
82 +(((
83 +//'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.//
84 +)))
85 +|(% colspan="3" %)(% colspan="3" %)
86 +(((
87 +== 4.10 ==
88 +)))
89 +|(% colspan="1" %)(% colspan="1" %)
90 +(((
91 +UI extensions
92 +)))|(% colspan="1" %)(% colspan="1" %)
93 +(((
94 +4.10 Beta 7
95 +)))|(% colspan="1" %)(% colspan="1" %)
96 +(((
97 +**FFI**: (% style="color: rgb(0,0,0);" %)SetMapRenderCargoContents(%%)(), (% style="color: rgb(0,0,0);" %)SetMapRenderWorkForceInfo(), (% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)SetMapRenderCrewInfo() and (% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)SetMapRenderDockedShipInfos()(%%) deprecated
98 +)))
99 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
100 +(((
101 +//The functionality represented by (% style="color: rgb(0,0,0);" %)SetMapRenderCargoContents(%%)(), (% style="color: rgb(0,0,0);" %)SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos()(%%) has been removed and the function was therefore stubbed.//
102 +)))
103 +|(% colspan="1" %)(% colspan="1" %)
104 +(((
105 +UI extensions
106 +)))|(% colspan="1" %)(% colspan="1" %)
107 +(((
108 +4.10 Beta 6
109 +)))|(% colspan="1" %)(% colspan="1" %)
110 +(((
111 +**FFI**: CustomGameStartPlayerProperty2 changed
112 +)))
113 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
114 +(((
115 +//This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.//
116 +)))
117 +|(% colspan="1" %)(% colspan="1" %)
118 +(((
119 +Parameters
120 +)))|(% colspan="1" %)(% colspan="1" %)
121 +(((
122 +4.10 Beta 3
123 +)))|(% colspan="1" %)(% colspan="1" %)
124 +(((
125 +Renamed **<stationinfobox>** to **<infobox>**
126 +)))
127 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
128 +(((
129 +//Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.//
130 +)))
131 +|(% colspan="1" %)(% colspan="1" %)
132 +(((
133 +UI extensions
134 +)))|(% colspan="1" %)(% colspan="1" %)
135 +(((
136 +4.10 Beta 2
137 +)))|(% colspan="1" %)(% colspan="1" %)
138 +(((
139 +**FFI**: SetMacroMapPlayerSectorOffset() deprecated
140 +)))
141 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
142 +(((
143 +//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.//
144 +)))
145 +|(((
146 +UI extensions
147 +)))|(((
148 +4.10 Beta 2
149 +)))|(((
150 +**FFI**: (% style="color: rgb(0,0,0);" %)FilterComponentForMapMode(%%)() and (% style="color: rgb(0,0,0);" %)SetMapObjectFilter() changed
151 +)))
152 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
153 +(((
154 +//These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.//
155 +)))
156 +|(((
157 +Scripts
158 +)))|(((
159 +4.10 Beta 1
160 +)))|(((
161 +People related attributes of mission** <delivery> **node moved
162 +)))
163 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
164 +(((
165 +//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.//
166 +)))
167 +|(% colspan="1" %)(% colspan="1" %)
168 +(((
169 +Scripts
170 +)))|(% colspan="1" %)(% colspan="1" %)
171 +(((
172 +4.10 Beta 1
173 +)))|(% colspan="1" %)(% colspan="1" %)
174 +(((
175 +**$destructible.productions** replaced with $defensible.productions
176 +)))
177 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
178 +(((
179 +//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.//
180 +)))
181 +|(((
182 +Scripts
183 +)))|(((
184 +4.10 Beta 1
185 +)))|(((
186 +Removed script property **$object.spawnsourceseed**
187 +)))
188 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
189 +(((
190 +//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.//
191 +)))
192 +|(% colspan="3" %)(% colspan="3" %)
193 +(((
194 +== 4.00 ==
195 +)))
196 +|(% colspan="1" %)(% colspan="1" %)
197 +(((
30 30  UI core
31 31  )))|(% colspan="1" %)(% colspan="1" %)
32 32  (((
201 +4.00 Beta 10
202 +)))|(% colspan="1" %)(% colspan="1" %)
203 +(((
204 +Controlled ship can change without a **gameplanchange-event** occurring.
205 +)))
206 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
207 +(((
208 +//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).
209 +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.
210 +//
211 +)))
212 +|(((
213 +Scripts
214 +)))|(((
215 +4.00 Beta 7
216 +)))|(((
217 +Parameters of **<event_terraforming_project_succeeded>** and **<event_terraforming_project_failed>** changed
218 +)))
219 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
220 +(((
221 +//Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
222 +New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
223 +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//
224 +)))
225 +|(% colspan="1" %)(% colspan="1" %)
226 +(((
227 +UI core
228 +)))|(% colspan="1" %)(% colspan="1" %)
229 +(((
230 +4.00 Beta 6
231 +)))|(% colspan="1" %)(% colspan="1" %)
232 +(((
233 +**FFI:** GetFactionRelationStatus() handling for faction relation range [-20,-10] changed
234 +)))
235 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
236 +(((
237 +//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.
238 +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).//
239 +
240 +//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
241 +//
242 +)))
243 +|(% colspan="1" %)(% colspan="1" %)
244 +(((
245 +UI core
246 +)))|(% colspan="1" %)(% colspan="1" %)
247 +(((
248 +4.00 Beta 5
249 +)))|(% colspan="1" %)(% colspan="1" %)
250 +(((
251 +**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed
252 +)))
253 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
254 +(((
255 +//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.//
256 +
257 +//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).
258 +)))
259 +|(((
260 +Parameters
261 +)))|(((
262 +4.00 Beta 1
263 +)))|(((
264 +**requiresconstructionvessel** parameter moved
265 +)))
266 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
267 +(((
268 +//The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.//
269 +)))
270 +|(((
271 +Scripts
272 +)))|(((
273 +4.00 Beta 1
274 +)))|(((
275 +Changed behaviour of **gatedistance** script property
276 +)))
277 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
278 +(((
279 +//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.//
280 +)))
281 +|(% colspan="3" %)(% colspan="3" %)
282 +(((
283 +== 3.30 ==
284 +)))
285 +|(((
286 +UI extensions
287 +)))|(((
288 +3.30 Beta 3
289 +)))|(((
290 +**FFI: **Removed** (% style="color: rgb(0,0,0);" %)GetMissionLimit() (%%)**(% style="color: rgb(0,0,0);" %)and** **(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)**IsMissionLimit**(%%)**Enabled()**
291 +)))
292 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
293 +(((
294 +//These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI (% style="color: rgb(0,0,0);" %)IsMissionLimit(%%)Reach(% style="color: rgb(0,0,0);" %)ed()//
295 +)))
296 +|(% colspan="3" %)(% colspan="3" %)
297 +(((
298 +== 3.20 ==
299 +)))
300 +|(((
301 +Scripts
302 +)))|(((
303 +3.20 Beta 1
304 +)))|(((
305 +Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
306 +)))
307 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
308 +(((
309 +//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
310 +//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
311 +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//
312 +)))
313 +|(% colspan="1" %)(% colspan="1" %)
314 +(((
315 +Scripts
316 +)))|(% colspan="1" %)(% colspan="1" %)
317 +(((
318 +3.20 Beta 1
319 +)))|(% colspan="1" %)(% colspan="1" %)
320 +(((
321 +Removed script property $trade.**restriction.faction**
322 +)))
323 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
324 +(((
325 +//$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.//
326 +)))
327 +|(((
328 +UI extensions
329 +)))|(((
330 +3.20 Beta 1
331 +)))|(((
332 +**Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
333 +)))
334 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
335 +(((
336 +//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.//
337 +)))
338 +|(% colspan="3" %)(% colspan="3" %)
339 +(((
340 +== 3.10 ==
341 +)))
342 +|(% colspan="1" %)(% colspan="1" %)
343 +(((
344 +Scripts
345 +)))|(% colspan="1" %)(% colspan="1" %)
346 +(((
347 +3.10 Beta 1
348 +)))|(% colspan="1" %)(% colspan="1" %)
349 +(((
350 +Removed script action **<add_build/>**
351 +)))
352 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
353 +(((
354 +//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.//
355 +)))
356 +|(% colspan="3" %)(% colspan="3" %)
357 +(((
358 +== 3.00 ==
359 +)))
360 +|(% colspan="1" %)(% colspan="1" %)
361 +(((
362 +Scripts
363 +)))|(% colspan="1" %)(% colspan="1" %)
364 +(((
365 +3.0 Beta 6
366 +)))|(% colspan="1" %)(% colspan="1" %)
367 +(((
368 +Changed behaviour of script action **<get_suitable_job/>**
369 +)))
370 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
371 +(((
372 +//<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.//
373 +)))
374 +|(% colspan="1" %)(% colspan="1" %)
375 +(((
376 +Scripts
377 +)))|(% colspan="1" %)(% colspan="1" %)
378 +(((
379 +3.0 Beta 6
380 +)))|(% colspan="1" %)(% colspan="1" %)
381 +(((
382 +Changed behaviour of script action **<get_ware_definition/>**
383 +)))
384 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
385 +(((
386 +//<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.//
387 +)))
388 +|(% colspan="1" %)(% colspan="1" %)
389 +(((
390 +Global
391 +)))|(% colspan="1" %)(% colspan="1" %)
392 +(((
393 +3.0 Beta 5
394 +)))|(% colspan="1" %)(% colspan="1" %)
395 +(((
396 +Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
397 +)))
398 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
399 +(((
400 +//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.)\\
401 +
402 +//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).//
403 +)))
404 +|(% colspan="1" %)(% colspan="1" %)
405 +(((
406 +Scripts
407 +)))|(% colspan="1" %)(% colspan="1" %)
408 +(((
409 +3.0 Beta 5
410 +)))|(% colspan="1" %)(% colspan="1" %)
411 +(((
412 +Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
413 +)))
414 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
415 +(((
416 +//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.//
417 +)))
418 +|(% colspan="1" %)(% colspan="1" %)
419 +(((
420 +Scripts
421 +)))|(% colspan="1" %)(% colspan="1" %)
422 +(((
423 +3.0 Beta 5
424 +)))|(% colspan="1" %)(% colspan="1" %)
425 +(((
426 +Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
427 +)))
428 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
429 +(((
430 +//Before the change, positions are relative to $dockingbay.parent.
431 +After the change, positions are relative to $dockingbay as specified in the documentation.//
432 +)))
433 +|(% colspan="1" %)(% colspan="1" %)
434 +(((
435 +Global
436 +)))|(% colspan="1" %)(% colspan="1" %)
437 +(((
438 +3.0 Beta 2
439 +)))|(% colspan="1" %)(% colspan="1" %)
440 +(((
441 +Support for entity flag "**skillsvisible**" dropped
442 +)))
443 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
444 +(((
445 +//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().//
446 +)))
447 +|(((
448 +Scripts
449 +)))|(((
450 +3.0 Beta 2
451 +)))|(((
452 +Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
453 +)))
454 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
455 +(((
456 +//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.
457 +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.
458 +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.
459 +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).
460 +)))
461 +|(% colspan="1" %)(% colspan="1" %)
462 +(((
463 +Global
464 +)))|(% colspan="1" %)(% colspan="1" %)
465 +(((
33 33  3.0 Beta 1
34 34  )))|(% colspan="1" %)(% colspan="1" %)
35 35  (((
36 -**Lua: **GetMiniGameCursorPosition() removed
469 +**MissionBoard** support dropped
37 37  )))
38 38  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
39 39  (((
40 -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.
473 +//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.//
41 41  )))
475 +|(((
476 +Job/God
477 +)))|(((
478 +3.0 Beta 1
479 +)))|(((
480 +By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
481 +)))
482 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
483 +(((
484 +//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.//
485 +)))
42 42  |(% colspan="1" %)(% colspan="1" %)
43 43  (((
44 44  Scripts
... ... @@ -47,12 +47,11 @@
47 47  3.0 Beta 1
48 48  )))|(% colspan="1" %)(% colspan="1" %)
49 49  (((
50 -$ware.illegal updated
494 +Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
51 51  )))
52 52  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
53 53  (((
54 -$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
55 -\\It now returns true if $ware is illegal to any faction in the game.
498 +//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.//
56 56  )))
57 57  |(% colspan="1" %)(% colspan="1" %)
58 58  (((
... ... @@ -62,13 +62,11 @@
62 62  3.0 Beta 1
63 63  )))|(% colspan="1" %)(% colspan="1" %)
64 64  (((
65 -'checkoperational' filter behaviour changed
508 +Script action **<set_doors_locked/>** attribute **'group'** changed
66 66  )))
67 67  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
68 68  (((
69 -//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.//
70 -
71 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
512 +//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.//
72 72  )))
73 73  |(% colspan="1" %)(% colspan="1" %)
74 74  (((
... ... @@ -78,6 +78,130 @@
78 78  3.0 Beta 1
79 79  )))|(% colspan="1" %)(% colspan="1" %)
80 80  (((
522 +Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
523 +)))
524 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
525 +(((
526 +//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.//
527 +)))
528 +|(% colspan="1" %)(% colspan="1" %)
529 +(((
530 +Scripts
531 +)))|(% colspan="1" %)(% colspan="1" %)
532 +(((
533 +3.0 Beta 1
534 +)))|(% colspan="1" %)(% colspan="1" %)
535 +(((
536 +Script actions **<set_hack_target/>** and **<abort_hack/>** removed
537 +)))
538 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
539 +(((
540 +//These actions had no effect and were removed.//
541 +)))
542 +|(% colspan="1" %)(% colspan="1" %)
543 +(((
544 +Scripts
545 +)))|(% colspan="1" %)(% colspan="1" %)
546 +(((
547 +3.0 Beta 1
548 +)))|(% colspan="1" %)(% colspan="1" %)
549 +(((
550 +**<setup_conversation_minigame/>** script action removed
551 +)))
552 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
553 +(((
554 +//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.//
555 +)))
556 +|(% colspan="1" %)(% colspan="1" %)
557 +(((
558 +Scripts
559 +)))|(% colspan="1" %)(% colspan="1" %)
560 +(((
561 +3.0 Beta 1
562 +)))|(% colspan="1" %)(% colspan="1" %)
563 +(((
564 +<add_player_choice_*> **confidence** attribute removed
565 +)))
566 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
567 +(((
568 +//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
569 +)))
570 +|(% colspan="1" %)(% colspan="1" %)
571 +(((
572 +Scripts
573 +)))|(% colspan="1" %)(% colspan="1" %)
574 +(((
575 +3.0 Beta 1
576 +)))|(% colspan="1" %)(% colspan="1" %)
577 +(((
578 +**<hack_via_control_panel/>** script action removed
579 +)))
580 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
581 +(((
582 +//Unused script action <hack_via_control_panel/> was removed.//
583 +)))
584 +|(% colspan="1" %)(% colspan="1" %)
585 +(((
586 +UI core
587 +)))|(% colspan="1" %)(% colspan="1" %)
588 +(((
589 +3.0 Beta 1
590 +)))|(% colspan="1" %)(% colspan="1" %)
591 +(((
592 +**Lua: **GetMiniGameCursorPosition() removed
593 +)))
594 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
595 +(((
596 +//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.//
597 +)))
598 +|(((
599 +UI core
600 +)))|(((
601 +3.0 Beta 1
602 +)))|(((
603 +**FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
604 +)))
605 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
606 +(((
607 +//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.//
608 +)))
609 +|(% colspan="1" %)(% colspan="1" %)
610 +(((
611 +UI extensions
612 +)))|(% colspan="1" %)(% colspan="1" %)
613 +(((
614 +3.0 Beta 1
615 +)))|(% colspan="1" %)(% colspan="1" %)
616 +(((
617 +**FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
618 +)))
619 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
620 +(((
621 +//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.//
622 +)))
623 +|(% colspan="1" %)(% colspan="1" %)
624 +(((
625 +Scripts
626 +)))|(% colspan="1" %)(% colspan="1" %)
627 +(((
628 +3.0 Beta 1
629 +)))|(% colspan="1" %)(% colspan="1" %)
630 +(((
631 +**$ware.illegal** updated
632 +)))
633 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
634 +(((
635 +//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
636 +//It now returns true if $ware is illegal to any faction in the game.//
637 +)))
638 +|(% colspan="1" %)(% colspan="1" %)
639 +(((
640 +Scripts
641 +)))|(% colspan="1" %)(% colspan="1" %)
642 +(((
643 +3.0 Beta 1
644 +)))|(% colspan="1" %)(% colspan="1" %)
645 +(((
81 81  MD script **RML_Flight_Along_Path** removed
82 82  )))
83 83  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
... ... @@ -86,6 +86,77 @@
86 86  )))
87 87  |(% colspan="1" %)(% colspan="1" %)
88 88  (((
654 +Scripts
655 +)))|(% colspan="1" %)(% colspan="1" %)
656 +(((
657 +3.0 Beta 1
658 +)))|(% colspan="1" %)(% colspan="1" %)
659 +(((
660 +parameters of **<event_venture_mission_completed/>** changed
661 +)))
662 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
663 +(((
664 +//old params: param = venture details, param2 = ships involved, param3 = duration//
665 +//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
666 +)))
667 +|(((
668 +Scripts
669 +)))|(((
670 +3.0 Beta 1
671 +)))|(((
672 +**<set_object_wing_name/>** removed,
673 +**<set_object_fleet_name/>** added
674 +)))
675 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
676 +(((
677 +//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
678 +)))
679 +|(((
680 +Scripts
681 +)))|(((
682 +3.0 Beta 1
683 +)))|(((
684 +**$controllable.wing.*** removed,
685 +**$controllable.fleet.*** added
686 +)))
687 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
688 +(((
689 +$controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
690 +)))
691 +|(% colspan="3" %)(% colspan="3" %)
692 +(((
693 +== 2.60 ==
694 +)))
695 +|(((
696 +Scripts
697 +)))|(((
698 +2.60 Beta 1
699 +)))|(((
700 +'**checkoperational**' filter behaviour changed
701 +)))
702 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
703 +(((
704 +//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.//
705 +
706 +//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
707 +)))
708 +|(((
709 +Scripts
710 +)))|(((
711 +2.60 Beta 1
712 +)))|(((
713 +$container.**supplyresources** behavior changed
714 +)))
715 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
716 +(((
717 +//The script keyword $container.supplyresources now includes reserved wares.//
718 +)))
719 +|(% colspan="3" %)(% colspan="3" %)
720 +(((
721 +== 2.20 ==
722 +)))
723 +|(% colspan="1" %)(% colspan="1" %)
724 +(((
89 89  UI core
90 90  )))|(% colspan="1" %)(% colspan="1" %)
91 91  (((
... ... @@ -116,6 +116,10 @@
116 116  (((
117 117  //The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
118 118  )))
755 +|(% colspan="3" %)(% colspan="3" %)
756 +(((
757 +== 2.00 ==
758 +)))
119 119  |(% colspan="1" %)(% colspan="1" %)
120 120  (((
121 121  Scripts
... ... @@ -223,7 +223,7 @@
223 223  )))|(((
224 224  2.00 Beta 1
225 225  )))|(((
226 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
866 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.
227 227  )))
228 228  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
229 229  (((
... ... @@ -256,18 +256,22 @@
256 256  )))|(((
257 257  2.00 Beta 1
258 258  )))|(((
259 -**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" %)
899 +**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.
260 260  )))
261 261  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
262 262  (((
263 263  //Changed return value type to const char* to better identify failure reasons in Lua script.//
264 264  )))
905 +|(% colspan="3" %)(% colspan="3" %)
906 +(((
907 +== 1.50 ==
908 +)))
265 265  |(((
266 266  UI extensions
267 267  )))|(((
268 268  1.50 Beta 3
269 269  )))|(((
270 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
914 +**Lua: GetComponentData() **changed behavior of "docksizes" property.
271 271  )))
272 272  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
273 273  (((
... ... @@ -293,7 +293,7 @@
293 293  )))|(((
294 294  1.50 Beta 2
295 295  )))|(((
296 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
940 +**FFI: UpgradeGroupInfo **datatype was changed.
297 297  )))
298 298  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
299 299  (((
... ... @@ -321,12 +321,16 @@
321 321  )))|(((
322 322  1.50 Beta 1
323 323  )))|(((
324 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
968 +**FFI: CancelConstruction() **changed its return value.
325 325  )))
326 326  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
327 327  (((
328 328  (% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
329 329  )))
974 +|(% colspan="3" %)(% colspan="3" %)
975 +(((
976 +== 1.32 ==
977 +)))
330 330  |(((
331 331  UI extensions
332 332  )))|(((
... ... @@ -338,12 +338,16 @@
338 338  (((
339 339  //Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
340 340  )))
989 +|(% colspan="3" %)(% colspan="3" %)
990 +(((
991 +== 1.20 ==
992 +)))
341 341  |(((
342 342  UI extensions
343 343  )))|(((
344 344  1.20
345 345  )))|(((
346 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
998 +**FFI: GetAAOption()** got a new "useconfig" parameter.
347 347  )))
348 348  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
349 349  (((
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -83460733
1 +135856732
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/83460733/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/135856732/Breaking Changes