Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 46.1
edited by michael
on 2019/11/20 10:21
Change comment: correct event and parameter names
To version 38.1
edited by nick
on 2019/09/09 13:13
Change comment: added parameters of event_venture_mission_completed changed

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.michael
1 +xwiki:XWiki.nick
Content
... ... @@ -25,65 +25,19 @@
25 25  )))|=(((
26 26  Summary
27 27  )))
28 -|(% colspan="3" %)(% colspan="3" %)
29 -(((
30 -== 3.00 ==
31 -)))
32 32  |(% colspan="1" %)(% colspan="1" %)
33 33  (((
34 -Global
35 -)))|(% colspan="1" %)(% colspan="1" %)
36 -(((
37 -3.0 Beta 2
38 -)))|(% colspan="1" %)(% colspan="1" %)
39 -(((
40 -Support for entity flag "**skillsvisible**" dropped
41 -)))
42 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
43 -(((
44 -//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().//
45 -)))
46 -|(((
47 47  Scripts
48 -)))|(((
49 -3.0 Beta 2
50 -)))|(((
51 -Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
52 -)))
53 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
54 -(((
55 -//Before 3.0 Beta 2 there was just a single event_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.
56 -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.
57 -If in your scripts you make use of the event_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.
58 -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).//
59 -)))
60 -|(% colspan="1" %)(% colspan="1" %)
61 -(((
62 -Global
63 63  )))|(% colspan="1" %)(% colspan="1" %)
64 64  (((
65 65  3.0 Beta 1
66 66  )))|(% colspan="1" %)(% colspan="1" %)
67 67  (((
68 -MissionBoard support dropped
69 -)))
70 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
71 -(((
72 -//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 behavior would occur. Therefore we cleaned things up in 3.0 Beta 1 including deprecating/removing any related UI/script function.//
73 -)))
74 -|(% colspan="1" %)(% colspan="1" %)
75 -(((
76 -Scripts
77 -)))|(% colspan="1" %)(% colspan="1" %)
78 -(((
79 -3.0 Beta 1
80 -)))|(% colspan="1" %)(% colspan="1" %)
81 -(((
82 82  Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
83 83  )))
84 84  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
85 85  (((
86 -//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.//
40 +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.
87 87  )))
88 88  |(% colspan="1" %)(% colspan="1" %)
89 89  (((
... ... @@ -183,30 +183,20 @@
183 183  (((
184 184  //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.//
185 185  )))
186 -|(((
187 -UI core
188 -)))|(((
189 -3.0 Beta 1
190 -)))|(((
191 -**FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
192 -)))
193 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
194 -(((
195 -//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.//
196 -)))
197 197  |(% colspan="1" %)(% colspan="1" %)
198 198  (((
199 -UI extensions
142 +Scripts
200 200  )))|(% colspan="1" %)(% colspan="1" %)
201 201  (((
202 202  3.0 Beta 1
203 203  )))|(% colspan="1" %)(% colspan="1" %)
204 204  (((
205 -**FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
148 +**$ware.illegal** updated
206 206  )))
207 207  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
208 208  (((
209 -//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.//
152 +//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
153 +\\//It now returns true if $ware is illegal to any faction in the game.//
210 210  )))
211 211  |(% colspan="1" %)(% colspan="1" %)
212 212  (((
... ... @@ -216,12 +216,13 @@
216 216  3.0 Beta 1
217 217  )))|(% colspan="1" %)(% colspan="1" %)
218 218  (((
219 -**$ware.illegal** updated
163 +'**checkoperational**' filter behaviour changed
220 220  )))
221 221  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
222 222  (((
223 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
224 -//It now returns true if $ware is illegal to any faction in the game.//
167 +//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.//
168 +
169 +//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
225 225  )))
226 226  |(% colspan="1" %)(% colspan="1" %)
227 227  (((
... ... @@ -245,69 +245,24 @@
245 245  3.0 Beta 1
246 246  )))|(% colspan="1" %)(% colspan="1" %)
247 247  (((
248 -parameters of **<event_venture_mission_completed/>** changed
193 +parameters of event_venture_mission_completed changed
249 249  )))
250 250  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
251 251  (((
252 -//old params: param = venture details, param2 = ships involved, param3 = duration//
253 -//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
197 +old params: param = venture details, param2 = ships involved, param3 = duration
198 +new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration
254 254  )))
255 255  |(((
256 256  Scripts
257 257  )))|(((
258 -3.0 Beta 1
259 -)))|(((
260 -**<set_object_wing_name/>** removed,
261 -**<set_object_fleet_name/>** added
262 -)))
263 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
264 -(((
265 -//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
266 -)))
267 -|(((
268 -Scripts
269 -)))|(((
270 -3.0 Beta 1
271 -)))|(((
272 -**$controllable.wing.*** removed,
273 -**$controllable.fleet.*** added
274 -)))
275 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
276 -(((
277 -$controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
278 -)))
279 -|(% colspan="3" %)(% colspan="3" %)
280 -(((
281 -== 2.60 ==
282 -)))
283 -|(((
284 -Scripts
285 -)))|(((
286 286  2.60 Beta 1
287 287  )))|(((
288 -'**checkoperational**' filter behaviour changed
205 +$container.supplyresources behavior changed
289 289  )))
290 290  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
291 291  (((
292 -//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.//
293 -
294 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
295 -)))
296 -|(((
297 -Scripts
298 -)))|(((
299 -2.60 Beta 1
300 -)))|(((
301 -$container.**supplyresources** behavior changed
302 -)))
303 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
304 -(((
305 305  //The script keyword $container.supplyresources now includes reserved wares.//
306 306  )))
307 -|(% colspan="3" %)(% colspan="3" %)
308 -(((
309 -== 2.20 ==
310 -)))
311 311  |(% colspan="1" %)(% colspan="1" %)
312 312  (((
313 313  UI core
... ... @@ -340,10 +340,6 @@
340 340  (((
341 341  //The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
342 342  )))
343 -|(% colspan="3" %)(% colspan="3" %)
344 -(((
345 -== 2.00 ==
346 -)))
347 347  |(% colspan="1" %)(% colspan="1" %)
348 348  (((
349 349  Scripts
... ... @@ -490,10 +490,6 @@
490 490  (((
491 491  //Changed return value type to const char* to better identify failure reasons in Lua script.//
492 492  )))
493 -|(% colspan="3" %)(% colspan="3" %)
494 -(((
495 -== 1.50 ==
496 -)))
497 497  |(((
498 498  UI extensions
499 499  )))|(((
... ... @@ -559,10 +559,6 @@
559 559  (((
560 560  (% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
561 561  )))
562 -|(% colspan="3" %)(% colspan="3" %)
563 -(((
564 -== 1.32 ==
565 -)))
566 566  |(((
567 567  UI extensions
568 568  )))|(((
... ... @@ -574,10 +574,6 @@
574 574  (((
575 575  //Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
576 576  )))
577 -|(% colspan="3" %)(% colspan="3" %)
578 -(((
579 -== 1.20 ==
580 -)))
581 581  |(((
582 582  UI extensions
583 583  )))|(((
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -88346135
1 +85622793
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/88346135/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/85622793/Breaking Changes