Changes for page Breaking Changes

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

Manage
- Copy
Actions
- Export
- Print Preview

From 35.1 to 36.1 From 55.1 to 56.1

From version 36.1

edited by owen
on 2019/08/26 00:28

Change comment: There is no comment for this version

To version 55.1

edited by stefan
on 2020/01/17 14:41

Change comment: extended list of lower file name change to cover UI files as well

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Author

@@ -1,1 +1,1 @@
--xwiki:XWiki.owen
++xwiki:XWiki.stefan

Content

@@ -25,19 +25,121 @@
  )))|=(((
  Summary
  )))
++|(% colspan="3" %)(% colspan="3" %)
++(((
++== 3.00 ==
++)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
++Global
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 5
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.)\\
++
++//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).//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
  Scripts
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
++3.0 Beta 5
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 5
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//Before the change, positions are relative to $dockingbay.parent.
++After the change, positions are relative to $dockingbay as specified in the documentation.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Global
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 2
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Support for entity flag "**skillsvisible**" dropped
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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().//
++)))
++|(((
++Scripts
++)))|(((
++3.0 Beta 2
++)))|(((
++Changes to **<event_object_changed_owner>** and added **<event_object_changed_true_owner>**.
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.
++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.
++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.
++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).
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Global
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
 .0 Beta 1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
++**MissionBoard** support dropped
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.//
++)))
++|(((
++Job/God
++)))|(((
++3.0 Beta 1
++)))|(((
++By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Scripts
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
  Script action **<add_actor_to_room/> **attribute **'room'** renamed to **'object'**
  )))
  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
  (((
--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.
++//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.//
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -137,8 +137,33 @@
  (((
  //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.//
  )))
++|(((
++UI core
++)))|(((
++3.0 Beta 1
++)))|(((
++**FFI: **GetLocalizedInteractiveNotificationKey can return icon placeholders
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.//
++)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
++UI extensions
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++3.0 Beta 1
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++**FFI: **UIWeaponMod returned by GetInstalledWeaponMod() now includes property SurfaceElementFactor
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.//
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
  Scripts
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
@@ -150,7 +150,7 @@
  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
  (((
  //$ware.illegal used to return true if the specified ware has the 'illegal' tag which is no longer used.//
--\\//It now returns true if $ware is illegal to any faction in the game.//
++//It now returns true if $ware is illegal to any faction in the game.//
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -160,13 +160,11 @@
 .0 Beta 1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--'**checkoperational**' filter behaviour changed
++MD script **RML_Flight_Along_Path** removed
  )))
  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
  (((
--//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.//
--
--//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
++//The MD script RML_Flight_Along_Path was not referened and was removed.//
  )))
  |(% colspan="1" %)(% colspan="1" %)
  (((
@@ -176,12 +176,69 @@
 .0 Beta 1
  )))|(% colspan="1" %)(% colspan="1" %)
  (((
--MD script **RML_Flight_Along_Path** removed
++parameters of **<event_venture_mission_completed/>** changed
  )))
  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
  (((
--//The MD script RML_Flight_Along_Path was not referened and was removed.//
++//old params: param = venture details, param2 = ships involved, param3 = duration//
++//new params: param = venture detail list: [mission name, mission type], param2 = list of ships involved, param3 = duration//
  )))
++|(((
++Scripts
++)))|(((
++3.0 Beta 1
++)))|(((
++**<set_object_wing_name/>** removed,
++**<set_object_fleet_name/>** added
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The common action <set_object_wing_name/> has been replaced with <set_object_fleet_name/>//
++)))
++|(((
++Scripts
++)))|(((
++3.0 Beta 1
++)))|(((
++**$controllable.wing.*** removed,
++**$controllable.fleet.*** added
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++$controllable.wing.name, $controllable.wing.iscommander, and $controllable.wing.commander have been replaced with $controllable.fleet.name, $controllable.fleet.iscommander, and $controllable.fleet.commander
++)))
++|(% colspan="3" %)(% colspan="3" %)
++(((
++== 2.60 ==
++)))
++|(((
++Scripts
++)))|(((
++2.60 Beta 1
++)))|(((
++'**checkoperational**' filter behaviour changed
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//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.//
++
++//Sub nodes such as match_child will have checkoperational default to false. Existing uses may find that results now include non-operational components.//
++)))
++|(((
++Scripts
++)))|(((
++2.60 Beta 1
++)))|(((
++$container.**supplyresources** behavior changed
++)))
++|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
++(((
++//The script keyword $container.supplyresources now includes reserved wares.//
++)))
++|(% colspan="3" %)(% colspan="3" %)
++(((
++== 2.20 ==
++)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
  UI core
@@ -214,6 +214,10 @@
  (((
  //The underlying behaviour remains the same in that it involves the buildprocessor, not the buildmodule. The attribute name has simply been corrected.//
  )))
++|(% colspan="3" %)(% colspan="3" %)
++(((
++== 2.00 ==
++)))
  |(% colspan="1" %)(% colspan="1" %)
  (((
  Scripts
@@ -360,6 +360,10 @@
  (((
  //Changed return value type to const char* to better identify failure reasons in Lua script.//
  )))
++|(% colspan="3" %)(% colspan="3" %)
++(((
++== 1.50 ==
++)))
  |(((
  UI extensions
  )))|(((
@@ -425,6 +425,10 @@
  (((
  (% style="color: rgb(0,0,0);" %)//CancelConstruction() now returns if the cancellation was successful. //
  )))
++|(% colspan="3" %)(% colspan="3" %)
++(((
++== 1.32 ==
++)))
  |(((
  UI extensions
  )))|(((
@@ -436,6 +436,10 @@
  (((
  //Instead of "nextdestname", use the properties "destination" or "destinationsector" to retrieve a destination component, then retrieve its "name" property.//
  )))
++|(% colspan="3" %)(% colspan="3" %)
++(((
++== 1.20 ==
++)))
  |(((
  UI extensions
  )))|(((

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--85131856
++89825104

url

@@ -1,1 +1,1 @@
--https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/85131856/Breaking Changes
++https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/89825104/Breaking Changes

Changes for page Breaking Changes

Summary

Details

Navigation

Applications