Changes for page Breaking Changes

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

From version 82.1
edited by owen
on 2021/04/26 13:58
Change comment: There is no comment for this version
To version 124.30
edited by Klaus Meyer
on 2025/01/07 16:59
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.owen
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,189 +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 instead of rounding down
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 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. 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.10 ==
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" %)
35 35  |(((
36 -Scripts
96 +Libraries
37 37  )))|(((
38 -4.10 Beta 1
39 -)))|(((
40 -Removed script property $object.spawnsourceseed
41 -)))|(((
42 -
98 +6.00 Beta 7
99 +)))|(% colspan="2" %)(((
100 +Updated weights for ship groups in shipgroups.xml libraries of base game and all DLCs.
43 43  )))
44 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
102 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
45 45  (((
46 -The spawnsource seed is no longer directly accessable 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 return a result that differs between objects of the same macro, meaning it can now reliably be used for player property or job ships.
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.
47 47  )))
48 -|(% colspan="4" %)(% colspan="4" %)
108 +|(% colspan="1" %)(% colspan="1" %)
49 49  (((
50 -== 4.00 ==
110 +Scripts
111 +)))|(% colspan="1" %)(% colspan="1" %)
112 +(((
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.
51 51  )))
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 +)))
52 52  |(% colspan="1" %)(% colspan="1" %)
53 53  (((
54 -UI core
126 +Scripts
55 55  )))|(% colspan="1" %)(% colspan="1" %)
56 56  (((
57 -4.00 Beta 10
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
58 58  )))|(% colspan="1" %)(% colspan="1" %)
59 59  (((
60 -Controlled ship can change without a **gameplanchange-event** occurring.
147 +6.00 Beta 1
148 +)))|(% colspan="2" %)(% colspan="1" %)
149 +(((
150 +Behaviour change for **<match_dock>** script component filter
151 +)))
152 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
153 +(((
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
61 61  )))|(% colspan="1" %)(% colspan="1" %)
62 62  (((
63 -
162 +6.00 Beta 1
163 +)))|(% colspan="2" %)(% colspan="1" %)
164 +(((
165 +Changed result attribute location for **<get_attackstrength>**
64 64  )))
65 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
167 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
66 66  (((
67 -//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).
68 -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.
69 -//
169 +The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.
170 +)))
171 +|(((
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 +(((
185 +Scripts
70 70  )))|(% colspan="1" %)(% colspan="1" %)
71 71  (((
72 -
188 +6.00 Beta 1
189 +)))|(% colspan="2" %)(% colspan="1" %)
190 +(((
191 +Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
73 73  )))
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 +)))
74 74  |(((
75 75  Scripts
76 76  )))|(((
77 -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
78 78  )))|(((
79 -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
80 80  )))|(((
81 -
228 +5.00 Beta 1
229 +)))|(% colspan="2" %)(((
230 +**<controlpanel><entry>: minduration** removed, **maxduration** renamed to duration
82 82  )))
83 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
232 +|(% colspan="7" %)(% colspan="3" %)
84 84  (((
85 -//Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
86 -New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
87 -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//
88 -)))|(% 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" %)
89 89  (((
90 -
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
91 91  )))
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 +)))
92 92  |(% colspan="1" %)(% colspan="1" %)
93 93  (((
94 -UI core
258 +UI extensions
95 95  )))|(% colspan="1" %)(% colspan="1" %)
96 96  (((
97 -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
98 98  )))|(% colspan="1" %)(% colspan="1" %)
99 99  (((
100 -**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
101 101  )))|(% colspan="1" %)(% colspan="1" %)
102 102  (((
103 -
289 +4.10 Beta 2
290 +)))|(% colspan="2" %)(% colspan="1" %)
291 +(((
292 +**FFI**: SetMacroMapPlayerSectorOffset() deprecated
104 104  )))
105 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
294 +|(% colspan="4" %)(% colspan="3" %)
106 106  (((
107 -//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.
108 -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).//
109 -
110 -//If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
111 -//
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
112 112  )))|(% colspan="1" %)(% colspan="1" %)
113 113  (((
114 -
325 +4.10 Beta 1
326 +)))|(% colspan="2" %)(% colspan="1" %)
327 +(((
328 +**$destructible.productions** replaced with $defensible.productions
115 115  )))
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" %)
116 116  |(% colspan="1" %)(% colspan="1" %)
117 117  (((
118 118  UI core
119 119  )))|(% colspan="1" %)(% colspan="1" %)
120 120  (((
121 -4.00 Beta 5
122 -)))|(% colspan="1" %)(% colspan="1" %)
356 +4.00 Beta 10
357 +)))|(% colspan="2" %)(% colspan="1" %)
123 123  (((
124 -**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
125 125  )))|(% colspan="1" %)(% colspan="1" %)
126 126  (((
127 -
384 +4.00 Beta 6
385 +)))|(% colspan="2" %)(% colspan="1" %)
386 +(((
387 +**FFI:** GetFactionRelationStatus() handling for faction relation range [-20,-10] changed
128 128  )))
129 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
389 +|(% colspan="4" %)(% colspan="3" %)
130 130  (((
131 -//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).
132 132  
133 -//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
134 134  )))|(% colspan="1" %)(% colspan="1" %)
135 135  (((
136 -
401 +4.00 Beta 5
402 +)))|(% colspan="2" %)(% colspan="1" %)
403 +(((
404 +**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed
137 137  )))
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 +)))
138 138  |(((
139 139  Parameters
140 140  )))|(((
141 141  4.00 Beta 1
142 -)))|(((
416 +)))|(% colspan="2" %)(((
143 143  **requiresconstructionvessel** parameter moved
144 -)))|(((
145 -
146 146  )))
147 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
419 +|(% colspan="4" %)(% colspan="3" %)
148 148  (((
149 -//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.
150 150  )))
151 151  |(((
152 152  Scripts
153 153  )))|(((
154 154  4.00 Beta 1
155 -)))|(((
427 +)))|(% colspan="2" %)(((
156 156  Changed behaviour of **gatedistance** script property
157 -)))|(((
158 -
159 159  )))
160 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
430 +|(% colspan="4" %)(% colspan="3" %)
161 161  (((
162 -//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.//
163 -)))|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
164 -(((
165 -
432 +The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.
166 166  )))
167 -|(% colspan="4" %)(% colspan="4" %)
168 -(((
169 -== 3.30 ==
170 -)))
434 +
435 +----
436 +
437 +=== Version 3.30 ===
438 +
439 +(% class="table-striped" %)
171 171  |(((
172 172  UI extensions
173 173  )))|(((
174 174  3.30 Beta 3
175 -)))|(((
176 -**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()**
177 -)))|(% colspan="1" %)(% colspan="1" %)
178 -(((
179 -
444 +)))|(% colspan="2" %)(((
445 +**FFI: **Removed** GetMissionLimit() **and** IsMissionLimitEnabled()**
180 180  )))
181 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
447 +|(% colspan="7" %)(% colspan="3" %)
182 182  (((
183 -//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()
184 184  )))
185 -|(% colspan="4" %)(% colspan="4" %)
186 -(((
187 -== 3.20 ==
188 -)))
451 +
452 +----
453 +
454 +=== Version 3.20 ===
455 +
456 +(% class="table-striped" %)
189 189  |(((
190 190  Scripts
191 191  )))|(((
192 192  3.20 Beta 1
193 -)))|(((
461 +)))|(% colspan="2" %)(((
194 194  Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
195 -)))|(% colspan="1" %)(% colspan="1" %)
196 -(((
197 -
198 198  )))
199 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
464 +|(% colspan="4" %)(% colspan="3" %)
200 200  (((
201 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
202 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
203 -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
204 204  )))
205 205  |(% colspan="1" %)(% colspan="1" %)
206 206  (((
... ... @@ -208,35 +208,31 @@
208 208  )))|(% colspan="1" %)(% colspan="1" %)
209 209  (((
210 210  3.20 Beta 1
211 -)))|(% colspan="1" %)(% colspan="1" %)
476 +)))|(% colspan="2" %)(% colspan="1" %)
212 212  (((
213 213  Removed script property $trade.**restriction.faction**
214 -)))|(% colspan="1" %)(% colspan="1" %)
215 -(((
216 -
217 217  )))
218 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
480 +|(% colspan="4" %)(% colspan="3" %)
219 219  (((
220 -//$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.
221 221  )))
222 222  |(((
223 223  UI extensions
224 224  )))|(((
225 225  3.20 Beta 1
226 -)))|(((
488 +)))|(% colspan="2" %)(((
227 227  **Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
228 -)))|(% colspan="1" %)(% colspan="1" %)
229 -(((
230 -
231 231  )))
232 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
491 +|(% colspan="4" %)(% colspan="3" %)
233 233  (((
234 -//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.
235 235  )))
236 -|(% colspan="4" %)(% colspan="4" %)
237 -(((
238 -== 3.10 ==
239 -)))
495 +
496 +----
497 +
498 +=== Version 3.10 ===
499 +
500 +(% class="table-striped" %)
240 240  |(% colspan="1" %)(% colspan="1" %)
241 241  (((
242 242  Scripts
... ... @@ -243,21 +243,20 @@
243 243  )))|(% colspan="1" %)(% colspan="1" %)
244 244  (((
245 245  3.10 Beta 1
246 -)))|(% colspan="1" %)(% colspan="1" %)
507 +)))|(% colspan="2" %)(% colspan="1" %)
247 247  (((
248 248  Removed script action **<add_build/>**
249 -)))|(% colspan="1" %)(% colspan="1" %)
250 -(((
251 -
252 252  )))
253 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
511 +|(% colspan="7" %)(% colspan="3" %)
254 254  (((
255 -//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.
256 256  )))
257 -|(% colspan="4" %)(% colspan="4" %)
258 -(((
259 -== 3.00 ==
260 -)))
515 +
516 +----
517 +
518 +=== Version 3.00 ===
519 +
520 +(% class="table-striped" %)
261 261  |(% colspan="1" %)(% colspan="1" %)
262 262  (((
263 263  Scripts
... ... @@ -264,16 +264,13 @@
264 264  )))|(% colspan="1" %)(% colspan="1" %)
265 265  (((
266 266  3.0 Beta 6
267 -)))|(% colspan="1" %)(% colspan="1" %)
527 +)))|(% colspan="2" %)(% colspan="1" %)
268 268  (((
269 269  Changed behaviour of script action **<get_suitable_job/>**
270 -)))|(% colspan="1" %)(% colspan="1" %)
271 -(((
272 -
273 273  )))
274 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
531 +|(% colspan="4" %)(% colspan="3" %)
275 275  (((
276 -//<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.
277 277  )))
278 278  |(% colspan="1" %)(% colspan="1" %)
279 279  (((
... ... @@ -281,16 +281,13 @@
281 281  )))|(% colspan="1" %)(% colspan="1" %)
282 282  (((
283 283  3.0 Beta 6
284 -)))|(% colspan="1" %)(% colspan="1" %)
541 +)))|(% colspan="2" %)(% colspan="1" %)
285 285  (((
286 286  Changed behaviour of script action **<get_ware_definition/>**
287 -)))|(% colspan="1" %)(% colspan="1" %)
288 -(((
289 -
290 290  )))
291 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
545 +|(% colspan="4" %)(% colspan="3" %)
292 292  (((
293 -//<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.
294 294  )))
295 295  |(% colspan="1" %)(% colspan="1" %)
296 296  (((
... ... @@ -298,18 +298,15 @@
298 298  )))|(% colspan="1" %)(% colspan="1" %)
299 299  (((
300 300  3.0 Beta 5
301 -)))|(% colspan="1" %)(% colspan="1" %)
555 +)))|(% colspan="2" %)(% colspan="1" %)
302 302  (((
303 303  Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
304 -)))|(% colspan="1" %)(% colspan="1" %)
305 -(((
306 -
307 307  )))
308 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
559 +|(% colspan="4" %)(% colspan="3" %)
309 309  (((
310 -//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.)
311 311  
312 -//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).
313 313  )))
314 314  |(% colspan="1" %)(% colspan="1" %)
315 315  (((
... ... @@ -317,16 +317,13 @@
317 317  )))|(% colspan="1" %)(% colspan="1" %)
318 318  (((
319 319  3.0 Beta 5
320 -)))|(% colspan="1" %)(% colspan="1" %)
571 +)))|(% colspan="2" %)(% colspan="1" %)
321 321  (((
322 322  Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
323 -)))|(% colspan="1" %)(% colspan="1" %)
324 -(((
325 -
326 326  )))
327 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
575 +|(% colspan="4" %)(% colspan="3" %)
328 328  (((
329 -//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.
330 330  )))
331 331  |(% colspan="1" %)(% colspan="1" %)
332 332  (((
... ... @@ -334,17 +334,14 @@
334 334  )))|(% colspan="1" %)(% colspan="1" %)
335 335  (((
336 336  3.0 Beta 5
337 -)))|(% colspan="1" %)(% colspan="1" %)
585 +)))|(% colspan="2" %)(% colspan="1" %)
338 338  (((
339 339  Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
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" %)
589 +|(% colspan="4" %)(% colspan="3" %)
345 345  (((
346 -//Before the change, positions are relative to $dockingbay.parent.
347 -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.
348 348  )))
349 349  |(% colspan="1" %)(% colspan="1" %)
350 350  (((
... ... @@ -352,30 +352,24 @@
352 352  )))|(% colspan="1" %)(% colspan="1" %)
353 353  (((
354 354  3.0 Beta 2
355 -)))|(% colspan="1" %)(% colspan="1" %)
600 +)))|(% colspan="2" %)(% colspan="1" %)
356 356  (((
357 357  Support for entity flag "**skillsvisible**" dropped
358 -)))|(% colspan="1" %)(% colspan="1" %)
359 -(((
360 -
361 361  )))
362 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
604 +|(% colspan="4" %)(% colspan="3" %)
363 363  (((
364 -//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().
365 365  )))
366 366  |(((
367 367  Scripts
368 368  )))|(((
369 369  3.0 Beta 2
370 -)))|(((
612 +)))|(% colspan="2" %)(((
371 371  Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
372 -)))|(% colspan="1" %)(% colspan="1" %)
373 -(((
374 -
375 375  )))
376 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
615 +|(% colspan="4" %)(% colspan="3" %)
377 377  (((
378 -//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.
379 379  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.
380 380  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.
381 381  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).
... ... @@ -386,30 +386,24 @@
386 386  )))|(% colspan="1" %)(% colspan="1" %)
387 387  (((
388 388  3.0 Beta 1
389 -)))|(% colspan="1" %)(% colspan="1" %)
628 +)))|(% colspan="2" %)(% colspan="1" %)
390 390  (((
391 391  **MissionBoard** support dropped
392 -)))|(% colspan="1" %)(% colspan="1" %)
393 -(((
394 -
395 395  )))
396 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
632 +|(% colspan="4" %)(% colspan="3" %)
397 397  (((
398 -//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.
399 399  )))
400 400  |(((
401 401  Job/God
402 402  )))|(((
403 403  3.0 Beta 1
404 -)))|(((
640 +)))|(% colspan="2" %)(((
405 405  By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
406 -)))|(% colspan="1" %)(% colspan="1" %)
407 -(((
408 -
409 409  )))
410 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
643 +|(% colspan="4" %)(% colspan="3" %)
411 411  (((
412 -//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.
413 413  )))
414 414  |(% colspan="1" %)(% colspan="1" %)
415 415  (((
... ... @@ -417,16 +417,13 @@
417 417  )))|(% colspan="1" %)(% colspan="1" %)
418 418  (((
419 419  3.0 Beta 1
420 -)))|(% colspan="1" %)(% colspan="1" %)
653 +)))|(% colspan="2" %)(% colspan="1" %)
421 421  (((
422 422  Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
423 -)))|(% colspan="1" %)(% colspan="1" %)
424 -(((
425 -
426 426  )))
427 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
657 +|(% colspan="4" %)(% colspan="3" %)
428 428  (((
429 -//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.
430 430  )))
431 431  |(% colspan="1" %)(% colspan="1" %)
432 432  (((
... ... @@ -434,16 +434,13 @@
434 434  )))|(% colspan="1" %)(% colspan="1" %)
435 435  (((
436 436  3.0 Beta 1
437 -)))|(% colspan="1" %)(% colspan="1" %)
667 +)))|(% colspan="2" %)(% colspan="1" %)
438 438  (((
439 439  Script action **<set_doors_locked/>** attribute **'group'** changed
440 -)))|(% colspan="1" %)(% colspan="1" %)
441 -(((
442 -
443 443  )))
444 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
671 +|(% colspan="4" %)(% colspan="3" %)
445 445  (((
446 -//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.
447 447  )))
448 448  |(% colspan="1" %)(% colspan="1" %)
449 449  (((
... ... @@ -451,16 +451,13 @@
451 451  )))|(% colspan="1" %)(% colspan="1" %)
452 452  (((
453 453  3.0 Beta 1
454 -)))|(% colspan="1" %)(% colspan="1" %)
681 +)))|(% colspan="2" %)(% colspan="1" %)
455 455  (((
456 456  Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
457 -)))|(% colspan="1" %)(% colspan="1" %)
458 -(((
459 -
460 460  )))
461 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
685 +|(% colspan="4" %)(% colspan="3" %)
462 462  (((
463 -//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.
464 464  )))
465 465  |(% colspan="1" %)(% colspan="1" %)
466 466  (((
... ... @@ -468,16 +468,13 @@
468 468  )))|(% colspan="1" %)(% colspan="1" %)
469 469  (((
470 470  3.0 Beta 1
471 -)))|(% colspan="1" %)(% colspan="1" %)
695 +)))|(% colspan="2" %)(% colspan="1" %)
472 472  (((
473 473  Script actions **<set_hack_target/>** and **<abort_hack/>** removed
474 -)))|(% colspan="1" %)(% colspan="1" %)
475 -(((
476 -
477 477  )))
478 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
699 +|(% colspan="4" %)(% colspan="3" %)
479 479  (((
480 -//These actions had no effect and were removed.//
701 +These actions had no effect and were removed.
481 481  )))
482 482  |(% colspan="1" %)(% colspan="1" %)
483 483  (((
... ... @@ -485,16 +485,13 @@
485 485  )))|(% colspan="1" %)(% colspan="1" %)
486 486  (((
487 487  3.0 Beta 1
488 -)))|(% colspan="1" %)(% colspan="1" %)
709 +)))|(% colspan="2" %)(% colspan="1" %)
489 489  (((
490 490  **<setup_conversation_minigame/>** script action removed
491 -)))|(% colspan="1" %)(% colspan="1" %)
492 -(((
493 -
494 494  )))
495 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
713 +|(% colspan="4" %)(% colspan="3" %)
496 496  (((
497 -//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.
498 498  )))
499 499  |(% colspan="1" %)(% colspan="1" %)
500 500  (((
... ... @@ -502,16 +502,13 @@
502 502  )))|(% colspan="1" %)(% colspan="1" %)
503 503  (((
504 504  3.0 Beta 1
505 -)))|(% colspan="1" %)(% colspan="1" %)
723 +)))|(% colspan="2" %)(% colspan="1" %)
506 506  (((
507 507  <add_player_choice_*> **confidence** attribute removed
508 -)))|(% colspan="1" %)(% colspan="1" %)
509 -(((
510 -
511 511  )))
512 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
727 +|(% colspan="4" %)(% colspan="3" %)
513 513  (((
514 -//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.
515 515  )))
516 516  |(% colspan="1" %)(% colspan="1" %)
517 517  (((
... ... @@ -519,16 +519,13 @@
519 519  )))|(% colspan="1" %)(% colspan="1" %)
520 520  (((
521 521  3.0 Beta 1
522 -)))|(% colspan="1" %)(% colspan="1" %)
737 +)))|(% colspan="2" %)(% colspan="1" %)
523 523  (((
524 524  **<hack_via_control_panel/>** script action removed
525 -)))|(% colspan="1" %)(% colspan="1" %)
526 -(((
527 -
528 528  )))
529 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
741 +|(% colspan="4" %)(% colspan="3" %)
530 530  (((
531 -//Unused script action <hack_via_control_panel/> was removed.//
743 +Unused script action <hack_via_control_panel/> was removed.
532 532  )))
533 533  |(% colspan="1" %)(% colspan="1" %)
534 534  (((
... ... @@ -536,30 +536,24 @@
536 536  )))|(% colspan="1" %)(% colspan="1" %)
537 537  (((
538 538  3.0 Beta 1
539 -)))|(% colspan="1" %)(% colspan="1" %)
751 +)))|(% colspan="2" %)(% colspan="1" %)
540 540  (((
541 541  **Lua: **GetMiniGameCursorPosition() removed
542 -)))|(% colspan="1" %)(% colspan="1" %)
543 -(((
544 -
545 545  )))
546 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
755 +|(% colspan="4" %)(% colspan="3" %)
547 547  (((
548 -//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.
549 549  )))
550 550  |(((
551 551  UI core
552 552  )))|(((
553 553  3.0 Beta 1
554 -)))|(((
763 +)))|(% colspan="2" %)(((
555 555  **FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
556 -)))|(% colspan="1" %)(% colspan="1" %)
557 -(((
558 -
559 559  )))
560 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
766 +|(% colspan="4" %)(% colspan="3" %)
561 561  (((
562 -//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.
563 563  )))
564 564  |(% colspan="1" %)(% colspan="1" %)
565 565  (((
... ... @@ -567,16 +567,13 @@
567 567  )))|(% colspan="1" %)(% colspan="1" %)
568 568  (((
569 569  3.0 Beta 1
570 -)))|(% colspan="1" %)(% colspan="1" %)
776 +)))|(% colspan="2" %)(% colspan="1" %)
571 571  (((
572 572  **FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
573 -)))|(% colspan="1" %)(% colspan="1" %)
574 -(((
575 -
576 576  )))
577 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
780 +|(% colspan="4" %)(% colspan="3" %)
578 578  (((
579 -//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.
580 580  )))
581 581  |(% colspan="1" %)(% colspan="1" %)
582 582  (((
... ... @@ -584,17 +584,14 @@
584 584  )))|(% colspan="1" %)(% colspan="1" %)
585 585  (((
586 586  3.0 Beta 1
587 -)))|(% colspan="1" %)(% colspan="1" %)
790 +)))|(% colspan="2" %)(% colspan="1" %)
588 588  (((
589 589  **$ware.illegal** updated
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" %)
794 +|(% colspan="4" %)(% colspan="3" %)
595 595  (((
596 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
597 -//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.
598 598  )))
599 599  |(% colspan="1" %)(% colspan="1" %)
600 600  (((
... ... @@ -602,16 +602,13 @@
602 602  )))|(% colspan="1" %)(% colspan="1" %)
603 603  (((
604 604  3.0 Beta 1
605 -)))|(% colspan="1" %)(% colspan="1" %)
805 +)))|(% colspan="2" %)(% colspan="1" %)
606 606  (((
607 607  MD script **RML_Flight_Along_Path** removed
608 -)))|(% colspan="1" %)(% colspan="1" %)
609 -(((
610 -
611 611  )))
612 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
809 +|(% colspan="4" %)(% colspan="3" %)
613 613  (((
614 -//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.
615 615  )))
616 616  |(% colspan="1" %)(% colspan="1" %)
617 617  (((
... ... @@ -619,86 +619,75 @@
619 619  )))|(% colspan="1" %)(% colspan="1" %)
620 620  (((
621 621  3.0 Beta 1
622 -)))|(% colspan="1" %)(% colspan="1" %)
819 +)))|(% colspan="2" %)(% colspan="1" %)
623 623  (((
624 624  parameters of **<event_venture_mission_completed/>** changed
625 -)))|(% colspan="1" %)(% colspan="1" %)
626 -(((
627 -
628 628  )))
629 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
823 +|(% colspan="4" %)(% colspan="3" %)
630 630  (((
631 -//old params: param = venture details, param2 = ships involved, param3 = duration//
632 -//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
633 633  )))
634 634  |(((
635 635  Scripts
636 636  )))|(((
637 637  3.0 Beta 1
638 -)))|(((
832 +)))|(% colspan="2" %)(((
639 639  **<set_object_wing_name/>** removed,
640 640  **<set_object_fleet_name/>** added
641 -)))|(% colspan="1" %)(% colspan="1" %)
642 -(((
643 -
644 644  )))
645 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
836 +|(% colspan="4" %)(% colspan="3" %)
646 646  (((
647 -//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/>
648 648  )))
649 649  |(((
650 650  Scripts
651 651  )))|(((
652 652  3.0 Beta 1
653 -)))|(((
844 +)))|(% colspan="2" %)(((
654 654  **$controllable.wing.*** removed,
655 655  **$controllable.fleet.*** added
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" %)
848 +|(% colspan="4" %)(% colspan="3" %)
661 661  (((
662 662  $controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
663 663  )))
664 -|(% colspan="4" %)(% colspan="4" %)
665 -(((
666 -== 2.60 ==
667 -)))
852 +
853 +----
854 +
855 +=== Version 2.60 ===
856 +
857 +(% class="table-striped" %)
668 668  |(((
669 669  Scripts
670 670  )))|(((
671 671  2.60 Beta 1
672 -)))|(((
862 +)))|(% colspan="2" %)(((
673 673  '**checkoperational**' filter behaviour changed
674 -)))|(% colspan="1" %)(% colspan="1" %)
675 -(((
676 -
677 677  )))
678 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
865 +|(% colspan="10" %)(% colspan="3" %)
679 679  (((
680 -//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.
681 681  
682 -//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.
683 683  )))
684 684  |(((
685 685  Scripts
686 686  )))|(((
687 687  2.60 Beta 1
688 -)))|(((
875 +)))|(% colspan="2" %)(((
689 689  $container.**supplyresources** behavior changed
690 -)))|(% colspan="1" %)(% colspan="1" %)
877 +)))| | |
878 +|(% colspan="10" %)(% colspan="3" %)
691 691  (((
692 -
880 +The script keyword $container.supplyresources now includes reserved wares.
693 693  )))
694 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
695 -(((
696 -//The script keyword $container.supplyresources now includes reserved wares.//
697 -)))
698 -|(% colspan="4" %)(% colspan="4" %)
699 -(((
700 -== 2.20 ==
701 -)))
882 +
883 +----
884 +
885 +=== Version 2.20 ===
886 +
887 +(% class="table-striped" %)
702 702  |(% colspan="1" %)(% colspan="1" %)
703 703  (((
704 704  UI core
... ... @@ -705,20 +705,16 @@
705 705  )))|(% colspan="1" %)(% colspan="1" %)
706 706  (((
707 707  2.20 Beta 3/4
708 -)))|(% colspan="1" %)(% colspan="1" %)
894 +)))|(% colspan="2" %)(% colspan="1" %)
709 709  (((
710 710  **Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
711 -)))|(% colspan="1" %)(% colspan="1" %)
712 -(((
713 -
714 714  )))
715 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
898 +|(% colspan="4" %)(% colspan="3" %)
716 716  (((
717 -//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.
718 -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.
719 719  
720 -//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.
721 -//
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.
722 722  )))
723 723  |(% colspan="1" %)(% colspan="1" %)
724 724  (((
... ... @@ -726,21 +726,20 @@
726 726  )))|(% colspan="1" %)(% colspan="1" %)
727 727  (((
728 728  2.20 Beta 3
729 -)))|(% colspan="1" %)(% colspan="1" %)
911 +)))|(% colspan="2" %)(% colspan="1" %)
730 730  (((
731 731  Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
732 -)))|(% colspan="1" %)(% colspan="1" %)
733 -(((
734 -
735 735  )))
736 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
915 +|(% colspan="4" %)(% colspan="3" %)
737 737  (((
738 -//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.
739 739  )))
740 -|(% colspan="4" %)(% colspan="4" %)
741 -(((
742 -== 2.00 ==
743 -)))
919 +
920 +----
921 +
922 +=== Version 2.00 ===
923 +
924 +(% class="table-striped" %)
744 744  |(% colspan="1" %)(% colspan="1" %)
745 745  (((
746 746  Scripts
... ... @@ -747,16 +747,13 @@
747 747  )))|(% colspan="1" %)(% colspan="1" %)
748 748  (((
749 749  2.00 Beta 1
750 -)))|(% colspan="1" %)(% colspan="1" %)
931 +)))|(% colspan="2" %)(% colspan="1" %)
751 751  (((
752 752  **<event_build_finished/> **param2 now returns null instead of a construction sequence
753 -)))|(% colspan="1" %)(% colspan="1" %)
754 -(((
755 -
756 756  )))
757 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
935 +|(% colspan="4" %)(% colspan="3" %)
758 758  (((
759 -//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.
760 760  )))
761 761  |(% colspan="1" %)(% colspan="1" %)
762 762  (((
... ... @@ -764,16 +764,13 @@
764 764  )))|(% colspan="1" %)(% colspan="1" %)
765 765  (((
766 766  2.00 Beta 1
767 -)))|(% colspan="1" %)(% colspan="1" %)
945 +)))|(% colspan="2" %)(% colspan="1" %)
768 768  (((
769 769  **param.boarding.{...}** strength parameters removed
770 -)))|(% colspan="1" %)(% colspan="1" %)
771 -(((
772 -
773 773  )))
774 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
949 +|(% colspan="4" %)(% colspan="3" %)
775 775  (((
776 -//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.
777 777  )))
778 778  |(% colspan="1" %)(% colspan="1" %)
779 779  (((
... ... @@ -781,197 +781,160 @@
781 781  )))|(% colspan="1" %)(% colspan="1" %)
782 782  (((
783 783  2.00 Beta 1
784 -)))|(% colspan="1" %)(% colspan="1" %)
959 +)))|(% colspan="2" %)(% colspan="1" %)
785 785  (((
786 786  **$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
787 -)))|(% colspan="1" %)(% colspan="1" %)
788 -(((
789 -
790 790  )))
791 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
963 +|(% colspan="4" %)(% colspan="3" %)
792 792  (((
793 -//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.
794 794  )))
795 795  |(((
796 796  UI extensions
797 797  )))|(((
798 798  2.00 Beta 1
799 -)))|(((
971 +)))|(% colspan="2" %)(((
800 800  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
801 -)))|(% colspan="1" %)(% colspan="1" %)
802 -(((
803 -
804 804  )))
805 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
974 +|(% colspan="4" %)(% colspan="3" %)
806 806  (((
807 -//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.
808 808  )))
809 809  |(((
810 810  UI extensions
811 811  )))|(((
812 812  2.00 Beta 1
813 -)))|(((
982 +)))|(% colspan="2" %)(((
814 814  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
815 -)))|(% colspan="1" %)(% colspan="1" %)
816 -(((
817 -
818 818  )))
819 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
985 +|(% colspan="4" %)(% colspan="3" %)
820 820  (((
821 -//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.//
822 -//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.
823 823  )))
824 824  |(((
825 825  Scripts
826 826  )))|(((
827 827  2.00 Beta 1
828 -)))|(((
994 +)))|(% colspan="2" %)(((
829 829  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
830 -)))|(% colspan="1" %)(% colspan="1" %)
831 -(((
832 -
833 833  )))
834 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
997 +|(% colspan="4" %)(% colspan="3" %)
835 835  (((
836 -//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.
837 837  )))
838 838  |(((
839 839  Scripts
840 840  )))|(((
841 841  2.00 Beta 1
842 -)))|(((
1005 +)))|(% colspan="2" %)(((
843 843  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
844 -)))|(% colspan="1" %)(% colspan="1" %)
845 -(((
846 -
847 847  )))
848 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1008 +|(% colspan="4" %)(% colspan="3" %)
849 849  (((
850 -//For prior behavior, check for event.param being non-null.//
1010 +For prior behavior, check for event.param being non-null.
851 851  )))
852 852  |(((
853 853  AI Scripts
854 854  )))|(((
855 855  2.00 Beta 1
856 -)))|(((
1016 +)))|(% colspan="2" %)(((
857 857  **<shoot/>/<shoot_at/>** attribute changes.
858 -)))|(% colspan="1" %)(% colspan="1" %)
859 -(((
860 -
861 861  )))
862 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1019 +|(% colspan="4" %)(% colspan="3" %)
863 863  (((
864 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
865 -//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.//
866 -//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.
867 867  
868 -//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.
869 869  )))
870 870  |(((
871 871  UI extensions
872 872  )))|(((
873 873  2.00 Beta 1
874 -)))|(((
875 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
876 -)))|(% colspan="1" %)(% colspan="1" %)
877 -(((
878 -
1031 +)))|(% colspan="2" %)(((
1032 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.
879 879  )))
880 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1034 +|(% colspan="4" %)(% colspan="3" %)
881 881  (((
882 -//Added possibility to query build tasks of a certain buildmodule.//
1036 +Added possibility to query build tasks of a certain buildmodule.
883 883  )))
884 884  |(((
885 885  UI extensions
886 886  )))|(((
887 887  2.00 Beta 1
888 -)))|(((
1042 +)))|(% colspan="2" %)(((
889 889  **Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
890 -)))|(% colspan="1" %)(% colspan="1" %)
891 -(((
892 -
893 893  )))
894 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1045 +|(% colspan="4" %)(% colspan="3" %)
895 895  (((
896 -//Added list of resources a buildmodule needs to build.//
1047 +Added list of resources a buildmodule needs to build.
897 897  )))
898 898  |(((
899 899  UI extensions
900 900  )))|(((
901 901  2.00 Beta 1
902 -)))|(((
903 -(% 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);" %)
904 -)))|(% colspan="1" %)(% colspan="1" %)
905 -(((
906 -
1053 +)))|(% colspan="2" %)(((
1054 +**Lua: CalculateTotalHullFraction() **was removed.
907 907  )))
908 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1056 +|(% colspan="4" %)(% colspan="3" %)
909 909  (((
910 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
1058 +Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.
911 911  )))
912 912  |(((
913 913  UI extensions
914 914  )))|(((
915 915  2.00 Beta 1
916 -)))|(((
917 -**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" %)
918 -)))|(% colspan="1" %)(% colspan="1" %)
919 -(((
920 -
1064 +)))|(% colspan="2" %)(((
1065 +**FFI: RequestDockAtReason()/UndockPlayerShip() **changed their return values.
921 921  )))
922 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1067 +|(% colspan="4" %)(% colspan="3" %)
923 923  (((
924 -//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.
925 925  )))
926 -|(% colspan="4" %)(% colspan="4" %)
927 -(((
928 -== 1.50 ==
929 -)))
1071 +
1072 +----
1073 +
1074 +=== Version 1.50 ===
1075 +
1076 +(% class="table-striped" %)
930 930  |(((
931 931  UI extensions
932 932  )))|(((
933 933  1.50 Beta 3
934 -)))|(((
935 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
936 -)))|(% colspan="1" %)(% colspan="1" %)
937 -(((
938 -
1081 +)))|(% colspan="2" %)(((
1082 +**Lua: GetComponentData() **changed behavior of "docksizes" property.
939 939  )))
940 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1084 +|(% colspan="4" %)(% colspan="3" %)
941 941  (((
942 -//The "docksizes" property no longer includes internal ship storage docks.//
1086 +The "docksizes" property no longer includes internal ship storage docks.
943 943  )))
944 944  |(((
945 945  All
946 946  )))|(((
947 947  1.50 Beta 2
948 -)))|(((
1092 +)))|(% colspan="2" %)(((
949 949  **Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
950 -)))|(% colspan="1" %)(% colspan="1" %)
951 -(((
952 -
953 953  )))
954 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1095 +|(% colspan="4" %)(% colspan="3" %)
955 955  (((
956 -//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".
957 957  
958 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
959 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
960 -//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)
961 961  )))
962 962  |(((
963 963  UI extensions
964 964  )))|(((
965 965  1.50 Beta 2
966 -)))|(((
967 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
968 -)))|(% colspan="1" %)(% colspan="1" %)
969 -(((
970 -
1107 +)))|(% colspan="2" %)(((
1108 +**FFI: UpgradeGroupInfo **datatype was changed.
971 971  )))
972 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1110 +|(% colspan="4" %)(% colspan="3" %)
973 973  (((
974 -//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.
975 975  )))
976 976  |(% colspan="1" %)(% colspan="1" %)
977 977  (((
... ... @@ -979,67 +979,58 @@
979 979  )))|(% colspan="1" %)(% colspan="1" %)
980 980  (((
981 981  1.50 Beta 1
982 -)))|(% colspan="1" %)(% colspan="1" %)
1120 +)))|(% colspan="2" %)(% colspan="1" %)
983 983  (((
984 984  **FFI: SetGuidance()** removed useinfopoint argument.
985 -)))|(% colspan="1" %)(% colspan="1" %)
986 -(((
987 -
988 988  )))
989 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1124 +|(% colspan="4" %)(% colspan="3" %)
990 990  (((
991 -//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.
992 -//
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.
993 993  
994 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1128 +The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)
995 995  )))
996 996  |(((
997 997  UI extensions
998 998  )))|(((
999 999  1.50 Beta 1
1000 -)))|(((
1001 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
1002 -)))|(% colspan="1" %)(% colspan="1" %)
1003 -(((
1004 -
1134 +)))|(% colspan="2" %)(((
1135 +**FFI: CancelConstruction() **changed its return value.
1005 1005  )))
1006 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1137 +|(% colspan="4" %)(% colspan="3" %)
1007 1007  (((
1008 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
1139 +CancelConstruction() now returns if the cancellation was successful.
1009 1009  )))
1010 -|(% colspan="4" %)(% colspan="4" %)
1011 -(((
1012 -== 1.32 ==
1013 -)))
1141 +
1142 +----
1143 +
1144 +=== Version 1.32 ===
1145 +
1146 +(% class="table-striped" %)
1014 1014  |(((
1015 1015  UI extensions
1016 1016  )))|(((
1017 1017  1.32
1018 -)))|(((
1151 +)))|(% colspan="2" %)(((
1019 1019  **Lua: GetComponentData() **removed the "nextdestname" property.
1020 -)))|(% colspan="1" %)(% colspan="1" %)
1021 -(((
1022 -
1023 1023  )))
1024 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1154 +|(% colspan="4" %)(% colspan="3" %)
1025 1025  (((
1026 -//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.
1027 1027  )))
1028 -|(% colspan="4" %)(% colspan="4" %)
1029 -(((
1030 -== 1.20 ==
1031 -)))
1158 +
1159 +----
1160 +
1161 +=== Version 1.20 ===
1162 +
1163 +(% class="table-striped" %)
1032 1032  |(((
1033 1033  UI extensions
1034 1034  )))|(((
1035 1035  1.20
1036 -)))|(((
1037 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
1038 -)))|(% colspan="1" %)(% colspan="1" %)
1039 -(((
1040 -
1168 +)))|(% colspan="2" %)(((
1169 +**FFI: GetAAOption()** got a new "useconfig" parameter.
1041 1041  )))
1042 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1171 +|(% colspan="4" %)(% colspan="3" %)
1043 1043  (((
1044 -//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.//
1045 1045  )))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,0 @@
1 -102924739
space
... ... @@ -1,1 +1,0 @@
1 -X4WIKI
url
... ... @@ -1,1 +1,0 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/102924739/Breaking Changes