Changes for page Breaking Changes

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

From version 80.1
edited by stefan
on 2021/03/05 01:24
Change comment: add note on gameplanchange-event change
To version 124.31
edited by Klaus Meyer
on 2025/01/07 17:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +X4 Foundations Wiki.Modding Support.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.stefan
1 +xwiki:XWiki.Klaus
Content
... ... @@ -4,13 +4,13 @@
4 4  The following table provides an overview about all breaking changes. This should help you to make any necessary changes to restore compatibility of older mods with new versions of X4.
5 5  Feel free to drop a note if a certain breaking change is breaking your mod and you have difficulties finding a way to work around the issue.
6 6  
7 -{{note}}
8 -The list of breaking changes does **NOT** cover changes in the provided/shipped scripts (for instance UI scripts like the ones located under ui/addons/XXX or ui/core/Lua). These scripts can change anytime without explicit notice. If you hook into one of these scripts or provide replacements for these, please check the script for possible breaking changes yourself.
7 +{{info}}
8 +The list of breaking changes does **NOT** cover changes in the provided/shipped scripts (for instance UI scripts like the ones located under ui/addons/XXX or ui/core/Lua). These scripts can change anytime without explicit notice. If you hook into one of these scripts or provide replacements for these, please check the script for possible breaking changes yourself.
9 9  
10 10  Further note that the list provides information about breaking changes which are in the pipeline of being released. This is meant merely as an informational heads up. Neither do mistake this as an announcement of that version becoming available soon nor take it for granted that such a change will go live. Any information provided for not yet released versions can change (and even be removed) prior to such version having seen the light of day.
11 11  
12 12  As a final note, please be aware that issues introduced during the beta phase might not be explicitly mentioned in the list below, if things would only be broken in-between two beta versions. While we still aim to document any (potential) breaking change here, there might be circumstances for which we divert from that procedure (especially in case of only minor issues which are considered merely bugfixes rather than an intended behavior change).
13 -{{/note}}
13 +{{/info}}
14 14  
15 15  {{warning title="UI modding considered unstable until further notice..."}}
16 16  Please note that UI modding must be considered **unstable** in the current version. While we are working hard to get the UI modding integration into a stable state, we might have to introduce larger backwards incompatibilities in the following patches. This means that you might have to modify any mod using UI modding capabilities to a larger extend to keep it compatible with certain patches. Still, we are doing our best not to unnecessarily break things for modders and certainly will announce such changes on this page here.
... ... @@ -18,171 +18,454 @@
18 18  
19 19  = Breaking Changes =
20 20  
21 -|=(((
22 -Type
23 -)))|=(((
24 -Version
25 -)))|=(((
26 -Summary
27 -)))|=(% colspan="1" %)(% colspan="1" %)
21 +{{toc scope="LOCAL" start="3"/}}
22 +
23 +=== Version 7.50 ===
24 +
25 +(% class="table-striped" %)
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 (previously rounded down to +26)
27 +|(% colspan="4" style="width:117px" %)(((
28 +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 UI). 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 mapping within the range from 0.32 and 1.0 has been adjusted so that 0.5 now exactly corresponds to +27. For consistency, the negative range between -1.0 and -0.32 has been adjusted analogously (-0.5 is now displayed as -27).
29 +)))
30 +|(% 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**
31 +|(% colspan="7" style="width:117px" %)(((
32 +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.
33 +)))
34 +
35 +=== Version 7.00 ===
36 +
37 +
38 +(% class="table-striped" %)
39 +|(% colspan="1" style="width:117px" %)Gamestarts|(% colspan="1" style="width:119px" %)7.00 Beta 8|(% colspan="2" style="width:1625px" %)**Text references**
40 +|(% 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.
41 +|(% 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**
42 +|(% colspan="4" style="width:117px" %)highway_fx_electric_02 is still available in "legacy" folder if needed
43 +|(% 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
44 +|(% colspan="4" style="width:117px" %)(((
45 +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.
46 +)))
47 +|(% 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.
48 +|(% colspan="4" style="width:117px" %)(((
49 +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.**
50 +)))
51 +|(% 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.
52 +|(% colspan="4" style="width:117px" %)(((
53 +Some material names and texture paths were changed. Please DIFF the materiallibrary.xml from 6.20 with 7.0 to see the difference
54 +)))
55 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
28 28  (((
29 -
57 +Scripts
58 +)))|(% colspan="1" style="width:119px" %)(((
59 +7.00 Beta 1
60 +)))|(% colspan="2" style="width:1625px" %)(((
61 +MD action **<set_presentation_cluster_persistence/>** now requires the cluster to be a presentation cluster.
30 30  )))
31 -|(% colspan="4" %)(% colspan="4" %)
63 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
32 32  (((
33 -== 4.00 ==
65 + Previously it was possible to set normal clusters to be persistent presentation clusters which was an invalid state.
34 34  )))
67 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
68 +(((
69 +UI extensions
70 +)))|(% colspan="1" style="width:119px" %)(((
71 +7.00 Beta 1
72 +)))|(% colspan="2" style="width:1625px" %)(((
73 +**FFI**: RemoveBuildPlot() changed
74 +)))
75 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
76 +(((
77 + 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.
78 +)))
79 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
80 +(((
81 +Assets
82 +)))|(% colspan="1" style="width:119px" %)(((
83 +7.00 Beta 1
84 +)))|(% colspan="2" style="width:1625px" %)(((
85 +**Some Split DLC materials moved to base game**
86 +)))
87 +|(% colspan="7" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
88 +(((
89 +// //"spl_p1_fx" AND "split_p1_hulltexture_01" were moved from Split DLC to base game
90 +)))
91 +
92 +=== Version 6.00 ===
93 +
94 +(% class="table-striped" %)
95 +|(((
96 +Libraries
97 +)))|(((
98 +6.00 Beta 7
99 +)))|(% colspan="2" %)(((
100 +Updated weights for ship groups in shipgroups.xml libraries of base game and all DLCs.
101 +)))
102 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
103 +(((
104 +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.
105 +
106 +All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.
107 +)))
35 35  |(% colspan="1" %)(% colspan="1" %)
36 36  (((
37 -UI core
110 +Scripts
38 38  )))|(% colspan="1" %)(% colspan="1" %)
39 39  (((
40 -4.00 Beta 10
113 +6.00 Beta 4
114 +)))|(% colspan="2" %)(% colspan="1" %)
115 +(((
116 +Changed conditions for **<event_player_travelmode_started> <event_player_travelmode_stopped> <event_player_travelmode_charge_started> <event_player_travelmode_charge_aborted>** to be raised.
117 +)))
118 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
119 +(((
120 +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.
121 +
122 +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.
123 +)))
124 +|(% colspan="1" %)(% colspan="1" %)
125 +(((
126 +Scripts
41 41  )))|(% colspan="1" %)(% colspan="1" %)
42 42  (((
43 -Controlled ship can change without a **gameplanchange-event** occurring.
129 +6.00 Beta 3
130 +)))|(% colspan="2" %)(% colspan="1" %)
131 +(((
132 +Changed result of **<find_object_surface>** action in the case of a failure
133 +)))
134 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
135 +(((
136 +The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.
137 +
138 +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.
139 +
140 +The action itself has been improved to increase the chance of finding suitable surface positions.
141 +)))
142 +|(% colspan="1" %)(% colspan="1" %)
143 +(((
144 +Scripts
44 44  )))|(% colspan="1" %)(% colspan="1" %)
45 45  (((
46 -
147 +6.00 Beta 1
148 +)))|(% colspan="2" %)(% colspan="1" %)
149 +(((
150 +Behaviour change for **<match_dock>** script component filter
47 47  )))
48 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
152 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
49 49  (((
50 -//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).
51 -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.//
154 +<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
155 +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.
156 +)))
157 +|(% colspan="1" %)(% colspan="1" %)
158 +(((
159 +Scripts
52 52  )))|(% colspan="1" %)(% colspan="1" %)
53 53  (((
54 -
162 +6.00 Beta 1
163 +)))|(% colspan="2" %)(% colspan="1" %)
164 +(((
165 +Changed result attribute location for **<get_attackstrength>**
55 55  )))
167 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
168 +(((
169 +The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.
170 +)))
56 56  |(((
172 +Assets
173 +)))|(((
174 +6.00 Beta 1
175 +)))|(% colspan="2" %)(((
176 +Surface element **connections** are incompatible by default unless tagged as "**standard**", and also "**combat**" for non-missile, non-mining weapons
177 +)))
178 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
179 +(((
180 +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.
181 +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.
182 +)))
183 +|(% colspan="1" %)(% colspan="1" %)
184 +(((
57 57  Scripts
186 +)))|(% colspan="1" %)(% colspan="1" %)
187 +(((
188 +6.00 Beta 1
189 +)))|(% colspan="2" %)(% colspan="1" %)
190 +(((
191 +Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
192 +)))
193 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
194 +(((
195 +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.
196 +)))
197 +|(((
198 +Scripts
58 58  )))|(((
59 -4.00 Beta 7
200 +6.00 Beta 1
201 +)))|(% colspan="2" %)(((
202 +**<event_player_owned_killed_object>** and **<event_player_owned_destroyed>** are now triggered before the corresponding **<event_object_destroyed>**, instead of afterwards.
203 +)))
204 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
205 +(((
206 +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.
207 +)))
208 +|(((
209 +Cutscenes
60 60  )))|(((
61 -Parameters of **<event_terraforming_project_succeeded>** and **<event_terraforming_project_failed>** changed
211 +6.00 Beta 1
212 +)))|(% colspan="2" %)(((
213 +Changed behaviour of **<angles>** in cutscenes
214 +)))
215 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
216 +(((
217 +The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.
218 +)))
219 +
220 +----
221 +
222 +=== Version 5.00 ===
223 +
224 +(% class="table-striped" %)
225 +|(((
226 +Parameters
62 62  )))|(((
63 -
228 +5.00 Beta 1
229 +)))|(% colspan="2" %)(((
230 +**<controlpanel><entry>: minduration** removed, **maxduration** renamed to duration
64 64  )))
65 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
232 +|(% colspan="7" %)(% colspan="3" %)
66 66  (((
67 -//Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
68 -New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
69 -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//
70 -)))|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
234 +'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.
235 +)))
236 +
237 +----
238 +
239 +=== Version 4.10 ===
240 +
241 +(% class="table-striped" %)
242 +|(% colspan="1" %)(% colspan="1" %)
71 71  (((
72 -
244 +UI extensions
245 +)))|(% colspan="1" %)(% colspan="1" %)
246 +(((
247 +4.10 Beta 7
248 +)))|(% colspan="2" %)(% colspan="1" %)
249 +(((
250 +**FFI**: SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() deprecated
73 73  )))
252 +|(% colspan="4" %)(% colspan="3" %)
253 +(((
254 +The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.
255 +)))
74 74  |(% colspan="1" %)(% colspan="1" %)
75 75  (((
76 -UI core
258 +UI extensions
77 77  )))|(% colspan="1" %)(% colspan="1" %)
78 78  (((
79 -4.00 Beta 6
261 +4.10 Beta 6
262 +)))|(% colspan="2" %)(% colspan="1" %)
263 +(((
264 +**FFI**: CustomGameStartPlayerProperty2 changed
265 +)))
266 +|(% colspan="4" %)(% colspan="3" %)
267 +(((
268 +This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.
269 +)))
270 +|(% colspan="1" %)(% colspan="1" %)
271 +(((
272 +Parameters
80 80  )))|(% colspan="1" %)(% colspan="1" %)
81 81  (((
82 -**FFI:** GetFactionRelationStatus() handling for faction relation range [-20,-10] changed
275 +4.10 Beta 3
276 +)))|(% colspan="2" %)(% colspan="1" %)
277 +(((
278 +Renamed **<stationinfobox>** to **<infobox>**
279 +)))
280 +|(% colspan="4" %)(% colspan="3" %)
281 +(((
282 +Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.
283 +)))
284 +|(% colspan="1" %)(% colspan="1" %)
285 +(((
286 +UI extensions
83 83  )))|(% colspan="1" %)(% colspan="1" %)
84 84  (((
85 -
289 +4.10 Beta 2
290 +)))|(% colspan="2" %)(% colspan="1" %)
291 +(((
292 +**FFI**: SetMacroMapPlayerSectorOffset() deprecated
86 86  )))
87 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
294 +|(% colspan="4" %)(% colspan="3" %)
88 88  (((
89 -//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.
90 -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).//
91 -
92 -//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
93 -//
296 +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.
297 +)))
298 +|(((
299 +UI extensions
300 +)))|(((
301 +4.10 Beta 2
302 +)))|(% colspan="2" %)(((
303 +**FFI**: FilterComponentForMapMode() and SetMapObjectFilter() changed
304 +)))
305 +|(% colspan="4" %)(% colspan="3" %)
306 +(((
307 +These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.
308 +)))
309 +|(((
310 +Scripts
311 +)))|(((
312 +4.10 Beta 1
313 +)))|(% colspan="2" %)(((
314 +People related attributes of mission** <delivery> **node moved
315 +)))
316 +|(% colspan="4" %)(% colspan="3" %)
317 +(((
318 +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.
319 +)))
320 +|(% colspan="1" %)(% colspan="1" %)
321 +(((
322 +Scripts
94 94  )))|(% colspan="1" %)(% colspan="1" %)
95 95  (((
96 -
325 +4.10 Beta 1
326 +)))|(% colspan="2" %)(% colspan="1" %)
327 +(((
328 +**$destructible.productions** replaced with $defensible.productions
97 97  )))
330 +|(% colspan="4" %)(% colspan="3" %)
331 +(((
332 +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.
333 +)))
334 +|(((
335 +Scripts
336 +)))|(((
337 +4.10 Beta 1
338 +)))|(% colspan="2" %)(((
339 +Removed script property **$object.spawnsourceseed**
340 +)))
341 +|(% colspan="4" %)(% colspan="3" %)
342 +(((
343 +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.
344 +)))
345 +
346 +----
347 +
348 +=== Version 4.00 ===
349 +
350 +(% class="table-striped" %)
98 98  |(% colspan="1" %)(% colspan="1" %)
99 99  (((
100 100  UI core
101 101  )))|(% colspan="1" %)(% colspan="1" %)
102 102  (((
103 -4.00 Beta 5
104 -)))|(% colspan="1" %)(% colspan="1" %)
356 +4.00 Beta 10
357 +)))|(% colspan="2" %)(% colspan="1" %)
105 105  (((
106 -**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed
359 +Controlled ship can change without a **gameplanchange-event** occurring.
360 +)))
361 +|(% colspan="4" %)(% colspan="3" %)
362 +(((
363 +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).
364 +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.
365 +)))
366 +|(((
367 +Scripts
368 +)))|(((
369 +4.00 Beta 7
370 +)))|(% colspan="2" %)(((
371 +Parameters of **<event_terraforming_project_succeeded>** and **<event_terraforming_project_failed>** changed
372 +)))
373 +|(% colspan="4" %)(% colspan="3" %)
374 +(((
375 +Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
376 +New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
377 +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
378 +)))
379 +|(% colspan="1" %)(% colspan="1" %)
380 +(((
381 +UI core
107 107  )))|(% colspan="1" %)(% colspan="1" %)
108 108  (((
109 -
384 +4.00 Beta 6
385 +)))|(% colspan="2" %)(% colspan="1" %)
386 +(((
387 +**FFI:** GetFactionRelationStatus() handling for faction relation range [-20,-10] changed
110 110  )))
111 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
389 +|(% colspan="4" %)(% colspan="3" %)
112 112  (((
113 -//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.//
391 +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.
392 +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).
114 114  
115 -//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 +If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
395 +)))
396 +|(% colspan="1" %)(% colspan="1" %)
397 +(((
398 +UI core
116 116  )))|(% colspan="1" %)(% colspan="1" %)
117 117  (((
118 -
401 +4.00 Beta 5
402 +)))|(% colspan="2" %)(% colspan="1" %)
403 +(((
404 +**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed
119 119  )))
406 +|(% colspan="4" %)(% colspan="3" %)
407 +(((
408 +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.
409 +
410 +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).
411 +)))
120 120  |(((
121 121  Parameters
122 122  )))|(((
123 123  4.00 Beta 1
124 -)))|(((
416 +)))|(% colspan="2" %)(((
125 125  **requiresconstructionvessel** parameter moved
126 -)))|(((
127 -
128 128  )))
129 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
419 +|(% colspan="4" %)(% colspan="3" %)
130 130  (((
131 -//The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.//
421 +The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.
132 132  )))
133 133  |(((
134 134  Scripts
135 135  )))|(((
136 136  4.00 Beta 1
137 -)))|(((
427 +)))|(% colspan="2" %)(((
138 138  Changed behaviour of **gatedistance** script property
139 -)))|(((
140 -
141 141  )))
142 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
430 +|(% colspan="4" %)(% colspan="3" %)
143 143  (((
144 -//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.//
145 -)))|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
146 -(((
147 -
432 +The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.
148 148  )))
149 -|(% colspan="4" %)(% colspan="4" %)
150 -(((
151 -== 3.30 ==
152 -)))
434 +
435 +----
436 +
437 +=== Version 3.30 ===
438 +
439 +(% class="table-striped" %)
153 153  |(((
154 154  UI extensions
155 155  )))|(((
156 156  3.30 Beta 3
157 -)))|(((
158 -**FFI: **Removed** (% style="color: rgb(0,0,0);" %)GetMissionLimit() (%%)**(% style="color: rgb(0,0,0);" %)and** **(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)**IsMissionLimit**(%%)**Enabled()**
159 -)))|(% colspan="1" %)(% colspan="1" %)
160 -(((
161 -
444 +)))|(% colspan="2" %)(((
445 +**FFI: **Removed** GetMissionLimit() **and** IsMissionLimitEnabled()**
162 162  )))
163 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
447 +|(% colspan="7" %)(% colspan="3" %)
164 164  (((
165 -//These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI (% style="color: rgb(0,0,0);" %)IsMissionLimit(%%)Reach(% style="color: rgb(0,0,0);" %)ed()//
449 +These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()
166 166  )))
167 -|(% colspan="4" %)(% colspan="4" %)
168 -(((
169 -== 3.20 ==
170 -)))
451 +
452 +----
453 +
454 +=== Version 3.20 ===
455 +
456 +(% class="table-striped" %)
171 171  |(((
172 172  Scripts
173 173  )))|(((
174 174  3.20 Beta 1
175 -)))|(((
461 +)))|(% colspan="2" %)(((
176 176  Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
177 -)))|(% colspan="1" %)(% colspan="1" %)
178 -(((
179 -
180 180  )))
181 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
464 +|(% colspan="4" %)(% colspan="3" %)
182 182  (((
183 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
184 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
185 -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 +Old params: param = attacked object, param2 = attack method, param3 = attacked component
467 +New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
468 +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
186 186  )))
187 187  |(% colspan="1" %)(% colspan="1" %)
188 188  (((
... ... @@ -190,35 +190,31 @@
190 190  )))|(% colspan="1" %)(% colspan="1" %)
191 191  (((
192 192  3.20 Beta 1
193 -)))|(% colspan="1" %)(% colspan="1" %)
476 +)))|(% colspan="2" %)(% colspan="1" %)
194 194  (((
195 195  Removed script property $trade.**restriction.faction**
196 -)))|(% colspan="1" %)(% colspan="1" %)
197 -(((
198 -
199 199  )))
200 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
480 +|(% colspan="4" %)(% colspan="3" %)
201 201  (((
202 -//$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.//
482 +$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.
203 203  )))
204 204  |(((
205 205  UI extensions
206 206  )))|(((
207 207  3.20 Beta 1
208 -)))|(((
488 +)))|(% colspan="2" %)(((
209 209  **Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
210 -)))|(% colspan="1" %)(% colspan="1" %)
211 -(((
212 -
213 213  )))
214 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
491 +|(% colspan="4" %)(% colspan="3" %)
215 215  (((
216 -//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.//
493 +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.
217 217  )))
218 -|(% colspan="4" %)(% colspan="4" %)
219 -(((
220 -== 3.10 ==
221 -)))
495 +
496 +----
497 +
498 +=== Version 3.10 ===
499 +
500 +(% class="table-striped" %)
222 222  |(% colspan="1" %)(% colspan="1" %)
223 223  (((
224 224  Scripts
... ... @@ -225,21 +225,20 @@
225 225  )))|(% colspan="1" %)(% colspan="1" %)
226 226  (((
227 227  3.10 Beta 1
228 -)))|(% colspan="1" %)(% colspan="1" %)
507 +)))|(% colspan="2" %)(% colspan="1" %)
229 229  (((
230 230  Removed script action **<add_build/>**
231 -)))|(% colspan="1" %)(% colspan="1" %)
232 -(((
233 -
234 234  )))
235 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
511 +|(% colspan="7" %)(% colspan="3" %)
236 236  (((
237 -//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.//
513 +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.
238 238  )))
239 -|(% colspan="4" %)(% colspan="4" %)
240 -(((
241 -== 3.00 ==
242 -)))
515 +
516 +----
517 +
518 +=== Version 3.00 ===
519 +
520 +(% class="table-striped" %)
243 243  |(% colspan="1" %)(% colspan="1" %)
244 244  (((
245 245  Scripts
... ... @@ -246,16 +246,13 @@
246 246  )))|(% colspan="1" %)(% colspan="1" %)
247 247  (((
248 248  3.0 Beta 6
249 -)))|(% colspan="1" %)(% colspan="1" %)
527 +)))|(% colspan="2" %)(% colspan="1" %)
250 250  (((
251 251  Changed behaviour of script action **<get_suitable_job/>**
252 -)))|(% colspan="1" %)(% colspan="1" %)
253 -(((
254 -
255 255  )))
256 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
531 +|(% colspan="4" %)(% colspan="3" %)
257 257  (((
258 -//<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.//
533 +<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.
259 259  )))
260 260  |(% colspan="1" %)(% colspan="1" %)
261 261  (((
... ... @@ -263,16 +263,13 @@
263 263  )))|(% colspan="1" %)(% colspan="1" %)
264 264  (((
265 265  3.0 Beta 6
266 -)))|(% colspan="1" %)(% colspan="1" %)
541 +)))|(% colspan="2" %)(% colspan="1" %)
267 267  (((
268 268  Changed behaviour of script action **<get_ware_definition/>**
269 -)))|(% colspan="1" %)(% colspan="1" %)
270 -(((
271 -
272 272  )))
273 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
545 +|(% colspan="4" %)(% colspan="3" %)
274 274  (((
275 -//<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.//
547 +<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.
276 276  )))
277 277  |(% colspan="1" %)(% colspan="1" %)
278 278  (((
... ... @@ -280,18 +280,15 @@
280 280  )))|(% colspan="1" %)(% colspan="1" %)
281 281  (((
282 282  3.0 Beta 5
283 -)))|(% colspan="1" %)(% colspan="1" %)
555 +)))|(% colspan="2" %)(% colspan="1" %)
284 284  (((
285 285  Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
286 -)))|(% colspan="1" %)(% colspan="1" %)
287 -(((
288 -
289 289  )))
290 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
559 +|(% colspan="4" %)(% colspan="3" %)
291 291  (((
292 -//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.)\\
561 +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.)
293 293  
294 -//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).//
563 +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).
295 295  )))
296 296  |(% colspan="1" %)(% colspan="1" %)
297 297  (((
... ... @@ -299,16 +299,13 @@
299 299  )))|(% colspan="1" %)(% colspan="1" %)
300 300  (((
301 301  3.0 Beta 5
302 -)))|(% colspan="1" %)(% colspan="1" %)
571 +)))|(% colspan="2" %)(% colspan="1" %)
303 303  (((
304 304  Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
305 -)))|(% colspan="1" %)(% colspan="1" %)
306 -(((
307 -
308 308  )))
309 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
575 +|(% colspan="4" %)(% colspan="3" %)
310 310  (((
311 -//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.//
577 +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.
312 312  )))
313 313  |(% colspan="1" %)(% colspan="1" %)
314 314  (((
... ... @@ -316,17 +316,14 @@
316 316  )))|(% colspan="1" %)(% colspan="1" %)
317 317  (((
318 318  3.0 Beta 5
319 -)))|(% colspan="1" %)(% colspan="1" %)
585 +)))|(% colspan="2" %)(% colspan="1" %)
320 320  (((
321 321  Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
322 -)))|(% colspan="1" %)(% colspan="1" %)
323 -(((
324 -
325 325  )))
326 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
589 +|(% colspan="4" %)(% colspan="3" %)
327 327  (((
328 -//Before the change, positions are relative to $dockingbay.parent.
329 -After the change, positions are relative to $dockingbay as specified in the documentation.//
591 +Before the change, positions are relative to $dockingbay.parent.
592 +After the change, positions are relative to $dockingbay as specified in the documentation.
330 330  )))
331 331  |(% colspan="1" %)(% colspan="1" %)
332 332  (((
... ... @@ -334,30 +334,24 @@
334 334  )))|(% colspan="1" %)(% colspan="1" %)
335 335  (((
336 336  3.0 Beta 2
337 -)))|(% colspan="1" %)(% colspan="1" %)
600 +)))|(% colspan="2" %)(% colspan="1" %)
338 338  (((
339 339  Support for entity flag "**skillsvisible**" dropped
340 -)))|(% colspan="1" %)(% colspan="1" %)
341 -(((
342 -
343 343  )))
344 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
604 +|(% colspan="4" %)(% colspan="3" %)
345 345  (((
346 -//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().//
606 +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().
347 347  )))
348 348  |(((
349 349  Scripts
350 350  )))|(((
351 351  3.0 Beta 2
352 -)))|(((
612 +)))|(% colspan="2" %)(((
353 353  Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
354 -)))|(% colspan="1" %)(% colspan="1" %)
355 -(((
356 -
357 357  )))
358 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
615 +|(% colspan="4" %)(% colspan="3" %)
359 359  (((
360 -//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.
617 +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.
361 361  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.
362 362  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.
363 363  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).
... ... @@ -368,30 +368,24 @@
368 368  )))|(% colspan="1" %)(% colspan="1" %)
369 369  (((
370 370  3.0 Beta 1
371 -)))|(% colspan="1" %)(% colspan="1" %)
628 +)))|(% colspan="2" %)(% colspan="1" %)
372 372  (((
373 373  **MissionBoard** support dropped
374 -)))|(% colspan="1" %)(% colspan="1" %)
375 -(((
376 -
377 377  )))
378 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
632 +|(% colspan="4" %)(% colspan="3" %)
379 379  (((
380 -//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.//
634 +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.
381 381  )))
382 382  |(((
383 383  Job/God
384 384  )))|(((
385 385  3.0 Beta 1
386 -)))|(((
640 +)))|(% colspan="2" %)(((
387 387  By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
388 -)))|(% colspan="1" %)(% colspan="1" %)
389 -(((
390 -
391 391  )))
392 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
643 +|(% colspan="4" %)(% colspan="3" %)
393 393  (((
394 -//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.//
645 +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.
395 395  )))
396 396  |(% colspan="1" %)(% colspan="1" %)
397 397  (((
... ... @@ -399,16 +399,13 @@
399 399  )))|(% colspan="1" %)(% colspan="1" %)
400 400  (((
401 401  3.0 Beta 1
402 -)))|(% colspan="1" %)(% colspan="1" %)
653 +)))|(% colspan="2" %)(% colspan="1" %)
403 403  (((
404 404  Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
405 -)))|(% colspan="1" %)(% colspan="1" %)
406 -(((
407 -
408 408  )))
409 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
657 +|(% colspan="4" %)(% colspan="3" %)
410 410  (((
411 -//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.//
659 +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.
412 412  )))
413 413  |(% colspan="1" %)(% colspan="1" %)
414 414  (((
... ... @@ -416,16 +416,13 @@
416 416  )))|(% colspan="1" %)(% colspan="1" %)
417 417  (((
418 418  3.0 Beta 1
419 -)))|(% colspan="1" %)(% colspan="1" %)
667 +)))|(% colspan="2" %)(% colspan="1" %)
420 420  (((
421 421  Script action **<set_doors_locked/>** attribute **'group'** changed
422 -)))|(% colspan="1" %)(% colspan="1" %)
423 -(((
424 -
425 425  )))
426 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
671 +|(% colspan="4" %)(% colspan="3" %)
427 427  (((
428 -//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.//
673 +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.
429 429  )))
430 430  |(% colspan="1" %)(% colspan="1" %)
431 431  (((
... ... @@ -433,16 +433,13 @@
433 433  )))|(% colspan="1" %)(% colspan="1" %)
434 434  (((
435 435  3.0 Beta 1
436 -)))|(% colspan="1" %)(% colspan="1" %)
681 +)))|(% colspan="2" %)(% colspan="1" %)
437 437  (((
438 438  Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
439 -)))|(% colspan="1" %)(% colspan="1" %)
440 -(((
441 -
442 442  )))
443 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
685 +|(% colspan="4" %)(% colspan="3" %)
444 444  (((
445 -//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.//
687 +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.
446 446  )))
447 447  |(% colspan="1" %)(% colspan="1" %)
448 448  (((
... ... @@ -450,16 +450,13 @@
450 450  )))|(% colspan="1" %)(% colspan="1" %)
451 451  (((
452 452  3.0 Beta 1
453 -)))|(% colspan="1" %)(% colspan="1" %)
695 +)))|(% colspan="2" %)(% colspan="1" %)
454 454  (((
455 455  Script actions **<set_hack_target/>** and **<abort_hack/>** removed
456 -)))|(% colspan="1" %)(% colspan="1" %)
457 -(((
458 -
459 459  )))
460 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
699 +|(% colspan="4" %)(% colspan="3" %)
461 461  (((
462 -//These actions had no effect and were removed.//
701 +These actions had no effect and were removed.
463 463  )))
464 464  |(% colspan="1" %)(% colspan="1" %)
465 465  (((
... ... @@ -467,16 +467,13 @@
467 467  )))|(% colspan="1" %)(% colspan="1" %)
468 468  (((
469 469  3.0 Beta 1
470 -)))|(% colspan="1" %)(% colspan="1" %)
709 +)))|(% colspan="2" %)(% colspan="1" %)
471 471  (((
472 472  **<setup_conversation_minigame/>** script action removed
473 -)))|(% colspan="1" %)(% colspan="1" %)
474 -(((
475 -
476 476  )))
477 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
713 +|(% colspan="4" %)(% colspan="3" %)
478 478  (((
479 -//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.//
715 +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.
480 480  )))
481 481  |(% colspan="1" %)(% colspan="1" %)
482 482  (((
... ... @@ -484,16 +484,13 @@
484 484  )))|(% colspan="1" %)(% colspan="1" %)
485 485  (((
486 486  3.0 Beta 1
487 -)))|(% colspan="1" %)(% colspan="1" %)
723 +)))|(% colspan="2" %)(% colspan="1" %)
488 488  (((
489 489  <add_player_choice_*> **confidence** attribute removed
490 -)))|(% colspan="1" %)(% colspan="1" %)
491 -(((
492 -
493 493  )))
494 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
727 +|(% colspan="4" %)(% colspan="3" %)
495 495  (((
496 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
729 +The default confidence of player options is another leftover from the XR era and had no effect in X4.
497 497  )))
498 498  |(% colspan="1" %)(% colspan="1" %)
499 499  (((
... ... @@ -501,16 +501,13 @@
501 501  )))|(% colspan="1" %)(% colspan="1" %)
502 502  (((
503 503  3.0 Beta 1
504 -)))|(% colspan="1" %)(% colspan="1" %)
737 +)))|(% colspan="2" %)(% colspan="1" %)
505 505  (((
506 506  **<hack_via_control_panel/>** script action removed
507 -)))|(% colspan="1" %)(% colspan="1" %)
508 -(((
509 -
510 510  )))
511 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
741 +|(% colspan="4" %)(% colspan="3" %)
512 512  (((
513 -//Unused script action <hack_via_control_panel/> was removed.//
743 +Unused script action <hack_via_control_panel/> was removed.
514 514  )))
515 515  |(% colspan="1" %)(% colspan="1" %)
516 516  (((
... ... @@ -518,30 +518,24 @@
518 518  )))|(% colspan="1" %)(% colspan="1" %)
519 519  (((
520 520  3.0 Beta 1
521 -)))|(% colspan="1" %)(% colspan="1" %)
751 +)))|(% colspan="2" %)(% colspan="1" %)
522 522  (((
523 523  **Lua: **GetMiniGameCursorPosition() removed
524 -)))|(% colspan="1" %)(% colspan="1" %)
525 -(((
526 -
527 527  )))
528 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
755 +|(% colspan="4" %)(% colspan="3" %)
529 529  (((
530 -//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.//
757 +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.
531 531  )))
532 532  |(((
533 533  UI core
534 534  )))|(((
535 535  3.0 Beta 1
536 -)))|(((
763 +)))|(% colspan="2" %)(((
537 537  **FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
538 -)))|(% colspan="1" %)(% colspan="1" %)
539 -(((
540 -
541 541  )))
542 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
766 +|(% colspan="4" %)(% colspan="3" %)
543 543  (((
544 -//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.//
768 +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.
545 545  )))
546 546  |(% colspan="1" %)(% colspan="1" %)
547 547  (((
... ... @@ -549,16 +549,13 @@
549 549  )))|(% colspan="1" %)(% colspan="1" %)
550 550  (((
551 551  3.0 Beta 1
552 -)))|(% colspan="1" %)(% colspan="1" %)
776 +)))|(% colspan="2" %)(% colspan="1" %)
553 553  (((
554 554  **FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
555 -)))|(% colspan="1" %)(% colspan="1" %)
556 -(((
557 -
558 558  )))
559 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
780 +|(% colspan="4" %)(% colspan="3" %)
560 560  (((
561 -//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.//
782 +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.
562 562  )))
563 563  |(% colspan="1" %)(% colspan="1" %)
564 564  (((
... ... @@ -566,17 +566,14 @@
566 566  )))|(% colspan="1" %)(% colspan="1" %)
567 567  (((
568 568  3.0 Beta 1
569 -)))|(% colspan="1" %)(% colspan="1" %)
790 +)))|(% colspan="2" %)(% colspan="1" %)
570 570  (((
571 571  **$ware.illegal** updated
572 -)))|(% colspan="1" %)(% colspan="1" %)
573 -(((
574 -
575 575  )))
576 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
794 +|(% colspan="4" %)(% colspan="3" %)
577 577  (((
578 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
579 -//It now returns true if $ware is illegal to any faction in the game.//
796 +$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
797 +It now returns true if $ware is illegal to any faction in the game.
580 580  )))
581 581  |(% colspan="1" %)(% colspan="1" %)
582 582  (((
... ... @@ -584,16 +584,13 @@
584 584  )))|(% colspan="1" %)(% colspan="1" %)
585 585  (((
586 586  3.0 Beta 1
587 -)))|(% colspan="1" %)(% colspan="1" %)
805 +)))|(% colspan="2" %)(% colspan="1" %)
588 588  (((
589 589  MD script **RML_Flight_Along_Path** removed
590 -)))|(% colspan="1" %)(% colspan="1" %)
591 -(((
592 -
593 593  )))
594 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
809 +|(% colspan="4" %)(% colspan="3" %)
595 595  (((
596 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
811 +The MD script RML_Flight_Along_Path was not referened and was removed.
597 597  )))
598 598  |(% colspan="1" %)(% colspan="1" %)
599 599  (((
... ... @@ -601,86 +601,75 @@
601 601  )))|(% colspan="1" %)(% colspan="1" %)
602 602  (((
603 603  3.0 Beta 1
604 -)))|(% colspan="1" %)(% colspan="1" %)
819 +)))|(% colspan="2" %)(% colspan="1" %)
605 605  (((
606 606  parameters of **<event_venture_mission_completed/>** changed
607 -)))|(% colspan="1" %)(% colspan="1" %)
608 -(((
609 -
610 610  )))
611 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
823 +|(% colspan="4" %)(% colspan="3" %)
612 612  (((
613 -//old params: param = venture details, param2 = ships involved, param3 = duration//
614 -//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
825 +old params: param = venture details, param2 = ships involved, param3 = duration
826 +new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration
615 615  )))
616 616  |(((
617 617  Scripts
618 618  )))|(((
619 619  3.0 Beta 1
620 -)))|(((
832 +)))|(% colspan="2" %)(((
621 621  **<set_object_wing_name/>** removed,
622 622  **<set_object_fleet_name/>** added
623 -)))|(% colspan="1" %)(% colspan="1" %)
624 -(((
625 -
626 626  )))
627 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
836 +|(% colspan="4" %)(% colspan="3" %)
628 628  (((
629 -//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
838 +The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>
630 630  )))
631 631  |(((
632 632  Scripts
633 633  )))|(((
634 634  3.0 Beta 1
635 -)))|(((
844 +)))|(% colspan="2" %)(((
636 636  **$controllable.wing.*** removed,
637 637  **$controllable.fleet.*** added
638 -)))|(% colspan="1" %)(% colspan="1" %)
639 -(((
640 -
641 641  )))
642 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
848 +|(% colspan="4" %)(% colspan="3" %)
643 643  (((
644 644  $controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
645 645  )))
646 -|(% colspan="4" %)(% colspan="4" %)
647 -(((
648 -== 2.60 ==
649 -)))
852 +
853 +----
854 +
855 +=== Version 2.60 ===
856 +
857 +(% class="table-striped" %)
650 650  |(((
651 651  Scripts
652 652  )))|(((
653 653  2.60 Beta 1
654 -)))|(((
862 +)))|(% colspan="2" %)(((
655 655  '**checkoperational**' filter behaviour changed
656 -)))|(% colspan="1" %)(% colspan="1" %)
657 -(((
658 -
659 659  )))
660 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
865 +|(% colspan="10" %)(% colspan="3" %)
661 661  (((
662 -//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.//
867 +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.
663 663  
664 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
869 +Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.
665 665  )))
666 666  |(((
667 667  Scripts
668 668  )))|(((
669 669  2.60 Beta 1
670 -)))|(((
875 +)))|(% colspan="2" %)(((
671 671  $container.**supplyresources** behavior changed
672 -)))|(% colspan="1" %)(% colspan="1" %)
877 +)))| | |
878 +|(% colspan="10" %)(% colspan="3" %)
673 673  (((
674 -
880 +The script keyword $container.supplyresources now includes reserved wares.
675 675  )))
676 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
677 -(((
678 -//The script keyword $container.supplyresources now includes reserved wares.//
679 -)))
680 -|(% colspan="4" %)(% colspan="4" %)
681 -(((
682 -== 2.20 ==
683 -)))
882 +
883 +----
884 +
885 +=== Version 2.20 ===
886 +
887 +(% class="table-striped" %)
684 684  |(% colspan="1" %)(% colspan="1" %)
685 685  (((
686 686  UI core
... ... @@ -687,20 +687,16 @@
687 687  )))|(% colspan="1" %)(% colspan="1" %)
688 688  (((
689 689  2.20 Beta 3/4
690 -)))|(% colspan="1" %)(% colspan="1" %)
894 +)))|(% colspan="2" %)(% colspan="1" %)
691 691  (((
692 692  **Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
693 -)))|(% colspan="1" %)(% colspan="1" %)
694 -(((
695 -
696 696  )))
697 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
898 +|(% colspan="4" %)(% colspan="3" %)
698 698  (((
699 -//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.
700 -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.//
900 +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.
901 +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.
701 701  
702 -//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.
703 -//
903 +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.
704 704  )))
705 705  |(% colspan="1" %)(% colspan="1" %)
706 706  (((
... ... @@ -708,21 +708,20 @@
708 708  )))|(% colspan="1" %)(% colspan="1" %)
709 709  (((
710 710  2.20 Beta 3
711 -)))|(% colspan="1" %)(% colspan="1" %)
911 +)))|(% colspan="2" %)(% colspan="1" %)
712 712  (((
713 713  Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
714 -)))|(% colspan="1" %)(% colspan="1" %)
715 -(((
716 -
717 717  )))
718 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
915 +|(% colspan="4" %)(% colspan="3" %)
719 719  (((
720 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
917 +The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.
721 721  )))
722 -|(% colspan="4" %)(% colspan="4" %)
723 -(((
724 -== 2.00 ==
725 -)))
919 +
920 +----
921 +
922 +=== Version 2.00 ===
923 +
924 +(% class="table-striped" %)
726 726  |(% colspan="1" %)(% colspan="1" %)
727 727  (((
728 728  Scripts
... ... @@ -729,16 +729,13 @@
729 729  )))|(% colspan="1" %)(% colspan="1" %)
730 730  (((
731 731  2.00 Beta 1
732 -)))|(% colspan="1" %)(% colspan="1" %)
931 +)))|(% colspan="2" %)(% colspan="1" %)
733 733  (((
734 734  **<event_build_finished/> **param2 now returns null instead of a construction sequence
735 -)))|(% colspan="1" %)(% colspan="1" %)
736 -(((
737 -
738 738  )))
739 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
935 +|(% colspan="4" %)(% colspan="3" %)
740 740  (((
741 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
937 +The construction sequence which was finished should now be accessed via the buildtask provided via param3.
742 742  )))
743 743  |(% colspan="1" %)(% colspan="1" %)
744 744  (((
... ... @@ -746,16 +746,13 @@
746 746  )))|(% colspan="1" %)(% colspan="1" %)
747 747  (((
748 748  2.00 Beta 1
749 -)))|(% colspan="1" %)(% colspan="1" %)
945 +)))|(% colspan="2" %)(% colspan="1" %)
750 750  (((
751 751  **param.boarding.{...}** strength parameters removed
752 -)))|(% colspan="1" %)(% colspan="1" %)
753 -(((
754 -
755 755  )))
756 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
949 +|(% colspan="4" %)(% colspan="3" %)
757 757  (((
758 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
951 +The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.
759 759  )))
760 760  |(% colspan="1" %)(% colspan="1" %)
761 761  (((
... ... @@ -763,197 +763,160 @@
763 763  )))|(% colspan="1" %)(% colspan="1" %)
764 764  (((
765 765  2.00 Beta 1
766 -)))|(% colspan="1" %)(% colspan="1" %)
959 +)))|(% colspan="2" %)(% colspan="1" %)
767 767  (((
768 768  **$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
769 -)))|(% colspan="1" %)(% colspan="1" %)
770 -(((
771 -
772 772  )))
773 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
963 +|(% colspan="4" %)(% colspan="3" %)
774 774  (((
775 -//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.//
965 +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.
776 776  )))
777 777  |(((
778 778  UI extensions
779 779  )))|(((
780 780  2.00 Beta 1
781 -)))|(((
971 +)))|(% colspan="2" %)(((
782 782  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
783 -)))|(% colspan="1" %)(% colspan="1" %)
784 -(((
785 -
786 786  )))
787 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
974 +|(% colspan="4" %)(% colspan="3" %)
788 788  (((
789 -//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.//
976 +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.
790 790  )))
791 791  |(((
792 792  UI extensions
793 793  )))|(((
794 794  2.00 Beta 1
795 -)))|(((
982 +)))|(% colspan="2" %)(((
796 796  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
797 -)))|(% colspan="1" %)(% colspan="1" %)
798 -(((
799 -
800 800  )))
801 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
985 +|(% colspan="4" %)(% colspan="3" %)
802 802  (((
803 -//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.//
804 -//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.//
987 +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.
988 +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.
805 805  )))
806 806  |(((
807 807  Scripts
808 808  )))|(((
809 809  2.00 Beta 1
810 -)))|(((
994 +)))|(% colspan="2" %)(((
811 811  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
812 -)))|(% colspan="1" %)(% colspan="1" %)
813 -(((
814 -
815 815  )))
816 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
997 +|(% colspan="4" %)(% colspan="3" %)
817 817  (((
818 -//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.//
999 +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.
819 819  )))
820 820  |(((
821 821  Scripts
822 822  )))|(((
823 823  2.00 Beta 1
824 -)))|(((
1005 +)))|(% colspan="2" %)(((
825 825  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
826 -)))|(% colspan="1" %)(% colspan="1" %)
827 -(((
828 -
829 829  )))
830 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1008 +|(% colspan="4" %)(% colspan="3" %)
831 831  (((
832 -//For prior behavior, check for event.param being non-null.//
1010 +For prior behavior, check for event.param being non-null.
833 833  )))
834 834  |(((
835 835  AI Scripts
836 836  )))|(((
837 837  2.00 Beta 1
838 -)))|(((
1016 +)))|(% colspan="2" %)(((
839 839  **<shoot/>/<shoot_at/>** attribute changes.
840 -)))|(% colspan="1" %)(% colspan="1" %)
841 -(((
842 -
843 843  )))
844 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1019 +|(% colspan="4" %)(% colspan="3" %)
845 845  (((
846 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
847 -//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.//
848 -//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 +Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.
1022 +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.
1023 +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.
849 849  
850 -//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
1025 +Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.
851 851  )))
852 852  |(((
853 853  UI extensions
854 854  )))|(((
855 855  2.00 Beta 1
856 -)))|(((
857 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
858 -)))|(% colspan="1" %)(% colspan="1" %)
859 -(((
860 -
1031 +)))|(% colspan="2" %)(((
1032 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.
861 861  )))
862 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1034 +|(% colspan="4" %)(% colspan="3" %)
863 863  (((
864 -//Added possibility to query build tasks of a certain buildmodule.//
1036 +Added possibility to query build tasks of a certain buildmodule.
865 865  )))
866 866  |(((
867 867  UI extensions
868 868  )))|(((
869 869  2.00 Beta 1
870 -)))|(((
1042 +)))|(% colspan="2" %)(((
871 871  **Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
872 -)))|(% colspan="1" %)(% colspan="1" %)
873 -(((
874 -
875 875  )))
876 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1045 +|(% colspan="4" %)(% colspan="3" %)
877 877  (((
878 -//Added list of resources a buildmodule needs to build.//
1047 +Added list of resources a buildmodule needs to build.
879 879  )))
880 880  |(((
881 881  UI extensions
882 882  )))|(((
883 883  2.00 Beta 1
884 -)))|(((
885 -(% style="color: rgb(0,0,0);" %)**Lua:**(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)** CalculateTotalHullFraction()**(% style="color: rgb(0,0,0);" %)** **(%%)was removed.(% style="color: rgb(0,0,0);" %)
886 -)))|(% colspan="1" %)(% colspan="1" %)
887 -(((
888 -
1053 +)))|(% colspan="2" %)(((
1054 +**Lua: CalculateTotalHullFraction() **was removed.
889 889  )))
890 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1056 +|(% colspan="4" %)(% colspan="3" %)
891 891  (((
892 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
1058 +Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.
893 893  )))
894 894  |(((
895 895  UI extensions
896 896  )))|(((
897 897  2.00 Beta 1
898 -)))|(((
899 -**FFI: (% style="color: rgb(0,0,0);" %)RequestDockAtReason()/(% style="color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0); color: rgb(0, 0, 0)" %)UndockPlayerShip()(%%) **changed their return values.(% style="color: rgb(0,0,0);" class="confluenceTd" %)
900 -)))|(% colspan="1" %)(% colspan="1" %)
901 -(((
902 -
1064 +)))|(% colspan="2" %)(((
1065 +**FFI: RequestDockAtReason()/UndockPlayerShip() **changed their return values.
903 903  )))
904 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1067 +|(% colspan="4" %)(% colspan="3" %)
905 905  (((
906 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
1069 +Changed return value type to const char* to better identify failure reasons in Lua script.
907 907  )))
908 -|(% colspan="4" %)(% colspan="4" %)
909 -(((
910 -== 1.50 ==
911 -)))
1071 +
1072 +----
1073 +
1074 +=== Version 1.50 ===
1075 +
1076 +(% class="table-striped" %)
912 912  |(((
913 913  UI extensions
914 914  )))|(((
915 915  1.50 Beta 3
916 -)))|(((
917 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
918 -)))|(% colspan="1" %)(% colspan="1" %)
919 -(((
920 -
1081 +)))|(% colspan="2" %)(((
1082 +**Lua: GetComponentData() **changed behavior of "docksizes" property.
921 921  )))
922 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1084 +|(% colspan="4" %)(% colspan="3" %)
923 923  (((
924 -//The "docksizes" property no longer includes internal ship storage docks.//
1086 +The "docksizes" property no longer includes internal ship storage docks.
925 925  )))
926 926  |(((
927 927  All
928 928  )))|(((
929 929  1.50 Beta 2
930 -)))|(((
1092 +)))|(% colspan="2" %)(((
931 931  **Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
932 -)))|(% colspan="1" %)(% colspan="1" %)
933 -(((
934 -
935 935  )))
936 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1095 +|(% colspan="4" %)(% colspan="3" %)
937 937  (((
938 -//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".//
1097 +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".
939 939  
940 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
941 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
942 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
1099 +Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()
1100 +Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"
1101 +Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)
943 943  )))
944 944  |(((
945 945  UI extensions
946 946  )))|(((
947 947  1.50 Beta 2
948 -)))|(((
949 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
950 -)))|(% colspan="1" %)(% colspan="1" %)
951 -(((
952 -
1107 +)))|(% colspan="2" %)(((
1108 +**FFI: UpgradeGroupInfo **datatype was changed.
953 953  )))
954 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1110 +|(% colspan="4" %)(% colspan="3" %)
955 955  (((
956 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
1112 +Added new "operational" field to retrieve information about number of operational upgrades in a group.
957 957  )))
958 958  |(% colspan="1" %)(% colspan="1" %)
959 959  (((
... ... @@ -961,67 +961,58 @@
961 961  )))|(% colspan="1" %)(% colspan="1" %)
962 962  (((
963 963  1.50 Beta 1
964 -)))|(% colspan="1" %)(% colspan="1" %)
1120 +)))|(% colspan="2" %)(% colspan="1" %)
965 965  (((
966 966  **FFI: SetGuidance()** removed useinfopoint argument.
967 -)))|(% colspan="1" %)(% colspan="1" %)
968 -(((
969 -
970 970  )))
971 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1124 +|(% colspan="4" %)(% colspan="3" %)
972 972  (((
973 -//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.
974 -//
1126 +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.
975 975  
976 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1128 +The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)
977 977  )))
978 978  |(((
979 979  UI extensions
980 980  )))|(((
981 981  1.50 Beta 1
982 -)))|(((
983 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
984 -)))|(% colspan="1" %)(% colspan="1" %)
985 -(((
986 -
1134 +)))|(% colspan="2" %)(((
1135 +**FFI: CancelConstruction() **changed its return value.
987 987  )))
988 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1137 +|(% colspan="4" %)(% colspan="3" %)
989 989  (((
990 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
1139 +CancelConstruction() now returns if the cancellation was successful.
991 991  )))
992 -|(% colspan="4" %)(% colspan="4" %)
993 -(((
994 -== 1.32 ==
995 -)))
1141 +
1142 +----
1143 +
1144 +=== Version 1.32 ===
1145 +
1146 +(% class="table-striped" %)
996 996  |(((
997 997  UI extensions
998 998  )))|(((
999 999  1.32
1000 -)))|(((
1151 +)))|(% colspan="2" %)(((
1001 1001  **Lua: GetComponentData() **removed the "nextdestname" property.
1002 -)))|(% colspan="1" %)(% colspan="1" %)
1003 -(((
1004 -
1005 1005  )))
1006 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1154 +|(% colspan="4" %)(% colspan="3" %)
1007 1007  (((
1008 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
1156 +Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.
1009 1009  )))
1010 -|(% colspan="4" %)(% colspan="4" %)
1011 -(((
1012 -== 1.20 ==
1013 -)))
1158 +
1159 +----
1160 +
1161 +=== Version 1.20 ===
1162 +
1163 +(% class="table-striped" %)
1014 1014  |(((
1015 1015  UI extensions
1016 1016  )))|(((
1017 1017  1.20
1018 -)))|(((
1019 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
1020 -)))|(% colspan="1" %)(% colspan="1" %)
1021 -(((
1022 -
1168 +)))|(% colspan="2" %)(((
1169 +**FFI: GetAAOption()** got a new "useconfig" parameter.
1023 1023  )))
1024 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1171 +|(% colspan="4" %)(% colspan="3" %)
1025 1025  (((
1026 -//The AA setting was changed to check the new setting with the user. In order to restore the old setting (% style="color: rgb(0,0,0);" %)GetAAOption() gets the option to retrieve the config settings.//
1173 +//The AA setting was changed to check the new setting with the user. In order to restore the old setting GetAAOption() gets the option to retrieve the config settings.//
1027 1027  )))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,0 @@
1 -101909300
space
... ... @@ -1,1 +1,0 @@
1 -X4WIKI
url
... ... @@ -1,1 +1,0 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/101909300/Breaking Changes