Changes for page Breaking Changes

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

From version 72.1
edited by stefan
on 2021/01/09 02:44
Change comment: There is no comment for this version
To version 143.1
edited by Owen Lake
on 2025/12/17 14:48
Change comment: added note about <add_build_to_expand_station> constructionplan attribute

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.Owen
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,144 +18,516 @@
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 9.00 ===
24 +
25 +(% class="table-striped" %)
26 +|(% colspan="1" style="width:117px" %)Scripts|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)Removed **flags **attribute from action **<add_blueprints>**
27 +|(% colspan="6" style="width:117px" %)(((
28 +The flags attribute is no longer available in the MD action <add_blueprints>
29 +)))
30 +|(% style="width:117px" %)Scripts|(% style="width:117px" %)9.00 Beta 1|(% colspan="3" style="width:117px" %)Construction sequence param removed from build_started events
31 +|(% colspan="6" style="width:117px" %)Script events <event_build_started> and <event_player_build_started> no longer receive the construction sequence via param2. param2 will now yield null. Query the sequence via the param3 buildtask instead.
32 +|(% style="width:117px" %)Scripts|(% style="width:117px" %)9.00 Beta 1|(% colspan="3" style="width:117px" %)Script properties removed from macro
33 +|(% colspan="6" style="width:117px" %)**.purposemacro** and **.purposename **have been removed from the **macro **script properties
34 +|(% style="width:117px" %)Scripts|(% style="width:117px" %)9.00 Beta 1|(% colspan="4" rowspan="1" style="width:117px" %)**constructionplan **attribute now required for **<add_build_to_expand_station>**
35 +|(% colspan="6" style="width:117px" %)The constructionplan attribute for the <add_build_to_expand_station> action is no longer optional. Past behaviour when omitted was for the station to recycle down to nothing. Use new script action <add_build_to_recycle_station> instead.
36 +
37 +=== Version 8.00 ===
38 +
39 +(% class="table-striped" %)
40 +|(% colspan="1" style="width:117px" %)Scripts|(% colspan="1" style="width:119px" %)8.00 Beta 1|(% colspan="4" style="width:1625px" %)Removed MD action **<populate_platforms>**
41 +|(% colspan="6" style="width:117px" %)(((
42 +The deprecated MD action <populate_platforms> has been removed. The previously referenced character quotas in quotas.xml have also been removed.
43 +)))
44 +|(% style="width:117px" %)Assets|(% style="width:117px" %)8.00 Beta 1|(% colspan="4" rowspan="1" style="width:117px" %)**\assets\units\size_m\ship_gen_m_transdrone_container_02** and **\assets\units\size_s\ship_gen_s_transdrone_container_02** moved to **ego_dlc_terran**
45 +|(% colspan="6" style="width:117px" %)**ship_gen_m_transdrone_container_02** and **ship_gen_s_transdrone_container_02** (templates and macros) have been moved to the **ego_dlc_terran** extension and any reference to these files now requires that the resulting dependency on that extension is taken into account.
46 +|(% style="width:117px" %)Assets|(% style="width:117px" %)8.00 Beta 1|(% colspan="4" rowspan="1" style="width:117px" %)Icons moved from **assets\fx\textures\gui** to **assets\textures\ui**
47 +|(% colspan="6" style="width:117px" %)Assets with the exception of the **loadingscreen** folder have been moved and any reference to these files will require updating (mostly affects icons.xml).
48 +|(% style="width:117px" %)Assets|(% colspan="3" style="width:117px" %)8.00 Beta 1|(% colspan="3" style="width:117px" %)**boron** and **terran** tags for equipment (weapons, engines, ...) changed to **advanced**
49 +|(% colspan="6" style="width:117px" %)Ships and equipment with **boron **and **terran** (Frontier terran, not CoH terran) tags will no longer work properly as they do not match the new **advanced** tag (for example "small engine boron" has been replaced by "small engine advanced") which has been introduced for a compatibility between boron and Frontier-terran ships/equipment.
50 +|(% style="width:117px" %)Assets|(% style="width:117px" %)8.00|(% colspan="4" rowspan="1" style="width:117px" %)Terran NPC heads from Terran DLC **extensions/ego_dlc_terran/assets/characters/terran/heads/[...]** have been removed
51 +|(% colspan="6" style="width:117px" %)All Terran NPC heads are now pointed to **assets/characters/argon/heads/char_arg_f_dyn_blend_head** (female characters) and **assets/characters/argon/heads/char_arg_m_dyn_blend_head** (male characters) instead of using random selection from a list.
52 +
53 +=== Version 7.50 ===
54 +
55 +(% class="table-striped" %)
56 +|(% 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)
57 +|(% colspan="4" style="width:117px" %)(((
58 +The "ally" range is the interval from 0.5 to 1.0, which previously corresponded to the UI value range of approximately +26.9897 to +30. The interpolated mapping within the range from 0.32 and 1.0 has been adjusted so that 0.5 now exactly corresponds to +27. As a consequence, certain relations that were previously between 25 and 28 (rounded down) may have gained +1 in the UI, i.e. they are now displayed as 26 instead of 25, etc. For consistency, the negative range between -1.0 and -0.32 has been adjusted analogously (-0.5 is now displayed as -27). This mostly only affects the UI display, not actual gameplay.
59 +)))
60 +|(% 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**
61 +|(% colspan="7" style="width:117px" %)(((
62 +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.
63 +)))
64 +
65 +=== Version 7.00 ===
66 +
67 +
68 +(% class="table-striped" %)
69 +|(% colspan="1" style="width:117px" %)Gamestarts|(% colspan="1" style="width:119px" %)7.00 Beta 8|(% colspan="2" style="width:1625px" %)**Text references**
70 +|(% 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.
71 +|(% 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**
72 +|(% colspan="4" style="width:117px" %)highway_fx_electric_02 is still available in "legacy" folder if needed
73 +|(% 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
74 +|(% colspan="4" style="width:117px" %)(((
75 +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.
76 +)))
77 +|(% 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.
78 +|(% colspan="4" style="width:117px" %)(((
79 +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.**
80 +)))
81 +|(% 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.
82 +|(% colspan="4" style="width:117px" %)(((
83 +Some material names and texture paths were changed. Please DIFF the materiallibrary.xml from 6.20 with 7.0 to see the difference
84 +)))
85 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
28 28  (((
29 -
87 +Scripts
88 +)))|(% colspan="1" style="width:119px" %)(((
89 +7.00 Beta 1
90 +)))|(% colspan="2" style="width:1625px" %)(((
91 +MD action **<set_presentation_cluster_persistence/>** now requires the cluster to be a presentation cluster.
30 30  )))
31 -|(% colspan="4" %)(% colspan="4" %)
93 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
32 32  (((
33 -== 4.00 ==
95 + Previously it was possible to set normal clusters to be persistent presentation clusters which was an invalid state.
34 34  )))
97 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
98 +(((
99 +UI extensions
100 +)))|(% colspan="1" style="width:119px" %)(((
101 +7.00 Beta 1
102 +)))|(% colspan="2" style="width:1625px" %)(((
103 +**FFI**: RemoveBuildPlot() changed
104 +)))
105 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
106 +(((
107 + 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.
108 +)))
109 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
110 +(((
111 +Assets
112 +)))|(% colspan="1" style="width:119px" %)(((
113 +7.00 Beta 1
114 +)))|(% colspan="2" style="width:1625px" %)(((
115 +**Some Split DLC materials moved to base game**
116 +)))
117 +|(% colspan="7" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
118 +(((
119 +// //"spl_p1_fx" AND "split_p1_hulltexture_01" were moved from Split DLC to base game
120 +)))
121 +
122 +=== Version 6.00 ===
123 +
124 +(% class="table-striped" %)
125 +|(((
126 +Libraries
127 +)))|(((
128 +6.00 Beta 7
129 +)))|(% colspan="2" %)(((
130 +Updated weights for ship groups in shipgroups.xml libraries of base game and all DLCs.
131 +)))
132 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
133 +(((
134 +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.
135 +
136 +All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.
137 +)))
35 35  |(% colspan="1" %)(% colspan="1" %)
36 36  (((
37 -UI core
140 +Scripts
38 38  )))|(% colspan="1" %)(% colspan="1" %)
39 39  (((
40 -4.00 Beta 5
143 +6.00 Beta 4
144 +)))|(% colspan="2" %)(% colspan="1" %)
145 +(((
146 +Changed conditions for **<event_player_travelmode_started> <event_player_travelmode_stopped> <event_player_travelmode_charge_started> <event_player_travelmode_charge_aborted>** to be raised.
147 +)))
148 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
149 +(((
150 +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.
151 +
152 +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.
153 +)))
154 +|(% colspan="1" %)(% colspan="1" %)
155 +(((
156 +Scripts
41 41  )))|(% colspan="1" %)(% colspan="1" %)
42 42  (((
43 -**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in ranges relation range [-25,-10] changed
159 +6.00 Beta 3
160 +)))|(% colspan="2" %)(% colspan="1" %)
161 +(((
162 +Changed result of **<find_object_surface>** action in the case of a failure
163 +)))
164 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
165 +(((
166 +The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.
167 +
168 +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.
169 +
170 +The action itself has been improved to increase the chance of finding suitable surface positions.
171 +)))
172 +|(% colspan="1" %)(% colspan="1" %)
173 +(((
174 +Scripts
44 44  )))|(% colspan="1" %)(% colspan="1" %)
45 45  (((
46 -
177 +6.00 Beta 1
178 +)))|(% colspan="2" %)(% colspan="1" %)
179 +(((
180 +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" %)
182 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
49 49  (((
50 -//4.00 Beta 5// //introduces a new 'adversary' relation state. Previously objects within that relation range were categorized as 'enemy' and GetRelationStatus()/GetRelationStatus2() therefore returned 0 (enemy) for these objects.
51 -Since these objects are now visualized and therefore are distinguishable from enemies, several related changes were made for these objects to bring them more in line with how 'neutral' objects are handled (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.
52 -If you rely on a handling where they are treated like enemies, please use the new GetRelationStatus3() //FFI function which returns the new range for these objects: 1 (meaning 'adversary' here with following relations having been shifted up).
184 +<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
185 +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.
186 +)))
187 +|(% colspan="1" %)(% colspan="1" %)
188 +(((
189 +Scripts
53 53  )))|(% colspan="1" %)(% colspan="1" %)
54 54  (((
55 -
192 +6.00 Beta 1
193 +)))|(% colspan="2" %)(% colspan="1" %)
194 +(((
195 +Changed result attribute location for **<get_attackstrength>**
56 56  )))
197 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
198 +(((
199 +The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.
200 +)))
57 57  |(((
58 -Parameters
202 +Assets
59 59  )))|(((
60 -4.00 Beta 1
61 -)))|(((
62 -**requiresconstructionvessel** parameter moved
63 -)))|(((
64 -
204 +6.00 Beta 1
205 +)))|(% colspan="2" %)(((
206 +Surface element **connections** are incompatible by default unless tagged as "**standard**", and also "**combat**" for non-missile, non-mining weapons
65 65  )))
66 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
208 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
67 67  (((
68 -//The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.//
210 +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.
211 +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.
69 69  )))
213 +|(% colspan="1" %)(% colspan="1" %)
214 +(((
215 +Scripts
216 +)))|(% colspan="1" %)(% colspan="1" %)
217 +(((
218 +6.00 Beta 1
219 +)))|(% colspan="2" %)(% colspan="1" %)
220 +(((
221 +Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
222 +)))
223 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
224 +(((
225 +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.
226 +)))
70 70  |(((
71 71  Scripts
72 72  )))|(((
73 -4.00 Beta 1
230 +6.00 Beta 1
231 +)))|(% colspan="2" %)(((
232 +**<event_player_owned_killed_object>** and **<event_player_owned_destroyed>** are now triggered before the corresponding **<event_object_destroyed>**, instead of afterwards.
233 +)))
234 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
235 +(((
236 +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.
237 +)))
238 +|(((
239 +Cutscenes
74 74  )))|(((
75 -Changed behaviour of **gatedistance** script property
241 +6.00 Beta 1
242 +)))|(% colspan="2" %)(((
243 +Changed behaviour of **<angles>** in cutscenes
244 +)))
245 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
246 +(((
247 +The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.
248 +)))
249 +
250 +----
251 +
252 +=== Version 5.00 ===
253 +
254 +(% class="table-striped" %)
255 +|(((
256 +Parameters
76 76  )))|(((
77 -
258 +5.00 Beta 1
259 +)))|(% colspan="2" %)(((
260 +**<controlpanel><entry>: minduration** removed, **maxduration** renamed to duration
78 78  )))
79 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
262 +|(% colspan="7" %)(% colspan="3" %)
80 80  (((
81 -//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.//
82 -)))|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
264 +'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.
265 +)))
266 +
267 +----
268 +
269 +=== Version 4.10 ===
270 +
271 +(% class="table-striped" %)
272 +|(% colspan="1" %)(% colspan="1" %)
83 83  (((
84 -
274 +UI extensions
275 +)))|(% colspan="1" %)(% colspan="1" %)
276 +(((
277 +4.10 Beta 7
278 +)))|(% colspan="2" %)(% colspan="1" %)
279 +(((
280 +**FFI**: SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() deprecated
85 85  )))
86 -|(% colspan="4" %)(% colspan="4" %)
282 +|(% colspan="4" %)(% colspan="3" %)
87 87  (((
88 -== 3.30 ==
284 +The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.
89 89  )))
286 +|(% colspan="1" %)(% colspan="1" %)
287 +(((
288 +UI extensions
289 +)))|(% colspan="1" %)(% colspan="1" %)
290 +(((
291 +4.10 Beta 6
292 +)))|(% colspan="2" %)(% colspan="1" %)
293 +(((
294 +**FFI**: CustomGameStartPlayerProperty2 changed
295 +)))
296 +|(% colspan="4" %)(% colspan="3" %)
297 +(((
298 +This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.
299 +)))
300 +|(% colspan="1" %)(% colspan="1" %)
301 +(((
302 +Parameters
303 +)))|(% colspan="1" %)(% colspan="1" %)
304 +(((
305 +4.10 Beta 3
306 +)))|(% colspan="2" %)(% colspan="1" %)
307 +(((
308 +Renamed **<stationinfobox>** to **<infobox>**
309 +)))
310 +|(% colspan="4" %)(% colspan="3" %)
311 +(((
312 +Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.
313 +)))
314 +|(% colspan="1" %)(% colspan="1" %)
315 +(((
316 +UI extensions
317 +)))|(% colspan="1" %)(% colspan="1" %)
318 +(((
319 +4.10 Beta 2
320 +)))|(% colspan="2" %)(% colspan="1" %)
321 +(((
322 +**FFI**: SetMacroMapPlayerSectorOffset() deprecated
323 +)))
324 +|(% colspan="4" %)(% colspan="3" %)
325 +(((
326 +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.
327 +)))
90 90  |(((
91 91  UI extensions
92 92  )))|(((
93 -3.30 Beta 3
331 +4.10 Beta 2
332 +)))|(% colspan="2" %)(((
333 +**FFI**: FilterComponentForMapMode() and SetMapObjectFilter() changed
334 +)))
335 +|(% colspan="4" %)(% colspan="3" %)
336 +(((
337 +These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.
338 +)))
339 +|(((
340 +Scripts
94 94  )))|(((
95 -**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()**
96 -)))|(% colspan="1" %)(% colspan="1" %)
342 +4.10 Beta 1
343 +)))|(% colspan="2" %)(((
344 +People related attributes of mission** <delivery> **node moved
345 +)))
346 +|(% colspan="4" %)(% colspan="3" %)
97 97  (((
98 -
348 +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.
99 99  )))
100 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
350 +|(% colspan="1" %)(% colspan="1" %)
101 101  (((
102 -//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()//
352 +Scripts
353 +)))|(% colspan="1" %)(% colspan="1" %)
354 +(((
355 +4.10 Beta 1
356 +)))|(% colspan="2" %)(% colspan="1" %)
357 +(((
358 +**$destructible.productions** replaced with $defensible.productions
103 103  )))
104 -|(% colspan="4" %)(% colspan="4" %)
360 +|(% colspan="4" %)(% colspan="3" %)
105 105  (((
106 -== 3.20 ==
362 +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.
107 107  )))
108 108  |(((
109 109  Scripts
110 110  )))|(((
111 -3.20 Beta 1
112 -)))|(((
113 -Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
367 +4.10 Beta 1
368 +)))|(% colspan="2" %)(((
369 +Removed script property **$object.spawnsourceseed**
370 +)))
371 +|(% colspan="4" %)(% colspan="3" %)
372 +(((
373 +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.
374 +)))
375 +
376 +----
377 +
378 +=== Version 4.00 ===
379 +
380 +(% class="table-striped" %)
381 +|(% colspan="1" %)(% colspan="1" %)
382 +(((
383 +UI core
114 114  )))|(% colspan="1" %)(% colspan="1" %)
115 115  (((
116 -
386 +4.00 Beta 10
387 +)))|(% colspan="2" %)(% colspan="1" %)
388 +(((
389 +Controlled ship can change without a **gameplanchange-event** occurring.
117 117  )))
118 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
391 +|(% colspan="4" %)(% colspan="3" %)
119 119  (((
120 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
121 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
122 -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//
393 +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).
394 +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.
123 123  )))
396 +|(((
397 +Scripts
398 +)))|(((
399 +4.00 Beta 7
400 +)))|(% colspan="2" %)(((
401 +Parameters of **<event_terraforming_project_succeeded>** and **<event_terraforming_project_failed>** changed
402 +)))
403 +|(% colspan="4" %)(% colspan="3" %)
404 +(((
405 +Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
406 +New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
407 +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
408 +)))
124 124  |(% colspan="1" %)(% colspan="1" %)
125 125  (((
126 -Scripts
411 +UI core
127 127  )))|(% colspan="1" %)(% colspan="1" %)
128 128  (((
129 -3.20 Beta 1
130 -)))|(% colspan="1" %)(% colspan="1" %)
414 +4.00 Beta 6
415 +)))|(% colspan="2" %)(% colspan="1" %)
131 131  (((
132 -Removed script property $trade.**restriction.faction**
417 +**FFI:** GetFactionRelationStatus() handling for faction relation range [-20,-10] changed
418 +)))
419 +|(% colspan="4" %)(% colspan="3" %)
420 +(((
421 +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.
422 +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).
423 +
424 +If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
425 +)))
426 +|(% colspan="1" %)(% colspan="1" %)
427 +(((
428 +UI core
133 133  )))|(% colspan="1" %)(% colspan="1" %)
134 134  (((
135 -
431 +4.00 Beta 5
432 +)))|(% colspan="2" %)(% colspan="1" %)
433 +(((
434 +**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed
136 136  )))
137 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
436 +|(% colspan="4" %)(% colspan="3" %)
138 138  (((
139 -//$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.//
438 +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.
439 +
440 +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).
140 140  )))
141 141  |(((
443 +Parameters
444 +)))|(((
445 +4.00 Beta 1
446 +)))|(% colspan="2" %)(((
447 +**requiresconstructionvessel** parameter moved
448 +)))
449 +|(% colspan="4" %)(% colspan="3" %)
450 +(((
451 +The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.
452 +)))
453 +|(((
454 +Scripts
455 +)))|(((
456 +4.00 Beta 1
457 +)))|(% colspan="2" %)(((
458 +Changed behaviour of **gatedistance** script property
459 +)))
460 +|(% colspan="4" %)(% colspan="3" %)
461 +(((
462 +The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.
463 +)))
464 +
465 +----
466 +
467 +=== Version 3.30 ===
468 +
469 +(% class="table-striped" %)
470 +|(((
142 142  UI extensions
143 143  )))|(((
144 -3.20 Beta 1
473 +3.30 Beta 3
474 +)))|(% colspan="2" %)(((
475 +**FFI: **Removed** GetMissionLimit() **and** IsMissionLimitEnabled()**
476 +)))
477 +|(% colspan="7" %)(% colspan="3" %)
478 +(((
479 +These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()
480 +)))
481 +
482 +----
483 +
484 +=== Version 3.20 ===
485 +
486 +(% class="table-striped" %)
487 +|(((
488 +Scripts
145 145  )))|(((
146 -**Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
490 +3.20 Beta 1
491 +)))|(% colspan="2" %)(((
492 +Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
493 +)))
494 +|(% colspan="4" %)(% colspan="3" %)
495 +(((
496 +Old params: param = attacked object, param2 = attack method, param3 = attacked component
497 +New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
498 +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
499 +)))
500 +|(% colspan="1" %)(% colspan="1" %)
501 +(((
502 +Scripts
147 147  )))|(% colspan="1" %)(% colspan="1" %)
148 148  (((
149 -
505 +3.20 Beta 1
506 +)))|(% colspan="2" %)(% colspan="1" %)
507 +(((
508 +Removed script property $trade.**restriction.faction**
150 150  )))
151 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
510 +|(% colspan="4" %)(% colspan="3" %)
152 152  (((
153 -//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.//
512 +$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.
154 154  )))
155 -|(% colspan="4" %)(% colspan="4" %)
514 +|(((
515 +UI extensions
516 +)))|(((
517 +3.20 Beta 1
518 +)))|(% colspan="2" %)(((
519 +**Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
520 +)))
521 +|(% colspan="4" %)(% colspan="3" %)
156 156  (((
157 -== 3.10 ==
523 +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.
158 158  )))
525 +
526 +----
527 +
528 +=== Version 3.10 ===
529 +
530 +(% class="table-striped" %)
159 159  |(% colspan="1" %)(% colspan="1" %)
160 160  (((
161 161  Scripts
... ... @@ -162,21 +162,20 @@
162 162  )))|(% colspan="1" %)(% colspan="1" %)
163 163  (((
164 164  3.10 Beta 1
165 -)))|(% colspan="1" %)(% colspan="1" %)
537 +)))|(% colspan="2" %)(% colspan="1" %)
166 166  (((
167 167  Removed script action **<add_build/>**
168 -)))|(% colspan="1" %)(% colspan="1" %)
169 -(((
170 -
171 171  )))
172 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
541 +|(% colspan="7" %)(% colspan="3" %)
173 173  (((
174 -//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.//
543 +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.
175 175  )))
176 -|(% colspan="4" %)(% colspan="4" %)
177 -(((
178 -== 3.00 ==
179 -)))
545 +
546 +----
547 +
548 +=== Version 3.00 ===
549 +
550 +(% class="table-striped" %)
180 180  |(% colspan="1" %)(% colspan="1" %)
181 181  (((
182 182  Scripts
... ... @@ -183,16 +183,13 @@
183 183  )))|(% colspan="1" %)(% colspan="1" %)
184 184  (((
185 185  3.0 Beta 6
186 -)))|(% colspan="1" %)(% colspan="1" %)
557 +)))|(% colspan="2" %)(% colspan="1" %)
187 187  (((
188 188  Changed behaviour of script action **<get_suitable_job/>**
189 -)))|(% colspan="1" %)(% colspan="1" %)
190 -(((
191 -
192 192  )))
193 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
561 +|(% colspan="4" %)(% colspan="3" %)
194 194  (((
195 -//<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.//
563 +<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.
196 196  )))
197 197  |(% colspan="1" %)(% colspan="1" %)
198 198  (((
... ... @@ -200,16 +200,13 @@
200 200  )))|(% colspan="1" %)(% colspan="1" %)
201 201  (((
202 202  3.0 Beta 6
203 -)))|(% colspan="1" %)(% colspan="1" %)
571 +)))|(% colspan="2" %)(% colspan="1" %)
204 204  (((
205 205  Changed behaviour of script action **<get_ware_definition/>**
206 -)))|(% colspan="1" %)(% colspan="1" %)
207 -(((
208 -
209 209  )))
210 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
575 +|(% colspan="4" %)(% colspan="3" %)
211 211  (((
212 -//<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.//
577 +<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.
213 213  )))
214 214  |(% colspan="1" %)(% colspan="1" %)
215 215  (((
... ... @@ -217,18 +217,15 @@
217 217  )))|(% colspan="1" %)(% colspan="1" %)
218 218  (((
219 219  3.0 Beta 5
220 -)))|(% colspan="1" %)(% colspan="1" %)
585 +)))|(% colspan="2" %)(% colspan="1" %)
221 221  (((
222 222  Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
223 -)))|(% colspan="1" %)(% colspan="1" %)
224 -(((
225 -
226 226  )))
227 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
589 +|(% colspan="4" %)(% colspan="3" %)
228 228  (((
229 -//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.)\\
591 +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.)
230 230  
231 -//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).//
593 +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).
232 232  )))
233 233  |(% colspan="1" %)(% colspan="1" %)
234 234  (((
... ... @@ -236,16 +236,13 @@
236 236  )))|(% colspan="1" %)(% colspan="1" %)
237 237  (((
238 238  3.0 Beta 5
239 -)))|(% colspan="1" %)(% colspan="1" %)
601 +)))|(% colspan="2" %)(% colspan="1" %)
240 240  (((
241 241  Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
242 -)))|(% colspan="1" %)(% colspan="1" %)
243 -(((
244 -
245 245  )))
246 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
605 +|(% colspan="4" %)(% colspan="3" %)
247 247  (((
248 -//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.//
607 +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.
249 249  )))
250 250  |(% colspan="1" %)(% colspan="1" %)
251 251  (((
... ... @@ -253,17 +253,14 @@
253 253  )))|(% colspan="1" %)(% colspan="1" %)
254 254  (((
255 255  3.0 Beta 5
256 -)))|(% colspan="1" %)(% colspan="1" %)
615 +)))|(% colspan="2" %)(% colspan="1" %)
257 257  (((
258 258  Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
259 -)))|(% colspan="1" %)(% colspan="1" %)
260 -(((
261 -
262 262  )))
263 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
619 +|(% colspan="4" %)(% colspan="3" %)
264 264  (((
265 -//Before the change, positions are relative to $dockingbay.parent.
266 -After the change, positions are relative to $dockingbay as specified in the documentation.//
621 +Before the change, positions are relative to $dockingbay.parent.
622 +After the change, positions are relative to $dockingbay as specified in the documentation.
267 267  )))
268 268  |(% colspan="1" %)(% colspan="1" %)
269 269  (((
... ... @@ -271,30 +271,24 @@
271 271  )))|(% colspan="1" %)(% colspan="1" %)
272 272  (((
273 273  3.0 Beta 2
274 -)))|(% colspan="1" %)(% colspan="1" %)
630 +)))|(% colspan="2" %)(% colspan="1" %)
275 275  (((
276 276  Support for entity flag "**skillsvisible**" dropped
277 -)))|(% colspan="1" %)(% colspan="1" %)
278 -(((
279 -
280 280  )))
281 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
634 +|(% colspan="4" %)(% colspan="3" %)
282 282  (((
283 -//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().//
636 +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().
284 284  )))
285 285  |(((
286 286  Scripts
287 287  )))|(((
288 288  3.0 Beta 2
289 -)))|(((
642 +)))|(% colspan="2" %)(((
290 290  Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
291 -)))|(% colspan="1" %)(% colspan="1" %)
292 -(((
293 -
294 294  )))
295 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
645 +|(% colspan="4" %)(% colspan="3" %)
296 296  (((
297 -//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.
647 +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.
298 298  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.
299 299  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.
300 300  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).
... ... @@ -305,30 +305,24 @@
305 305  )))|(% colspan="1" %)(% colspan="1" %)
306 306  (((
307 307  3.0 Beta 1
308 -)))|(% colspan="1" %)(% colspan="1" %)
658 +)))|(% colspan="2" %)(% colspan="1" %)
309 309  (((
310 310  **MissionBoard** support dropped
311 -)))|(% colspan="1" %)(% colspan="1" %)
312 -(((
313 -
314 314  )))
315 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
662 +|(% colspan="4" %)(% colspan="3" %)
316 316  (((
317 -//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.//
664 +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.
318 318  )))
319 319  |(((
320 320  Job/God
321 321  )))|(((
322 322  3.0 Beta 1
323 -)))|(((
670 +)))|(% colspan="2" %)(((
324 324  By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
325 -)))|(% colspan="1" %)(% colspan="1" %)
326 -(((
327 -
328 328  )))
329 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
673 +|(% colspan="4" %)(% colspan="3" %)
330 330  (((
331 -//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.//
675 +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.
332 332  )))
333 333  |(% colspan="1" %)(% colspan="1" %)
334 334  (((
... ... @@ -336,16 +336,13 @@
336 336  )))|(% colspan="1" %)(% colspan="1" %)
337 337  (((
338 338  3.0 Beta 1
339 -)))|(% colspan="1" %)(% colspan="1" %)
683 +)))|(% colspan="2" %)(% colspan="1" %)
340 340  (((
341 341  Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
342 -)))|(% colspan="1" %)(% colspan="1" %)
343 -(((
344 -
345 345  )))
346 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
687 +|(% colspan="4" %)(% colspan="3" %)
347 347  (((
348 -//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.//
689 +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.
349 349  )))
350 350  |(% colspan="1" %)(% colspan="1" %)
351 351  (((
... ... @@ -353,16 +353,13 @@
353 353  )))|(% colspan="1" %)(% colspan="1" %)
354 354  (((
355 355  3.0 Beta 1
356 -)))|(% colspan="1" %)(% colspan="1" %)
697 +)))|(% colspan="2" %)(% colspan="1" %)
357 357  (((
358 358  Script action **<set_doors_locked/>** attribute **'group'** changed
359 -)))|(% colspan="1" %)(% colspan="1" %)
360 -(((
361 -
362 362  )))
363 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
701 +|(% colspan="4" %)(% colspan="3" %)
364 364  (((
365 -//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.//
703 +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.
366 366  )))
367 367  |(% colspan="1" %)(% colspan="1" %)
368 368  (((
... ... @@ -370,16 +370,13 @@
370 370  )))|(% colspan="1" %)(% colspan="1" %)
371 371  (((
372 372  3.0 Beta 1
373 -)))|(% colspan="1" %)(% colspan="1" %)
711 +)))|(% colspan="2" %)(% colspan="1" %)
374 374  (((
375 375  Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
376 -)))|(% colspan="1" %)(% colspan="1" %)
377 -(((
378 -
379 379  )))
380 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
715 +|(% colspan="4" %)(% colspan="3" %)
381 381  (((
382 -//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.//
717 +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.
383 383  )))
384 384  |(% colspan="1" %)(% colspan="1" %)
385 385  (((
... ... @@ -387,16 +387,13 @@
387 387  )))|(% colspan="1" %)(% colspan="1" %)
388 388  (((
389 389  3.0 Beta 1
390 -)))|(% colspan="1" %)(% colspan="1" %)
725 +)))|(% colspan="2" %)(% colspan="1" %)
391 391  (((
392 392  Script actions **<set_hack_target/>** and **<abort_hack/>** removed
393 -)))|(% colspan="1" %)(% colspan="1" %)
394 -(((
395 -
396 396  )))
397 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
729 +|(% colspan="4" %)(% colspan="3" %)
398 398  (((
399 -//These actions had no effect and were removed.//
731 +These actions had no effect and were removed.
400 400  )))
401 401  |(% colspan="1" %)(% colspan="1" %)
402 402  (((
... ... @@ -404,16 +404,13 @@
404 404  )))|(% colspan="1" %)(% colspan="1" %)
405 405  (((
406 406  3.0 Beta 1
407 -)))|(% colspan="1" %)(% colspan="1" %)
739 +)))|(% colspan="2" %)(% colspan="1" %)
408 408  (((
409 409  **<setup_conversation_minigame/>** script action removed
410 -)))|(% colspan="1" %)(% colspan="1" %)
411 -(((
412 -
413 413  )))
414 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
743 +|(% colspan="4" %)(% colspan="3" %)
415 415  (((
416 -//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.//
745 +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.
417 417  )))
418 418  |(% colspan="1" %)(% colspan="1" %)
419 419  (((
... ... @@ -421,16 +421,13 @@
421 421  )))|(% colspan="1" %)(% colspan="1" %)
422 422  (((
423 423  3.0 Beta 1
424 -)))|(% colspan="1" %)(% colspan="1" %)
753 +)))|(% colspan="2" %)(% colspan="1" %)
425 425  (((
426 426  <add_player_choice_*> **confidence** attribute removed
427 -)))|(% colspan="1" %)(% colspan="1" %)
428 -(((
429 -
430 430  )))
431 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
757 +|(% colspan="4" %)(% colspan="3" %)
432 432  (((
433 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
759 +The default confidence of player options is another leftover from the XR era and had no effect in X4.
434 434  )))
435 435  |(% colspan="1" %)(% colspan="1" %)
436 436  (((
... ... @@ -438,16 +438,13 @@
438 438  )))|(% colspan="1" %)(% colspan="1" %)
439 439  (((
440 440  3.0 Beta 1
441 -)))|(% colspan="1" %)(% colspan="1" %)
767 +)))|(% colspan="2" %)(% colspan="1" %)
442 442  (((
443 443  **<hack_via_control_panel/>** script action removed
444 -)))|(% colspan="1" %)(% colspan="1" %)
445 -(((
446 -
447 447  )))
448 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
771 +|(% colspan="4" %)(% colspan="3" %)
449 449  (((
450 -//Unused script action <hack_via_control_panel/> was removed.//
773 +Unused script action <hack_via_control_panel/> was removed.
451 451  )))
452 452  |(% colspan="1" %)(% colspan="1" %)
453 453  (((
... ... @@ -455,30 +455,24 @@
455 455  )))|(% colspan="1" %)(% colspan="1" %)
456 456  (((
457 457  3.0 Beta 1
458 -)))|(% colspan="1" %)(% colspan="1" %)
781 +)))|(% colspan="2" %)(% colspan="1" %)
459 459  (((
460 460  **Lua: **GetMiniGameCursorPosition() removed
461 -)))|(% colspan="1" %)(% colspan="1" %)
462 -(((
463 -
464 464  )))
465 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
785 +|(% colspan="4" %)(% colspan="3" %)
466 466  (((
467 -//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.//
787 +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.
468 468  )))
469 469  |(((
470 470  UI core
471 471  )))|(((
472 472  3.0 Beta 1
473 -)))|(((
793 +)))|(% colspan="2" %)(((
474 474  **FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
475 -)))|(% colspan="1" %)(% colspan="1" %)
476 -(((
477 -
478 478  )))
479 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
796 +|(% colspan="4" %)(% colspan="3" %)
480 480  (((
481 -//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.//
798 +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.
482 482  )))
483 483  |(% colspan="1" %)(% colspan="1" %)
484 484  (((
... ... @@ -486,16 +486,13 @@
486 486  )))|(% colspan="1" %)(% colspan="1" %)
487 487  (((
488 488  3.0 Beta 1
489 -)))|(% colspan="1" %)(% colspan="1" %)
806 +)))|(% colspan="2" %)(% colspan="1" %)
490 490  (((
491 491  **FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
492 -)))|(% colspan="1" %)(% colspan="1" %)
493 -(((
494 -
495 495  )))
496 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
810 +|(% colspan="4" %)(% colspan="3" %)
497 497  (((
498 -//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.//
812 +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.
499 499  )))
500 500  |(% colspan="1" %)(% colspan="1" %)
501 501  (((
... ... @@ -503,17 +503,14 @@
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 505  3.0 Beta 1
506 -)))|(% colspan="1" %)(% colspan="1" %)
820 +)))|(% colspan="2" %)(% colspan="1" %)
507 507  (((
508 508  **$ware.illegal** updated
509 -)))|(% colspan="1" %)(% colspan="1" %)
510 -(((
511 -
512 512  )))
513 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
824 +|(% colspan="4" %)(% colspan="3" %)
514 514  (((
515 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
516 -//It now returns true if $ware is illegal to any faction in the game.//
826 +$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
827 +It now returns true if $ware is illegal to any faction in the game.
517 517  )))
518 518  |(% colspan="1" %)(% colspan="1" %)
519 519  (((
... ... @@ -521,16 +521,13 @@
521 521  )))|(% colspan="1" %)(% colspan="1" %)
522 522  (((
523 523  3.0 Beta 1
524 -)))|(% colspan="1" %)(% colspan="1" %)
835 +)))|(% colspan="2" %)(% colspan="1" %)
525 525  (((
526 526  MD script **RML_Flight_Along_Path** removed
527 -)))|(% colspan="1" %)(% colspan="1" %)
528 -(((
529 -
530 530  )))
531 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
839 +|(% colspan="4" %)(% colspan="3" %)
532 532  (((
533 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
841 +The MD script RML_Flight_Along_Path was not referened and was removed.
534 534  )))
535 535  |(% colspan="1" %)(% colspan="1" %)
536 536  (((
... ... @@ -538,86 +538,75 @@
538 538  )))|(% colspan="1" %)(% colspan="1" %)
539 539  (((
540 540  3.0 Beta 1
541 -)))|(% colspan="1" %)(% colspan="1" %)
849 +)))|(% colspan="2" %)(% colspan="1" %)
542 542  (((
543 543  parameters of **<event_venture_mission_completed/>** changed
544 -)))|(% colspan="1" %)(% colspan="1" %)
545 -(((
546 -
547 547  )))
548 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
853 +|(% colspan="4" %)(% colspan="3" %)
549 549  (((
550 -//old params: param = venture details, param2 = ships involved, param3 = duration//
551 -//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
855 +old params: param = venture details, param2 = ships involved, param3 = duration
856 +new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration
552 552  )))
553 553  |(((
554 554  Scripts
555 555  )))|(((
556 556  3.0 Beta 1
557 -)))|(((
862 +)))|(% colspan="2" %)(((
558 558  **<set_object_wing_name/>** removed,
559 559  **<set_object_fleet_name/>** added
560 -)))|(% colspan="1" %)(% colspan="1" %)
561 -(((
562 -
563 563  )))
564 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
866 +|(% colspan="4" %)(% colspan="3" %)
565 565  (((
566 -//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
868 +The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>
567 567  )))
568 568  |(((
569 569  Scripts
570 570  )))|(((
571 571  3.0 Beta 1
572 -)))|(((
874 +)))|(% colspan="2" %)(((
573 573  **$controllable.wing.*** removed,
574 574  **$controllable.fleet.*** added
575 -)))|(% colspan="1" %)(% colspan="1" %)
576 -(((
577 -
578 578  )))
579 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
878 +|(% colspan="4" %)(% colspan="3" %)
580 580  (((
581 581  $controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
582 582  )))
583 -|(% colspan="4" %)(% colspan="4" %)
584 -(((
585 -== 2.60 ==
586 -)))
882 +
883 +----
884 +
885 +=== Version 2.60 ===
886 +
887 +(% class="table-striped" %)
587 587  |(((
588 588  Scripts
589 589  )))|(((
590 590  2.60 Beta 1
591 -)))|(((
892 +)))|(% colspan="2" %)(((
592 592  '**checkoperational**' filter behaviour changed
593 -)))|(% colspan="1" %)(% colspan="1" %)
594 -(((
595 -
596 596  )))
597 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
895 +|(% colspan="10" %)(% colspan="3" %)
598 598  (((
599 -//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.//
897 +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.
600 600  
601 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
899 +Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.
602 602  )))
603 603  |(((
604 604  Scripts
605 605  )))|(((
606 606  2.60 Beta 1
607 -)))|(((
905 +)))|(% colspan="2" %)(((
608 608  $container.**supplyresources** behavior changed
609 -)))|(% colspan="1" %)(% colspan="1" %)
907 +)))| | |
908 +|(% colspan="10" %)(% colspan="3" %)
610 610  (((
611 -
910 +The script keyword $container.supplyresources now includes reserved wares.
612 612  )))
613 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
614 -(((
615 -//The script keyword $container.supplyresources now includes reserved wares.//
616 -)))
617 -|(% colspan="4" %)(% colspan="4" %)
618 -(((
619 -== 2.20 ==
620 -)))
912 +
913 +----
914 +
915 +=== Version 2.20 ===
916 +
917 +(% class="table-striped" %)
621 621  |(% colspan="1" %)(% colspan="1" %)
622 622  (((
623 623  UI core
... ... @@ -624,20 +624,16 @@
624 624  )))|(% colspan="1" %)(% colspan="1" %)
625 625  (((
626 626  2.20 Beta 3/4
627 -)))|(% colspan="1" %)(% colspan="1" %)
924 +)))|(% colspan="2" %)(% colspan="1" %)
628 628  (((
629 629  **Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
630 -)))|(% colspan="1" %)(% colspan="1" %)
631 -(((
632 -
633 633  )))
634 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
928 +|(% colspan="4" %)(% colspan="3" %)
635 635  (((
636 -//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.
637 -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.//
930 +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.
931 +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.
638 638  
639 -//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.
640 -//
933 +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.
641 641  )))
642 642  |(% colspan="1" %)(% colspan="1" %)
643 643  (((
... ... @@ -645,21 +645,20 @@
645 645  )))|(% colspan="1" %)(% colspan="1" %)
646 646  (((
647 647  2.20 Beta 3
648 -)))|(% colspan="1" %)(% colspan="1" %)
941 +)))|(% colspan="2" %)(% colspan="1" %)
649 649  (((
650 650  Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
651 -)))|(% colspan="1" %)(% colspan="1" %)
652 -(((
653 -
654 654  )))
655 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
945 +|(% colspan="4" %)(% colspan="3" %)
656 656  (((
657 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
947 +The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.
658 658  )))
659 -|(% colspan="4" %)(% colspan="4" %)
660 -(((
661 -== 2.00 ==
662 -)))
949 +
950 +----
951 +
952 +=== Version 2.00 ===
953 +
954 +(% class="table-striped" %)
663 663  |(% colspan="1" %)(% colspan="1" %)
664 664  (((
665 665  Scripts
... ... @@ -666,16 +666,13 @@
666 666  )))|(% colspan="1" %)(% colspan="1" %)
667 667  (((
668 668  2.00 Beta 1
669 -)))|(% colspan="1" %)(% colspan="1" %)
961 +)))|(% colspan="2" %)(% colspan="1" %)
670 670  (((
671 671  **<event_build_finished/> **param2 now returns null instead of a construction sequence
672 -)))|(% colspan="1" %)(% colspan="1" %)
673 -(((
674 -
675 675  )))
676 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
965 +|(% colspan="4" %)(% colspan="3" %)
677 677  (((
678 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
967 +The construction sequence which was finished should now be accessed via the buildtask provided via param3.
679 679  )))
680 680  |(% colspan="1" %)(% colspan="1" %)
681 681  (((
... ... @@ -683,16 +683,13 @@
683 683  )))|(% colspan="1" %)(% colspan="1" %)
684 684  (((
685 685  2.00 Beta 1
686 -)))|(% colspan="1" %)(% colspan="1" %)
975 +)))|(% colspan="2" %)(% colspan="1" %)
687 687  (((
688 688  **param.boarding.{...}** strength parameters removed
689 -)))|(% colspan="1" %)(% colspan="1" %)
690 -(((
691 -
692 692  )))
693 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
979 +|(% colspan="4" %)(% colspan="3" %)
694 694  (((
695 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
981 +The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.
696 696  )))
697 697  |(% colspan="1" %)(% colspan="1" %)
698 698  (((
... ... @@ -700,197 +700,160 @@
700 700  )))|(% colspan="1" %)(% colspan="1" %)
701 701  (((
702 702  2.00 Beta 1
703 -)))|(% colspan="1" %)(% colspan="1" %)
989 +)))|(% colspan="2" %)(% colspan="1" %)
704 704  (((
705 705  **$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
706 -)))|(% colspan="1" %)(% colspan="1" %)
707 -(((
708 -
709 709  )))
710 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
993 +|(% colspan="4" %)(% colspan="3" %)
711 711  (((
712 -//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.//
995 +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.
713 713  )))
714 714  |(((
715 715  UI extensions
716 716  )))|(((
717 717  2.00 Beta 1
718 -)))|(((
1001 +)))|(% colspan="2" %)(((
719 719  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
720 -)))|(% colspan="1" %)(% colspan="1" %)
721 -(((
722 -
723 723  )))
724 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1004 +|(% colspan="4" %)(% colspan="3" %)
725 725  (((
726 -//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.//
1006 +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.
727 727  )))
728 728  |(((
729 729  UI extensions
730 730  )))|(((
731 731  2.00 Beta 1
732 -)))|(((
1012 +)))|(% colspan="2" %)(((
733 733  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
734 -)))|(% colspan="1" %)(% colspan="1" %)
735 -(((
736 -
737 737  )))
738 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1015 +|(% colspan="4" %)(% colspan="3" %)
739 739  (((
740 -//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.//
741 -//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.//
1017 +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.
1018 +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.
742 742  )))
743 743  |(((
744 744  Scripts
745 745  )))|(((
746 746  2.00 Beta 1
747 -)))|(((
1024 +)))|(% colspan="2" %)(((
748 748  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
749 -)))|(% colspan="1" %)(% colspan="1" %)
750 -(((
751 -
752 752  )))
753 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1027 +|(% colspan="4" %)(% colspan="3" %)
754 754  (((
755 -//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.//
1029 +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.
756 756  )))
757 757  |(((
758 758  Scripts
759 759  )))|(((
760 760  2.00 Beta 1
761 -)))|(((
1035 +)))|(% colspan="2" %)(((
762 762  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
763 -)))|(% colspan="1" %)(% colspan="1" %)
764 -(((
765 -
766 766  )))
767 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1038 +|(% colspan="4" %)(% colspan="3" %)
768 768  (((
769 -//For prior behavior, check for event.param being non-null.//
1040 +For prior behavior, check for event.param being non-null.
770 770  )))
771 771  |(((
772 772  AI Scripts
773 773  )))|(((
774 774  2.00 Beta 1
775 -)))|(((
1046 +)))|(% colspan="2" %)(((
776 776  **<shoot/>/<shoot_at/>** attribute changes.
777 -)))|(% colspan="1" %)(% colspan="1" %)
778 -(((
779 -
780 780  )))
781 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1049 +|(% colspan="4" %)(% colspan="3" %)
782 782  (((
783 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
784 -//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.//
785 -//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.//
1051 +Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.
1052 +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.
1053 +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.
786 786  
787 -//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
1055 +Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.
788 788  )))
789 789  |(((
790 790  UI extensions
791 791  )))|(((
792 792  2.00 Beta 1
793 -)))|(((
794 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
795 -)))|(% colspan="1" %)(% colspan="1" %)
796 -(((
797 -
1061 +)))|(% colspan="2" %)(((
1062 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.
798 798  )))
799 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1064 +|(% colspan="4" %)(% colspan="3" %)
800 800  (((
801 -//Added possibility to query build tasks of a certain buildmodule.//
1066 +Added possibility to query build tasks of a certain buildmodule.
802 802  )))
803 803  |(((
804 804  UI extensions
805 805  )))|(((
806 806  2.00 Beta 1
807 -)))|(((
1072 +)))|(% colspan="2" %)(((
808 808  **Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
809 -)))|(% colspan="1" %)(% colspan="1" %)
810 -(((
811 -
812 812  )))
813 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1075 +|(% colspan="4" %)(% colspan="3" %)
814 814  (((
815 -//Added list of resources a buildmodule needs to build.//
1077 +Added list of resources a buildmodule needs to build.
816 816  )))
817 817  |(((
818 818  UI extensions
819 819  )))|(((
820 820  2.00 Beta 1
821 -)))|(((
822 -(% 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);" %)
823 -)))|(% colspan="1" %)(% colspan="1" %)
824 -(((
825 -
1083 +)))|(% colspan="2" %)(((
1084 +**Lua: CalculateTotalHullFraction() **was removed.
826 826  )))
827 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1086 +|(% colspan="4" %)(% colspan="3" %)
828 828  (((
829 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
1088 +Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.
830 830  )))
831 831  |(((
832 832  UI extensions
833 833  )))|(((
834 834  2.00 Beta 1
835 -)))|(((
836 -**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" %)
837 -)))|(% colspan="1" %)(% colspan="1" %)
838 -(((
839 -
1094 +)))|(% colspan="2" %)(((
1095 +**FFI: RequestDockAtReason()/UndockPlayerShip() **changed their return values.
840 840  )))
841 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1097 +|(% colspan="4" %)(% colspan="3" %)
842 842  (((
843 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
1099 +Changed return value type to const char* to better identify failure reasons in Lua script.
844 844  )))
845 -|(% colspan="4" %)(% colspan="4" %)
846 -(((
847 -== 1.50 ==
848 -)))
1101 +
1102 +----
1103 +
1104 +=== Version 1.50 ===
1105 +
1106 +(% class="table-striped" %)
849 849  |(((
850 850  UI extensions
851 851  )))|(((
852 852  1.50 Beta 3
853 -)))|(((
854 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
855 -)))|(% colspan="1" %)(% colspan="1" %)
856 -(((
857 -
1111 +)))|(% colspan="2" %)(((
1112 +**Lua: GetComponentData() **changed behavior of "docksizes" property.
858 858  )))
859 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1114 +|(% colspan="4" %)(% colspan="3" %)
860 860  (((
861 -//The "docksizes" property no longer includes internal ship storage docks.//
1116 +The "docksizes" property no longer includes internal ship storage docks.
862 862  )))
863 863  |(((
864 864  All
865 865  )))|(((
866 866  1.50 Beta 2
867 -)))|(((
1122 +)))|(% colspan="2" %)(((
868 868  **Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
869 -)))|(% colspan="1" %)(% colspan="1" %)
870 -(((
871 -
872 872  )))
873 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1125 +|(% colspan="4" %)(% colspan="3" %)
874 874  (((
875 -//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".//
1127 +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".
876 876  
877 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
878 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
879 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
1129 +Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()
1130 +Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"
1131 +Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)
880 880  )))
881 881  |(((
882 882  UI extensions
883 883  )))|(((
884 884  1.50 Beta 2
885 -)))|(((
886 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
887 -)))|(% colspan="1" %)(% colspan="1" %)
888 -(((
889 -
1137 +)))|(% colspan="2" %)(((
1138 +**FFI: UpgradeGroupInfo **datatype was changed.
890 890  )))
891 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1140 +|(% colspan="4" %)(% colspan="3" %)
892 892  (((
893 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
1142 +Added new "operational" field to retrieve information about number of operational upgrades in a group.
894 894  )))
895 895  |(% colspan="1" %)(% colspan="1" %)
896 896  (((
... ... @@ -898,67 +898,58 @@
898 898  )))|(% colspan="1" %)(% colspan="1" %)
899 899  (((
900 900  1.50 Beta 1
901 -)))|(% colspan="1" %)(% colspan="1" %)
1150 +)))|(% colspan="2" %)(% colspan="1" %)
902 902  (((
903 903  **FFI: SetGuidance()** removed useinfopoint argument.
904 -)))|(% colspan="1" %)(% colspan="1" %)
905 -(((
906 -
907 907  )))
908 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1154 +|(% colspan="4" %)(% colspan="3" %)
909 909  (((
910 -//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.
911 -//
1156 +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.
912 912  
913 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1158 +The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)
914 914  )))
915 915  |(((
916 916  UI extensions
917 917  )))|(((
918 918  1.50 Beta 1
919 -)))|(((
920 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
921 -)))|(% colspan="1" %)(% colspan="1" %)
922 -(((
923 -
1164 +)))|(% colspan="2" %)(((
1165 +**FFI: CancelConstruction() **changed its return value.
924 924  )))
925 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1167 +|(% colspan="4" %)(% colspan="3" %)
926 926  (((
927 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
1169 +CancelConstruction() now returns if the cancellation was successful.
928 928  )))
929 -|(% colspan="4" %)(% colspan="4" %)
930 -(((
931 -== 1.32 ==
932 -)))
1171 +
1172 +----
1173 +
1174 +=== Version 1.32 ===
1175 +
1176 +(% class="table-striped" %)
933 933  |(((
934 934  UI extensions
935 935  )))|(((
936 936  1.32
937 -)))|(((
1181 +)))|(% colspan="2" %)(((
938 938  **Lua: GetComponentData() **removed the "nextdestname" property.
939 -)))|(% colspan="1" %)(% colspan="1" %)
940 -(((
941 -
942 942  )))
943 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1184 +|(% colspan="4" %)(% colspan="3" %)
944 944  (((
945 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
1186 +Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.
946 946  )))
947 -|(% colspan="4" %)(% colspan="4" %)
948 -(((
949 -== 1.20 ==
950 -)))
1188 +
1189 +----
1190 +
1191 +=== Version 1.20 ===
1192 +
1193 +(% class="table-striped" %)
951 951  |(((
952 952  UI extensions
953 953  )))|(((
954 954  1.20
955 -)))|(((
956 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
957 -)))|(% colspan="1" %)(% colspan="1" %)
958 -(((
959 -
1198 +)))|(% colspan="2" %)(((
1199 +**FFI: GetAAOption()** got a new "useconfig" parameter.
960 960  )))
961 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)
1201 +|(% colspan="4" %)(% colspan="3" %)
962 962  (((
963 -//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.//
1203 +//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.//
964 964  )))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,0 @@
1 -100860794
space
... ... @@ -1,1 +1,0 @@
1 -X4WIKI
url
... ... @@ -1,1 +1,0 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/100860794/Breaking Changes