Changes for page Breaking Changes

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

From version 33.1
edited by stefan
on 2019/06/26 12:02
Change comment: added setup_conversation_minigame note
To version 46.1
edited by michael
on 2019/11/20 10:21
Change comment: correct event and parameter names

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.stefan
1 +xwiki:XWiki.michael
Content
... ... @@ -25,19 +25,51 @@
25 25  )))|=(((
26 26  Summary
27 27  )))
28 +|(% colspan="3" %)(% colspan="3" %)
29 +(((
30 +== 3.00 ==
31 +)))
28 28  |(% colspan="1" %)(% colspan="1" %)
29 29  (((
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 +|(((
30 30  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
31 31  )))|(% colspan="1" %)(% colspan="1" %)
32 32  (((
33 33  3.0 Beta 1
34 34  )))|(% colspan="1" %)(% colspan="1" %)
35 35  (((
36 -<setup_conversation_minigame/> script action removed
68 +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 -//The script action was a left over 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.//
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.//
41 41  )))
42 42  |(% colspan="1" %)(% colspan="1" %)
43 43  (((
... ... @@ -47,10 +47,94 @@
47 47  3.0 Beta 1
48 48  )))|(% colspan="1" %)(% colspan="1" %)
49 49  (((
50 -<hack_via_control_panel/> script action removed
82 +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  (((
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.//
87 +)))
88 +|(% colspan="1" %)(% colspan="1" %)
89 +(((
90 +Scripts
91 +)))|(% colspan="1" %)(% colspan="1" %)
92 +(((
93 +3.0 Beta 1
94 +)))|(% colspan="1" %)(% colspan="1" %)
95 +(((
96 +Script action **<set_doors_locked/>** attribute **'group'** changed
97 +)))
98 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
99 +(((
100 +//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.//
101 +)))
102 +|(% colspan="1" %)(% colspan="1" %)
103 +(((
104 +Scripts
105 +)))|(% colspan="1" %)(% colspan="1" %)
106 +(((
107 +3.0 Beta 1
108 +)))|(% colspan="1" %)(% colspan="1" %)
109 +(((
110 +Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
111 +)))
112 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
113 +(((
114 +//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.//
115 +)))
116 +|(% colspan="1" %)(% colspan="1" %)
117 +(((
118 +Scripts
119 +)))|(% colspan="1" %)(% colspan="1" %)
120 +(((
121 +3.0 Beta 1
122 +)))|(% colspan="1" %)(% colspan="1" %)
123 +(((
124 +Script actions **<set_hack_target/>** and **<abort_hack/>** removed
125 +)))
126 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
127 +(((
128 +//These actions had no effect and were removed.//
129 +)))
130 +|(% colspan="1" %)(% colspan="1" %)
131 +(((
132 +Scripts
133 +)))|(% colspan="1" %)(% colspan="1" %)
134 +(((
135 +3.0 Beta 1
136 +)))|(% colspan="1" %)(% colspan="1" %)
137 +(((
138 +**<setup_conversation_minigame/>** script action removed
139 +)))
140 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
141 +(((
142 +//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.//
143 +)))
144 +|(% colspan="1" %)(% colspan="1" %)
145 +(((
146 +Scripts
147 +)))|(% colspan="1" %)(% colspan="1" %)
148 +(((
149 +3.0 Beta 1
150 +)))|(% colspan="1" %)(% colspan="1" %)
151 +(((
152 +<add_player_choice_*> **confidence** attribute removed
153 +)))
154 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
155 +(((
156 +//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
157 +)))
158 +|(% colspan="1" %)(% colspan="1" %)
159 +(((
160 +Scripts
161 +)))|(% colspan="1" %)(% colspan="1" %)
162 +(((
163 +3.0 Beta 1
164 +)))|(% colspan="1" %)(% colspan="1" %)
165 +(((
166 +**<hack_via_control_panel/>** script action removed
167 +)))
168 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
169 +(((
54 54  //Unused script action <hack_via_control_panel/> was removed.//
55 55  )))
56 56  |(% colspan="1" %)(% colspan="1" %)
... ... @@ -67,20 +67,30 @@
67 67  (((
68 68  //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.//
69 69  )))
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 +)))
70 70  |(% colspan="1" %)(% colspan="1" %)
71 71  (((
72 -Scripts
199 +UI extensions
73 73  )))|(% colspan="1" %)(% colspan="1" %)
74 74  (((
75 75  3.0 Beta 1
76 76  )))|(% colspan="1" %)(% colspan="1" %)
77 77  (((
78 -$ware.illegal updated
205 +**FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
79 79  )))
80 80  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
81 81  (((
82 -$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
83 -\\It now returns true if $ware is illegal to any faction in the game.
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.//
84 84  )))
85 85  |(% colspan="1" %)(% colspan="1" %)
86 86  (((
... ... @@ -90,13 +90,12 @@
90 90  3.0 Beta 1
91 91  )))|(% colspan="1" %)(% colspan="1" %)
92 92  (((
93 -'checkoperational' filter behaviour changed
219 +**$ware.illegal** updated
94 94  )))
95 95  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
96 96  (((
97 -//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.//
98 -
99 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
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.//
100 100  )))
101 101  |(% colspan="1" %)(% colspan="1" %)
102 102  (((
... ... @@ -114,6 +114,77 @@
114 114  )))
115 115  |(% colspan="1" %)(% colspan="1" %)
116 116  (((
242 +Scripts
243 +)))|(% colspan="1" %)(% colspan="1" %)
244 +(((
245 +3.0 Beta 1
246 +)))|(% colspan="1" %)(% colspan="1" %)
247 +(((
248 +parameters of **<event_venture_mission_completed/>** changed
249 +)))
250 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
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//
254 +)))
255 +|(((
256 +Scripts
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 +2.60 Beta 1
287 +)))|(((
288 +'**checkoperational**' filter behaviour changed
289 +)))
290 +|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
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 +//The script keyword $container.supplyresources now includes reserved wares.//
306 +)))
307 +|(% colspan="3" %)(% colspan="3" %)
308 +(((
309 +== 2.20 ==
310 +)))
311 +|(% colspan="1" %)(% colspan="1" %)
312 +(((
117 117  UI core
118 118  )))|(% colspan="1" %)(% colspan="1" %)
119 119  (((
... ... @@ -144,6 +144,10 @@
144 144  (((
145 145  //The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
146 146  )))
343 +|(% colspan="3" %)(% colspan="3" %)
344 +(((
345 +== 2.00 ==
346 +)))
147 147  |(% colspan="1" %)(% colspan="1" %)
148 148  (((
149 149  Scripts
... ... @@ -290,6 +290,10 @@
290 290  (((
291 291  //Changed return value type to const char* to better identify failure reasons in Lua script.//
292 292  )))
493 +|(% colspan="3" %)(% colspan="3" %)
494 +(((
495 +== 1.50 ==
496 +)))
293 293  |(((
294 294  UI extensions
295 295  )))|(((
... ... @@ -355,6 +355,10 @@
355 355  (((
356 356  (% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
357 357  )))
562 +|(% colspan="3" %)(% colspan="3" %)
563 +(((
564 +== 1.32 ==
565 +)))
358 358  |(((
359 359  UI extensions
360 360  )))|(((
... ... @@ -366,6 +366,10 @@
366 366  (((
367 367  //Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
368 368  )))
577 +|(% colspan="3" %)(% colspan="3" %)
578 +(((
579 +== 1.20 ==
580 +)))
369 369  |(((
370 370  UI extensions
371 371  )))|(((
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -83460874
1 +88346135
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/83460874/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/88346135/Breaking Changes