Changes for page Breaking Changes

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

From version 119.2
edited by Daniel Turner
on 2024/05/22 13:31
Change comment: There is no comment for this version
To version 128.1
edited by Michael Baumgardt
on 2025/06/04 08:45
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.Daniel
1 +xwiki:XWiki.Michael
Content
... ... @@ -20,17 +20,47 @@
20 20  
21 21  {{toc scope="LOCAL" start="3"/}}
22 22  
23 +=== Version 8.00 ===
24 +
25 +(% class="table-striped" %)
26 +|(% colspan="1" style="width:117px" %)Scripts|(% colspan="1" style="width:119px" %)8.00 Beta 1|(% colspan="4" style="width:1625px" %)Removed MD action **<populate_platforms>**
27 +|(% colspan="6" style="width:117px" %)(((
28 +The deprecated MD action <populate_platforms> has been removed. The previously referenced character quotas in quotas.xml have also been removed.
29 +)))
30 +|(% style="width:117px" %)Assets|(% style="width:117px" %)8.00 Beta 1|(% colspan="4" rowspan="1" style="width:117px" %)**\assets\units\size_m\ship_gen_m_transdrone_container_02** and **\assets\units\size_s\ship_gen_s_transdrone_container_02** moved to **ego_dlc_terran**
31 +|(% colspan="6" style="width:117px" %)**ship_gen_m_transdrone_container_02** and **ship_gen_s_transdrone_container_02** (templates and macros) have been moved to the **ego_dlc_terran** extension and any reference to these files now results in a dependency on that extension.
32 +
33 +=== Version 7.50 ===
34 +
35 +(% class="table-striped" %)
36 +|(% colspan="1" style="width:117px" %)Relations|(% colspan="1" style="width:119px" %)7.50 Beta 4|(% colspan="2" style="width:1625px" %)**Adjusted displayed UI values (25 to 30) for relations between 0.32 and 1.0:** The minimum relation for the "ally" range (0.5) now corresponds to the displayed UI value of precisely +27 (previously rounded down to +26)
37 +|(% colspan="4" style="width:117px" %)(((
38 +The "ally" range is the interval from 0.5 to 1.0, which previously corresponded to the UI value range of approximately +26.9897 to +30. The interpolated mapping within the range from 0.32 and 1.0 has been adjusted so that 0.5 now exactly corresponds to +27. As a consequence, certain relations that were previously between 25 and 28 (rounded down) may have gained +1 in the UI, i.e. they are now displayed as 26 instead of 25, etc. For consistency, the negative range between -1.0 and -0.32 has been adjusted analogously (-0.5 is now displayed as -27). This mostly only affects the UI display, not actual gameplay.
39 +)))
40 +|(% colspan="1" style="width:117px" %)Parameters|(% colspan="1" style="width:119px" %)7.50 Beta 4|(% colspan="2" style="width:1625px" %)**<holomap><radar>**:** complete change in structure**
41 +|(% colspan="7" style="width:117px" %)(((
42 +This section now contains sets of parameters for the different modes it can be in, each in its own <mode> child node. This list can be dynamically expanded to add more modes.
43 +)))
44 +
23 23  === Version 7.00 ===
24 24  
25 25  
26 26  (% class="table-striped" %)
49 +|(% colspan="1" style="width:117px" %)Gamestarts|(% colspan="1" style="width:119px" %)7.00 Beta 8|(% colspan="2" style="width:1625px" %)**Text references**
50 +|(% colspan="4" style="width:117px" %)Fields containing text references in gamestarts.xml now have full text conversion applied, allowing texts to be constructed from multiple text entries, e.g. {1234,56}\n\n{1234,78}. As a result, raw text placed in the text fields needs to be formatted accordingly, e.g. "Test start (easy)" would need to be changed to "Test start \(easy\)" to avoid the text in brackets being treated as a comment.
51 +|(% colspan="1" style="width:117px" %)Assets|(% colspan="1" style="width:119px" %)7.00 Beta 7|(% colspan="2" style="width:1625px" %)**\assets\textures\fx\highway_fx_electric_02** was deleted and replaced with **\assets\textures\fx\fx_p2_electric_01**
52 +|(% colspan="4" style="width:117px" %)highway_fx_electric_02 is still available in "legacy" folder if needed
53 +|(% colspan="1" style="width:117px" %)Parameters|(% colspan="1" style="width:119px" %)7.00 Beta 7|(% colspan="2" style="width:1625px" %)**<aiflight><skills>**: **strafespeed**, **strafeacc**, **steeringspeed**, **steeringacc** moved to separate nodes; added support for min and max values
54 +|(% colspan="4" style="width:117px" %)(((
55 +The four parameters used to represent flat factors applied to ships' properties with respect to their respective pilots' skill levels. Parameters moved to separate nodes with support for min and max values which, if supplied, scales the factor linearly if the affected ship's unmodified property is within min and max. Factor does not affect the ship if that property is below min.
56 +)))
27 27  |(% colspan="1" style="width:117px" %)Scripts|(% colspan="1" style="width:119px" %)7.00 Beta 6|(% colspan="2" style="width:1625px" %)MD action **<set_holomap_target>** parameter change.
28 28  |(% colspan="4" style="width:117px" %)(((
29 -//The **pantime** parameter has never actually done anything beyond turning panning on or making the transition instant. To make this clear it has been** **replaced with the boolean parameter **instant.**//
59 +The **pantime** parameter has never actually done anything beyond turning panning on or making the transition instant. To make this clear it has been** **replaced with the boolean parameter **instant.**
30 30  )))
31 31  |(% colspan="1" style="width:117px" %)Assets|(% colspan="1" style="width:119px" %)7.00 Beta 1|(% colspan="2" style="width:1625px" %)Renamed some material names and changed file paths for textures.
32 32  |(% colspan="4" style="width:117px" %)(((
33 -(% style="color:#ffffff" %)//Some material names and texture paths were changed. Please DIFF the materiallibrary.xml from 6.20 with 7.0 to see the difference//
63 +Some material names and texture paths were changed. Please DIFF the materiallibrary.xml from 6.20 with 7.0 to see the difference
34 34  )))
35 35  |(% colspan="1" style="width:117px" %)(% colspan="1" %)
36 36  (((
... ... @@ -42,7 +42,7 @@
42 42  )))
43 43  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
44 44  (((
45 -// Previously it was possible to set normal clusters to be persistent presentation clusters which was an invalid state.//
75 + Previously it was possible to set normal clusters to be persistent presentation clusters which was an invalid state.
46 46  )))
47 47  |(% colspan="1" style="width:117px" %)(% colspan="1" %)
48 48  (((
... ... @@ -54,7 +54,7 @@
54 54  )))
55 55  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
56 56  (((
57 -// 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.//
87 + 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.
58 58  )))
59 59  |(% colspan="1" style="width:117px" %)(% colspan="1" %)
60 60  (((
... ... @@ -68,10 +68,7 @@
68 68  (((
69 69  // //"spl_p1_fx" AND "split_p1_hulltexture_01" were moved from Split DLC to base game
70 70  )))
71 -|(% colspan="7" title="Background colour :" %)
72 72  
73 -----
74 -
75 75  === Version 6.00 ===
76 76  
77 77  (% class="table-striped" %)
... ... @@ -84,9 +84,9 @@
84 84  )))
85 85  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
86 86  (((
87 -//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.//
114 +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.
88 88  
89 -//All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.//
116 +All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.
90 90  )))
91 91  |(% colspan="1" %)(% colspan="1" %)
92 92  (((
... ... @@ -100,9 +100,9 @@
100 100  )))
101 101  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
102 102  (((
103 -//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. //
130 +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.
104 104  
105 -//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.//
132 +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.
106 106  )))
107 107  |(% colspan="1" %)(% colspan="1" %)
108 108  (((
... ... @@ -116,11 +116,11 @@
116 116  )))
117 117  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
118 118  (((
119 -//The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.//
146 +The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.
120 120  
121 -//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.//
148 +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.
122 122  
123 -//The action itself has been improved to increase the chance of finding suitable surface positions.//
150 +The action itself has been improved to increase the chance of finding suitable surface positions.
124 124  )))
125 125  |(% colspan="1" %)(% colspan="1" %)
126 126  (((
... ... @@ -134,8 +134,8 @@
134 134  )))
135 135  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
136 136  (((
137 -//<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
138 -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.//
164 +<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
165 +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.
139 139  )))
140 140  |(% colspan="1" %)(% colspan="1" %)
141 141  (((
... ... @@ -149,7 +149,7 @@
149 149  )))
150 150  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
151 151  (((
152 -//The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.//
179 +The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.
153 153  )))
154 154  |(((
155 155  Assets
... ... @@ -160,8 +160,8 @@
160 160  )))
161 161  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
162 162  (((
163 -//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.
164 -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.//
190 +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.
191 +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.
165 165  )))
166 166  |(% colspan="1" %)(% colspan="1" %)
167 167  (((
... ... @@ -175,7 +175,7 @@
175 175  )))
176 176  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
177 177  (((
178 -//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.//
205 +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.
179 179  )))
180 180  |(((
181 181  Scripts
... ... @@ -186,7 +186,7 @@
186 186  )))
187 187  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
188 188  (((
189 -//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.//
216 +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.
190 190  )))
191 191  |(((
192 192  Cutscenes
... ... @@ -197,7 +197,7 @@
197 197  )))
198 198  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
199 199  (((
200 -//The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.//
227 +The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.
201 201  )))
202 202  
203 203  ----
... ... @@ -214,7 +214,7 @@
214 214  )))
215 215  |(% colspan="7" %)(% colspan="3" %)
216 216  (((
217 -//'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.//
244 +'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.
218 218  )))
219 219  
220 220  ----
... ... @@ -234,7 +234,7 @@
234 234  )))
235 235  |(% colspan="4" %)(% colspan="3" %)
236 236  (((
237 -//The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.//
264 +The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.
238 238  )))
239 239  |(% colspan="1" %)(% colspan="1" %)
240 240  (((
... ... @@ -248,7 +248,7 @@
248 248  )))
249 249  |(% colspan="4" %)(% colspan="3" %)
250 250  (((
251 -//This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.//
278 +This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.
252 252  )))
253 253  |(% colspan="1" %)(% colspan="1" %)
254 254  (((
... ... @@ -262,7 +262,7 @@
262 262  )))
263 263  |(% colspan="4" %)(% colspan="3" %)
264 264  (((
265 -//Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.//
292 +Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.
266 266  )))
267 267  |(% colspan="1" %)(% colspan="1" %)
268 268  (((
... ... @@ -276,7 +276,7 @@
276 276  )))
277 277  |(% colspan="4" %)(% colspan="3" %)
278 278  (((
279 -//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.//
306 +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.
280 280  )))
281 281  |(((
282 282  UI extensions
... ... @@ -287,7 +287,7 @@
287 287  )))
288 288  |(% colspan="4" %)(% colspan="3" %)
289 289  (((
290 -//These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.//
317 +These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.
291 291  )))
292 292  |(((
293 293  Scripts
... ... @@ -298,7 +298,7 @@
298 298  )))
299 299  |(% colspan="4" %)(% colspan="3" %)
300 300  (((
301 -//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.//
328 +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.
302 302  )))
303 303  |(% colspan="1" %)(% colspan="1" %)
304 304  (((
... ... @@ -312,7 +312,7 @@
312 312  )))
313 313  |(% colspan="4" %)(% colspan="3" %)
314 314  (((
315 -//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.//
342 +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.
316 316  )))
317 317  |(((
318 318  Scripts
... ... @@ -323,7 +323,7 @@
323 323  )))
324 324  |(% colspan="4" %)(% colspan="3" %)
325 325  (((
326 -//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.//
353 +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.
327 327  )))
328 328  
329 329  ----
... ... @@ -343,8 +343,8 @@
343 343  )))
344 344  |(% colspan="4" %)(% colspan="3" %)
345 345  (((
346 -//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).
347 -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.//
373 +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).
374 +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.
348 348  )))
349 349  |(((
350 350  Scripts
... ... @@ -355,9 +355,9 @@
355 355  )))
356 356  |(% colspan="4" %)(% colspan="3" %)
357 357  (((
358 -//Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
385 +Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
359 359  New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
360 -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//
387 +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
361 361  )))
362 362  |(% colspan="1" %)(% colspan="1" %)
363 363  (((
... ... @@ -371,10 +371,10 @@
371 371  )))
372 372  |(% colspan="4" %)(% colspan="3" %)
373 373  (((
374 -//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.
375 -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).//
401 +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.
402 +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).
376 376  
377 -//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.//
404 +If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
378 378  )))
379 379  |(% colspan="1" %)(% colspan="1" %)
380 380  (((
... ... @@ -388,9 +388,9 @@
388 388  )))
389 389  |(% colspan="4" %)(% colspan="3" %)
390 390  (((
391 -//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.//
418 +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.
392 392  
393 -//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).
420 +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).
394 394  )))
395 395  |(((
396 396  Parameters
... ... @@ -401,7 +401,7 @@
401 401  )))
402 402  |(% colspan="4" %)(% colspan="3" %)
403 403  (((
404 -//The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.//
431 +The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.
405 405  )))
406 406  |(((
407 407  Scripts
... ... @@ -412,7 +412,7 @@
412 412  )))
413 413  |(% colspan="4" %)(% colspan="3" %)
414 414  (((
415 -//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.//
442 +The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.
416 416  )))
417 417  
418 418  ----
... ... @@ -429,7 +429,7 @@
429 429  )))
430 430  |(% colspan="7" %)(% colspan="3" %)
431 431  (((
432 -//These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()//
459 +These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()
433 433  )))
434 434  
435 435  ----
... ... @@ -446,9 +446,9 @@
446 446  )))
447 447  |(% colspan="4" %)(% colspan="3" %)
448 448  (((
449 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
450 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
451 -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//
476 +Old params: param = attacked object, param2 = attack method, param3 = attacked component
477 +New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
478 +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
452 452  )))
453 453  |(% colspan="1" %)(% colspan="1" %)
454 454  (((
... ... @@ -462,7 +462,7 @@
462 462  )))
463 463  |(% colspan="4" %)(% colspan="3" %)
464 464  (((
465 -//$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.//
492 +$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.
466 466  )))
467 467  |(((
468 468  UI extensions
... ... @@ -473,7 +473,7 @@
473 473  )))
474 474  |(% colspan="4" %)(% colspan="3" %)
475 475  (((
476 -//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.//
503 +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.
477 477  )))
478 478  
479 479  ----
... ... @@ -493,7 +493,7 @@
493 493  )))
494 494  |(% colspan="7" %)(% colspan="3" %)
495 495  (((
496 -//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.//
523 +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.
497 497  )))
498 498  
499 499  ----
... ... @@ -513,7 +513,7 @@
513 513  )))
514 514  |(% colspan="4" %)(% colspan="3" %)
515 515  (((
516 -//<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.//
543 +<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.
517 517  )))
518 518  |(% colspan="1" %)(% colspan="1" %)
519 519  (((
... ... @@ -527,7 +527,7 @@
527 527  )))
528 528  |(% colspan="4" %)(% colspan="3" %)
529 529  (((
530 -//<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.//
557 +<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.
531 531  )))
532 532  |(% colspan="1" %)(% colspan="1" %)
533 533  (((
... ... @@ -541,9 +541,9 @@
541 541  )))
542 542  |(% colspan="4" %)(% colspan="3" %)
543 543  (((
544 -//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.)
571 +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.)
545 545  
546 -//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).//
573 +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).
547 547  )))
548 548  |(% colspan="1" %)(% colspan="1" %)
549 549  (((
... ... @@ -557,7 +557,7 @@
557 557  )))
558 558  |(% colspan="4" %)(% colspan="3" %)
559 559  (((
560 -//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.//
587 +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.
561 561  )))
562 562  |(% colspan="1" %)(% colspan="1" %)
563 563  (((
... ... @@ -571,8 +571,8 @@
571 571  )))
572 572  |(% colspan="4" %)(% colspan="3" %)
573 573  (((
574 -//Before the change, positions are relative to $dockingbay.parent.
575 -After the change, positions are relative to $dockingbay as specified in the documentation.//
601 +Before the change, positions are relative to $dockingbay.parent.
602 +After the change, positions are relative to $dockingbay as specified in the documentation.
576 576  )))
577 577  |(% colspan="1" %)(% colspan="1" %)
578 578  (((
... ... @@ -586,7 +586,7 @@
586 586  )))
587 587  |(% colspan="4" %)(% colspan="3" %)
588 588  (((
589 -//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().//
616 +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().
590 590  )))
591 591  |(((
592 592  Scripts
... ... @@ -597,7 +597,7 @@
597 597  )))
598 598  |(% colspan="4" %)(% colspan="3" %)
599 599  (((
600 -//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.
627 +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.
601 601  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.
602 602  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.
603 603  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).
... ... @@ -614,7 +614,7 @@
614 614  )))
615 615  |(% colspan="4" %)(% colspan="3" %)
616 616  (((
617 -//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.//
644 +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.
618 618  )))
619 619  |(((
620 620  Job/God
... ... @@ -625,7 +625,7 @@
625 625  )))
626 626  |(% colspan="4" %)(% colspan="3" %)
627 627  (((
628 -//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.//
655 +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.
629 629  )))
630 630  |(% colspan="1" %)(% colspan="1" %)
631 631  (((
... ... @@ -639,7 +639,7 @@
639 639  )))
640 640  |(% colspan="4" %)(% colspan="3" %)
641 641  (((
642 -//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.//
669 +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.
643 643  )))
644 644  |(% colspan="1" %)(% colspan="1" %)
645 645  (((
... ... @@ -653,7 +653,7 @@
653 653  )))
654 654  |(% colspan="4" %)(% colspan="3" %)
655 655  (((
656 -//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.//
683 +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.
657 657  )))
658 658  |(% colspan="1" %)(% colspan="1" %)
659 659  (((
... ... @@ -667,7 +667,7 @@
667 667  )))
668 668  |(% colspan="4" %)(% colspan="3" %)
669 669  (((
670 -//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.//
697 +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.
671 671  )))
672 672  |(% colspan="1" %)(% colspan="1" %)
673 673  (((
... ... @@ -681,7 +681,7 @@
681 681  )))
682 682  |(% colspan="4" %)(% colspan="3" %)
683 683  (((
684 -//These actions had no effect and were removed.//
711 +These actions had no effect and were removed.
685 685  )))
686 686  |(% colspan="1" %)(% colspan="1" %)
687 687  (((
... ... @@ -695,7 +695,7 @@
695 695  )))
696 696  |(% colspan="4" %)(% colspan="3" %)
697 697  (((
698 -//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.//
725 +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.
699 699  )))
700 700  |(% colspan="1" %)(% colspan="1" %)
701 701  (((
... ... @@ -709,7 +709,7 @@
709 709  )))
710 710  |(% colspan="4" %)(% colspan="3" %)
711 711  (((
712 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
739 +The default confidence of player options is another leftover from the XR era and had no effect in X4.
713 713  )))
714 714  |(% colspan="1" %)(% colspan="1" %)
715 715  (((
... ... @@ -723,7 +723,7 @@
723 723  )))
724 724  |(% colspan="4" %)(% colspan="3" %)
725 725  (((
726 -//Unused script action <hack_via_control_panel/> was removed.//
753 +Unused script action <hack_via_control_panel/> was removed.
727 727  )))
728 728  |(% colspan="1" %)(% colspan="1" %)
729 729  (((
... ... @@ -737,7 +737,7 @@
737 737  )))
738 738  |(% colspan="4" %)(% colspan="3" %)
739 739  (((
740 -//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.//
767 +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.
741 741  )))
742 742  |(((
743 743  UI core
... ... @@ -748,7 +748,7 @@
748 748  )))
749 749  |(% colspan="4" %)(% colspan="3" %)
750 750  (((
751 -//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.//
778 +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.
752 752  )))
753 753  |(% colspan="1" %)(% colspan="1" %)
754 754  (((
... ... @@ -762,7 +762,7 @@
762 762  )))
763 763  |(% colspan="4" %)(% colspan="3" %)
764 764  (((
765 -//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.//
792 +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.
766 766  )))
767 767  |(% colspan="1" %)(% colspan="1" %)
768 768  (((
... ... @@ -776,8 +776,8 @@
776 776  )))
777 777  |(% colspan="4" %)(% colspan="3" %)
778 778  (((
779 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
780 -//It now returns true if $ware is illegal to any faction in the game.//
806 +$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
807 +It now returns true if $ware is illegal to any faction in the game.
781 781  )))
782 782  |(% colspan="1" %)(% colspan="1" %)
783 783  (((
... ... @@ -791,7 +791,7 @@
791 791  )))
792 792  |(% colspan="4" %)(% colspan="3" %)
793 793  (((
794 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
821 +The MD script RML_Flight_Along_Path was not referened and was removed.
795 795  )))
796 796  |(% colspan="1" %)(% colspan="1" %)
797 797  (((
... ... @@ -805,8 +805,8 @@
805 805  )))
806 806  |(% colspan="4" %)(% colspan="3" %)
807 807  (((
808 -//old params: param = venture details, param2 = ships involved, param3 = duration//
809 -//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
835 +old params: param = venture details, param2 = ships involved, param3 = duration
836 +new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration
810 810  )))
811 811  |(((
812 812  Scripts
... ... @@ -818,7 +818,7 @@
818 818  )))
819 819  |(% colspan="4" %)(% colspan="3" %)
820 820  (((
821 -//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
848 +The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>
822 822  )))
823 823  |(((
824 824  Scripts
... ... @@ -847,9 +847,9 @@
847 847  )))
848 848  |(% colspan="10" %)(% colspan="3" %)
849 849  (((
850 -//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.//
877 +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.
851 851  
852 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
879 +Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.
853 853  )))
854 854  |(((
855 855  Scripts
... ... @@ -860,7 +860,7 @@
860 860  )))| | |
861 861  |(% colspan="10" %)(% colspan="3" %)
862 862  (((
863 -//The script keyword $container.supplyresources now includes reserved wares.//
890 +The script keyword $container.supplyresources now includes reserved wares.
864 864  )))
865 865  
866 866  ----
... ... @@ -880,10 +880,10 @@
880 880  )))
881 881  |(% colspan="4" %)(% colspan="3" %)
882 882  (((
883 -//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.
884 -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.//
910 +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.
911 +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.
885 885  
886 -//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.//
913 +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.
887 887  )))
888 888  |(% colspan="1" %)(% colspan="1" %)
889 889  (((
... ... @@ -897,7 +897,7 @@
897 897  )))
898 898  |(% colspan="4" %)(% colspan="3" %)
899 899  (((
900 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
927 +The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.
901 901  )))
902 902  
903 903  ----
... ... @@ -917,7 +917,7 @@
917 917  )))
918 918  |(% colspan="4" %)(% colspan="3" %)
919 919  (((
920 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
947 +The construction sequence which was finished should now be accessed via the buildtask provided via param3.
921 921  )))
922 922  |(% colspan="1" %)(% colspan="1" %)
923 923  (((
... ... @@ -931,7 +931,7 @@
931 931  )))
932 932  |(% colspan="4" %)(% colspan="3" %)
933 933  (((
934 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
961 +The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.
935 935  )))
936 936  |(% colspan="1" %)(% colspan="1" %)
937 937  (((
... ... @@ -945,7 +945,7 @@
945 945  )))
946 946  |(% colspan="4" %)(% colspan="3" %)
947 947  (((
948 -//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.//
975 +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.
949 949  )))
950 950  |(((
951 951  UI extensions
... ... @@ -956,7 +956,7 @@
956 956  )))
957 957  |(% colspan="4" %)(% colspan="3" %)
958 958  (((
959 -//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.//
986 +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.
960 960  )))
961 961  |(((
962 962  UI extensions
... ... @@ -967,8 +967,8 @@
967 967  )))
968 968  |(% colspan="4" %)(% colspan="3" %)
969 969  (((
970 -//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.//
971 -//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.//
997 +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.
998 +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.
972 972  )))
973 973  |(((
974 974  Scripts
... ... @@ -979,7 +979,7 @@
979 979  )))
980 980  |(% colspan="4" %)(% colspan="3" %)
981 981  (((
982 -//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.//
1009 +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.
983 983  )))
984 984  |(((
985 985  Scripts
... ... @@ -990,7 +990,7 @@
990 990  )))
991 991  |(% colspan="4" %)(% colspan="3" %)
992 992  (((
993 -//For prior behavior, check for event.param being non-null.//
1020 +For prior behavior, check for event.param being non-null.
994 994  )))
995 995  |(((
996 996  AI Scripts
... ... @@ -1001,11 +1001,11 @@
1001 1001  )))
1002 1002  |(% colspan="4" %)(% colspan="3" %)
1003 1003  (((
1004 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
1005 -//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.//
1006 -//New attribute: "missiles" is an optional attribute that defines whether only missile launchers will be used. If false, only guns will be fired. Defaults to false.//
1031 +Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.
1032 +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.
1033 +New attribute: "missiles" is an optional attribute that defines whether only missile launchers will be used. If false, only guns will be fired. Defaults to false.
1007 1007  
1008 -//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
1035 +Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.
1009 1009  )))
1010 1010  |(((
1011 1011  UI extensions
... ... @@ -1016,7 +1016,7 @@
1016 1016  )))
1017 1017  |(% colspan="4" %)(% colspan="3" %)
1018 1018  (((
1019 -//Added possibility to query build tasks of a certain buildmodule.//
1046 +Added possibility to query build tasks of a certain buildmodule.
1020 1020  )))
1021 1021  |(((
1022 1022  UI extensions
... ... @@ -1027,7 +1027,7 @@
1027 1027  )))
1028 1028  |(% colspan="4" %)(% colspan="3" %)
1029 1029  (((
1030 -//Added list of resources a buildmodule needs to build.//
1057 +Added list of resources a buildmodule needs to build.
1031 1031  )))
1032 1032  |(((
1033 1033  UI extensions
... ... @@ -1038,7 +1038,7 @@
1038 1038  )))
1039 1039  |(% colspan="4" %)(% colspan="3" %)
1040 1040  (((
1041 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
1068 +Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.
1042 1042  )))
1043 1043  |(((
1044 1044  UI extensions
... ... @@ -1049,7 +1049,7 @@
1049 1049  )))
1050 1050  |(% colspan="4" %)(% colspan="3" %)
1051 1051  (((
1052 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
1079 +Changed return value type to const char* to better identify failure reasons in Lua script.
1053 1053  )))
1054 1054  
1055 1055  ----
... ... @@ -1066,7 +1066,7 @@
1066 1066  )))
1067 1067  |(% colspan="4" %)(% colspan="3" %)
1068 1068  (((
1069 -//The "docksizes" property no longer includes internal ship storage docks.//
1096 +The "docksizes" property no longer includes internal ship storage docks.
1070 1070  )))
1071 1071  |(((
1072 1072  All
... ... @@ -1077,11 +1077,11 @@
1077 1077  )))
1078 1078  |(% colspan="4" %)(% colspan="3" %)
1079 1079  (((
1080 -//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".//
1107 +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".
1081 1081  
1082 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
1083 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
1084 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
1109 +Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()
1110 +Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"
1111 +Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)
1085 1085  )))
1086 1086  |(((
1087 1087  UI extensions
... ... @@ -1092,7 +1092,7 @@
1092 1092  )))
1093 1093  |(% colspan="4" %)(% colspan="3" %)
1094 1094  (((
1095 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
1122 +Added new "operational" field to retrieve information about number of operational upgrades in a group.
1096 1096  )))
1097 1097  |(% colspan="1" %)(% colspan="1" %)
1098 1098  (((
... ... @@ -1106,9 +1106,9 @@
1106 1106  )))
1107 1107  |(% colspan="4" %)(% colspan="3" %)
1108 1108  (((
1109 -//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.//
1136 +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.
1110 1110  
1111 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1138 +The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)
1112 1112  )))
1113 1113  |(((
1114 1114  UI extensions
... ... @@ -1119,7 +1119,7 @@
1119 1119  )))
1120 1120  |(% colspan="4" %)(% colspan="3" %)
1121 1121  (((
1122 -//CancelConstruction() now returns if the cancellation was successful. //
1149 +CancelConstruction() now returns if the cancellation was successful.
1123 1123  )))
1124 1124  
1125 1125  ----
... ... @@ -1136,7 +1136,7 @@
1136 1136  )))
1137 1137  |(% colspan="4" %)(% colspan="3" %)
1138 1138  (((
1139 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
1166 +Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.
1140 1140  )))
1141 1141  
1142 1142  ----