Changes for page Breaking Changes

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

From version 47.1
edited by michael
on 2019/11/20 10:24
Change comment: There is no comment for this version
To version 147.1
edited by Matthias Haan
on 2026/02/20 11:22
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.michael
1 +xwiki:XWiki.Matthias
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,41 +18,649 @@
18 18  
19 19  = Breaking Changes =
20 20  
21 -|=(((
22 -Type
23 -)))|=(((
24 -Version
25 -)))|=(((
26 -Summary
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 **<event_area_discovered>**
27 +|(% colspan="6" style="width:117px" %)Removed for performance reasons
28 +|(% colspan="1" style="width:117px" %)Assets|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)Added **overheatcooldelay** property to **<heat>** of weapons, changed functionality of **cooldelay**
29 +|(% colspan="6" style="width:117px" %)**cooldelay** now optionally defines a delay between firing a non-overheating shot and the cooldown starting, **overheatcooldelay** is an additional penalty delay when the weapon overheats.
30 +|(% colspan="1" style="width:117px" %)Scripts|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)Removed script action **<get_highest_resource_yield>**
31 +|(% colspan="6" style="width:117px" %)A new property that can be used in its place is **$sector.bestyieldrating.{$ware}**.
32 +|(% colspan="1" style="width:117px" %)Scripts|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)Removed **<find_asteroid_in_cluster>** and **<find_recyclable_in_cluster>**
33 +|(% colspan="6" style="width:117px" %)**<find_asteroid_with_yield_in_sector>** and **<find_recyclable_with_yield_in_sector>** should now be used instead.
34 +|(% colspan="1" style="width:117px" %)Parameters|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)Removed **<yielddensities>** from **<miningparams>**
35 +|(% colspan="6" style="width:117px" %)It has been replaced with the new **<resources>** node.
36 +|(% colspan="1" style="width:117px" %)Libraries|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)**region_definitions.xml** no longer contains **<resources>** or **<scaneffect> **nodes
37 +|(% colspan="6" style="width:117px" %)Instead of defining resources in regions, they're now defined via resource areas in sectors (see **mapdefaults.xml** and **resourceyields.xml**). Regions can still have some control by defining **<allowedyields>**.
38 +|(% colspan="1" style="width:117px" %)Libraries|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)**regionyields.xml** has a completely different structure
39 +|(% colspan="6" style="width:117px" %)It now contains definitions of resource areas referenced by sector properties (see **mapdefaults.xml**).
40 +|(% colspan="1" style="width:117px" %)Scripts|(% colspan="1" style="width:119px" %)9.00 Beta 1|(% colspan="4" style="width:1625px" %)Removed **$resourceprobe.currentbestyield** and **.maxyield**, **$sector.averagemaxyield**, and **$galaxy.yieldthresholds**
41 +|(% colspan="6" style="width:117px" %)New properties that can be used are **$resourceprobe.bestyieldrating** and **$sector.yieldrating.{$ware}**. Yields thresholds are no longer a thing in 9.00.
42 +|(% 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>**
43 +|(% colspan="6" style="width:117px" %)(((
44 +The flags attribute is no longer available in the MD action <add_blueprints>
27 27  )))
28 -|(% colspan="3" %)(% colspan="3" %)
46 +|(% style="width:117px" %)Scripts|(% style="width:117px" %)9.00 Beta 1|(% colspan="3" style="width:117px" %)Construction sequence param removed from build_started events
47 +|(% 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.
48 +|(% style="width:117px" %)Scripts|(% style="width:117px" %)9.00 Beta 1|(% colspan="3" style="width:117px" %)Script properties removed from macro
49 +|(% colspan="6" style="width:117px" %)**.purposemacro** and **.purposename **have been removed from the **macro **script properties
50 +|(% 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>**
51 +|(% 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.
52 +
53 +=== Version 8.00 ===
54 +
55 +(% class="table-striped" %)
56 +|(% 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>**
57 +|(% colspan="6" style="width:117px" %)(((
58 +The deprecated MD action <populate_platforms> has been removed. The previously referenced character quotas in quotas.xml have also been removed.
59 +)))
60 +|(% 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**
61 +|(% 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.
62 +|(% 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**
63 +|(% 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).
64 +|(% 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**
65 +|(% 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.
66 +|(% 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
67 +|(% 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.
68 +
69 +=== Version 7.50 ===
70 +
71 +(% class="table-striped" %)
72 +|(% 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)
73 +|(% colspan="4" style="width:117px" %)(((
74 +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.
75 +)))
76 +|(% 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**
77 +|(% colspan="7" style="width:117px" %)(((
78 +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.
79 +)))
80 +
81 +=== Version 7.00 ===
82 +
83 +
84 +(% class="table-striped" %)
85 +|(% colspan="1" style="width:117px" %)Gamestarts|(% colspan="1" style="width:119px" %)7.00 Beta 8|(% colspan="2" style="width:1625px" %)**Text references**
86 +|(% 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.
87 +|(% 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**
88 +|(% colspan="4" style="width:117px" %)highway_fx_electric_02 is still available in "legacy" folder if needed
89 +|(% 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
90 +|(% colspan="4" style="width:117px" %)(((
91 +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.
92 +)))
93 +|(% 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.
94 +|(% colspan="4" style="width:117px" %)(((
95 +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.**
96 +)))
97 +|(% 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.
98 +|(% colspan="4" style="width:117px" %)(((
99 +Some material names and texture paths were changed. Please DIFF the materiallibrary.xml from 6.20 with 7.0 to see the difference
100 +)))
101 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
29 29  (((
30 -== 3.00 ==
103 +Scripts
104 +)))|(% colspan="1" style="width:119px" %)(((
105 +7.00 Beta 1
106 +)))|(% colspan="2" style="width:1625px" %)(((
107 +MD action **<set_presentation_cluster_persistence/>** now requires the cluster to be a presentation cluster.
31 31  )))
109 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
110 +(((
111 + Previously it was possible to set normal clusters to be persistent presentation clusters which was an invalid state.
112 +)))
113 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
114 +(((
115 +UI extensions
116 +)))|(% colspan="1" style="width:119px" %)(((
117 +7.00 Beta 1
118 +)))|(% colspan="2" style="width:1625px" %)(((
119 +**FFI**: RemoveBuildPlot() changed
120 +)))
121 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
122 +(((
123 + 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.
124 +)))
125 +|(% colspan="1" style="width:117px" %)(% colspan="1" %)
126 +(((
127 +Assets
128 +)))|(% colspan="1" style="width:119px" %)(((
129 +7.00 Beta 1
130 +)))|(% colspan="2" style="width:1625px" %)(((
131 +**Some Split DLC materials moved to base game**
132 +)))
133 +|(% colspan="7" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
134 +(((
135 +// //"spl_p1_fx" AND "split_p1_hulltexture_01" were moved from Split DLC to base game
136 +)))
137 +
138 +=== Version 6.00 ===
139 +
140 +(% class="table-striped" %)
141 +|(((
142 +Libraries
143 +)))|(((
144 +6.00 Beta 7
145 +)))|(% colspan="2" %)(((
146 +Updated weights for ship groups in shipgroups.xml libraries of base game and all DLCs.
147 +)))
148 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
149 +(((
150 +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.
151 +
152 +All groups should now have "weight" parameter added and old "weights" were updated to not have single-digit numbers.
153 +)))
32 32  |(% colspan="1" %)(% colspan="1" %)
33 33  (((
156 +Scripts
157 +)))|(% colspan="1" %)(% colspan="1" %)
158 +(((
159 +6.00 Beta 4
160 +)))|(% colspan="2" %)(% colspan="1" %)
161 +(((
162 +Changed conditions for **<event_player_travelmode_started> <event_player_travelmode_stopped> <event_player_travelmode_charge_started> <event_player_travelmode_charge_aborted>** to be raised.
163 +)))
164 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
165 +(((
166 +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.
167 +
168 +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.
169 +)))
170 +|(% colspan="1" %)(% colspan="1" %)
171 +(((
172 +Scripts
173 +)))|(% colspan="1" %)(% colspan="1" %)
174 +(((
175 +6.00 Beta 3
176 +)))|(% colspan="2" %)(% colspan="1" %)
177 +(((
178 +Changed result of **<find_object_surface>** action in the case of a failure
179 +)))
180 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
181 +(((
182 +The 'posname' and 'rotname' result attributes of <find_object_surface> will now return null in the case of no valid surface position being found.
183 +
184 +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.
185 +
186 +The action itself has been improved to increase the chance of finding suitable surface positions.
187 +)))
188 +|(% colspan="1" %)(% colspan="1" %)
189 +(((
190 +Scripts
191 +)))|(% colspan="1" %)(% colspan="1" %)
192 +(((
193 +6.00 Beta 1
194 +)))|(% colspan="2" %)(% colspan="1" %)
195 +(((
196 +Behaviour change for **<match_dock>** script component filter
197 +)))
198 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
199 +(((
200 +<match_dock> nodes can now be used on container and walkablemodule classes without wrapping them in <match_content> nodes.
201 +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.
202 +)))
203 +|(% colspan="1" %)(% colspan="1" %)
204 +(((
205 +Scripts
206 +)))|(% colspan="1" %)(% colspan="1" %)
207 +(((
208 +6.00 Beta 1
209 +)))|(% colspan="2" %)(% colspan="1" %)
210 +(((
211 +Changed result attribute location for **<get_attackstrength>**
212 +)))
213 +|(% colspan="4" title="Background colour :" %)(% colspan="3" title="Background colour :" %)
214 +(((
215 +The 'result' attribute of get_attackstrength has been moved into the new <result> subnode and renamed to 'total'.
216 +)))
217 +|(((
218 +Assets
219 +)))|(((
220 +6.00 Beta 1
221 +)))|(% colspan="2" %)(((
222 +Surface element **connections** are incompatible by default unless tagged as "**standard**", and also "**combat**" for non-missile, non-mining weapons
223 +)))
224 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
225 +(((
226 +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.
227 +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.
228 +)))
229 +|(% colspan="1" %)(% colspan="1" %)
230 +(((
231 +Scripts
232 +)))|(% colspan="1" %)(% colspan="1" %)
233 +(((
234 +6.00 Beta 1
235 +)))|(% colspan="2" %)(% colspan="1" %)
236 +(((
237 +Changed behaviour of attribute **sortbygatedistanceto** when finding objects, discarding unreachable objects
238 +)))
239 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
240 +(((
241 +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.
242 +)))
243 +|(((
244 +Scripts
245 +)))|(((
246 +6.00 Beta 1
247 +)))|(% colspan="2" %)(((
248 +**<event_player_owned_killed_object>** and **<event_player_owned_destroyed>** are now triggered before the corresponding **<event_object_destroyed>**, instead of afterwards.
249 +)))
250 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
251 +(((
252 +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.
253 +)))
254 +|(((
255 +Cutscenes
256 +)))|(((
257 +6.00 Beta 1
258 +)))|(% colspan="2" %)(((
259 +Changed behaviour of **<angles>** in cutscenes
260 +)))
261 +|(% colspan="4" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)(% colspan="3" data-highlight-colour="#f4f5f7" title="Background color : Light grey 100%" %)
262 +(((
263 +The yaw and pitch nodes in <angles> are now correctly interpreted as values in degrees.
264 +)))
265 +
266 +----
267 +
268 +=== Version 5.00 ===
269 +
270 +(% class="table-striped" %)
271 +|(((
272 +Parameters
273 +)))|(((
274 +5.00 Beta 1
275 +)))|(% colspan="2" %)(((
276 +**<controlpanel><entry>: minduration** removed, **maxduration** renamed to duration
277 +)))
278 +|(% colspan="7" %)(% colspan="3" %)
279 +(((
280 +'minduration' was unused in X4, maxduration was and still is taken as the actual duration of control panel hacks. No functionality change.
281 +)))
282 +
283 +----
284 +
285 +=== Version 4.10 ===
286 +
287 +(% class="table-striped" %)
288 +|(% colspan="1" %)(% colspan="1" %)
289 +(((
290 +UI extensions
291 +)))|(% colspan="1" %)(% colspan="1" %)
292 +(((
293 +4.10 Beta 7
294 +)))|(% colspan="2" %)(% colspan="1" %)
295 +(((
296 +**FFI**: SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() deprecated
297 +)))
298 +|(% colspan="4" %)(% colspan="3" %)
299 +(((
300 +The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed.
301 +)))
302 +|(% colspan="1" %)(% colspan="1" %)
303 +(((
304 +UI extensions
305 +)))|(% colspan="1" %)(% colspan="1" %)
306 +(((
307 +4.10 Beta 6
308 +)))|(% colspan="2" %)(% colspan="1" %)
309 +(((
310 +**FFI**: CustomGameStartPlayerProperty2 changed
311 +)))
312 +|(% colspan="4" %)(% colspan="3" %)
313 +(((
314 +This struct was added in 4.10 Beta 2 and an additional member count was added in Beta 6.
315 +)))
316 +|(% colspan="1" %)(% colspan="1" %)
317 +(((
318 +Parameters
319 +)))|(% colspan="1" %)(% colspan="1" %)
320 +(((
321 +4.10 Beta 3
322 +)))|(% colspan="2" %)(% colspan="1" %)
323 +(((
324 +Renamed **<stationinfobox>** to **<infobox>**
325 +)))
326 +|(% colspan="4" %)(% colspan="3" %)
327 +(((
328 +Info box parameters are now shared across stations and ships. The node has a more generic name to reflect that.
329 +)))
330 +|(% colspan="1" %)(% colspan="1" %)
331 +(((
332 +UI extensions
333 +)))|(% colspan="1" %)(% colspan="1" %)
334 +(((
335 +4.10 Beta 2
336 +)))|(% colspan="2" %)(% colspan="1" %)
337 +(((
338 +**FFI**: SetMacroMapPlayerSectorOffset() deprecated
339 +)))
340 +|(% colspan="4" %)(% colspan="3" %)
341 +(((
342 +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.
343 +)))
344 +|(((
345 +UI extensions
346 +)))|(((
347 +4.10 Beta 2
348 +)))|(% colspan="2" %)(((
349 +**FFI**: FilterComponentForMapMode() and SetMapObjectFilter() changed
350 +)))
351 +|(% colspan="4" %)(% colspan="3" %)
352 +(((
353 +These functions were added in 4.10 Beta 1 and an additional boolean parameter allowentitydeliverymissionobject was added in Beta 2.
354 +)))
355 +|(((
356 +Scripts
357 +)))|(((
358 +4.10 Beta 1
359 +)))|(% colspan="2" %)(((
360 +People related attributes of mission** <delivery> **node moved
361 +)))
362 +|(% colspan="4" %)(% colspan="3" %)
363 +(((
364 +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.
365 +)))
366 +|(% colspan="1" %)(% colspan="1" %)
367 +(((
368 +Scripts
369 +)))|(% colspan="1" %)(% colspan="1" %)
370 +(((
371 +4.10 Beta 1
372 +)))|(% colspan="2" %)(% colspan="1" %)
373 +(((
374 +**$destructible.productions** replaced with $defensible.productions
375 +)))
376 +|(% colspan="4" %)(% colspan="3" %)
377 +(((
378 +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.
379 +)))
380 +|(((
381 +Scripts
382 +)))|(((
383 +4.10 Beta 1
384 +)))|(% colspan="2" %)(((
385 +Removed script property **$object.spawnsourceseed**
386 +)))
387 +|(% colspan="4" %)(% colspan="3" %)
388 +(((
389 +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.
390 +)))
391 +
392 +----
393 +
394 +=== Version 4.00 ===
395 +
396 +(% class="table-striped" %)
397 +|(% colspan="1" %)(% colspan="1" %)
398 +(((
399 +UI core
400 +)))|(% colspan="1" %)(% colspan="1" %)
401 +(((
402 +4.00 Beta 10
403 +)))|(% colspan="2" %)(% colspan="1" %)
404 +(((
405 +Controlled ship can change without a **gameplanchange-event** occurring.
406 +)))
407 +|(% colspan="4" %)(% colspan="3" %)
408 +(((
409 +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).
410 +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.
411 +)))
412 +|(((
413 +Scripts
414 +)))|(((
415 +4.00 Beta 7
416 +)))|(% colspan="2" %)(((
417 +Parameters of **<event_terraforming_project_succeeded>** and **<event_terraforming_project_failed>** changed
418 +)))
419 +|(% colspan="4" %)(% colspan="3" %)
420 +(((
421 +Old params: param = project ID, param2 = were there positive side-effects?, param3 = were there negative side-effects?
422 +New params: param = project ID, param2 = [were there positive side-effects?, were there negative side-effects?], param3 = payout in Credits
423 +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
424 +)))
425 +|(% colspan="1" %)(% colspan="1" %)
426 +(((
427 +UI core
428 +)))|(% colspan="1" %)(% colspan="1" %)
429 +(((
430 +4.00 Beta 6
431 +)))|(% colspan="2" %)(% colspan="1" %)
432 +(((
433 +**FFI:** GetFactionRelationStatus() handling for faction relation range [-20,-10] changed
434 +)))
435 +|(% colspan="4" %)(% colspan="3" %)
436 +(((
437 +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.
438 +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).
439 +
440 +If you rely on a handling where these factions are treated like enemies, please use the new GetFactionRelationStatus2() function instead.
441 +)))
442 +|(% colspan="1" %)(% colspan="1" %)
443 +(((
444 +UI core
445 +)))|(% colspan="1" %)(% colspan="1" %)
446 +(((
447 +4.00 Beta 5
448 +)))|(% colspan="2" %)(% colspan="1" %)
449 +(((
450 +**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed
451 +)))
452 +|(% colspan="4" %)(% colspan="3" %)
453 +(((
454 +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.
455 +
456 +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).
457 +)))
458 +|(((
459 +Parameters
460 +)))|(((
461 +4.00 Beta 1
462 +)))|(% colspan="2" %)(((
463 +**requiresconstructionvessel** parameter moved
464 +)))
465 +|(% colspan="4" %)(% colspan="3" %)
466 +(((
467 +The 'requiresconstructionvessel' attribute has been moved from the 'recycling' node itself, to the new 'station' subnode.
468 +)))
469 +|(((
470 +Scripts
471 +)))|(((
472 +4.00 Beta 1
473 +)))|(% colspan="2" %)(((
474 +Changed behaviour of **gatedistance** script property
475 +)))
476 +|(% colspan="4" %)(% colspan="3" %)
477 +(((
478 +The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.
479 +)))
480 +
481 +----
482 +
483 +=== Version 3.30 ===
484 +
485 +(% class="table-striped" %)
486 +|(((
487 +UI extensions
488 +)))|(((
489 +3.30 Beta 3
490 +)))|(% colspan="2" %)(((
491 +**FFI: **Removed** GetMissionLimit() **and** IsMissionLimitEnabled()**
492 +)))
493 +|(% colspan="7" %)(% colspan="3" %)
494 +(((
495 +These mission limit-related functions (added in 3.30 Beta 1 and 2) are replaced with FFI IsMissionLimitReached()
496 +)))
497 +
498 +----
499 +
500 +=== Version 3.20 ===
501 +
502 +(% class="table-striped" %)
503 +|(((
504 +Scripts
505 +)))|(((
506 +3.20 Beta 1
507 +)))|(% colspan="2" %)(((
508 +Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
509 +)))
510 +|(% colspan="4" %)(% colspan="3" %)
511 +(((
512 +Old params: param = attacked object, param2 = attack method, param3 = attacked component
513 +New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
514 +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
515 +)))
516 +|(% colspan="1" %)(% colspan="1" %)
517 +(((
518 +Scripts
519 +)))|(% colspan="1" %)(% colspan="1" %)
520 +(((
521 +3.20 Beta 1
522 +)))|(% colspan="2" %)(% colspan="1" %)
523 +(((
524 +Removed script property $trade.**restriction.faction**
525 +)))
526 +|(% colspan="4" %)(% colspan="3" %)
527 +(((
528 +$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions.
529 +)))
530 +|(((
531 +UI extensions
532 +)))|(((
533 +3.20 Beta 1
534 +)))|(% colspan="2" %)(((
535 +**Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
536 +)))
537 +|(% colspan="4" %)(% colspan="3" %)
538 +(((
539 +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.
540 +)))
541 +
542 +----
543 +
544 +=== Version 3.10 ===
545 +
546 +(% class="table-striped" %)
547 +|(% colspan="1" %)(% colspan="1" %)
548 +(((
549 +Scripts
550 +)))|(% colspan="1" %)(% colspan="1" %)
551 +(((
552 +3.10 Beta 1
553 +)))|(% colspan="2" %)(% colspan="1" %)
554 +(((
555 +Removed script action **<add_build/>**
556 +)))
557 +|(% colspan="7" %)(% colspan="3" %)
558 +(((
559 +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.
560 +)))
561 +
562 +----
563 +
564 +=== Version 3.00 ===
565 +
566 +(% class="table-striped" %)
567 +|(% colspan="1" %)(% colspan="1" %)
568 +(((
569 +Scripts
570 +)))|(% colspan="1" %)(% colspan="1" %)
571 +(((
572 +3.0 Beta 6
573 +)))|(% colspan="2" %)(% colspan="1" %)
574 +(((
575 +Changed behaviour of script action **<get_suitable_job/>**
576 +)))
577 +|(% colspan="4" %)(% colspan="3" %)
578 +(((
579 +<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.
580 +)))
581 +|(% colspan="1" %)(% colspan="1" %)
582 +(((
583 +Scripts
584 +)))|(% colspan="1" %)(% colspan="1" %)
585 +(((
586 +3.0 Beta 6
587 +)))|(% colspan="2" %)(% colspan="1" %)
588 +(((
589 +Changed behaviour of script action **<get_ware_definition/>**
590 +)))
591 +|(% colspan="4" %)(% colspan="3" %)
592 +(((
593 +<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.
594 +)))
595 +|(% colspan="1" %)(% colspan="1" %)
596 +(((
34 34  Global
35 35  )))|(% colspan="1" %)(% colspan="1" %)
36 36  (((
37 -3.0 Beta 2
600 +3.0 Beta 5
601 +)))|(% colspan="2" %)(% colspan="1" %)
602 +(((
603 +Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
604 +)))
605 +|(% colspan="4" %)(% colspan="3" %)
606 +(((
607 +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.)
608 +
609 +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).
610 +)))
611 +|(% colspan="1" %)(% colspan="1" %)
612 +(((
613 +Scripts
38 38  )))|(% colspan="1" %)(% colspan="1" %)
39 39  (((
616 +3.0 Beta 5
617 +)))|(% colspan="2" %)(% colspan="1" %)
618 +(((
619 +Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
620 +)))
621 +|(% colspan="4" %)(% colspan="3" %)
622 +(((
623 +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.
624 +)))
625 +|(% colspan="1" %)(% colspan="1" %)
626 +(((
627 +Scripts
628 +)))|(% colspan="1" %)(% colspan="1" %)
629 +(((
630 +3.0 Beta 5
631 +)))|(% colspan="2" %)(% colspan="1" %)
632 +(((
633 +Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
634 +)))
635 +|(% colspan="4" %)(% colspan="3" %)
636 +(((
637 +Before the change, positions are relative to $dockingbay.parent.
638 +After the change, positions are relative to $dockingbay as specified in the documentation.
639 +)))
640 +|(% colspan="1" %)(% colspan="1" %)
641 +(((
642 +Global
643 +)))|(% colspan="1" %)(% colspan="1" %)
644 +(((
645 +3.0 Beta 2
646 +)))|(% colspan="2" %)(% colspan="1" %)
647 +(((
40 40  Support for entity flag "**skillsvisible**" dropped
41 41  )))
42 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
650 +|(% colspan="4" %)(% colspan="3" %)
43 43  (((
44 -//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().//
652 +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().
45 45  )))
46 46  |(((
47 47  Scripts
48 48  )))|(((
49 49  3.0 Beta 2
50 -)))|(((
658 +)))|(% colspan="2" %)(((
51 51  Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
52 52  )))
53 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
661 +|(% colspan="4" %)(% colspan="3" %)
54 54  (((
55 -//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.
663 +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.
56 56  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.
57 57  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.
58 58  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).
... ... @@ -63,14 +63,25 @@
63 63  )))|(% colspan="1" %)(% colspan="1" %)
64 64  (((
65 65  3.0 Beta 1
66 -)))|(% colspan="1" %)(% colspan="1" %)
674 +)))|(% colspan="2" %)(% colspan="1" %)
67 67  (((
68 -MissionBoard support dropped
676 +**MissionBoard** support dropped
69 69  )))
70 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
678 +|(% colspan="4" %)(% colspan="3" %)
71 71  (((
72 -//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 behavior would occur. Therefore we cleaned things up in 3.0 Beta 1 including deprecating/removing any related UI/script function.//
680 +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.
73 73  )))
682 +|(((
683 +Job/God
684 +)))|(((
685 +3.0 Beta 1
686 +)))|(% colspan="2" %)(((
687 +By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
688 +)))
689 +|(% colspan="4" %)(% colspan="3" %)
690 +(((
691 +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.
692 +)))
74 74  |(% colspan="1" %)(% colspan="1" %)
75 75  (((
76 76  Scripts
... ... @@ -77,13 +77,13 @@
77 77  )))|(% colspan="1" %)(% colspan="1" %)
78 78  (((
79 79  3.0 Beta 1
80 -)))|(% colspan="1" %)(% colspan="1" %)
699 +)))|(% colspan="2" %)(% colspan="1" %)
81 81  (((
82 82  Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
83 83  )))
84 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
703 +|(% colspan="4" %)(% colspan="3" %)
85 85  (((
86 -//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.//
705 +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.
87 87  )))
88 88  |(% colspan="1" %)(% colspan="1" %)
89 89  (((
... ... @@ -91,13 +91,13 @@
91 91  )))|(% colspan="1" %)(% colspan="1" %)
92 92  (((
93 93  3.0 Beta 1
94 -)))|(% colspan="1" %)(% colspan="1" %)
713 +)))|(% colspan="2" %)(% colspan="1" %)
95 95  (((
96 96  Script action **<set_doors_locked/>** attribute **'group'** changed
97 97  )))
98 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
717 +|(% colspan="4" %)(% colspan="3" %)
99 99  (((
100 -//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.//
719 +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.
101 101  )))
102 102  |(% colspan="1" %)(% colspan="1" %)
103 103  (((
... ... @@ -105,13 +105,13 @@
105 105  )))|(% colspan="1" %)(% colspan="1" %)
106 106  (((
107 107  3.0 Beta 1
108 -)))|(% colspan="1" %)(% colspan="1" %)
727 +)))|(% colspan="2" %)(% colspan="1" %)
109 109  (((
110 110  Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed
111 111  )))
112 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
731 +|(% colspan="4" %)(% colspan="3" %)
113 113  (((
114 -//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.//
733 +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.
115 115  )))
116 116  |(% colspan="1" %)(% colspan="1" %)
117 117  (((
... ... @@ -119,13 +119,13 @@
119 119  )))|(% colspan="1" %)(% colspan="1" %)
120 120  (((
121 121  3.0 Beta 1
122 -)))|(% colspan="1" %)(% colspan="1" %)
741 +)))|(% colspan="2" %)(% colspan="1" %)
123 123  (((
124 124  Script actions **<set_hack_target/>** and **<abort_hack/>** removed
125 125  )))
126 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
745 +|(% colspan="4" %)(% colspan="3" %)
127 127  (((
128 -//These actions had no effect and were removed.//
747 +These actions had no effect and were removed.
129 129  )))
130 130  |(% colspan="1" %)(% colspan="1" %)
131 131  (((
... ... @@ -133,13 +133,13 @@
133 133  )))|(% colspan="1" %)(% colspan="1" %)
134 134  (((
135 135  3.0 Beta 1
136 -)))|(% colspan="1" %)(% colspan="1" %)
755 +)))|(% colspan="2" %)(% colspan="1" %)
137 137  (((
138 138  **<setup_conversation_minigame/>** script action removed
139 139  )))
140 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
759 +|(% colspan="4" %)(% colspan="3" %)
141 141  (((
142 -//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.//
761 +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.
143 143  )))
144 144  |(% colspan="1" %)(% colspan="1" %)
145 145  (((
... ... @@ -147,13 +147,13 @@
147 147  )))|(% colspan="1" %)(% colspan="1" %)
148 148  (((
149 149  3.0 Beta 1
150 -)))|(% colspan="1" %)(% colspan="1" %)
769 +)))|(% colspan="2" %)(% colspan="1" %)
151 151  (((
152 152  <add_player_choice_*> **confidence** attribute removed
153 153  )))
154 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
773 +|(% colspan="4" %)(% colspan="3" %)
155 155  (((
156 -//The default confidence of player options is another leftover from the XR era and had no effect in X4.//
775 +The default confidence of player options is another leftover from the XR era and had no effect in X4.
157 157  )))
158 158  |(% colspan="1" %)(% colspan="1" %)
159 159  (((
... ... @@ -161,13 +161,13 @@
161 161  )))|(% colspan="1" %)(% colspan="1" %)
162 162  (((
163 163  3.0 Beta 1
164 -)))|(% colspan="1" %)(% colspan="1" %)
783 +)))|(% colspan="2" %)(% colspan="1" %)
165 165  (((
166 166  **<hack_via_control_panel/>** script action removed
167 167  )))
168 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
787 +|(% colspan="4" %)(% colspan="3" %)
169 169  (((
170 -//Unused script action <hack_via_control_panel/> was removed.//
789 +Unused script action <hack_via_control_panel/> was removed.
171 171  )))
172 172  |(% colspan="1" %)(% colspan="1" %)
173 173  (((
... ... @@ -175,24 +175,24 @@
175 175  )))|(% colspan="1" %)(% colspan="1" %)
176 176  (((
177 177  3.0 Beta 1
178 -)))|(% colspan="1" %)(% colspan="1" %)
797 +)))|(% colspan="2" %)(% colspan="1" %)
179 179  (((
180 180  **Lua: **GetMiniGameCursorPosition() removed
181 181  )))
182 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
801 +|(% colspan="4" %)(% colspan="3" %)
183 183  (((
184 -//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.//
803 +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.
185 185  )))
186 186  |(((
187 187  UI core
188 188  )))|(((
189 189  3.0 Beta 1
190 -)))|(((
809 +)))|(% colspan="2" %)(((
191 191  **FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
192 192  )))
193 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
812 +|(% colspan="4" %)(% colspan="3" %)
194 194  (((
195 -//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.//
814 +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.
196 196  )))
197 197  |(% colspan="1" %)(% colspan="1" %)
198 198  (((
... ... @@ -200,13 +200,13 @@
200 200  )))|(% colspan="1" %)(% colspan="1" %)
201 201  (((
202 202  3.0 Beta 1
203 -)))|(% colspan="1" %)(% colspan="1" %)
822 +)))|(% colspan="2" %)(% colspan="1" %)
204 204  (((
205 205  **FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
206 206  )))
207 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
826 +|(% colspan="4" %)(% colspan="3" %)
208 208  (((
209 -//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.//
828 +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.
210 210  )))
211 211  |(% colspan="1" %)(% colspan="1" %)
212 212  (((
... ... @@ -214,14 +214,14 @@
214 214  )))|(% colspan="1" %)(% colspan="1" %)
215 215  (((
216 216  3.0 Beta 1
217 -)))|(% colspan="1" %)(% colspan="1" %)
836 +)))|(% colspan="2" %)(% colspan="1" %)
218 218  (((
219 219  **$ware.illegal** updated
220 220  )))
221 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
840 +|(% colspan="4" %)(% colspan="3" %)
222 222  (((
223 -//$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
224 -//It now returns true if $ware is illegal to any faction in the game.//
842 +$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.
843 +It now returns true if $ware is illegal to any faction in the game.
225 225  )))
226 226  |(% colspan="1" %)(% colspan="1" %)
227 227  (((
... ... @@ -229,13 +229,13 @@
229 229  )))|(% colspan="1" %)(% colspan="1" %)
230 230  (((
231 231  3.0 Beta 1
232 -)))|(% colspan="1" %)(% colspan="1" %)
851 +)))|(% colspan="2" %)(% colspan="1" %)
233 233  (((
234 234  MD script **RML_Flight_Along_Path** removed
235 235  )))
236 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
855 +|(% colspan="4" %)(% colspan="3" %)
237 237  (((
238 -//The MD script RML_Flight_Along_Path was not referened and was removed.//
857 +The MD script RML_Flight_Along_Path was not referened and was removed.
239 239  )))
240 240  |(% colspan="1" %)(% colspan="1" %)
241 241  (((
... ... @@ -243,71 +243,75 @@
243 243  )))|(% colspan="1" %)(% colspan="1" %)
244 244  (((
245 245  3.0 Beta 1
246 -)))|(% colspan="1" %)(% colspan="1" %)
865 +)))|(% colspan="2" %)(% colspan="1" %)
247 247  (((
248 248  parameters of **<event_venture_mission_completed/>** changed
249 249  )))
250 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
869 +|(% colspan="4" %)(% colspan="3" %)
251 251  (((
252 -//old params: param = venture details, param2 = ships involved, param3 = duration//
253 -//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
871 +old params: param = venture details, param2 = ships involved, param3 = duration
872 +new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration
254 254  )))
255 255  |(((
256 256  Scripts
257 257  )))|(((
258 258  3.0 Beta 1
259 -)))|(((
878 +)))|(% colspan="2" %)(((
260 260  **<set_object_wing_name/>** removed,
261 261  **<set_object_fleet_name/>** added
262 262  )))
263 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
882 +|(% colspan="4" %)(% colspan="3" %)
264 264  (((
265 -//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
884 +The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>
266 266  )))
267 267  |(((
268 268  Scripts
269 269  )))|(((
270 270  3.0 Beta 1
271 -)))|(((
890 +)))|(% colspan="2" %)(((
272 272  **$controllable.wing.*** removed,
273 273  **$controllable.fleet.*** added
274 274  )))
275 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
894 +|(% colspan="4" %)(% colspan="3" %)
276 276  (((
277 277  $controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
278 278  )))
279 -|(% colspan="3" %)(% colspan="3" %)
280 -(((
281 -== 2.60 ==
282 -)))
898 +
899 +----
900 +
901 +=== Version 2.60 ===
902 +
903 +(% class="table-striped" %)
283 283  |(((
284 284  Scripts
285 285  )))|(((
286 286  2.60 Beta 1
287 -)))|(((
908 +)))|(% colspan="2" %)(((
288 288  '**checkoperational**' filter behaviour changed
289 289  )))
290 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
911 +|(% colspan="10" %)(% colspan="3" %)
291 291  (((
292 -//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.//
913 +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.
293 293  
294 -//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
915 +Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.
295 295  )))
296 296  |(((
297 297  Scripts
298 298  )))|(((
299 299  2.60 Beta 1
300 -)))|(((
921 +)))|(% colspan="2" %)(((
301 301  $container.**supplyresources** behavior changed
302 -)))
303 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
923 +)))| | |
924 +|(% colspan="10" %)(% colspan="3" %)
304 304  (((
305 -//The script keyword $container.supplyresources now includes reserved wares.//
926 +The script keyword $container.supplyresources now includes reserved wares.
306 306  )))
307 -|(% colspan="3" %)(% colspan="3" %)
308 -(((
309 -== 2.20 ==
310 -)))
928 +
929 +----
930 +
931 +=== Version 2.20 ===
932 +
933 +(% class="table-striped" %)
311 311  |(% colspan="1" %)(% colspan="1" %)
312 312  (((
313 313  UI core
... ... @@ -314,17 +314,16 @@
314 314  )))|(% colspan="1" %)(% colspan="1" %)
315 315  (((
316 316  2.20 Beta 3/4
317 -)))|(% colspan="1" %)(% colspan="1" %)
940 +)))|(% colspan="2" %)(% colspan="1" %)
318 318  (((
319 319  **Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined.
320 320  )))
321 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
944 +|(% colspan="4" %)(% colspan="3" %)
322 322  (((
323 -//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.
324 -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.//
946 +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.
947 +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.
325 325  
326 -//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.
327 -//
949 +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.
328 328  )))
329 329  |(% colspan="1" %)(% colspan="1" %)
330 330  (((
... ... @@ -332,18 +332,20 @@
332 332  )))|(% colspan="1" %)(% colspan="1" %)
333 333  (((
334 334  2.20 Beta 3
335 -)))|(% colspan="1" %)(% colspan="1" %)
957 +)))|(% colspan="2" %)(% colspan="1" %)
336 336  (((
337 337  Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor'
338 338  )))
339 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
961 +|(% colspan="4" %)(% colspan="3" %)
340 340  (((
341 -//The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
963 +The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.
342 342  )))
343 -|(% colspan="3" %)(% colspan="3" %)
344 -(((
345 -== 2.00 ==
346 -)))
965 +
966 +----
967 +
968 +=== Version 2.00 ===
969 +
970 +(% class="table-striped" %)
347 347  |(% colspan="1" %)(% colspan="1" %)
348 348  (((
349 349  Scripts
... ... @@ -350,13 +350,13 @@
350 350  )))|(% colspan="1" %)(% colspan="1" %)
351 351  (((
352 352  2.00 Beta 1
353 -)))|(% colspan="1" %)(% colspan="1" %)
977 +)))|(% colspan="2" %)(% colspan="1" %)
354 354  (((
355 355  **<event_build_finished/> **param2 now returns null instead of a construction sequence
356 356  )))
357 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
981 +|(% colspan="4" %)(% colspan="3" %)
358 358  (((
359 -//The construction sequence which was finished should now be accessed via the buildtask provided via param3.//
983 +The construction sequence which was finished should now be accessed via the buildtask provided via param3.
360 360  )))
361 361  |(% colspan="1" %)(% colspan="1" %)
362 362  (((
... ... @@ -364,13 +364,13 @@
364 364  )))|(% colspan="1" %)(% colspan="1" %)
365 365  (((
366 366  2.00 Beta 1
367 -)))|(% colspan="1" %)(% colspan="1" %)
991 +)))|(% colspan="2" %)(% colspan="1" %)
368 368  (((
369 369  **param.boarding.{...}** strength parameters removed
370 370  )))
371 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
995 +|(% colspan="4" %)(% colspan="3" %)
372 372  (((
373 -//The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.//
997 +The 'recruitstrength', 'veteranstrength' and 'elitestrength' script parameters were no longer required for balancing the boarding gameplay, and were removed.
374 374  )))
375 375  |(% colspan="1" %)(% colspan="1" %)
376 376  (((
... ... @@ -378,158 +378,160 @@
378 378  )))|(% colspan="1" %)(% colspan="1" %)
379 379  (((
380 380  2.00 Beta 1
381 -)))|(% colspan="1" %)(% colspan="1" %)
1005 +)))|(% colspan="2" %)(% colspan="1" %)
382 382  (((
383 383  **$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed
384 384  )))
385 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1009 +|(% colspan="4" %)(% colspan="3" %)
386 386  (((
387 -//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.//
1011 +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.
388 388  )))
389 389  |(((
390 390  UI extensions
391 391  )))|(((
392 392  2.00 Beta 1
393 -)))|(((
1017 +)))|(% colspan="2" %)(((
394 394  **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals
395 395  )))
396 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1020 +|(% colspan="4" %)(% colspan="3" %)
397 397  (((
398 -//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.//
1022 +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.
399 399  )))
400 400  |(((
401 401  UI extensions
402 402  )))|(((
403 403  2.00 Beta 1
404 -)))|(((
1028 +)))|(% colspan="2" %)(((
405 405  **FFI: SetFormationShape()** no longer indicates an error upon certain error cases
406 406  )))
407 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1031 +|(% colspan="4" %)(% colspan="3" %)
408 408  (((
409 -//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.//
410 -//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.//
1033 +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.
1034 +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.
411 411  )))
412 412  |(((
413 413  Scripts
414 414  )))|(((
415 415  2.00 Beta 1
416 -)))|(((
1040 +)))|(% colspan="2" %)(((
417 417  **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated.
418 418  )))
419 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1043 +|(% colspan="4" %)(% colspan="3" %)
420 420  (((
421 -//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.//
1045 +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.
422 422  )))
423 423  |(((
424 424  Scripts
425 425  )))|(((
426 426  2.00 Beta 1
427 -)))|(((
1051 +)))|(% colspan="2" %)(((
428 428  **<event_player_changed_target/>** now fires and returns null if the player deselects a target.
429 429  )))
430 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1054 +|(% colspan="4" %)(% colspan="3" %)
431 431  (((
432 -//For prior behavior, check for event.param being non-null.//
1056 +For prior behavior, check for event.param being non-null.
433 433  )))
434 434  |(((
435 435  AI Scripts
436 436  )))|(((
437 437  2.00 Beta 1
438 -)))|(((
1062 +)))|(% colspan="2" %)(((
439 439  **<shoot/>/<shoot_at/>** attribute changes.
440 440  )))
441 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1065 +|(% colspan="4" %)(% colspan="3" %)
442 442  (((
443 -//Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//
444 -//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.//
445 -//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.//
1067 +Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.
1068 +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.
1069 +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.
446 446  
447 -//Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.//
1071 +Corrects now-obsolete assumption that primary weapon groups only contain guns and secondary weapon groups only contain missile launchers.
448 448  )))
449 449  |(((
450 450  UI extensions
451 451  )))|(((
452 452  2.00 Beta 1
453 -)))|(((
454 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %)
1077 +)))|(% colspan="2" %)(((
1078 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.
455 455  )))
456 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1080 +|(% colspan="4" %)(% colspan="3" %)
457 457  (((
458 -//Added possibility to query build tasks of a certain buildmodule.//
1082 +Added possibility to query build tasks of a certain buildmodule.
459 459  )))
460 460  |(((
461 461  UI extensions
462 462  )))|(((
463 463  2.00 Beta 1
464 -)))|(((
1088 +)))|(% colspan="2" %)(((
465 465  **Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field.
466 466  )))
467 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1091 +|(% colspan="4" %)(% colspan="3" %)
468 468  (((
469 -//Added list of resources a buildmodule needs to build.//
1093 +Added list of resources a buildmodule needs to build.
470 470  )))
471 471  |(((
472 472  UI extensions
473 473  )))|(((
474 474  2.00 Beta 1
475 -)))|(((
476 -(% 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);" %)
1099 +)))|(% colspan="2" %)(((
1100 +**Lua: CalculateTotalHullFraction() **was removed.
477 477  )))
478 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1102 +|(% colspan="4" %)(% colspan="3" %)
479 479  (((
480 -//Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//
1104 +Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.
481 481  )))
482 482  |(((
483 483  UI extensions
484 484  )))|(((
485 485  2.00 Beta 1
486 -)))|(((
487 -**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" %)
1110 +)))|(% colspan="2" %)(((
1111 +**FFI: RequestDockAtReason()/UndockPlayerShip() **changed their return values.
488 488  )))
489 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1113 +|(% colspan="4" %)(% colspan="3" %)
490 490  (((
491 -//Changed return value type to const char* to better identify failure reasons in Lua script.//
1115 +Changed return value type to const char* to better identify failure reasons in Lua script.
492 492  )))
493 -|(% colspan="3" %)(% colspan="3" %)
494 -(((
495 -== 1.50 ==
496 -)))
1117 +
1118 +----
1119 +
1120 +=== Version 1.50 ===
1121 +
1122 +(% class="table-striped" %)
497 497  |(((
498 498  UI extensions
499 499  )))|(((
500 500  1.50 Beta 3
501 -)))|(((
502 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %)
1127 +)))|(% colspan="2" %)(((
1128 +**Lua: GetComponentData() **changed behavior of "docksizes" property.
503 503  )))
504 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1130 +|(% colspan="4" %)(% colspan="3" %)
505 505  (((
506 -//The "docksizes" property no longer includes internal ship storage docks.//
1132 +The "docksizes" property no longer includes internal ship storage docks.
507 507  )))
508 508  |(((
509 509  All
510 510  )))|(((
511 511  1.50 Beta 2
512 -)))|(((
1138 +)))|(% colspan="2" %)(((
513 513  **Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR).
514 514  )))
515 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1141 +|(% colspan="4" %)(% colspan="3" %)
516 516  (((
517 -//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".//
1143 +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".
518 518  
519 -//Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//
520 -//Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//
521 -//Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)//
1145 +Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()
1146 +Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"
1147 +Scripts: Fixed property .isshipyard, added .iswharf (.canbuildships existed already)
522 522  )))
523 523  |(((
524 524  UI extensions
525 525  )))|(((
526 526  1.50 Beta 2
527 -)))|(((
528 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %)
1153 +)))|(% colspan="2" %)(((
1154 +**FFI: UpgradeGroupInfo **datatype was changed.
529 529  )))
530 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1156 +|(% colspan="4" %)(% colspan="3" %)
531 531  (((
532 -//Added new "operational" field to retrieve information about number of operational upgrades in a group.//
1158 +Added new "operational" field to retrieve information about number of operational upgrades in a group.
533 533  )))
534 534  |(% colspan="1" %)(% colspan="1" %)
535 535  (((
... ... @@ -537,55 +537,58 @@
537 537  )))|(% colspan="1" %)(% colspan="1" %)
538 538  (((
539 539  1.50 Beta 1
540 -)))|(% colspan="1" %)(% colspan="1" %)
1166 +)))|(% colspan="2" %)(% colspan="1" %)
541 541  (((
542 542  **FFI: SetGuidance()** removed useinfopoint argument.
543 543  )))
544 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1170 +|(% colspan="4" %)(% colspan="3" %)
545 545  (((
546 -//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.
547 -//
1172 +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.
548 548  
549 -//The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//
1174 +The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)
550 550  )))
551 551  |(((
552 552  UI extensions
553 553  )))|(((
554 554  1.50 Beta 1
555 -)))|(((
556 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %)
1180 +)))|(% colspan="2" %)(((
1181 +**FFI: CancelConstruction() **changed its return value.
557 557  )))
558 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1183 +|(% colspan="4" %)(% colspan="3" %)
559 559  (((
560 -(% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
1185 +CancelConstruction() now returns if the cancellation was successful.
561 561  )))
562 -|(% colspan="3" %)(% colspan="3" %)
563 -(((
564 -== 1.32 ==
565 -)))
1187 +
1188 +----
1189 +
1190 +=== Version 1.32 ===
1191 +
1192 +(% class="table-striped" %)
566 566  |(((
567 567  UI extensions
568 568  )))|(((
569 569  1.32
570 -)))|(((
1197 +)))|(% colspan="2" %)(((
571 571  **Lua: GetComponentData() **removed the "nextdestname" property.
572 572  )))
573 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1200 +|(% colspan="4" %)(% colspan="3" %)
574 574  (((
575 -//Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
1202 +Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.
576 576  )))
577 -|(% colspan="3" %)(% colspan="3" %)
578 -(((
579 -== 1.20 ==
580 -)))
1204 +
1205 +----
1206 +
1207 +=== Version 1.20 ===
1208 +
1209 +(% class="table-striped" %)
581 581  |(((
582 582  UI extensions
583 583  )))|(((
584 584  1.20
585 -)))|(((
586 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %)
1214 +)))|(% colspan="2" %)(((
1215 +**FFI: GetAAOption()** got a new "useconfig" parameter.
587 587  )))
588 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
1217 +|(% colspan="4" %)(% colspan="3" %)
589 589  (((
590 -//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.//
1219 +//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.//
591 591  )))
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,0 @@
1 -89132385
space
... ... @@ -1,1 +1,0 @@
1 -X4WIKI
url
... ... @@ -1,1 +1,0 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/89132385/Breaking Changes