Changes for page Breaking Changes
Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 75.1
edited by stefan
on 2021/02/01 04:38
on 2021/02/01 04:38
Change comment:
There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 0 added, 1 removed)
Details
- Page properties
-
- Parent
-
... ... @@ -1,0 +1,1 @@ 1 +X4 Foundations Wiki.Modding Support.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 -xwiki:XWiki. stefan1 +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 -{{no te}}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 -{{/no te}}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,143 +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 - UIcore140 +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 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 -|(% c lass="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 '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. 51 -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). 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 52 52 )))|(% colspan="1" %)(% colspan="1" %) 53 53 ((( 54 - 192 +6.00 Beta 1 193 +)))|(% colspan="2" %)(% colspan="1" %) 194 +((( 195 +Changed result attribute location for **<get_attackstrength>** 55 55 ))) 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 +))) 56 56 |((( 57 - Parameters202 +Assets 58 58 )))|((( 59 -4.00 Beta 1 60 -)))|((( 61 -**requiresconstructionvessel** parameter moved 62 -)))|((( 63 - 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 64 64 ))) 65 -|(% c lass="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%" %) 66 66 ((( 67 -//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. 68 68 ))) 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 +))) 69 69 |((( 70 70 Scripts 71 71 )))|((( 72 -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 73 73 )))|((( 74 -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 75 75 )))|((( 76 - 258 +5.00 Beta 1 259 +)))|(% colspan="2" %)((( 260 +**<controlpanel><entry>: minduration** removed, **maxduration** renamed to duration 77 77 ))) 78 -|(% c lass="highlight-grey" colspan="3"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="3"data-highlight-colour="grey"%)262 +|(% colspan="7" %)(% colspan="3" %) 79 79 ((( 80 -//The 'gatedistance' script property now minimizes the number of gate jumps instead of counting the number gate jumps in the fastest route.// 81 -)))|(% 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" %) 82 82 ((( 83 - 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 84 84 ))) 85 -|(% colspan="4" %)(% colspan=" 4" %)282 +|(% colspan="4" %)(% colspan="3" %) 86 86 ((( 87 - ==3.30==284 +The functionality represented by SetMapRenderCargoContents(), SetMapRenderWorkForceInfo(), SetMapRenderCrewInfo() and SetMapRenderDockedShipInfos() has been removed and the function was therefore stubbed. 88 88 ))) 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 +))) 89 89 |((( 90 90 UI extensions 91 91 )))|((( 92 -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 93 93 )))|((( 94 -**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()** 95 -)))|(% 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" %) 96 96 ((( 97 - 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. 98 98 ))) 99 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)350 +|(% colspan="1" %)(% colspan="1" %) 100 100 ((( 101 -//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 102 102 ))) 103 -|(% colspan="4" %)(% colspan=" 4" %)360 +|(% colspan="4" %)(% colspan="3" %) 104 104 ((( 105 - ==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. 106 106 ))) 107 107 |((( 108 108 Scripts 109 109 )))|((( 110 -3.20 Beta 1 111 -)))|((( 112 -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 113 113 )))|(% colspan="1" %)(% colspan="1" %) 114 114 ((( 115 - 386 +4.00 Beta 10 387 +)))|(% colspan="2" %)(% colspan="1" %) 388 +((( 389 +Controlled ship can change without a **gameplanchange-event** occurring. 116 116 ))) 117 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)391 +|(% colspan="4" %)(% colspan="3" %) 118 118 ((( 119 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component// 120 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon] 121 -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. 122 122 ))) 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 +))) 123 123 |(% colspan="1" %)(% colspan="1" %) 124 124 ((( 125 - Scripts411 +UI core 126 126 )))|(% colspan="1" %)(% colspan="1" %) 127 127 ((( 128 - 3.20 Beta1129 -)))|(% colspan=" 1" %)(% colspan="1" %)414 +4.00 Beta 6 415 +)))|(% colspan="2" %)(% colspan="1" %) 130 130 ((( 131 -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 132 132 )))|(% colspan="1" %)(% colspan="1" %) 133 133 ((( 134 - 431 +4.00 Beta 5 432 +)))|(% colspan="2" %)(% colspan="1" %) 433 +((( 434 +**FFI:** GetRelationStatus()/GetRelationStatus2() handling for objects in relation range [-25,-10] changed 135 135 ))) 136 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)436 +|(% colspan="4" %)(% colspan="3" %) 137 137 ((( 138 -//$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). 139 139 ))) 140 140 |((( 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 +|((( 141 141 UI extensions 142 142 )))|((( 143 -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 144 144 )))|((( 145 -**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 146 146 )))|(% colspan="1" %)(% colspan="1" %) 147 147 ((( 148 - 505 +3.20 Beta 1 506 +)))|(% colspan="2" %)(% colspan="1" %) 507 +((( 508 +Removed script property $trade.**restriction.faction** 149 149 ))) 150 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)510 +|(% colspan="4" %)(% colspan="3" %) 151 151 ((( 152 - //With theaddition of theTradeRule featurethe givenfunctionsareobsolete anddo notfunction anymore.This setof functions willreturndummy valuestoavoidbreakingscripts.Use GetAllTradeRules(), GetContainerTradeRuleID(),SetContainerTradeRule() and similar trade rulefunctionsas replacement.//512 +$trade.restriction.faction has been replaced with $trade.restriction.factions, which returns a list of factions. 153 153 ))) 154 -|(% 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" %) 155 155 ((( 156 - ==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. 157 157 ))) 525 + 526 +---- 527 + 528 +=== Version 3.10 === 529 + 530 +(% class="table-striped" %) 158 158 |(% colspan="1" %)(% colspan="1" %) 159 159 ((( 160 160 Scripts ... ... @@ -161,21 +161,20 @@ 161 161 )))|(% colspan="1" %)(% colspan="1" %) 162 162 ((( 163 163 3.10 Beta 1 164 -)))|(% colspan=" 1" %)(% colspan="1" %)537 +)))|(% colspan="2" %)(% colspan="1" %) 165 165 ((( 166 166 Removed script action **<add_build/>** 167 -)))|(% colspan="1" %)(% colspan="1" %) 168 -((( 169 - 170 170 ))) 171 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)541 +|(% colspan="7" %)(% colspan="3" %) 172 172 ((( 173 - //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. 174 174 ))) 175 -|(% colspan="4" %)(% colspan="4" %) 176 -((( 177 -== 3.00 == 178 -))) 545 + 546 +---- 547 + 548 +=== Version 3.00 === 549 + 550 +(% class="table-striped" %) 179 179 |(% colspan="1" %)(% colspan="1" %) 180 180 ((( 181 181 Scripts ... ... @@ -182,16 +182,13 @@ 182 182 )))|(% colspan="1" %)(% colspan="1" %) 183 183 ((( 184 184 3.0 Beta 6 185 -)))|(% colspan=" 1" %)(% colspan="1" %)557 +)))|(% colspan="2" %)(% colspan="1" %) 186 186 ((( 187 187 Changed behaviour of script action **<get_suitable_job/>** 188 -)))|(% colspan="1" %)(% colspan="1" %) 189 -((( 190 - 191 191 ))) 192 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)561 +|(% colspan="4" %)(% colspan="3" %) 193 193 ((( 194 - //<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. 195 195 ))) 196 196 |(% colspan="1" %)(% colspan="1" %) 197 197 ((( ... ... @@ -199,16 +199,13 @@ 199 199 )))|(% colspan="1" %)(% colspan="1" %) 200 200 ((( 201 201 3.0 Beta 6 202 -)))|(% colspan=" 1" %)(% colspan="1" %)571 +)))|(% colspan="2" %)(% colspan="1" %) 203 203 ((( 204 204 Changed behaviour of script action **<get_ware_definition/>** 205 -)))|(% colspan="1" %)(% colspan="1" %) 206 -((( 207 - 208 208 ))) 209 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)575 +|(% colspan="4" %)(% colspan="3" %) 210 210 ((( 211 - //<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. 212 212 ))) 213 213 |(% colspan="1" %)(% colspan="1" %) 214 214 ((( ... ... @@ -216,18 +216,15 @@ 216 216 )))|(% colspan="1" %)(% colspan="1" %) 217 217 ((( 218 218 3.0 Beta 5 219 -)))|(% colspan=" 1" %)(% colspan="1" %)585 +)))|(% colspan="2" %)(% colspan="1" %) 220 220 ((( 221 221 Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case 222 -)))|(% colspan="1" %)(% colspan="1" %) 223 -((( 224 - 225 225 ))) 226 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)589 +|(% colspan="4" %)(% colspan="3" %) 227 227 ((( 228 - //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.) 229 229 230 - //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). 231 231 ))) 232 232 |(% colspan="1" %)(% colspan="1" %) 233 233 ((( ... ... @@ -235,16 +235,13 @@ 235 235 )))|(% colspan="1" %)(% colspan="1" %) 236 236 ((( 237 237 3.0 Beta 5 238 -)))|(% colspan=" 1" %)(% colspan="1" %)601 +)))|(% colspan="2" %)(% colspan="1" %) 239 239 ((( 240 240 Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions> 241 -)))|(% colspan="1" %)(% colspan="1" %) 242 -((( 243 - 244 244 ))) 245 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)605 +|(% colspan="4" %)(% colspan="3" %) 246 246 ((( 247 - //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. 248 248 ))) 249 249 |(% colspan="1" %)(% colspan="1" %) 250 250 ((( ... ... @@ -252,17 +252,14 @@ 252 252 )))|(% colspan="1" %)(% colspan="1" %) 253 253 ((( 254 254 3.0 Beta 5 255 -)))|(% colspan=" 1" %)(% colspan="1" %)615 +)))|(% colspan="2" %)(% colspan="1" %) 256 256 ((( 257 257 Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos** 258 -)))|(% colspan="1" %)(% colspan="1" %) 259 -((( 260 - 261 261 ))) 262 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)619 +|(% colspan="4" %)(% colspan="3" %) 263 263 ((( 264 - //Before the change, positions are relative to $dockingbay.parent.265 -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. 266 266 ))) 267 267 |(% colspan="1" %)(% colspan="1" %) 268 268 ((( ... ... @@ -270,30 +270,24 @@ 270 270 )))|(% colspan="1" %)(% colspan="1" %) 271 271 ((( 272 272 3.0 Beta 2 273 -)))|(% colspan=" 1" %)(% colspan="1" %)630 +)))|(% colspan="2" %)(% colspan="1" %) 274 274 ((( 275 275 Support for entity flag "**skillsvisible**" dropped 276 -)))|(% colspan="1" %)(% colspan="1" %) 277 -((( 278 - 279 279 ))) 280 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)634 +|(% colspan="4" %)(% colspan="3" %) 281 281 ((( 282 - //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(). 283 283 ))) 284 284 |((( 285 285 Scripts 286 286 )))|((( 287 287 3.0 Beta 2 288 -)))|((( 642 +)))|(% colspan="2" %)((( 289 289 Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**. 290 -)))|(% colspan="1" %)(% colspan="1" %) 291 -((( 292 - 293 293 ))) 294 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)645 +|(% colspan="4" %)(% colspan="3" %) 295 295 ((( 296 - //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. 297 297 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. 298 298 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. 299 299 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). ... ... @@ -304,30 +304,24 @@ 304 304 )))|(% colspan="1" %)(% colspan="1" %) 305 305 ((( 306 306 3.0 Beta 1 307 -)))|(% colspan=" 1" %)(% colspan="1" %)658 +)))|(% colspan="2" %)(% colspan="1" %) 308 308 ((( 309 309 **MissionBoard** support dropped 310 -)))|(% colspan="1" %)(% colspan="1" %) 311 -((( 312 - 313 313 ))) 314 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)662 +|(% colspan="4" %)(% colspan="3" %) 315 315 ((( 316 - //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. 317 317 ))) 318 318 |((( 319 319 Job/God 320 320 )))|((( 321 321 3.0 Beta 1 322 -)))|((( 670 +)))|(% colspan="2" %)((( 323 323 By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined 324 -)))|(% colspan="1" %)(% colspan="1" %) 325 -((( 326 - 327 327 ))) 328 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)673 +|(% colspan="4" %)(% colspan="3" %) 329 329 ((( 330 - //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. 331 331 ))) 332 332 |(% colspan="1" %)(% colspan="1" %) 333 333 ((( ... ... @@ -335,16 +335,13 @@ 335 335 )))|(% colspan="1" %)(% colspan="1" %) 336 336 ((( 337 337 3.0 Beta 1 338 -)))|(% colspan=" 1" %)(% colspan="1" %)683 +)))|(% colspan="2" %)(% colspan="1" %) 339 339 ((( 340 340 Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'** 341 -)))|(% colspan="1" %)(% colspan="1" %) 342 -((( 343 - 344 344 ))) 345 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)687 +|(% colspan="4" %)(% colspan="3" %) 346 346 ((( 347 - //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. 348 348 ))) 349 349 |(% colspan="1" %)(% colspan="1" %) 350 350 ((( ... ... @@ -352,16 +352,13 @@ 352 352 )))|(% colspan="1" %)(% colspan="1" %) 353 353 ((( 354 354 3.0 Beta 1 355 -)))|(% colspan=" 1" %)(% colspan="1" %)697 +)))|(% colspan="2" %)(% colspan="1" %) 356 356 ((( 357 357 Script action **<set_doors_locked/>** attribute **'group'** changed 358 -)))|(% colspan="1" %)(% colspan="1" %) 359 -((( 360 - 361 361 ))) 362 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)701 +|(% colspan="4" %)(% colspan="3" %) 363 363 ((( 364 - //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. 365 365 ))) 366 366 |(% colspan="1" %)(% colspan="1" %) 367 367 ((( ... ... @@ -369,16 +369,13 @@ 369 369 )))|(% colspan="1" %)(% colspan="1" %) 370 370 ((( 371 371 3.0 Beta 1 372 -)))|(% colspan=" 1" %)(% colspan="1" %)711 +)))|(% colspan="2" %)(% colspan="1" %) 373 373 ((( 374 374 Script conditions **<event_hack_*/>** and **<event_controlpanel_hack_*/>** removed 375 -)))|(% colspan="1" %)(% colspan="1" %) 376 -((( 377 - 378 378 ))) 379 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)715 +|(% colspan="4" %)(% colspan="3" %) 380 380 ((( 381 - //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. 382 382 ))) 383 383 |(% colspan="1" %)(% colspan="1" %) 384 384 ((( ... ... @@ -386,16 +386,13 @@ 386 386 )))|(% colspan="1" %)(% colspan="1" %) 387 387 ((( 388 388 3.0 Beta 1 389 -)))|(% colspan=" 1" %)(% colspan="1" %)725 +)))|(% colspan="2" %)(% colspan="1" %) 390 390 ((( 391 391 Script actions **<set_hack_target/>** and **<abort_hack/>** removed 392 -)))|(% colspan="1" %)(% colspan="1" %) 393 -((( 394 - 395 395 ))) 396 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)729 +|(% colspan="4" %)(% colspan="3" %) 397 397 ((( 398 - //These actions had no effect and were removed.//731 +These actions had no effect and were removed. 399 399 ))) 400 400 |(% colspan="1" %)(% colspan="1" %) 401 401 ((( ... ... @@ -403,16 +403,13 @@ 403 403 )))|(% colspan="1" %)(% colspan="1" %) 404 404 ((( 405 405 3.0 Beta 1 406 -)))|(% colspan=" 1" %)(% colspan="1" %)739 +)))|(% colspan="2" %)(% colspan="1" %) 407 407 ((( 408 408 **<setup_conversation_minigame/>** script action removed 409 -)))|(% colspan="1" %)(% colspan="1" %) 410 -((( 411 - 412 412 ))) 413 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)743 +|(% colspan="4" %)(% colspan="3" %) 414 414 ((( 415 - //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. 416 416 ))) 417 417 |(% colspan="1" %)(% colspan="1" %) 418 418 ((( ... ... @@ -420,16 +420,13 @@ 420 420 )))|(% colspan="1" %)(% colspan="1" %) 421 421 ((( 422 422 3.0 Beta 1 423 -)))|(% colspan=" 1" %)(% colspan="1" %)753 +)))|(% colspan="2" %)(% colspan="1" %) 424 424 ((( 425 425 <add_player_choice_*> **confidence** attribute removed 426 -)))|(% colspan="1" %)(% colspan="1" %) 427 -((( 428 - 429 429 ))) 430 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)757 +|(% colspan="4" %)(% colspan="3" %) 431 431 ((( 432 - //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. 433 433 ))) 434 434 |(% colspan="1" %)(% colspan="1" %) 435 435 ((( ... ... @@ -437,16 +437,13 @@ 437 437 )))|(% colspan="1" %)(% colspan="1" %) 438 438 ((( 439 439 3.0 Beta 1 440 -)))|(% colspan=" 1" %)(% colspan="1" %)767 +)))|(% colspan="2" %)(% colspan="1" %) 441 441 ((( 442 442 **<hack_via_control_panel/>** script action removed 443 -)))|(% colspan="1" %)(% colspan="1" %) 444 -((( 445 - 446 446 ))) 447 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)771 +|(% colspan="4" %)(% colspan="3" %) 448 448 ((( 449 - //Unused script action <hack_via_control_panel/> was removed.//773 +Unused script action <hack_via_control_panel/> was removed. 450 450 ))) 451 451 |(% colspan="1" %)(% colspan="1" %) 452 452 ((( ... ... @@ -454,30 +454,24 @@ 454 454 )))|(% colspan="1" %)(% colspan="1" %) 455 455 ((( 456 456 3.0 Beta 1 457 -)))|(% colspan=" 1" %)(% colspan="1" %)781 +)))|(% colspan="2" %)(% colspan="1" %) 458 458 ((( 459 459 **Lua: **GetMiniGameCursorPosition() removed 460 -)))|(% colspan="1" %)(% colspan="1" %) 461 -((( 462 - 463 463 ))) 464 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)785 +|(% colspan="4" %)(% colspan="3" %) 465 465 ((( 466 - //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. 467 467 ))) 468 468 |((( 469 469 UI core 470 470 )))|((( 471 471 3.0 Beta 1 472 -)))|((( 793 +)))|(% colspan="2" %)((( 473 473 **FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders 474 -)))|(% colspan="1" %)(% colspan="1" %) 475 -((( 476 - 477 477 ))) 478 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)796 +|(% colspan="4" %)(% colspan="3" %) 479 479 ((( 480 - //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. 481 481 ))) 482 482 |(% colspan="1" %)(% colspan="1" %) 483 483 ((( ... ... @@ -485,16 +485,13 @@ 485 485 )))|(% colspan="1" %)(% colspan="1" %) 486 486 ((( 487 487 3.0 Beta 1 488 -)))|(% colspan=" 1" %)(% colspan="1" %)806 +)))|(% colspan="2" %)(% colspan="1" %) 489 489 ((( 490 490 **FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor 491 -)))|(% colspan="1" %)(% colspan="1" %) 492 -((( 493 - 494 494 ))) 495 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)810 +|(% colspan="4" %)(% colspan="3" %) 496 496 ((( 497 - //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. 498 498 ))) 499 499 |(% colspan="1" %)(% colspan="1" %) 500 500 ((( ... ... @@ -502,17 +502,14 @@ 502 502 )))|(% colspan="1" %)(% colspan="1" %) 503 503 ((( 504 504 3.0 Beta 1 505 -)))|(% colspan=" 1" %)(% colspan="1" %)820 +)))|(% colspan="2" %)(% colspan="1" %) 506 506 ((( 507 507 **$ware.illegal** updated 508 -)))|(% colspan="1" %)(% colspan="1" %) 509 -((( 510 - 511 511 ))) 512 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)824 +|(% colspan="4" %)(% colspan="3" %) 513 513 ((( 514 - //$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//515 - //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. 516 516 ))) 517 517 |(% colspan="1" %)(% colspan="1" %) 518 518 ((( ... ... @@ -520,16 +520,13 @@ 520 520 )))|(% colspan="1" %)(% colspan="1" %) 521 521 ((( 522 522 3.0 Beta 1 523 -)))|(% colspan=" 1" %)(% colspan="1" %)835 +)))|(% colspan="2" %)(% colspan="1" %) 524 524 ((( 525 525 MD script **RML_Flight_Along_Path** removed 526 -)))|(% colspan="1" %)(% colspan="1" %) 527 -((( 528 - 529 529 ))) 530 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)839 +|(% colspan="4" %)(% colspan="3" %) 531 531 ((( 532 - //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. 533 533 ))) 534 534 |(% colspan="1" %)(% colspan="1" %) 535 535 ((( ... ... @@ -537,86 +537,75 @@ 537 537 )))|(% colspan="1" %)(% colspan="1" %) 538 538 ((( 539 539 3.0 Beta 1 540 -)))|(% colspan=" 1" %)(% colspan="1" %)849 +)))|(% colspan="2" %)(% colspan="1" %) 541 541 ((( 542 542 parameters of **<event_venture_mission_completed/>** changed 543 -)))|(% colspan="1" %)(% colspan="1" %) 544 -((( 545 - 546 546 ))) 547 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)853 +|(% colspan="4" %)(% colspan="3" %) 548 548 ((( 549 - //old params: param = venture details, param2 = ships involved, param3 = duration//550 - //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 551 551 ))) 552 552 |((( 553 553 Scripts 554 554 )))|((( 555 555 3.0 Beta 1 556 -)))|((( 862 +)))|(% colspan="2" %)((( 557 557 **<set_object_wing_name/>** removed, 558 558 **<set_object_fleet_name/>** added 559 -)))|(% colspan="1" %)(% colspan="1" %) 560 -((( 561 - 562 562 ))) 563 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)866 +|(% colspan="4" %)(% colspan="3" %) 564 564 ((( 565 - //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/> 566 566 ))) 567 567 |((( 568 568 Scripts 569 569 )))|((( 570 570 3.0 Beta 1 571 -)))|((( 874 +)))|(% colspan="2" %)((( 572 572 **$controllable.wing.*** removed, 573 573 **$controllable.fleet.*** added 574 -)))|(% colspan="1" %)(% colspan="1" %) 575 -((( 576 - 577 577 ))) 578 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)878 +|(% colspan="4" %)(% colspan="3" %) 579 579 ((( 580 580 $controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander 581 581 ))) 582 -|(% colspan="4" %)(% colspan="4" %) 583 -((( 584 -== 2.60 == 585 -))) 882 + 883 +---- 884 + 885 +=== Version 2.60 === 886 + 887 +(% class="table-striped" %) 586 586 |((( 587 587 Scripts 588 588 )))|((( 589 589 2.60 Beta 1 590 -)))|((( 892 +)))|(% colspan="2" %)((( 591 591 '**checkoperational**' filter behaviour changed 592 -)))|(% colspan="1" %)(% colspan="1" %) 593 -((( 594 - 595 595 ))) 596 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)895 +|(% colspan="10" %)(% colspan="3" %) 597 597 ((( 598 - //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. 599 599 600 - //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. 601 601 ))) 602 602 |((( 603 603 Scripts 604 604 )))|((( 605 605 2.60 Beta 1 606 -)))|((( 905 +)))|(% colspan="2" %)((( 607 607 $container.**supplyresources** behavior changed 608 -)))|(% colspan="1" %)(% colspan="1" %) 907 +)))| | | 908 +|(% colspan="10" %)(% colspan="3" %) 609 609 ((( 610 - 910 +The script keyword $container.supplyresources now includes reserved wares. 611 611 ))) 612 -|(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="4" data-highlight-colour="grey" %) 613 -((( 614 -//The script keyword $container.supplyresources now includes reserved wares.// 615 -))) 616 -|(% colspan="4" %)(% colspan="4" %) 617 -((( 618 -== 2.20 == 619 -))) 912 + 913 +---- 914 + 915 +=== Version 2.20 === 916 + 917 +(% class="table-striped" %) 620 620 |(% colspan="1" %)(% colspan="1" %) 621 621 ((( 622 622 UI core ... ... @@ -623,20 +623,16 @@ 623 623 )))|(% colspan="1" %)(% colspan="1" %) 624 624 ((( 625 625 2.20 Beta 3/4 626 -)))|(% colspan=" 1" %)(% colspan="1" %)924 +)))|(% colspan="2" %)(% colspan="1" %) 627 627 ((( 628 628 **Lua: GetControllerInfo()** returned mouseSteering/mouseCursor values are undefined. 629 -)))|(% colspan="1" %)(% colspan="1" %) 630 -((( 631 - 632 632 ))) 633 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)928 +|(% colspan="4" %)(% colspan="3" %) 634 634 ((( 635 - //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.636 -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. 637 637 638 -//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. 639 -// 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. 640 640 ))) 641 641 |(% colspan="1" %)(% colspan="1" %) 642 642 ((( ... ... @@ -644,21 +644,20 @@ 644 644 )))|(% colspan="1" %)(% colspan="1" %) 645 645 ((( 646 646 2.20 Beta 3 647 -)))|(% colspan=" 1" %)(% colspan="1" %)941 +)))|(% colspan="2" %)(% colspan="1" %) 648 648 ((( 649 649 Attribute for build related conditions e.g. **<event_build_finished/>** renamed from 'buildmodule' to 'buildprocessor' 650 -)))|(% colspan="1" %)(% colspan="1" %) 651 -((( 652 - 653 653 ))) 654 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)945 +|(% colspan="4" %)(% colspan="3" %) 655 655 ((( 656 - //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. 657 657 ))) 658 -|(% colspan="4" %)(% colspan="4" %) 659 -((( 660 -== 2.00 == 661 -))) 949 + 950 +---- 951 + 952 +=== Version 2.00 === 953 + 954 +(% class="table-striped" %) 662 662 |(% colspan="1" %)(% colspan="1" %) 663 663 ((( 664 664 Scripts ... ... @@ -665,16 +665,13 @@ 665 665 )))|(% colspan="1" %)(% colspan="1" %) 666 666 ((( 667 667 2.00 Beta 1 668 -)))|(% colspan=" 1" %)(% colspan="1" %)961 +)))|(% colspan="2" %)(% colspan="1" %) 669 669 ((( 670 670 **<event_build_finished/> **param2 now returns null instead of a construction sequence 671 -)))|(% colspan="1" %)(% colspan="1" %) 672 -((( 673 - 674 674 ))) 675 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)965 +|(% colspan="4" %)(% colspan="3" %) 676 676 ((( 677 - //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. 678 678 ))) 679 679 |(% colspan="1" %)(% colspan="1" %) 680 680 ((( ... ... @@ -682,16 +682,13 @@ 682 682 )))|(% colspan="1" %)(% colspan="1" %) 683 683 ((( 684 684 2.00 Beta 1 685 -)))|(% colspan=" 1" %)(% colspan="1" %)975 +)))|(% colspan="2" %)(% colspan="1" %) 686 686 ((( 687 687 **param.boarding.{...}** strength parameters removed 688 -)))|(% colspan="1" %)(% colspan="1" %) 689 -((( 690 - 691 691 ))) 692 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)979 +|(% colspan="4" %)(% colspan="3" %) 693 693 ((( 694 - //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. 695 695 ))) 696 696 |(% colspan="1" %)(% colspan="1" %) 697 697 ((( ... ... @@ -699,197 +699,160 @@ 699 699 )))|(% colspan="1" %)(% colspan="1" %) 700 700 ((( 701 701 2.00 Beta 1 702 -)))|(% colspan=" 1" %)(% colspan="1" %)989 +)))|(% colspan="2" %)(% colspan="1" %) 703 703 ((( 704 704 **$defensible.boardee/$defensible.boarder** and **<set_object_boarder/>/<remove_object_boarder/>** removed 705 -)))|(% colspan="1" %)(% colspan="1" %) 706 -((( 707 - 708 708 ))) 709 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)993 +|(% colspan="4" %)(% colspan="3" %) 710 710 ((( 711 - //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. 712 712 ))) 713 713 |((( 714 714 UI extensions 715 715 )))|((( 716 716 2.00 Beta 1 717 -)))|((( 1001 +)))|(% colspan="2" %)((( 718 718 **FFI: GetUpgradeSlotCurrentComponent()/GetUpgradeSlotGroup()** works on non-operationals 719 -)))|(% colspan="1" %)(% colspan="1" %) 720 -((( 721 - 722 722 ))) 723 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1004 +|(% colspan="4" %)(% colspan="3" %) 724 724 ((( 725 - //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. 726 726 ))) 727 727 |((( 728 728 UI extensions 729 729 )))|((( 730 730 2.00 Beta 1 731 -)))|((( 1012 +)))|(% colspan="2" %)((( 732 732 **FFI: SetFormationShape()** no longer indicates an error upon certain error cases 733 -)))|(% colspan="1" %)(% colspan="1" %) 734 -((( 735 - 736 736 ))) 737 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1015 +|(% colspan="4" %)(% colspan="3" %) 738 738 ((( 739 - //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.//740 - //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. 741 741 ))) 742 742 |((( 743 743 Scripts 744 744 )))|((( 745 745 2.00 Beta 1 746 -)))|((( 1024 +)))|(% colspan="2" %)((( 747 747 **<create_formation/>** now requires the attributes: 'leader' and 'follower'. Attribute 'object' is now deprecated. 748 -)))|(% colspan="1" %)(% colspan="1" %) 749 -((( 750 - 751 751 ))) 752 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1027 +|(% colspan="4" %)(% colspan="3" %) 753 753 ((( 754 - //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. 755 755 ))) 756 756 |((( 757 757 Scripts 758 758 )))|((( 759 759 2.00 Beta 1 760 -)))|((( 1035 +)))|(% colspan="2" %)((( 761 761 **<event_player_changed_target/>** now fires and returns null if the player deselects a target. 762 -)))|(% colspan="1" %)(% colspan="1" %) 763 -((( 764 - 765 765 ))) 766 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1038 +|(% colspan="4" %)(% colspan="3" %) 767 767 ((( 768 - //For prior behavior, check for event.param being non-null.//1040 +For prior behavior, check for event.param being non-null. 769 769 ))) 770 770 |((( 771 771 AI Scripts 772 772 )))|((( 773 773 2.00 Beta 1 774 -)))|((( 1046 +)))|(% colspan="2" %)((( 775 775 **<shoot/>/<shoot_at/>** attribute changes. 776 -)))|(% colspan="1" %)(% colspan="1" %) 777 -((( 778 - 779 779 ))) 780 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1049 +|(% colspan="4" %)(% colspan="3" %) 781 781 ((( 782 - //Changed: Attribute "primary" is now optional and defines whether weapons from the ship's active primary weapon group will be fired. Defaults to true.//783 - //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.//784 - //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. 785 785 786 - //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. 787 787 ))) 788 788 |((( 789 789 UI extensions 790 790 )))|((( 791 791 2.00 Beta 1 792 -)))|((( 793 -**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter.(% class="confluenceTd" %) 794 -)))|(% colspan="1" %)(% colspan="1" %) 795 -((( 796 - 1061 +)))|(% colspan="2" %)((( 1062 +**FFI: GetBuildTask()/GetNumBuildTasks()** got a new "buildmoduleid" parameter. 797 797 ))) 798 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1064 +|(% colspan="4" %)(% colspan="3" %) 799 799 ((( 800 - //Added possibility to query build tasks of a certain buildmodule.//1066 +Added possibility to query build tasks of a certain buildmodule. 801 801 ))) 802 802 |((( 803 803 UI extensions 804 804 )))|((( 805 805 2.00 Beta 1 806 -)))|((( 1072 +)))|(% colspan="2" %)((( 807 807 **Lua:** **GetLibraryEntry()** retrieved a new "buildresources" field. 808 -)))|(% colspan="1" %)(% colspan="1" %) 809 -((( 810 - 811 811 ))) 812 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1075 +|(% colspan="4" %)(% colspan="3" %) 813 813 ((( 814 - //Added list of resources a buildmodule needs to build.//1077 +Added list of resources a buildmodule needs to build. 815 815 ))) 816 816 |((( 817 817 UI extensions 818 818 )))|((( 819 819 2.00 Beta 1 820 -)))|((( 821 -(% 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);" %) 822 -)))|(% colspan="1" %)(% colspan="1" %) 823 -((( 824 - 1083 +)))|(% colspan="2" %)((( 1084 +**Lua: CalculateTotalHullFraction() **was removed. 825 825 ))) 826 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1086 +|(% colspan="4" %)(% colspan="3" %) 827 827 ((( 828 - //Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead.//1088 +Unused, derelict function from XR - use GetComponentData(..., "hullpercent") instead. 829 829 ))) 830 830 |((( 831 831 UI extensions 832 832 )))|((( 833 833 2.00 Beta 1 834 -)))|((( 835 -**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" %) 836 -)))|(% colspan="1" %)(% colspan="1" %) 837 -((( 838 - 1094 +)))|(% colspan="2" %)((( 1095 +**FFI: RequestDockAtReason()/UndockPlayerShip() **changed their return values. 839 839 ))) 840 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1097 +|(% colspan="4" %)(% colspan="3" %) 841 841 ((( 842 - //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. 843 843 ))) 844 -|(% colspan="4" %)(% colspan="4" %) 845 -((( 846 -== 1.50 == 847 -))) 1101 + 1102 +---- 1103 + 1104 +=== Version 1.50 === 1105 + 1106 +(% class="table-striped" %) 848 848 |((( 849 849 UI extensions 850 850 )))|((( 851 851 1.50 Beta 3 852 -)))|((( 853 -**Lua: GetComponentData() **changed behavior of "docksizes" propertly.(% class="confluenceTd" %) 854 -)))|(% colspan="1" %)(% colspan="1" %) 855 -((( 856 - 1111 +)))|(% colspan="2" %)((( 1112 +**Lua: GetComponentData() **changed behavior of "docksizes" property. 857 857 ))) 858 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1114 +|(% colspan="4" %)(% colspan="3" %) 859 859 ((( 860 - //The "docksizes" property no longer includes internal ship storage docks.//1116 +The "docksizes" property no longer includes internal ship storage docks. 861 861 ))) 862 862 |((( 863 863 All 864 864 )))|((( 865 865 1.50 Beta 2 866 -)))|((( 1122 +)))|(% colspan="2" %)((( 867 867 **Meaning of "Shipyard"** was corrected throughout Lua/MD/AI scripts, so that Wharfs are not Shipyards (unlike in XR). 868 -)))|(% colspan="1" %)(% colspan="1" %) 869 -((( 870 - 871 871 ))) 872 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1125 +|(% colspan="4" %)(% colspan="3" %) 873 873 ((( 874 - //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". 875 875 876 - //Lua: Adjusted GetComponentData() and HasShipyard(), added HasWharf()//877 - //Lua / GetComponentData() properties: Removed "iscapitalshipyard", fixed "isshipyard", added "canbuildships", "iswharf", "isequipmentdock"//878 - //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) 879 879 ))) 880 880 |((( 881 881 UI extensions 882 882 )))|((( 883 883 1.50 Beta 2 884 -)))|((( 885 -**FFI: UpgradeGroupInfo **datatype was changed.(% class="confluenceTd" %) 886 -)))|(% colspan="1" %)(% colspan="1" %) 887 -((( 888 - 1137 +)))|(% colspan="2" %)((( 1138 +**FFI: UpgradeGroupInfo **datatype was changed. 889 889 ))) 890 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1140 +|(% colspan="4" %)(% colspan="3" %) 891 891 ((( 892 - //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. 893 893 ))) 894 894 |(% colspan="1" %)(% colspan="1" %) 895 895 ((( ... ... @@ -897,67 +897,58 @@ 897 897 )))|(% colspan="1" %)(% colspan="1" %) 898 898 ((( 899 899 1.50 Beta 1 900 -)))|(% colspan=" 1" %)(% colspan="1" %)1150 +)))|(% colspan="2" %)(% colspan="1" %) 901 901 ((( 902 902 **FFI: SetGuidance()** removed useinfopoint argument. 903 -)))|(% colspan="1" %)(% colspan="1" %) 904 -((( 905 - 906 906 ))) 907 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1154 +|(% colspan="4" %)(% colspan="3" %) 908 908 ((( 909 -//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. 910 -// 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. 911 911 912 - //The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset)//1158 +The new function declaration is: void SetGuidance(UniverseID componentid, UIPosRot offset) 913 913 ))) 914 914 |((( 915 915 UI extensions 916 916 )))|((( 917 917 1.50 Beta 1 918 -)))|((( 919 -**FFI: CancelConstruction() **changed its return value.(% class="confluenceTd" %) 920 -)))|(% colspan="1" %)(% colspan="1" %) 921 -((( 922 - 1164 +)))|(% colspan="2" %)((( 1165 +**FFI: CancelConstruction() **changed its return value. 923 923 ))) 924 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1167 +|(% colspan="4" %)(% colspan="3" %) 925 925 ((( 926 - (% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful.//1169 +CancelConstruction() now returns if the cancellation was successful. 927 927 ))) 928 -|(% colspan="4" %)(% colspan="4" %) 929 -((( 930 -== 1.32 == 931 -))) 1171 + 1172 +---- 1173 + 1174 +=== Version 1.32 === 1175 + 1176 +(% class="table-striped" %) 932 932 |((( 933 933 UI extensions 934 934 )))|((( 935 935 1.32 936 -)))|((( 1181 +)))|(% colspan="2" %)((( 937 937 **Lua: GetComponentData() **removed the "nextdestname" property. 938 -)))|(% colspan="1" %)(% colspan="1" %) 939 -((( 940 - 941 941 ))) 942 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1184 +|(% colspan="4" %)(% colspan="3" %) 943 943 ((( 944 - //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. 945 945 ))) 946 -|(% colspan="4" %)(% colspan="4" %) 947 -((( 948 -== 1.20 == 949 -))) 1188 + 1189 +---- 1190 + 1191 +=== Version 1.20 === 1192 + 1193 +(% class="table-striped" %) 950 950 |((( 951 951 UI extensions 952 952 )))|((( 953 953 1.20 954 -)))|((( 955 -**FFI: GetAAOption()** got a new "useconfig" parameter.(% class="confluenceTd" %) 956 -)))|(% colspan="1" %)(% colspan="1" %) 957 -((( 958 - 1198 +)))|(% colspan="2" %)((( 1199 +**FFI: GetAAOption()** got a new "useconfig" parameter. 959 959 ))) 960 -|(% c lass="highlight-grey" colspan="4"data-highlight-colour="grey"%)(% class="highlight-grey" colspan="4"data-highlight-colour="grey"%)1201 +|(% colspan="4" %)(% colspan="3" %) 961 961 ((( 962 -//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.// 963 963 )))
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,0 @@ 1 -101548080 - space
-
... ... @@ -1,1 +1,0 @@ 1 -X4WIKI - url
-
... ... @@ -1,1 +1,0 @@ 1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/101548080/Breaking Changes