Changes for page Breaking Changes

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

From version 123.4
edited by Matthias Haan
on 2024/12/20 11:42
Change comment: There is no comment for this version
To version 124.24
edited by Klaus Meyer
on 2025/01/07 16:57
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.Matthias
1 +xwiki:XWiki.Klaus
Content
... ... @@ -23,10 +23,11 @@
23 23  === Version 7.50 ===
24 24  
25 25  (% class="table-striped" %)
26 -|(% 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**
26 +|(% 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
27 +|(% colspan="4" style="width:117px" %)The mapping of relations (-1.0 to +1.0) to displayed UI values (-30 to +30) is a piecewise logarithmic interpolation between fixed mappings (e.g. +0.32 corresponds to +25 in the . The "ally" range is the interval from 0.5 to 1.0, which corresponds to the UI value range of approximately +26.9897 to +30. The mapping within the range from 0.32 and 1.0 has been adjusted so that 0.5 now precisely corresponds to +27.
28 +|(% 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**
27 27  |(% colspan="7" style="width:117px" %)(((
28 -It now contains sets of parameters for the different modes it can be in. This list can be dynamically expanded to add more modes.
29 -
30 +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.
30 30  )))
31 31  
32 32  === Version 7.00 ===
... ... @@ -34,20 +34,20 @@
34 34  
35 35  (% class="table-striped" %)
36 36  |(% colspan="1" style="width:117px" %)Gamestarts|(% colspan="1" style="width:119px" %)7.00 Beta 8|(% colspan="2" style="width:1625px" %)**Text references**
37 -|(% 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.//
38 +|(% 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.
38 38  |(% 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**
39 39  |(% colspan="4" style="width:117px" %)highway_fx_electric_02 is still available in "legacy" folder if needed
40 40  |(% 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
41 41  |(% colspan="4" style="width:117px" %)(((
42 -//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.//
43 +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.
43 43  )))
44 44  |(% 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.
45 45  |(% colspan="4" style="width:117px" %)(((
46 -//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.**//
47 +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.**
47 47  )))
48 48  |(% 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.
49 49  |(% colspan="4" style="width:117px" %)(((
50 -(% 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//
51 +Some material names and texture paths were changed. Please DIFF the materiallibrary.xml from 6.20 with 7.0 to see the difference
51 51  )))
52 52  |(% colspan="1" style="width:117px" %)(% colspan="1" %)
53 53  (((
... ... @@ -59,7 +59,7 @@
59 59  )))
60 60  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
61 61  (((
62 -// Previously it was possible to set normal clusters to be persistent presentation clusters which was an invalid state.//
63 + Previously it was possible to set normal clusters to be persistent presentation clusters which was an invalid state.
63 63  )))
64 64  |(% colspan="1" style="width:117px" %)(% colspan="1" %)
65 65  (((
... ... @@ -71,7 +71,7 @@
71 71  )))
72 72  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
73 73  (((
74 -// 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.//
75 + 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.
75 75  )))
76 76  |(% colspan="1" style="width:117px" %)(% colspan="1" %)
77 77  (((
... ... @@ -98,9 +98,9 @@
98 98  )))
99 99  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
100 100  (((
101 -//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.//
102 +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.
102 102  
103 -//All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.//
104 +All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.
104 104  )))
105 105  |(% colspan="1" %)(% colspan="1" %)
106 106  (((
... ... @@ -114,9 +114,9 @@
114 114  )))
115 115  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
116 116  (((
117 -//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. //
118 +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.
118 118  
119 -//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.//
120 +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.
120 120  )))
121 121  |(% colspan="1" %)(% colspan="1" %)
122 122  (((
... ... @@ -130,11 +130,11 @@
130 130  )))
131 131  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
132 132  (((
133 -//The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.//
134 +The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.
134 134  
135 -//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.//
136 +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.
136 136  
137 -//The action itself has been improved to increase the chance of finding suitable surface positions.//
138 +The action itself has been improved to increase the chance of finding suitable surface positions.
138 138  )))
139 139  |(% colspan="1" %)(% colspan="1" %)
140 140  (((
... ... @@ -148,8 +148,8 @@
148 148  )))
149 149  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
150 150  (((
151 -//<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
152 -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.//
152 +<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
153 +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.
153 153  )))
154 154  |(% colspan="1" %)(% colspan="1" %)
155 155  (((
... ... @@ -163,7 +163,7 @@
163 163  )))
164 164  |(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
165 165  (((
166 -//The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.//
167 +The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.
167 167  )))
168 168  |(((
169 169  Assets
... ... @@ -174,8 +174,8 @@
174 174  )))
175 175  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
176 176  (((
177 -//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.
178 -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.//
178 +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.
179 +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.
179 179  )))
180 180  |(% colspan="1" %)(% colspan="1" %)
181 181  (((
... ... @@ -189,7 +189,7 @@
189 189  )))
190 190  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
191 191  (((
192 -//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.//
193 +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.
193 193  )))
194 194  |(((
195 195  Scripts
... ... @@ -200,7 +200,7 @@
200 200  )))
201 201  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
202 202  (((
203 -//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.//
204 +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.
204 204  )))
205 205  |(((
206 206  Cutscenes
... ... @@ -211,7 +211,7 @@
211 211  )))
212 212  |(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
213 213  (((
214 -//The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.//
215 +The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.
215 215  )))
216 216  
217 217  ----
... ... @@ -228,7 +228,7 @@
228 228  )))
229 229  |(% colspan="7" %)(% colspan="3" %)
230 230  (((
231 -//'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.//
232 +'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.
232 232  )))
233 233  
234 234  ----
... ... @@ -248,7 +248,7 @@
248 248  )))
249 249  |(% colspan="4" %)(% colspan="3" %)
250 250  (((
251 -//The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.//
252 +The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.
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 -//This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.//
266 +This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.
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 -//Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.//
280 +Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.
280 280  )))
281 281  |(% colspan="1" %)(% colspan="1" %)
282 282  (((
... ... @@ -290,7 +290,7 @@
290 290  )))
291 291  |(% colspan="4" %)(% colspan="3" %)
292 292  (((
293 -//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.//
294 +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.
294 294  )))
295 295  |(((
296 296  UI extensions
... ... @@ -301,7 +301,7 @@
301 301  )))
302 302  |(% colspan="4" %)(% colspan="3" %)
303 303  (((
304 -//These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.//
305 +These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.
305 305  )))
306 306  |(((
307 307  Scripts
... ... @@ -312,7 +312,7 @@
312 312  )))
313 313  |(% colspan="4" %)(% colspan="3" %)
314 314  (((
315 -//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.//
316 +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.
316 316  )))
317 317  |(% colspan="1" %)(% colspan="1" %)
318 318  (((
... ... @@ -326,7 +326,7 @@
326 326  )))
327 327  |(% colspan="4" %)(% colspan="3" %)
328 328  (((
329 -//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.//
330 +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.
330 330  )))
331 331  |(((
332 332  Scripts
... ... @@ -337,7 +337,7 @@
337 337  )))
338 338  |(% colspan="4" %)(% colspan="3" %)
339 339  (((
340 -//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.//
341 +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.
341 341  )))
342 342  
343 343  ----
... ... @@ -357,8 +357,8 @@
357 357  )))
358 358  |(% colspan="4" %)(% colspan="3" %)
359 359  (((
360 -//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).
361 -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.//
361 +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).
362 +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.
362 362  )))
363 363  |(((
364 364  Scripts
... ... @@ -369,9 +369,9 @@
369 369  )))
370 370  |(% colspan="4" %)(% colspan="3" %)
371 371  (((
372 -//Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
373 +Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
373 373  New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
374 -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//
375 +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
375 375  )))
376 376  |(% colspan="1" %)(% colspan="1" %)
377 377  (((
... ... @@ -385,10 +385,10 @@
385 385  )))
386 386  |(% colspan="4" %)(% colspan="3" %)
387 387  (((
388 -//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.
389 -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).//
389 +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.
390 +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).
390 390  
391 -//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.//
392 +If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
392 392  )))
393 393  |(% colspan="1" %)(% colspan="1" %)
394 394  (((
... ... @@ -402,9 +402,9 @@
402 402  )))
403 403  |(% colspan="4" %)(% colspan="3" %)
404 404  (((
405 -//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.//
406 +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.
406 406  
407 -//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).
408 +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).
408 408  )))
409 409  |(((
410 410  Parameters
... ... @@ -415,7 +415,7 @@
415 415  )))
416 416  |(% colspan="4" %)(% colspan="3" %)
417 417  (((
418 -//The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.//
419 +The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.
419 419  )))
420 420  |(((
421 421  Scripts
... ... @@ -426,7 +426,7 @@
426 426  )))
427 427  |(% colspan="4" %)(% colspan="3" %)
428 428  (((
429 -//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.//
430 +The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.
430 430  )))
431 431  
432 432  ----
... ... @@ -443,7 +443,7 @@
443 443  )))
444 444  |(% colspan="7" %)(% colspan="3" %)
445 445  (((
446 -//These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()//
447 +These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()
447 447  )))
448 448  
449 449  ----
... ... @@ -460,9 +460,9 @@
460 460  )))
461 461  |(% colspan="4" %)(% colspan="3" %)
462 462  (((
463 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
464 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
465 -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//
464 +Old params: param = attacked object, param2 = attack method, param3 = attacked component
465 +New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
466 +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
466 466  )))
467 467  |(% colspan="1" %)(% colspan="1" %)
468 468  (((
... ... @@ -476,7 +476,7 @@
476 476  )))
477 477  |(% colspan="4" %)(% colspan="3" %)
478 478  (((
479 -//$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.//
480 +$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.
480 480  )))
481 481  |(((
482 482  UI extensions
... ... @@ -487,7 +487,7 @@
487 487  )))
488 488  |(% colspan="4" %)(% colspan="3" %)
489 489  (((
490 -//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.//
491 +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.
491 491  )))
492 492  
493 493  ----
... ... @@ -507,7 +507,7 @@
507 507  )))
508 508  |(% colspan="7" %)(% colspan="3" %)
509 509  (((
510 -//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.//
511 +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.
511 511  )))
512 512  
513 513  ----
... ... @@ -527,7 +527,7 @@
527 527  )))
528 528  |(% colspan="4" %)(% colspan="3" %)
529 529  (((
530 -//<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.//
531 +<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.
531 531  )))
532 532  |(% colspan="1" %)(% colspan="1" %)
533 533  (((
... ... @@ -541,7 +541,7 @@
541 541  )))
542 542  |(% colspan="4" %)(% colspan="3" %)
543 543  (((
544 -//<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.//
545 +<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.
545 545  )))
546 546  |(% colspan="1" %)(% colspan="1" %)
547 547  (((
... ... @@ -555,9 +555,9 @@
555 555  )))
556 556  |(% colspan="4" %)(% colspan="3" %)
557 557  (((
558 -//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.)
559 +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.)
559 559  
560 -//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).//
561 +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).
561 561  )))
562 562  |(% colspan="1" %)(% colspan="1" %)
563 563  (((
... ... @@ -571,7 +571,7 @@
571 571  )))
572 572  |(% colspan="4" %)(% colspan="3" %)
573 573  (((
574 -//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.//
575 +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.
575 575  )))
576 576  |(% colspan="1" %)(% colspan="1" %)
577 577  (((
... ... @@ -585,8 +585,8 @@
585 585  )))
586 586  |(% colspan="4" %)(% colspan="3" %)
587 587  (((
588 -//Before the change, positions are relative to $dockingbay.parent.
589 -After the change, positions are relative to $dockingbay as specified in the documentation.//
589 +Before the change, positions are relative to $dockingbay.parent.
590 +After the change, positions are relative to $dockingbay as specified in the documentation.
590 590  )))
591 591  |(% colspan="1" %)(% colspan="1" %)
592 592  (((
... ... @@ -600,7 +600,7 @@
600 600  )))
601 601  |(% colspan="4" %)(% colspan="3" %)
602 602  (((
603 -//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().//
604 +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().
604 604  )))
605 605  |(((
606 606  Scripts
... ... @@ -611,7 +611,7 @@
611 611  )))
612 612  |(% colspan="4" %)(% colspan="3" %)
613 613  (((
614 -//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.
615 +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.
615 615  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.
616 616  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.
617 617  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).
... ... @@ -628,7 +628,7 @@
628 628  )))
629 629  |(% colspan="4" %)(% colspan="3" %)
630 630  (((
631 -//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.//
632 +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.
632 632  )))
633 633  |(((
634 634  Job/God
... ... @@ -639,7 +639,7 @@
639 639  )))
640 640  |(% colspan="4" %)(% colspan="3" %)
641 641  (((
642 -//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.//
643 +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.
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 -//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.//
657 +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.
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 -//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.//
671 +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.
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 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.//
685 +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.
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 -//These actions had no effect and were removed.//
699 +These actions had no effect and were removed.
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 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.//
713 +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.
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 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
727 +The default confidence of player options is another leftover from the XR era and had no effect in X4.
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 -//Unused script action <hack_via_control_panel/> was removed.//
741 +Unused script action <hack_via_control_panel/> was removed.
741 741  )))
742 742  |(% colspan="1" %)(% colspan="1" %)
743 743  (((
... ... @@ -751,7 +751,7 @@
751 751  )))
752 752  |(% colspan="4" %)(% colspan="3" %)
753 753  (((
754 -//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.//
755 +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.
755 755  )))
756 756  |(((
757 757  UI core
... ... @@ -762,7 +762,7 @@
762 762  )))
763 763  |(% colspan="4" %)(% colspan="3" %)
764 764  (((
765 -//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.//
766 +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.
766 766  )))
767 767  |(% colspan="1" %)(% colspan="1" %)
768 768  (((
... ... @@ -776,7 +776,7 @@
776 776  )))
777 777  |(% colspan="4" %)(% colspan="3" %)
778 778  (((
779 -//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.//
780 +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.
780 780  )))
781 781  |(% colspan="1" %)(% colspan="1" %)
782 782  (((
... ... @@ -790,8 +790,8 @@
790 790  )))
791 791  |(% colspan="4" %)(% colspan="3" %)
792 792  (((
793 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
794 -//It now returns true if $ware is illegal to any faction in the game.//
794 +$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
795 +It now returns true if $ware is illegal to any faction in the game.
795 795  )))
796 796  |(% colspan="1" %)(% colspan="1" %)
797 797  (((
... ... @@ -805,7 +805,7 @@
805 805  )))
806 806  |(% colspan="4" %)(% colspan="3" %)
807 807  (((
808 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
809 +The MD script RML_Flight_Along_Path was not referened and was removed.
809 809  )))
810 810  |(% colspan="1" %)(% colspan="1" %)
811 811  (((
... ... @@ -819,8 +819,8 @@
819 819  )))
820 820  |(% colspan="4" %)(% colspan="3" %)
821 821  (((
822 -//old params: param = venture details, param2 = ships involved, param3 = duration//
823 -//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
823 +old params: param = venture details, param2 = ships involved, param3 = duration
824 +new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration
824 824  )))
825 825  |(((
826 826  Scripts
... ... @@ -832,7 +832,7 @@
832 832  )))
833 833  |(% colspan="4" %)(% colspan="3" %)
834 834  (((
835 -//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
836 +The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>
836 836  )))
837 837  |(((
838 838  Scripts
... ... @@ -861,9 +861,9 @@
861 861  )))
862 862  |(% colspan="10" %)(% colspan="3" %)
863 863  (((
864 -//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.//
865 +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.
865 865  
866 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
867 +Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.
867 867  )))
868 868  |(((
869 869  Scripts
... ... @@ -874,7 +874,7 @@
874 874  )))| | |
875 875  |(% colspan="10" %)(% colspan="3" %)
876 876  (((
877 -//The script keyword $container.supplyresources now includes reserved wares.//
878 +The script keyword $container.supplyresources now includes reserved wares.
878 878  )))
879 879  
880 880  ----
... ... @@ -894,10 +894,10 @@
894 894  )))
895 895  |(% colspan="4" %)(% colspan="3" %)
896 896  (((
897 -//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.
898 -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.//
898 +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.
899 +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.
899 899  
900 -//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.//
901 +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.
901 901  )))
902 902  |(% colspan="1" %)(% colspan="1" %)
903 903  (((
... ... @@ -911,7 +911,7 @@
911 911  )))
912 912  |(% colspan="4" %)(% colspan="3" %)
913 913  (((
914 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
915 +The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.
915 915  )))
916 916  
917 917  ----
... ... @@ -931,7 +931,7 @@
931 931  )))
932 932  |(% colspan="4" %)(% colspan="3" %)
933 933  (((
934 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
935 +The construction sequence which was finished should now be accessed via the buildtask provided via param3.
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 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
949 +The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.
949 949  )))
950 950  |(% colspan="1" %)(% colspan="1" %)
951 951  (((
... ... @@ -959,7 +959,7 @@
959 959  )))
960 960  |(% colspan="4" %)(% colspan="3" %)
961 961  (((
962 -//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.//
963 +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.
963 963  )))
964 964  |(((
965 965  UI extensions
... ... @@ -970,7 +970,7 @@
970 970  )))
971 971  |(% colspan="4" %)(% colspan="3" %)
972 972  (((
973 -//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.//
974 +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.
974 974  )))
975 975  |(((
976 976  UI extensions
... ... @@ -981,8 +981,8 @@
981 981  )))
982 982  |(% colspan="4" %)(% colspan="3" %)
983 983  (((
984 -//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.//
985 -//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.//
985 +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.
986 +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.
986 986  )))
987 987  |(((
988 988  Scripts
... ... @@ -993,7 +993,7 @@
993 993  )))
994 994  |(% colspan="4" %)(% colspan="3" %)
995 995  (((
996 -//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.//
997 +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.
997 997  )))
998 998  |(((
999 999  Scripts
... ... @@ -1004,7 +1004,7 @@
1004 1004  )))
1005 1005  |(% colspan="4" %)(% colspan="3" %)
1006 1006  (((
1007 -//For prior behavior, check for event.param being non-null.//
1008 +For prior behavior, check for event.param being non-null.
1008 1008  )))
1009 1009  |(((
1010 1010  AI Scripts
... ... @@ -1015,11 +1015,11 @@
1015 1015  )))
1016 1016  |(% colspan="4" %)(% colspan="3" %)
1017 1017  (((
1018 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
1019 -//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.//
1020 -//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.//
1019 +Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.
1020 +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.
1021 +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.
1021 1021  
1022 -//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
1023 +Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.
1023 1023  )))
1024 1024  |(((
1025 1025  UI extensions
... ... @@ -1030,7 +1030,7 @@
1030 1030  )))
1031 1031  |(% colspan="4" %)(% colspan="3" %)
1032 1032  (((
1033 -//Added possibility to query build tasks of a certain buildmodule.//
1034 +Added possibility to query build tasks of a certain buildmodule.
1034 1034  )))
1035 1035  |(((
1036 1036  UI extensions
... ... @@ -1041,7 +1041,7 @@
1041 1041  )))
1042 1042  |(% colspan="4" %)(% colspan="3" %)
1043 1043  (((
1044 -//Added list of resources a buildmodule needs to build.//
1045 +Added list of resources a buildmodule needs to build.
1045 1045  )))
1046 1046  |(((
1047 1047  UI extensions
... ... @@ -1052,7 +1052,7 @@
1052 1052  )))
1053 1053  |(% colspan="4" %)(% colspan="3" %)
1054 1054  (((
1055 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
1056 +Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.
1056 1056  )))
1057 1057  |(((
1058 1058  UI extensions
... ... @@ -1063,7 +1063,7 @@
1063 1063  )))
1064 1064  |(% colspan="4" %)(% colspan="3" %)
1065 1065  (((
1066 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
1067 +Changed return value type to const char* to better identify failure reasons in Lua script.
1067 1067  )))
1068 1068  
1069 1069  ----
... ... @@ -1080,7 +1080,7 @@
1080 1080  )))
1081 1081  |(% colspan="4" %)(% colspan="3" %)
1082 1082  (((
1083 -//The "docksizes" property no longer includes internal ship storage docks.//
1084 +The "docksizes" property no longer includes internal ship storage docks.
1084 1084  )))
1085 1085  |(((
1086 1086  All
... ... @@ -1091,11 +1091,11 @@
1091 1091  )))
1092 1092  |(% colspan="4" %)(% colspan="3" %)
1093 1093  (((
1094 -//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".//
1095 +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".
1095 1095  
1096 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
1097 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
1098 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
1097 +Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()
1098 +Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"
1099 +Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)
1099 1099  )))
1100 1100  |(((
1101 1101  UI extensions
... ... @@ -1106,7 +1106,7 @@
1106 1106  )))
1107 1107  |(% colspan="4" %)(% colspan="3" %)
1108 1108  (((
1109 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
1110 +Added new "operational" field to retrieve information about number of operational upgrades in a group.
1110 1110  )))
1111 1111  |(% colspan="1" %)(% colspan="1" %)
1112 1112  (((
... ... @@ -1120,9 +1120,9 @@
1120 1120  )))
1121 1121  |(% colspan="4" %)(% colspan="3" %)
1122 1122  (((
1123 -//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.//
1124 +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.
1124 1124  
1125 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1126 +The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)
1126 1126  )))
1127 1127  |(((
1128 1128  UI extensions
... ... @@ -1133,7 +1133,7 @@
1133 1133  )))
1134 1134  |(% colspan="4" %)(% colspan="3" %)
1135 1135  (((
1136 -//CancelConstruction() now returns if the cancellation was successful. //
1137 +CancelConstruction() now returns if the cancellation was successful.
1137 1137  )))
1138 1138  
1139 1139  ----
... ... @@ -1150,7 +1150,7 @@
1150 1150  )))
1151 1151  |(% colspan="4" %)(% colspan="3" %)
1152 1152  (((
1153 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
1154 +Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.
1154 1154  )))
1155 1155  
1156 1156  ----