Skip to Content

Changes for page Breaking Changes

Last modified by Michael Baumgardt on 2026/04/17 12:03
From version 63.1
edited by cbj
on 2020/04/30 11:13
Change comment: Formatting again
To version 46.1
edited by michael
on 2019/11/20 10:21
Change comment: correct event and parameter names

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.cbj
1 +xwiki:XWiki.michael
Content
... ... @@ -27,143 +27,13 @@
27 27  )))
28 28  |(% colspan="3" %)(% colspan="3" %)
29 29  (((
30 -== 3.20 ==
31 -)))
32 -|(((
33 -Scripts
34 -)))|(((
35 -3.20 Beta 1
36 -)))|(((
37 -Parameters of **<event_player_attacked_object/>** and **<event_object_attacked_object/>** changed
38 -)))
39 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
40 -(((
41 -//Old params: param = attacked object, param2 = attack method, param3 = attacked component//
42 -//New params: param = attacked object, param2 = attack method, param3 = attack component detail list: [attacked component, attacking weapon]
43 -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//
44 -)))
45 -|(((
46 -UI extensions
47 -)))|(((
48 -3.20 Beta 1
49 -)))|(((
50 -**FFI**: Deprecated the following functions: **GetContainerAllowedBuildFactions()**, **GetNumContainerAllowedBuildFactions()**, **IsContainerFactionBuildRescricted()**, **IsContainerFactionTradeRescricted()**, **SetContainerBuildAllowedFactions()**, **SetContainerFactionBuildRescricted()**
51 -)))
52 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
53 -(((
54 -//With the addition of the Trade Rule feature the given functions are considered deprecated and should not be used anymore. Consider GetAllTradeRules(), GetContainerTradeRuleID(), SetContainerTradeRule() and similar trade rule functions for replacement.//
55 -)))
56 -|(((
57 -UI extensions
58 -)))|(((
59 -3.20 Beta 1
60 -)))|(((
61 -**Lua**: **GetTradeRestrictions()**, **ToggleFactionTradeRestriction()** and **ToggleFactionTradeWareOverride()** are now obsolete!
62 -)))
63 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
64 -(((
65 -//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.//
66 -)))
67 -|(% colspan="3" %)(% colspan="3" %)
68 -(((
69 -== 3.10 ==
70 -)))
71 -|(% colspan="1" %)(% colspan="1" %)
72 -(((
73 -Scripts
74 -)))|(% colspan="1" %)(% colspan="1" %)
75 -(((
76 -3.10 Beta 1
77 -)))|(% colspan="1" %)(% colspan="1" %)
78 -(((
79 -Removed script action **<add_build/>**
80 -)))
81 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
82 -(((
83 -//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.//
84 -)))
85 -|(% colspan="3" %)(% colspan="3" %)
86 -(((
87 87  == 3.00 ==
88 88  )))
89 89  |(% colspan="1" %)(% colspan="1" %)
90 90  (((
91 -Scripts
92 -)))|(% colspan="1" %)(% colspan="1" %)
93 -(((
94 -3.0 Beta 6
95 -)))|(% colspan="1" %)(% colspan="1" %)
96 -(((
97 -Changed behaviour of script action **<get_suitable_job/>**
98 -)))
99 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
100 -(((
101 -//<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.//
102 -)))
103 -|(% colspan="1" %)(% colspan="1" %)
104 -(((
105 -Scripts
106 -)))|(% colspan="1" %)(% colspan="1" %)
107 -(((
108 -3.0 Beta 6
109 -)))|(% colspan="1" %)(% colspan="1" %)
110 -(((
111 -Changed behaviour of script action **<get_ware_definition/>**
112 -)))
113 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
114 -(((
115 -//<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.//
116 -)))
117 -|(% colspan="1" %)(% colspan="1" %)
118 -(((
119 119  Global
120 120  )))|(% colspan="1" %)(% colspan="1" %)
121 121  (((
122 -3.0 Beta 5
123 -)))|(% colspan="1" %)(% colspan="1" %)
124 -(((
125 -Renamed all files in the **md**, ui, and **cutscenes** folders to lower-case
126 -)))
127 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
128 -(((
129 -//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.)\\
130 -
131 -//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).//
132 -)))
133 -|(% colspan="1" %)(% colspan="1" %)
134 -(((
135 -Scripts
136 -)))|(% colspan="1" %)(% colspan="1" %)
137 -(((
138 -3.0 Beta 5
139 -)))|(% colspan="1" %)(% colspan="1" %)
140 -(((
141 -Adjustments of some MD library cues in the base game to change their usage from **<include_actions>** to <run_actions>
142 -)))
143 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
144 -(((
145 -//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.//
146 -)))
147 -|(% colspan="1" %)(% colspan="1" %)
148 -(((
149 -Scripts
150 -)))|(% colspan="1" %)(% colspan="1" %)
151 -(((
152 -3.0 Beta 5
153 -)))|(% colspan="1" %)(% colspan="1" %)
154 -(((
155 -Changes to $dockingbay.**todockpos** and $dockingbay.**launchpos**
156 -)))
157 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
158 -(((
159 -//Before the change, positions are relative to $dockingbay.parent.
160 -After the change, positions are relative to $dockingbay as specified in the documentation.//
161 -)))
162 -|(% colspan="1" %)(% colspan="1" %)
163 -(((
164 -Global
165 -)))|(% colspan="1" %)(% colspan="1" %)
166 -(((
167 167  3.0 Beta 2
168 168  )))|(% colspan="1" %)(% colspan="1" %)
169 169  (((
... ... @@ -182,10 +182,10 @@
182 182  )))
183 183  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
184 184  (((
185 -//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.
55 +//Before 3.0 Beta 2 there was just a single event_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.
186 186  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.
187 -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.
188 -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).
57 +If in your scripts you make use of the event_changed_owner condition you need to verify that you indeed want to work with the "effective" component owner or whether your script code actually should work with the true owner of an object and update your code accordingly.
58 +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).//
189 189  )))
190 190  |(% colspan="1" %)(% colspan="1" %)
191 191  (((
... ... @@ -195,23 +195,12 @@
195 195  3.0 Beta 1
196 196  )))|(% colspan="1" %)(% colspan="1" %)
197 197  (((
198 -**MissionBoard** support dropped
68 +MissionBoard support dropped
199 199  )))
200 200  |(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
201 201  (((
202 -//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.//
72 +//MissionBoards was a dummy asset type which was only used during early development and never meant to be shipped in the released version. If any mod tried to make use of this asset type, undefined behavior would occur. Therefore we cleaned things up in 3.0 Beta 1 including deprecating/removing any related UI/script function.//
203 203  )))
204 -|(((
205 -Job/God
206 -)))|(((
207 -3.0 Beta 1
208 -)))|(((
209 -By default, **job/god entries** now only spawn objects in space added by the extension in which they are defined
210 -)))
211 -|(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="3" data-highlight-colour="grey" %)
212 -(((
213 -//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.//
214 -)))
215 215  |(% colspan="1" %)(% colspan="1" %)
216 216  (((
217 217  Scripts
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -91949219
1 +88346135
url
... ... @@ -1,1 +1,1 @@
1 -https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/91949219/Breaking Changes
1 +https://www.egosoft.com:8444/confluence/wiki/spaces/X4WIKI/pages/88346135/Breaking Changes